ContainerGroupsConfiguration - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ContainerGroupsConfiguration

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

Contents

Note

In the following list, the required parameters are described first.

ConnectionPortRange

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.

Note

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.

Type: ConnectionPortRange object

Required: Yes

ContainerGroupDefinitionNames

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: ^[a-zA-Z0-9\-]+$|^arn:.*:containergroupdefinition\/[a-zA-Z0-9\-]+$

Required: Yes

DesiredReplicaContainerGroupsPerInstance

The number of times to replicate the replica container group on each instance in a container fleet. By default, Amazon GameLift calculates the maximum number of replica container groups that can fit on a fleet instance (based on CPU and memory resources). Leave this parameter empty if you want to use the maximum number, or specify a desired number to override the maximum. The desired number is used if it's less than the maximum number.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5000.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: