Interface CfnContainerFleetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnContainerFleetProps.Jsii$Proxy
CfnContainerFleet
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.gamelift.*; CfnContainerFleetProps cfnContainerFleetProps = CfnContainerFleetProps.builder() .fleetRoleArn("fleetRoleArn") // the properties below are optional .billingType("billingType") .deploymentConfiguration(DeploymentConfigurationProperty.builder() .impairmentStrategy("impairmentStrategy") .minimumHealthyPercentage(123) .protectionStrategy("protectionStrategy") .build()) .description("description") .gameServerContainerGroupDefinitionName("gameServerContainerGroupDefinitionName") .gameServerContainerGroupsPerInstance(123) .gameSessionCreationLimitPolicy(GameSessionCreationLimitPolicyProperty.builder() .newGameSessionsPerCreator(123) .policyPeriodInMinutes(123) .build()) .instanceConnectionPortRange(ConnectionPortRangeProperty.builder() .fromPort(123) .toPort(123) .build()) .instanceInboundPermissions(List.of(IpPermissionProperty.builder() .fromPort(123) .ipRange("ipRange") .protocol("protocol") .toPort(123) .build())) .instanceType("instanceType") .locations(List.of(LocationConfigurationProperty.builder() .location("location") // the properties below are optional .locationCapacity(LocationCapacityProperty.builder() .desiredEc2Instances(123) .maxSize(123) .minSize(123) .build()) .stoppedActions(List.of("stoppedActions")) .build())) .logConfiguration(LogConfigurationProperty.builder() .logDestination("logDestination") .s3BucketName("s3BucketName") .build()) .metricGroups(List.of("metricGroups")) .newGameSessionProtectionPolicy("newGameSessionProtectionPolicy") .perInstanceContainerGroupDefinitionName("perInstanceContainerGroupDefinitionName") .scalingPolicies(List.of(ScalingPolicyProperty.builder() .metricName("metricName") .name("name") // the properties below are optional .comparisonOperator("comparisonOperator") .evaluationPeriods(123) .policyType("policyType") .scalingAdjustment(123) .scalingAdjustmentType("scalingAdjustmentType") .targetConfiguration(TargetConfigurationProperty.builder() .targetValue(123) .build()) .threshold(123) .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnContainerFleetProps
static final class
An implementation forCfnContainerFleetProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Indicates whether the fleet uses On-Demand or Spot instances for this fleet.default Object
Set of rules for processing a deployment for a container fleet update.default String
A meaningful description of the container fleet.The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift.default String
The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.default Number
The number of times to replicate the game server container group on each fleet instance.default Object
A policy that limits the number of game sessions that each individual player can create on instances in this fleet.default Object
The set of port numbers to open on each instance in a container fleet.default Object
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.default String
The Amazon EC2 instance type to use for all instances in the fleet.default Object
default Object
The method that is used to collect container logs for the fleet.The name of an AWS CloudWatch metric group to add this fleet to.default String
Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.default String
The name of the fleet's per-instance container group definition.default Object
A list of rules that control how a fleet is scaled.getTags()
An array of key-value pairs to apply to this resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFleetRoleArn
The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift.See Set up an IAM service role . This fleet property can't be changed.
- See Also:
-
getBillingType
Indicates whether the fleet uses On-Demand or Spot instances for this fleet.Learn more about when to use On-Demand versus Spot Instances . You can't update this fleet property.
By default, this property is set to
ON_DEMAND
.- See Also:
-
getDeploymentConfiguration
Set of rules for processing a deployment for a container fleet update.- See Also:
-
getDescription
A meaningful description of the container fleet.- See Also:
-
getGameServerContainerGroupDefinitionName
The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.- See Also:
-
getGameServerContainerGroupsPerInstance
The number of times to replicate the game server container group on each fleet instance.- See Also:
-
getGameSessionCreationLimitPolicy
A policy that limits the number of game sessions that each individual player can create on instances in this fleet.The limit applies for a specified span of time.
- See Also:
-
getInstanceConnectionPortRange
The set of port numbers to open on each instance in a container fleet.Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
- See Also:
-
getInstanceInboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.- See Also:
-
getInstanceType
The Amazon EC2 instance type to use for all instances in the fleet.Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity. You can't update this fleet property.
- See Also:
-
getLocations
- See Also:
-
getLogConfiguration
The method that is used to collect container logs for the fleet.Amazon GameLift saves all standard output for each container in logs, including game session logs.
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group.S3
-- Store logs in an Amazon S3 bucket that you define.NONE
-- Don't collect container logs.
- See Also:
-
getMetricGroups
The name of an AWS CloudWatch metric group to add this fleet to.Metric groups aggregate metrics for multiple fleets.
- See Also:
-
getNewGameSessionProtectionPolicy
Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.Amazon GameLift might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession .
- NoProtection -- Game sessions can be shut down during active gameplay.
- FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
- See Also:
-
getPerInstanceContainerGroupDefinitionName
The name of the fleet's per-instance container group definition.- See Also:
-
getScalingPolicies
A list of rules that control how a fleet is scaled.- See Also:
-
getTags
An array of key-value pairs to apply to this resource.- See Also:
-
builder
- Returns:
- a
CfnContainerFleetProps.Builder
ofCfnContainerFleetProps
-