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
Contents
Note
In the following list, the required parameters are described first.
- ContainerName
-
The container definition identifier. Container names are unique within a container group definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-]+$Required: No
- 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.
Type: Array of ContainerDependency objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- 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.
Type: Array of ContainerEnvironment objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: No
- Essential
-
Indicates whether the container is vital to the container group. If an essential container fails, the entire container group restarts.
Type: Boolean
Required: No
- 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.
Type: ContainerHealthCheck object
Required: No
- ImageUri
-
The URI to the image that Amazon GameLift deploys to a container fleet. For a more specific identifier, see
ResolvedImageDigest.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9-_\.@\/:]+$Required: No
- 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
Type: Integer
Valid Range: Minimum value of 4. Maximum value of 1024000.
Required: No
- 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.
Type: Array of ContainerMountPoint objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- 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.Type: ContainerPortConfiguration object
Required: No
- ResolvedImageDigest
-
A unique and immutable identifier for the container image. The digest is a SHA 256 hash of the container image manifest.
Type: String
Pattern:
^sha256:[a-fA-F0-9]{64}$Required: No
- 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
Type: Double
Valid Range: Minimum value of 0.125. Maximum value of 10.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
