ContainerGroupDefinition
This data type is currently not available. It is under improvement as we respond to customer feedback from the Containers 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
Contents
Note
In the following list, the required parameters are described first.
- ContainerDefinitions
-
The set of container definitions that are included in the container group.
Type: Array of ContainerDefinition objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- 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 isarn:aws:gamelift:<region>::containergroupdefinition/[container group definition name]
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^arn:.*:containergroupdefinition\/containergroupdefinition-[a-zA-Z0-9-]+$
Required: No
- 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"
).Type: Timestamp
Required: No
- Name
-
A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-]+$
Required: No
- 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. Type: String
Valid Values:
AMAZON_LINUX_2023
Required: No
- 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.
Type: String
Valid Values:
REPLICA | DAEMON
Required: No
- Status
-
Current status of the container group definition resource. Values include:
-
COPYING
-- Amazon GameLift is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet. -
READY
-- Amazon GameLift has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet. -
FAILED
-- Amazon GameLift failed to create a valid container group definition resource. For more details on the cause of the failure, seeStatusReason
. A container group definition resource in failed status will be deleted within a few minutes.
Type: String
Valid Values:
READY | COPYING | FAILED
Required: No
-
- StatusReason
-
Additional information about a container group definition that's in
FAILED
status. Possible reasons include:-
An internal issue prevented Amazon GameLift from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinitionagain.
-
An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift.
-
The
ImageUri
value for at least one of the containers in the container group definition was invalid or not found in the current AWS account. -
At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift endpoints and quotas.
-
At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
-
- 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.
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 10240.
Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 4. Maximum value of 1024000.
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: