GameServerContainerDefinition
Describes the game server container in an existing game server container group. A game server container identifies a container image with your game server build. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.
You can update a container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property https://docs.aws.amazon.com/gamelift/latest/apireference/API_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 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
- ImageUri
-
The URI to the image that Amazon GameLift uses when deploying this container 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
- 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
-
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 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
- ServerSdkVersion
-
The Amazon GameLift server SDK version that the game server is integrated with. Only game servers using 5.2.0 or higher are compatible with container fleets.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^\d+\.\d+\.\d+$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
