This product is not supported for your selected Datadog site. ().
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_gamelift_container_group_definition

account_id

Type: STRING

container_group_definition_arn

Type: STRING
Provider name: ContainerGroupDefinitionArn
Description: 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].

container_group_type

Type: STRING
Provider name: ContainerGroupType
Description: The type of container group. Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: 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

Type: STRUCT
Provider name: GameServerContainerDefinition
Description: 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.

  • container_name
    Type: STRING
    Provider name: ContainerName
    Description: The container definition identifier. Container names are unique within a container group definition.
  • depends_on
    Type: UNORDERED_LIST_STRUCT
    Provider name: DependsOn
    Description: Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences. A container might have dependencies on multiple containers.
    • condition
      Type: STRING
      Provider name: Condition
      Description: The condition that the dependency container must reach before the dependent container can start. Valid conditions include:
      • START - The dependency container must have started.
      • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can’t be an essential container.
      • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can’t be an essential container.
      • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.
    • container_name
      Type: STRING
      Provider name: ContainerName
      Description: A descriptive label for the container definition that this container depends on.
  • environment_override
    Type: UNORDERED_LIST_STRUCT
    Provider name: EnvironmentOverride
    Description: A set of environment variables that’s passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
    • name
      Type: STRING
      Provider name: Name
      Description: The environment variable name.
    • value
      Type: STRING
      Provider name: Value
      Description: The environment variable value.
  • image_uri
    Type: STRING
    Provider name: ImageUri
    Description: The URI to the image that Amazon GameLift Servers uses when deploying this container to a container fleet. For a more specific identifier, see ResolvedImageDigest.
  • mount_points
    Type: UNORDERED_LIST_STRUCT
    Provider name: MountPoints
    Description: A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
    • access_level
      Type: STRING
      Provider name: AccessLevel
      Description: The type of access for the container.
    • container_path
      Type: STRING
      Provider name: ContainerPath
      Description: The mount path on the container. If this property isn’t set, the instance path is used.
    • instance_path
      Type: STRING
      Provider name: InstancePath
      Description: The path to the source file or directory.
  • port_configuration
    Type: STRUCT
    Provider name: PortConfiguration
    Description: The set of ports that are available to bind to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. Container ports aren’t directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet’s ConnectionPortRange.
    • container_port_ranges
      Type: UNORDERED_LIST_STRUCT
      Provider name: ContainerPortRanges
      Description: A set of one or more container port number ranges. The ranges can’t overlap if the ranges’ network protocols are the same. Overlapping ranges with different protocols is allowed but not recommended.
      • from_port
        Type: INT32
        Provider name: FromPort
        Description: A starting value for the range of allowed port numbers.
      • protocol
        Type: STRING
        Provider name: Protocol
        Description: The network protocol that these ports support.
      • to_port
        Type: INT32
        Provider name: ToPort
        Description: An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
  • resolved_image_digest
    Type: STRING
    Provider name: ResolvedImageDigest
    Description: A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
  • server_sdk_version
    Type: STRING
    Provider name: ServerSdkVersion
    Description: The Amazon GameLift Servers server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.

name

Type: STRING
Provider name: Name
Description: A descriptive identifier for the container group definition. The name value is unique in an Amazon Web Services Region.

operating_system

Type: STRING
Provider name: OperatingSystem
Description: The platform that all containers in the container group definition run on. 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 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.

status

Type: STRING
Provider name: Status
Description: 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.

status_reason

Type: STRING
Provider name: StatusReason
Description: 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

Type: UNORDERED_LIST_STRUCT
Provider name: SupportContainerDefinitions
Description: 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.

  • container_name
    Type: STRING
    Provider name: ContainerName
    Description: The container definition identifier. Container names are unique within a container group definition.
  • depends_on
    Type: UNORDERED_LIST_STRUCT
    Provider name: DependsOn
    Description: Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.
    • condition
      Type: STRING
      Provider name: Condition
      Description: The condition that the dependency container must reach before the dependent container can start. Valid conditions include:
      • START - The dependency container must have started.
      • COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can’t be an essential container.
      • SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can’t be an essential container.
      • HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.
    • container_name
      Type: STRING
      Provider name: ContainerName
      Description: A descriptive label for the container definition that this container depends on.
  • environment_override
    Type: UNORDERED_LIST_STRUCT
    Provider name: EnvironmentOverride
    Description: A set of environment variables that’s passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
    • name
      Type: STRING
      Provider name: Name
      Description: The environment variable name.
    • value
      Type: STRING
      Provider name: Value
      Description: The environment variable value.
  • essential
    Type: BOOLEAN
    Provider name: Essential
    Description: Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
  • health_check
    Type: STRUCT
    Provider name: HealthCheck
    Description: A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.
    • command
      Type: UNORDERED_LIST_STRING
      Provider name: Command
      Description: A string array that specifies the command that the container runs to determine if it’s healthy.
    • interval
      Type: INT32
      Provider name: Interval
      Description: The time period (in seconds) between each health check.
    • retries
      Type: INT32
      Provider name: Retries
      Description: The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.
    • start_period
      Type: INT32
      Provider name: StartPeriod
      Description: The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.
    • timeout
      Type: INT32
      Provider name: Timeout
      Description: The time period (in seconds) to wait for a health check to succeed before counting a failed health check.
  • image_uri
    Type: STRING
    Provider name: ImageUri
    Description: The URI to the image that Amazon GameLift Servers deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.
  • memory_hard_limit_mebibytes
    Type: INT32
    Provider name: MemoryHardLimitMebibytes
    Description: The amount of memory that Amazon GameLift Servers makes available to the container. If memory limits aren’t set for an individual container, the container shares the container group’s total memory allocation. Related data type: ContainerGroupDefinition TotalMemoryLimitMebibytes
  • mount_points
    Type: UNORDERED_LIST_STRUCT
    Provider name: MountPoints
    Description: A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
    • access_level
      Type: STRING
      Provider name: AccessLevel
      Description: The type of access for the container.
    • container_path
      Type: STRING
      Provider name: ContainerPath
      Description: The mount path on the container. If this property isn’t set, the instance path is used.
    • instance_path
      Type: STRING
      Provider name: InstancePath
      Description: The path to the source file or directory.
  • port_configuration
    Type: STRUCT
    Provider name: PortConfiguration
    Description: A set of ports that allow access to the container from external users. Processes running in the container can bind to a one of these ports. Container ports aren’t directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet’s ConnectionPortRange.
    • container_port_ranges
      Type: UNORDERED_LIST_STRUCT
      Provider name: ContainerPortRanges
      Description: A set of one or more container port number ranges. The ranges can’t overlap if the ranges’ network protocols are the same. Overlapping ranges with different protocols is allowed but not recommended.
      • from_port
        Type: INT32
        Provider name: FromPort
        Description: A starting value for the range of allowed port numbers.
      • protocol
        Type: STRING
        Provider name: Protocol
        Description: The network protocol that these ports support.
      • to_port
        Type: INT32
        Provider name: ToPort
        Description: An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort.
  • resolved_image_digest
    Type: STRING
    Provider name: ResolvedImageDigest
    Description: A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
  • vcpu
    Type: DOUBLE
    Provider name: Vcpu
    Description: The number of vCPU units that are reserved for the container. If no resources are reserved, the container shares the total vCPU limit for the container group. Related data type: ContainerGroupDefinition TotalVcpuLimit

tags

Type: UNORDERED_LIST_STRING

total_memory_limit_mebibytes

Type: INT32
Provider name: TotalMemoryLimitMebibytes
Description: 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

Type: DOUBLE
Provider name: TotalVcpuLimit
Description: 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

Type: STRING
Provider name: VersionDescription
Description: An optional description that was provided for a container group definition update. Each version can have a unique description.

version_number

Type: INT32
Provider name: VersionNumber
Description: 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.