AWS::GameLift::ContainerGroupDefinition SupportContainerDefinition
Describes a support container in a container group. A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.
You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput.
Part of: ContainerGroupDefinition
Returned by: DescribeContainerGroupDefinition, ListContainerGroupDefinitions, UpdateContainerGroupDefinition
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ContainerName" :String, "DependsOn" :[ ContainerDependency, ... ], "EnvironmentOverride" :[ ContainerEnvironment, ... ], "Essential" :Boolean, "HealthCheck" :ContainerHealthCheck, "ImageUri" :String, "MemoryHardLimitMebibytes" :Integer, "MountPoints" :[ ContainerMountPoint, ... ], "PortConfiguration" :PortConfiguration, "ResolvedImageDigest" :String, "Vcpu" :Number}
YAML
ContainerName:StringDependsOn:- ContainerDependencyEnvironmentOverride:- ContainerEnvironmentEssential:BooleanHealthCheck:ContainerHealthCheckImageUri:StringMemoryHardLimitMebibytes:IntegerMountPoints:- ContainerMountPointPortConfiguration:PortConfigurationResolvedImageDigest:StringVcpu:Number
Properties
ContainerName-
The container definition identifier. Container names are unique within a container group definition.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9-]+$Minimum:
1Maximum:
128Update requires: No interruption
DependsOn-
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.
Required: No
Type: Array of ContainerDependency
Minimum:
1Maximum:
10Update requires: No interruption
EnvironmentOverride-
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.
Required: No
Type: Array of ContainerEnvironment
Minimum:
1Maximum:
20Update requires: No interruption
Essential-
Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
Required: No
Type: Boolean
Update requires: No interruption
HealthCheck-
A configuration for a non-terminal health check. A support container automatically restarts if it stops functioning or if it fails this health check.
Required: No
Type: ContainerHealthCheck
Update requires: No interruption
ImageUri-
The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see
ResolvedImageDigest.Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9-_\.@\/:]+$Minimum:
1Maximum:
255Update requires: No interruption
MemoryHardLimitMebibytes-
The amount of memory that Amazon GameLift 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
Required: No
Type: Integer
Minimum:
4Maximum:
1024000Update requires: No interruption
MountPoints-
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.
Required: No
Type: Array of ContainerMountPoint
Minimum:
1Maximum:
10Update requires: No interruption
PortConfiguration-
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 maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange.Required: No
Type: PortConfiguration
Update requires: No interruption
ResolvedImageDigest-
A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
Required: No
Type: String
Pattern:
^sha256:[a-fA-F0-9]{64}$Update requires: No interruption
Vcpu-
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
Required: No
Type: Number
Minimum:
0Maximum:
10Update requires: No interruption
