GameServerContainerDefinitionInput
Describes the configuration for a container that runs your game server executable. This definition includes container configuration, resources, and start instructions. Use this data type when creating or updating a game server container group definition. For properties of a deployed container, see GameServerContainerDefinition. A game server container is automatically considered essential; if an essential container fails, the entire container group restarts.
Use with: CreateContainerGroupDefinition, UpdateContainerGroupDefinition
Contents
Note
In the following list, the required parameters are described first.
- ContainerName
-
A string that uniquely identifies the container definition within a container group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-]+$Required: Yes
- ImageUri
-
The location of the container image to deploy to a container fleet. Provide an image in an Amazon Elastic Container Registry public or private repository. The repository must be in the same AWS account and AWS Region where you're creating the container group definition. For limits on image size, see Amazon GameLift Servers endpoints and quotas. You can use any of the following image URI formats:
-
Image ID only:
[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID] -
Image ID and digest:
[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest] -
Image ID and tag:
[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9-_\.@\/:]+$Required: Yes
-
- PortConfiguration
-
A set of ports that Amazon GameLift Servers can assign to processes in the container. Processes, must be assigned a container port to accept inbound traffic connections. 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. Instead, Amazon GameLift Servers maps container ports to externally accessible connection ports (see the container fleet property
ConnectionPortRange).Type: ContainerPortConfiguration object
Required: Yes
- ServerSdkVersion
-
The Amazon GameLift Servers 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: Yes
- DependsOn
-
Establishes dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. For example, you might specify that ContainerB has a
STARTdependency on ContainerA. This dependency means that ContainerB can't start until after ContainerA has started. This dependency is reversed on shutdown, which means that ContainerB must shut down before ContainerA can shut down.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 to pass 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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
