container_group_definitions

Creates, updates, deletes or gets a container_group_definition resource or lists container_group_definitions in a region

Overview

Name	container_group_definitions
Type	Resource
Description	The AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition.
Id	aws.gamelift.container_group_definitions

Fields

Name	Datatype	Description
container_group_definition_arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions.
creation_time	string	A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
operating_system	string	The operating system of the container group
name	string	A descriptive label for the container group definition.
container_group_type	string	The scope of the container group
total_memory_limit_mebibytes	integer	The total memory limit of container groups following this definition in MiB
total_vcpu_limit	number	The total amount of virtual CPUs on the container group definition
game_server_container_definition	object	Specifies the information required to run game servers with this container group
support_container_definitions	array	A collection of support container definitions that define the containers in this group.
version_number	integer	The version of this ContainerGroupDefinition
source_version_number	integer	A specific ContainerGroupDefinition version to be updated
version_description	string	The description of this version
status	string	A string indicating ContainerGroupDefinition status.
status_reason	string	A string indicating the reason for ContainerGroupDefinition status.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::GameLift::ContainerGroupDefinition.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, OperatingSystem, TotalMemoryLimitMebibytes, TotalVcpuLimit, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all container_group_definitions in a region.

SELECT
region,
container_group_definition_arn,
creation_time,
operating_system,
name,
container_group_type,
total_memory_limit_mebibytes,
total_vcpu_limit,
game_server_container_definition,
support_container_definitions,
version_number,
source_version_number,
version_description,
status,
status_reason,
tags
FROM aws.gamelift.container_group_definitions
WHERE region = 'us-east-1';

Gets all properties from an individual container_group_definition.

SELECT
region,
container_group_definition_arn,
creation_time,
operating_system,
name,
container_group_type,
total_memory_limit_mebibytes,
total_vcpu_limit,
game_server_container_definition,
support_container_definitions,
version_number,
source_version_number,
version_description,
status,
status_reason,
tags
FROM aws.gamelift.container_group_definitions
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new container_group_definition resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.gamelift.container_group_definitions (
 OperatingSystem,
 Name,
 TotalMemoryLimitMebibytes,
 TotalVcpuLimit,
 region
)
SELECT 
'{{ OperatingSystem }}',
 '{{ Name }}',
 '{{ TotalMemoryLimitMebibytes }}',
 '{{ TotalVcpuLimit }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.gamelift.container_group_definitions (
 OperatingSystem,
 Name,
 ContainerGroupType,
 TotalMemoryLimitMebibytes,
 TotalVcpuLimit,
 GameServerContainerDefinition,
 SupportContainerDefinitions,
 SourceVersionNumber,
 VersionDescription,
 Tags,
 region
)
SELECT 
 '{{ OperatingSystem }}',
 '{{ Name }}',
 '{{ ContainerGroupType }}',
 '{{ TotalMemoryLimitMebibytes }}',
 '{{ TotalVcpuLimit }}',
 '{{ GameServerContainerDefinition }}',
 '{{ SupportContainerDefinitions }}',
 '{{ SourceVersionNumber }}',
 '{{ VersionDescription }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: container_group_definition
    props:
      - name: OperatingSystem
        value: '{{ OperatingSystem }}'
      - name: Name
        value: '{{ Name }}'
      - name: ContainerGroupType
        value: '{{ ContainerGroupType }}'
      - name: TotalMemoryLimitMebibytes
        value: '{{ TotalMemoryLimitMebibytes }}'
      - name: TotalVcpuLimit
        value: null
      - name: GameServerContainerDefinition
        value:
          ContainerName: '{{ ContainerName }}'
          DependsOn:
            - ContainerName: '{{ ContainerName }}'
              Condition: '{{ Condition }}'
          ServerSdkVersion: '{{ ServerSdkVersion }}'
          ImageUri: '{{ ImageUri }}'
          ResolvedImageDigest: '{{ ResolvedImageDigest }}'
          EnvironmentOverride:
            - Name: '{{ Name }}'
              Value: '{{ Value }}'
          PortConfiguration:
            ContainerPortRanges:
              - FromPort: '{{ FromPort }}'
                Protocol: '{{ Protocol }}'
                ToPort: '{{ ToPort }}'
          MountPoints:
            - InstancePath: '{{ InstancePath }}'
              ContainerPath: '{{ ContainerPath }}'
              AccessLevel: '{{ AccessLevel }}'
      - name: SupportContainerDefinitions
        value:
          - ContainerName: '{{ ContainerName }}'
            Vcpu: null
            DependsOn:
              - null
            Essential: '{{ Essential }}'
            ImageUri: '{{ ImageUri }}'
            ResolvedImageDigest: '{{ ResolvedImageDigest }}'
            MemoryHardLimitMebibytes: '{{ MemoryHardLimitMebibytes }}'
            EnvironmentOverride:
              - null
            PortConfiguration: null
            HealthCheck:
              Command:
                - '{{ Command[0] }}'
              Interval: '{{ Interval }}'
              Timeout: '{{ Timeout }}'
              Retries: '{{ Retries }}'
              StartPeriod: '{{ StartPeriod }}'
            MountPoints:
              - null
      - name: SourceVersionNumber
        value: '{{ SourceVersionNumber }}'
      - name: VersionDescription
        value: '{{ VersionDescription }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.gamelift.container_group_definitions
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the container_group_definitions resource, the following permissions are required:

Create

gamelift:CreateContainerGroupDefinition,
gamelift:DescribeContainerGroupDefinition,
gamelift:ListTagsForResource,
gamelift:TagResource,
ecr:BatchCheckLayerAvailability,
ecr:BatchGetImage,
ecr:GetDownloadUrlForLayer,
ecr:DescribeImages

Read

gamelift:DescribeContainerGroupDefinition,
gamelift:ListTagsForResource

Update

gamelift:UpdateContainerGroupDefinition,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource

Delete

gamelift:DescribeContainerGroupDefinition,
gamelift:DeleteContainerGroupDefinition

List

gamelift:ListContainerGroupDefinitions