Package software.amazon.awscdk.services.gamelift

Class CfnContainerFleet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.gamelift.CfnContainerFleet

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-04T09:06:23.068Z")
@Stability(Stable)
public class CfnContainerFleet
extends CfnResource
implements IInspectable, ITaggableV2

Describes an Amazon GameLift managed container fleet.

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.*;
 CfnContainerFleet cfnContainerFleet = CfnContainerFleet.Builder.create(this, "MyCfnContainerFleet")
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnContainerFleet.Builder	A fluent builder for CfnContainerFleet.
static interface	CfnContainerFleet.ConnectionPortRangeProperty	The set of port numbers to open on each instance in a container fleet.
static interface	CfnContainerFleet.DeploymentConfigurationProperty	Set of rules for processing a deployment for a container fleet update.
static interface	CfnContainerFleet.DeploymentDetailsProperty	Information about the most recent deployment for the container fleet.
static interface	CfnContainerFleet.GameSessionCreationLimitPolicyProperty	A policy that puts limits on the number of game sessions that a player can create within a specified span of time.
static interface	CfnContainerFleet.IpPermissionProperty	A range of IP addresses and port settings that allow inbound traffic to connect to processes on an instance in a fleet.
static interface	CfnContainerFleet.LocationCapacityProperty	Current resource capacity settings in a specified fleet or location.
static interface	CfnContainerFleet.LocationConfigurationProperty	A remote location where a multi-location fleet can deploy game servers for game hosting.
static interface	CfnContainerFleet.LogConfigurationProperty	A method for collecting container logs for the fleet.
static interface	CfnContainerFleet.ScalingPolicyProperty	Rule that controls how a fleet is scaled.
static interface	CfnContainerFleet.TargetConfigurationProperty	Settings for a target-based scaling policy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnContainerFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContainerFleet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnContainerFleet(software.constructs.Construct scope, String id, CfnContainerFleetProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreationTime()	A time stamp indicating when this data object was created.
IResolvable	getAttrDeploymentDetails()	Provides information about the last deployment ID and its status.
String	getAttrFleetArn()	The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
String	getAttrFleetId()	A unique identifier for the container fleet to retrieve.
String	getAttrGameServerContainerGroupDefinitionArn()	The Amazon Resource Name ( ARN ) that is assigned to the fleet's game server container group.
Number	getAttrMaximumGameServerContainerGroupsPerInstance()	The calculated maximum number of game server container group that can be deployed on each fleet instance.
String	getAttrPerInstanceContainerGroupDefinitionArn()	The Amazon Resource Name ( ARN ) that is assigned to the fleet's per-instance container group.
String	getAttrStatus()	The current status of the container fleet.
String	getBillingType()	Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getDeploymentConfiguration()	Set of rules for processing a deployment for a container fleet update.
String	getDescription()	A meaningful description of the container fleet.
String	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.
String	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.
Number	getGameServerContainerGroupsPerInstance()	The number of times to replicate the game server container group on each fleet instance.
Object	getGameSessionCreationLimitPolicy()	A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
Object	getInstanceConnectionPortRange()	The set of port numbers to open on each instance in a container fleet.
Object	getInstanceInboundPermissions()	The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
String	getInstanceType()	The Amazon EC2 instance type to use for all instances in the fleet.
Object	getLocations()
Object	getLogConfiguration()	The method that is used to collect container logs for the fleet.
List<String>	getMetricGroups()	The name of an AWS CloudWatch metric group to add this fleet to.
String	getNewGameSessionProtectionPolicy()	Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.
String	getPerInstanceContainerGroupDefinitionName()	The name of the fleet's per-instance container group definition.
Object	getScalingPolicies()	A list of rules that control how a fleet is scaled.
List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBillingType(String value)	Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
void	setDeploymentConfiguration(IResolvable value)	Set of rules for processing a deployment for a container fleet update.
void	setDeploymentConfiguration(CfnContainerFleet.DeploymentConfigurationProperty value)	Set of rules for processing a deployment for a container fleet update.
void	setDescription(String value)	A meaningful description of the container fleet.
void	setFleetRoleArn(String value)	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.
void	setGameServerContainerGroupDefinitionName(String value)	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.
void	setGameServerContainerGroupsPerInstance(Number value)	The number of times to replicate the game server container group on each fleet instance.
void	setGameSessionCreationLimitPolicy(IResolvable value)	A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
void	setGameSessionCreationLimitPolicy(CfnContainerFleet.GameSessionCreationLimitPolicyProperty value)	A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
void	setInstanceConnectionPortRange(IResolvable value)	The set of port numbers to open on each instance in a container fleet.
void	setInstanceConnectionPortRange(CfnContainerFleet.ConnectionPortRangeProperty value)	The set of port numbers to open on each instance in a container fleet.
void	setInstanceInboundPermissions(List<Object> value)	The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
void	setInstanceInboundPermissions(IResolvable value)	The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
void	setInstanceType(String value)	The Amazon EC2 instance type to use for all instances in the fleet.
void	setLocations(List<Object> value)
void	setLocations(IResolvable value)
void	setLogConfiguration(IResolvable value)	The method that is used to collect container logs for the fleet.
void	setLogConfiguration(CfnContainerFleet.LogConfigurationProperty value)	The method that is used to collect container logs for the fleet.
void	setMetricGroups(List<String> value)	The name of an AWS CloudWatch metric group to add this fleet to.
void	setNewGameSessionProtectionPolicy(String value)	Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.
void	setPerInstanceContainerGroupDefinitionName(String value)	The name of the fleet's per-instance container group definition.
void	setScalingPolicies(List<Object> value)	A list of rules that control how a fleet is scaled.
void	setScalingPolicies(IResolvable value)	A list of rules that control how a fleet is scaled.
void	setTags(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnContainerFleet

protected CfnContainerFleet(software.amazon.jsii.JsiiObjectRef objRef)

CfnContainerFleet

protected CfnContainerFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnContainerFleet

@Stability(Stable)
public CfnContainerFleet(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnContainerFleetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

A time stamp indicating when this data object was created.

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

getAttrDeploymentDetails

@Stability(Stable)
@NotNull
public IResolvable getAttrDeploymentDetails()

Provides information about the last deployment ID and its status.

getAttrFleetArn

@Stability(Stable)
@NotNull
public String getAttrFleetArn()

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.

getAttrFleetId

@Stability(Stable)
@NotNull
public String getAttrFleetId()

A unique identifier for the container fleet to retrieve.

getAttrGameServerContainerGroupDefinitionArn

@Stability(Stable)
@NotNull
public String getAttrGameServerContainerGroupDefinitionArn()

The Amazon Resource Name ( ARN ) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.

getAttrMaximumGameServerContainerGroupsPerInstance

@Stability(Stable)
@NotNull
public Number getAttrMaximumGameServerContainerGroupsPerInstance()

The calculated maximum number of game server container group that can be deployed on each fleet instance.

The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.

getAttrPerInstanceContainerGroupDefinitionArn

@Stability(Stable)
@NotNull
public String getAttrPerInstanceContainerGroupDefinitionArn()

The Amazon Resource Name ( ARN ) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The current status of the container fleet.

• PENDING -- A new container fleet has been requested.
• CREATING -- A new container fleet resource is being created.
• CREATED -- A new container fleet resource has been created. No fleet instances have been deployed.
• ACTIVATING -- New container fleet instances are being deployed.
• ACTIVE -- The container fleet has been deployed and is ready to host game sessions.
• UPDATING -- Updates to the container fleet is being updated. A deployment is in progress.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFleetRoleArn

@Stability(Stable)
@NotNull
public String 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.

setFleetRoleArn

@Stability(Stable)
public void setFleetRoleArn(@NotNull
 String value)

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.

getBillingType

@Stability(Stable)
@Nullable
public String getBillingType()

Indicates whether the fleet uses On-Demand or Spot instances for this fleet.

setBillingType

@Stability(Stable)
public void setBillingType(@Nullable
 String value)

Indicates whether the fleet uses On-Demand or Spot instances for this fleet.

getDeploymentConfiguration

@Stability(Stable)
@Nullable
public Object getDeploymentConfiguration()

Set of rules for processing a deployment for a container fleet update.

setDeploymentConfiguration

@Stability(Stable)
public void setDeploymentConfiguration(@Nullable
 IResolvable value)

Set of rules for processing a deployment for a container fleet update.

setDeploymentConfiguration

@Stability(Stable)
public void setDeploymentConfiguration(@Nullable
 CfnContainerFleet.DeploymentConfigurationProperty value)

Set of rules for processing a deployment for a container fleet update.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A meaningful description of the container fleet.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A meaningful description of the container fleet.

getGameServerContainerGroupDefinitionName

@Stability(Stable)
@Nullable
public String 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.

setGameServerContainerGroupDefinitionName

@Stability(Stable)
public void setGameServerContainerGroupDefinitionName(@Nullable
 String value)

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.

getGameServerContainerGroupsPerInstance

@Stability(Stable)
@Nullable
public Number getGameServerContainerGroupsPerInstance()

The number of times to replicate the game server container group on each fleet instance.

setGameServerContainerGroupsPerInstance

@Stability(Stable)
public void setGameServerContainerGroupsPerInstance(@Nullable
 Number value)

The number of times to replicate the game server container group on each fleet instance.

getGameSessionCreationLimitPolicy

@Stability(Stable)
@Nullable
public Object getGameSessionCreationLimitPolicy()

A policy that limits the number of game sessions that each individual player can create on instances in this fleet.

setGameSessionCreationLimitPolicy

@Stability(Stable)
public void setGameSessionCreationLimitPolicy(@Nullable
 IResolvable value)

A policy that limits the number of game sessions that each individual player can create on instances in this fleet.

setGameSessionCreationLimitPolicy

@Stability(Stable)
public void setGameSessionCreationLimitPolicy(@Nullable
 CfnContainerFleet.GameSessionCreationLimitPolicyProperty value)

A policy that limits the number of game sessions that each individual player can create on instances in this fleet.

getInstanceConnectionPortRange

@Stability(Stable)
@Nullable
public Object getInstanceConnectionPortRange()

The set of port numbers to open on each instance in a container fleet.

setInstanceConnectionPortRange

@Stability(Stable)
public void setInstanceConnectionPortRange(@Nullable
 IResolvable value)

The set of port numbers to open on each instance in a container fleet.

setInstanceConnectionPortRange

@Stability(Stable)
public void setInstanceConnectionPortRange(@Nullable
 CfnContainerFleet.ConnectionPortRangeProperty value)

The set of port numbers to open on each instance in a container fleet.

getInstanceInboundPermissions

@Stability(Stable)
@Nullable
public Object getInstanceInboundPermissions()

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

setInstanceInboundPermissions

@Stability(Stable)
public void setInstanceInboundPermissions(@Nullable
 IResolvable value)

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

setInstanceInboundPermissions

@Stability(Stable)
public void setInstanceInboundPermissions(@Nullable
 List<Object> value)

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

getInstanceType

@Stability(Stable)
@Nullable
public String getInstanceType()

The Amazon EC2 instance type to use for all instances in the fleet.

setInstanceType

@Stability(Stable)
public void setInstanceType(@Nullable
 String value)

The Amazon EC2 instance type to use for all instances in the fleet.

getLocations

@Stability(Stable)
@Nullable
public Object getLocations()

setLocations

@Stability(Stable)
public void setLocations(@Nullable
 IResolvable value)

setLocations

@Stability(Stable)
public void setLocations(@Nullable
 List<Object> value)

getLogConfiguration

@Stability(Stable)
@Nullable
public Object getLogConfiguration()

The method that is used to collect container logs for the fleet.

setLogConfiguration

@Stability(Stable)
public void setLogConfiguration(@Nullable
 IResolvable value)

The method that is used to collect container logs for the fleet.

setLogConfiguration

@Stability(Stable)
public void setLogConfiguration(@Nullable
 CfnContainerFleet.LogConfigurationProperty value)

The method that is used to collect container logs for the fleet.

getMetricGroups

@Stability(Stable)
@Nullable
public List<String> getMetricGroups()

The name of an AWS CloudWatch metric group to add this fleet to.

setMetricGroups

@Stability(Stable)
public void setMetricGroups(@Nullable
 List<String> value)

The name of an AWS CloudWatch metric group to add this fleet to.

getNewGameSessionProtectionPolicy

@Stability(Stable)
@Nullable
public String getNewGameSessionProtectionPolicy()

Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.

setNewGameSessionProtectionPolicy

@Stability(Stable)
public void setNewGameSessionProtectionPolicy(@Nullable
 String value)

Determines whether Amazon GameLift can shut down game sessions on the fleet that are actively running and hosting players.

getPerInstanceContainerGroupDefinitionName

@Stability(Stable)
@Nullable
public String getPerInstanceContainerGroupDefinitionName()

The name of the fleet's per-instance container group definition.

setPerInstanceContainerGroupDefinitionName

@Stability(Stable)
public void setPerInstanceContainerGroupDefinitionName(@Nullable
 String value)

The name of the fleet's per-instance container group definition.

getScalingPolicies

@Stability(Stable)
@Nullable
public Object getScalingPolicies()

A list of rules that control how a fleet is scaled.

setScalingPolicies

@Stability(Stable)
public void setScalingPolicies(@Nullable
 IResolvable value)

A list of rules that control how a fleet is scaled.

setScalingPolicies

@Stability(Stable)
public void setScalingPolicies(@Nullable
 List<Object> value)

A list of rules that control how a fleet is scaled.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

An array of key-value pairs to apply to this resource.