container_group_definition_versions
Creates, updates, deletes, gets or lists a container_group_definition_versions resource.
Overview
| Name | container_group_definition_versions |
| Type | Resource |
| Id | aws.gamelift.container_group_definition_versions |
Fields
The following fields are returned by SELECT queries:
- list_container_group_definition_versions
| Name | Datatype | Description |
|---|---|---|
container_group_definition_arn | string | The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift Servers ContainerGroupDefinition resource. It uniquely identifies the resource across all Amazon Web Services Regions. Format is arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version]. (pattern: <code>^arn:.*:containergroupdefinition/[a-zA-Z0-9-]+(:[0-9]+)?$</code>) |
container_group_type | string | The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance. (GAME_SERVER, PER_INSTANCE) |
creation_time | string (date-time) | A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). |
game_server_container_definition | object | The definition for the game server container in this group. This property is used only when the container group type is GAME_SERVER. This container definition specifies a container image with the game server build. |
name | string | A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region. (pattern: <code>^[a-zA-Z0-9-]+$</code>) |
operating_system | string | The platform that all containers in the container group definition run on. Amazon Linux 2 (AL2) will reach end of support on 6/30/2026. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5. (AMAZON_LINUX_2023) |
status | string | Current status of the container group definition resource. Values include: COPYING -- Amazon GameLift Servers 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 Servers 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 Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason. A container group definition resource in failed status will be deleted within a few minutes. (READY, COPYING, FAILED) |
status_reason | string | Additional information about a container group definition that's in FAILED status. Possible reasons include: An internal issue prevented Amazon GameLift Servers 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 Servers. The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current Amazon Web Services account. At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift Servers 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. |
support_container_definitions | array | The set of definitions for support containers in this group. A container group definition might have zero support container definitions. Support container can be used in any type of container group. |
total_memory_limit_mebibytes | integer | 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 a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit. |
total_vcpu_limit | number (double) | The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group. |
version_description | string | An optional description that was provided for a container group definition update. Each version can have a unique description. |
version_number | integer | Indicates the version of a particular container group definition. This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_container_group_definition_versions | select | region | This API works with the following fleet types: Container Retrieves all versions of a container group definition. Use the pagination parameters to retrieve results in a set of sequential pages. Request options: Get all versions of a specified container group definition. Specify the container group definition name or ARN value. (If the ARN value has a version number, it's ignored.) Results: If successful, this operation returns the complete properties of a set of container group definition versions that match the request. This operation returns the list of container group definitions in descending version order (latest first). Learn more Manage a container group definition |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_container_group_definition_versions
This API works with the following fleet types: Container Retrieves all versions of a container group definition. Use the pagination parameters to retrieve results in a set of sequential pages. Request options: Get all versions of a specified container group definition. Specify the container group definition name or ARN value. (If the ARN value has a version number, it's ignored.) Results: If successful, this operation returns the complete properties of a set of container group definition versions that match the request. This operation returns the list of container group definitions in descending version order (latest first). Learn more Manage a container group definition
SELECT
container_group_definition_arn,
container_group_type,
creation_time,
game_server_container_definition,
name,
operating_system,
status,
status_reason,
support_container_definitions,
total_memory_limit_mebibytes,
total_vcpu_limit,
version_description,
version_number
FROM aws.gamelift.container_group_definition_versions
WHERE region = '{{ region }}' -- required
;