CfnContainerGroupDefinitionProps

class aws_cdk.aws_gamelift.CfnContainerGroupDefinitionProps(*, name, operating_system, total_memory_limit_mebibytes, total_vcpu_limit, container_group_type=None, game_server_container_definition=None, source_version_number=None, support_container_definitions=None, tags=None, version_description=None)

Bases: object

Properties for defining a CfnContainerGroupDefinition.

Parameters:

• name (str) – A descriptive identifier for the container group definition. The name value is unique in an AWS Region.

• operating_system (str) – The platform that all containers in the container group definition run on. .. epigraph:: 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.

• total_memory_limit_mebibytes (Union[int, float]) – 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 (Union[int, float]) – 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.

• container_group_type (Optional[str]) – The type of container group. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.

• game_server_container_definition (Union[IResolvable, GameServerContainerDefinitionProperty, Dict[str, Any], None]) – 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.

• source_version_number (Union[int, float, None]) – A specific ContainerGroupDefinition version to be updated.

• support_container_definitions (Union[IResolvable, Sequence[Union[IResolvable, SupportContainerDefinitionProperty, Dict[str, Any]]], None]) – 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.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

• version_description (Optional[str]) – An optional description that was provided for a container group definition update. Each version can have a unique description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_gamelift as gamelift

cfn_container_group_definition_props = gamelift.CfnContainerGroupDefinitionProps(
    name="name",
    operating_system="operatingSystem",
    total_memory_limit_mebibytes=123,
    total_vcpu_limit=123,

    # the properties below are optional
    container_group_type="containerGroupType",
    game_server_container_definition=gamelift.CfnContainerGroupDefinition.GameServerContainerDefinitionProperty(
        container_name="containerName",
        image_uri="imageUri",
        server_sdk_version="serverSdkVersion",

        # the properties below are optional
        depends_on=[gamelift.CfnContainerGroupDefinition.ContainerDependencyProperty(
            condition="condition",
            container_name="containerName"
        )],
        environment_override=[gamelift.CfnContainerGroupDefinition.ContainerEnvironmentProperty(
            name="name",
            value="value"
        )],
        mount_points=[gamelift.CfnContainerGroupDefinition.ContainerMountPointProperty(
            instance_path="instancePath",

            # the properties below are optional
            access_level="accessLevel",
            container_path="containerPath"
        )],
        port_configuration=gamelift.CfnContainerGroupDefinition.PortConfigurationProperty(
            container_port_ranges=[gamelift.CfnContainerGroupDefinition.ContainerPortRangeProperty(
                from_port=123,
                protocol="protocol",
                to_port=123
            )]
        ),
        resolved_image_digest="resolvedImageDigest"
    ),
    source_version_number=123,
    support_container_definitions=[gamelift.CfnContainerGroupDefinition.SupportContainerDefinitionProperty(
        container_name="containerName",
        image_uri="imageUri",

        # the properties below are optional
        depends_on=[gamelift.CfnContainerGroupDefinition.ContainerDependencyProperty(
            condition="condition",
            container_name="containerName"
        )],
        environment_override=[gamelift.CfnContainerGroupDefinition.ContainerEnvironmentProperty(
            name="name",
            value="value"
        )],
        essential=False,
        health_check=gamelift.CfnContainerGroupDefinition.ContainerHealthCheckProperty(
            command=["command"],

            # the properties below are optional
            interval=123,
            retries=123,
            start_period=123,
            timeout=123
        ),
        memory_hard_limit_mebibytes=123,
        mount_points=[gamelift.CfnContainerGroupDefinition.ContainerMountPointProperty(
            instance_path="instancePath",

            # the properties below are optional
            access_level="accessLevel",
            container_path="containerPath"
        )],
        port_configuration=gamelift.CfnContainerGroupDefinition.PortConfigurationProperty(
            container_port_ranges=[gamelift.CfnContainerGroupDefinition.ContainerPortRangeProperty(
                from_port=123,
                protocol="protocol",
                to_port=123
            )]
        ),
        resolved_image_digest="resolvedImageDigest",
        vcpu=123
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version_description="versionDescription"
)

Attributes

container_group_type

The type of container group.

Container group type determines how Amazon GameLift deploys the container group on each fleet instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containergrouptype

game_server_container_definition

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition

name

A descriptive identifier for the container group definition.

The name value is unique in an AWS Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-name

operating_system

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 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem

source_version_number

A specific ContainerGroupDefinition version to be updated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-sourceversionnumber

support_container_definitions

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinitions

tags

An array of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-tags

total_memory_limit_mebibytes

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimitmebibytes

total_vcpu_limit

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalvcpulimit

version_description

An optional description that was provided for a container group definition update.

Each version can have a unique description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-versiondescription