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
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnContainerFleetPropsstatic final classAn implementation forCfnContainerFleetProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringIndicates whether to use On-Demand instances or Spot instances for this fleet.default ObjectProvides details about how to drain old tasks and replace them with new updated tasks.default StringA human-readable description of a fleet.A unique identifier for an AWS IAM role that manages access to your AWS services.default StringThe name of the container group definition that will be created per game server.default NumberThe number of desired game server container groups per instance, a number between 1-5000.default ObjectA policy that limits the number of game sessions a player can create on the same fleet.default ObjectDefines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.default ObjectA range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.default StringThe name of an EC2 instance type that is supported in Amazon GameLift.default Objectdefault ObjectA policy the location and provider of logs from the fleet.The name of an Amazon CloudWatch metric group.default StringA game session protection policy to apply to all game sessions hosted on instances in this fleet.default StringThe name of the container group definition that will be created per instance.default ObjectA 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
A unique identifier for an AWS IAM role that manages access to your AWS services.Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- See Also:
-
getBillingType
Indicates whether to use On-Demand instances or Spot instances for this fleet.If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.
- See Also:
-
getDeploymentConfiguration
Provides details about how to drain old tasks and replace them with new updated tasks.- See Also:
-
getDescription
A human-readable description of a fleet.- See Also:
-
getGameServerContainerGroupDefinitionName
The name of the container group definition that will be created per game server.You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.
- See Also:
-
getGameServerContainerGroupsPerInstance
The number of desired game server container groups per instance, a number between 1-5000.- See Also:
-
getGameSessionCreationLimitPolicy
A policy that limits the number of game sessions a player can create on the same fleet.This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".
The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.
- See Also:
-
getInstanceConnectionPortRange
Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.- See Also:
-
getInstanceInboundPermissions
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.- See Also:
-
getInstanceType
The name of an EC2 instance type that is supported in Amazon GameLift.A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
- See Also:
-
getLocations
- See Also:
-
getLogConfiguration
A policy the location and provider of logs from the fleet.- See Also:
-
getMetricGroups
The name of an Amazon CloudWatch metric group.A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- See Also:
-
getNewGameSessionProtectionPolicy
A game session protection policy to apply to all game sessions hosted on instances in this fleet.When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- See Also:
-
getPerInstanceContainerGroupDefinitionName
The name of the container group definition that will be created per instance.This field is optional if you specify GameServerContainerGroupDefinitionName.
- 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.BuilderofCfnContainerFleetProps
-