Package software.amazon.awscdk.services.gamelift

Interface CfnFleet.ContainerGroupsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.ContainerGroupsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFleet

@Stability(Stable)
public static interface CfnFleet.ContainerGroupsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

This data type is used with the Amazon GameLift containers feature, which is currently in public preview..

Configuration details for a set of container groups, for use when creating a fleet with compute type CONTAINER .

Used with: CreateFleet

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.*;
 ContainerGroupsConfigurationProperty containerGroupsConfigurationProperty = ContainerGroupsConfigurationProperty.builder()
         .connectionPortRange(ConnectionPortRangeProperty.builder()
                 .fromPort(123)
                 .toPort(123)
                 .build())
         .containerGroupDefinitionNames(List.of("containerGroupDefinitionNames"))
         // the properties below are optional
         .containerGroupsPerInstance(ContainerGroupsPerInstanceProperty.builder()
                 .desiredReplicaContainerGroupsPerInstance(123)
                 .maxReplicaContainerGroupsPerInstance(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleet.ContainerGroupsConfigurationProperty.Builder	A builder for CfnFleet.ContainerGroupsConfigurationProperty
static final class	CfnFleet.ContainerGroupsConfigurationProperty.Jsii$Proxy	An implementation for CfnFleet.ContainerGroupsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFleet.ContainerGroupsConfigurationProperty.Builder	builder()
Object	getConnectionPortRange()	A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.
List<String>	getContainerGroupDefinitionNames()	The list of container group definition names to deploy to a new container fleet.
default Object	getContainerGroupsPerInstance()	The number of container groups per instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionPortRange

@Stability(Stable)
@NotNull
Object getConnectionPortRange()

A set of ports to allow inbound traffic, including game clients, to connect to processes running in the container fleet.

Connection ports are dynamically mapped to container ports, which are assigned to individual processes running in a container. The connection port range must have enough ports to map to all container ports across a fleet instance. To calculate the minimum connection ports needed, use the following formula:

[Total number of container ports as defined for containers in the replica container group] * [Desired or calculated number of replica container groups per instance] + [Total number of container ports as defined for containers in the daemon container group]

As a best practice, double the minimum number of connection ports.

Use the fleet's EC2InboundPermissions property to control external access to connection ports. Set this property to the connection port numbers that you want to open access to. See IpPermission for more details.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-connectionportrange

getContainerGroupDefinitionNames

@Stability(Stable)
@NotNull
List<String> getContainerGroupDefinitionNames()

The list of container group definition names to deploy to a new container fleet.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-containergroupdefinitionnames

getContainerGroupsPerInstance

@Stability(Stable)
@Nullable
default Object getContainerGroupsPerInstance()

The number of container groups per instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-containergroupsconfiguration.html#cfn-gamelift-fleet-containergroupsconfiguration-containergroupsperinstance

builder

@Stability(Stable)
static CfnFleet.ContainerGroupsConfigurationProperty.Builder builder()

Returns:

a CfnFleet.ContainerGroupsConfigurationProperty.Builder of CfnFleet.ContainerGroupsConfigurationProperty