/AWS1/CL_GMLGAMESERVERCONTAI00¶
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
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_containername TYPE /AWS1/GMLNONZEROAND128MAXASC00 /AWS1/GMLNONZEROAND128MAXASC00¶
A string that uniquely identifies the container definition within a container group.
iv_imageuri TYPE /AWS1/GMLIMAGEURISTRING /AWS1/GMLIMAGEURISTRING¶
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 Amazon Web Services account and Amazon Web Services 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]
io_portconfiguration TYPE REF TO /AWS1/CL_GMLCONTAINERPORTCONF /AWS1/CL_GMLCONTAINERPORTCONF¶
A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property
ConnectionPortRange).
iv_serversdkversion TYPE /AWS1/GMLSERVERSDKVERSION /AWS1/GMLSERVERSDKVERSION¶
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.
Optional arguments:¶
it_dependson TYPE /AWS1/CL_GMLCONTAINERDEPENDE00=>TT_CONTAINERDEPENDENCYLIST TT_CONTAINERDEPENDENCYLIST¶
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.
it_mountpoints TYPE /AWS1/CL_GMLCONTAINERMOUNTPT=>TT_CONTAINERMOUNTPOINTLIST TT_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.
it_environmentoverride TYPE /AWS1/CL_GMLCONTAINERENVIRON00=>TT_CONTAINERENVIRONMENTLIST TT_CONTAINERENVIRONMENTLIST¶
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.
Queryable Attributes¶
ContainerName¶
A string that uniquely identifies the container definition within a container group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTAINERNAME() |
Getter for CONTAINERNAME, with configurable default |
ASK_CONTAINERNAME() |
Getter for CONTAINERNAME w/ exceptions if field has no value |
HAS_CONTAINERNAME() |
Determine if CONTAINERNAME has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPENDSON() |
Getter for DEPENDSON, with configurable default |
ASK_DEPENDSON() |
Getter for DEPENDSON w/ exceptions if field has no value |
HAS_DEPENDSON() |
Determine if DEPENDSON has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MOUNTPOINTS() |
Getter for MOUNTPOINTS, with configurable default |
ASK_MOUNTPOINTS() |
Getter for MOUNTPOINTS w/ exceptions if field has no value |
HAS_MOUNTPOINTS() |
Determine if MOUNTPOINTS has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENVIRONMENTOVERRIDE() |
Getter for ENVIRONMENTOVERRIDE, with configurable default |
ASK_ENVIRONMENTOVERRIDE() |
Getter for ENVIRONMENTOVERRIDE w/ exceptions if field has no |
HAS_ENVIRONMENTOVERRIDE() |
Determine if ENVIRONMENTOVERRIDE has a value |
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 Amazon Web Services account and Amazon Web Services 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]
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGEURI() |
Getter for IMAGEURI, with configurable default |
ASK_IMAGEURI() |
Getter for IMAGEURI w/ exceptions if field has no value |
HAS_IMAGEURI() |
Determine if IMAGEURI has a value |
PortConfiguration¶
A set of ports that Amazon GameLift Servers can assign to processes in a container. The container port configuration must have enough ports for each container process that accepts inbound traffic connections. For example, a game server process requires a container port to allow game clients to connect to it. A container port configuration can have can have one or more container port ranges. Each range specifies starting and ending values as well as the supported network protocol.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps each container port to an externally accessible connection port (see the container fleet property
ConnectionPortRange).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORTCONFIGURATION() |
Getter for PORTCONFIGURATION |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVERSDKVERSION() |
Getter for SERVERSDKVERSION, with configurable default |
ASK_SERVERSDKVERSION() |
Getter for SERVERSDKVERSION w/ exceptions if field has no va |
HAS_SERVERSDKVERSION() |
Determine if SERVERSDKVERSION has a value |