AWS::GameLift::ContainerGroupDefinition

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

The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.

Used with: CreateContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::GameLift::ContainerGroupDefinition",
  "Properties" : {
      "ContainerDefinitions" : [ ContainerDefinition, ... ],
      "Name" : String,
      "OperatingSystem" : String,
      "SchedulingStrategy" : String,
      "Tags" : [ Tag, ... ],
      "TotalCpuLimit" : Integer,
      "TotalMemoryLimit" : Integer
    }
}

YAML

Type: AWS::GameLift::ContainerGroupDefinition
Properties:
  ContainerDefinitions: 
    - ContainerDefinition
  Name: String
  OperatingSystem: String
  SchedulingStrategy: String
  Tags: 
    - Tag
  TotalCpuLimit: Integer
  TotalMemoryLimit: Integer

Properties

ContainerDefinitions

The set of container definitions that are included in the container group.

Required: Yes

Type: Array of ContainerDefinition

Minimum: 1

Maximum: 10

Update requires: Replacement

Name

A descriptive identifier for the container group definition. The name value is unique in an AWS Region.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

OperatingSystem

The platform required for all containers in the container group definition.

Note

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

Required: Yes

Type: String

Allowed values: AMAZON_LINUX_2023

Update requires: Replacement

SchedulingStrategy

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

Required: No

Type: String

Allowed values: REPLICA | DAEMON

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

TotalCpuLimit

The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

For more details on memory allocation, see the Container fleet design guide.

Required: Yes

Type: Integer

Minimum: 128

Maximum: 10240

Update requires: Replacement

TotalMemoryLimit

The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources.

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

• Equal to or greater than the sum of all container-specific soft memory limits in the group.

• Equal to or greater than any container-specific hard limits in the group.

For more details on memory allocation, see the Container fleet design guide.

Required: Yes

Type: Integer

Minimum: 4

Maximum: 1024000

Update requires: Replacement

Return values

Ref

Fn::GetAtt

ContainerGroupDefinitionArn

The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift ContainerGroupDefinition resource. It uniquely identifies the resource across all AWS Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name].

CreationTime

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").