Skip to content

SupportContainerDefinition

Source code in docs_src/capo_gamelift/types/support_container_definition.py
class SupportContainerDefinition(TypedDict, closed=True):
    container_name: NotRequired[
        "capo_gamelift.types.non_zero_and128_max_ascii_string.NonZeroAnd128MaxAsciiString"
    ]
    """<p>The container definition identifier. Container names are unique within a container group definition. </p>"""
    depends_on: NotRequired[
        "capo_gamelift.types.container_dependency_list.ContainerDependencyList"
    ]
    """<p>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.</p>"""
    mount_points: NotRequired[
        "capo_gamelift.types.container_mount_point_list.ContainerMountPointList"
    ]
    """<p>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.</p>"""
    environment_override: NotRequired[
        "capo_gamelift.types.container_environment_list.ContainerEnvironmentList"
    ]
    """<p>A set of environment variables that's passed to the container on startup. See the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-environment">ContainerDefinition::environment</a> parameter in the <i>Amazon Elastic Container Service API Reference</i>.</p>"""
    essential: NotRequired["capo_gamelift.types.boolean_model.BooleanModel"]
    """<p>Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.</p>"""
    health_check: NotRequired[
        "capo_gamelift.types.container_health_check.ContainerHealthCheck"
    ]
    """<p>A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check. </p>"""
    image_uri: NotRequired["capo_gamelift.types.image_uri_string.ImageUriString"]
    """<p>The URI to the image that Amazon GameLift Servers deploys to a container fleet. For a more specific identifier, see <code>ResolvedImageDigest</code>. </p>"""
    memory_hard_limit_mebibytes: NotRequired[
        "capo_gamelift.types.container_memory_limit.ContainerMemoryLimit"
    ]
    """<p>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.</p> <p> <b>Related data type: </b> <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition TotalMemoryLimitMebibytes</a> </p>"""
    port_configuration: NotRequired[
        "capo_gamelift.types.container_port_configuration.ContainerPortConfiguration"
    ]
    """<p>A set of ports that allow access to the container from external users. Processes running in the container can bind to 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 <code>ConnectionPortRange</code>.</p>"""
    resolved_image_digest: NotRequired["capo_gamelift.types.sha256.Sha256"]
    """<p>A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest. </p>"""
    vcpu: NotRequired["capo_gamelift.types.container_vcpu.ContainerVcpu"]
    """<p>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.</p> <p> <b>Related data type: </b> <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html">ContainerGroupDefinition TotalVcpuLimit</a> </p>"""
    linux_capabilities: NotRequired[
        "capo_gamelift.types.linux_capabilities.LinuxCapabilities"
    ]
    """<p>Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_LinuxCapabilities.html">LinuxCapabilities</a>.</p>"""

container_name instance-attribute

container_name: NotRequired[NonZeroAnd128MaxAsciiString]

The container definition identifier. Container names are unique within a container group definition.

depends_on instance-attribute

depends_on: NotRequired[ContainerDependencyList]

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.

environment_override instance-attribute

environment_override: NotRequired[ContainerEnvironmentList]

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.

essential instance-attribute

essential: NotRequired[BooleanModel]

Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.

health_check instance-attribute

health_check: NotRequired[ContainerHealthCheck]

A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.

image_uri instance-attribute

image_uri: NotRequired[ImageUriString]

The URI to the image that Amazon GameLift Servers deploys to a container fleet. For a more specific identifier, see ResolvedImageDigest.

linux_capabilities instance-attribute

linux_capabilities: NotRequired[LinuxCapabilities]

Linux-specific modifications that are applied to the default Docker container configuration, such as Linux capabilities. For more information see LinuxCapabilities.

memory_hard_limit_mebibytes instance-attribute

memory_hard_limit_mebibytes: NotRequired[ContainerMemoryLimit]

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 instance-attribute

mount_points: NotRequired[ContainerMountPointList]

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.

port_configuration instance-attribute

port_configuration: NotRequired[ContainerPortConfiguration]

A set of ports that allow access to the container from external users. Processes running in the container can bind to 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.

resolved_image_digest instance-attribute

resolved_image_digest: NotRequired[Sha256]

A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.

vcpu instance-attribute

vcpu: NotRequired[ContainerVcpu]

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