Package software.amazon.awscdk.services.gamelift

Interface CfnContainerGroupDefinition.GameServerContainerDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerGroupDefinition.GameServerContainerDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnContainerGroupDefinition

@Stability(Stable)
public static interface CfnContainerGroupDefinition.GameServerContainerDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition , ListContainerGroupDefinitions , UpdateContainerGroupDefinition

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 GameServerContainerDefinitionProperty gameServerContainerDefinitionProperty = GameServerContainerDefinitionProperty.builder()
         .containerName("containerName")
         .imageUri("imageUri")
         .serverSdkVersion("serverSdkVersion")
         // the properties below are optional
         .dependsOn(List.of(ContainerDependencyProperty.builder()
                 .condition("condition")
                 .containerName("containerName")
                 .build()))
         .environmentOverride(List.of(ContainerEnvironmentProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .mountPoints(List.of(ContainerMountPointProperty.builder()
                 .instancePath("instancePath")
                 // the properties below are optional
                 .accessLevel("accessLevel")
                 .containerPath("containerPath")
                 .build()))
         .portConfiguration(PortConfigurationProperty.builder()
                 .containerPortRanges(List.of(ContainerPortRangeProperty.builder()
                         .fromPort(123)
                         .protocol("protocol")
                         .toPort(123)
                         .build()))
                 .build())
         .resolvedImageDigest("resolvedImageDigest")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnContainerGroupDefinition.GameServerContainerDefinitionProperty.Builder	A builder for CfnContainerGroupDefinition.GameServerContainerDefinitionProperty
static final class	CfnContainerGroupDefinition.GameServerContainerDefinitionProperty.Jsii$Proxy	An implementation for CfnContainerGroupDefinition.GameServerContainerDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnContainerGroupDefinition.GameServerContainerDefinitionProperty.Builder	builder()
String	getContainerName()	The container definition identifier.
default Object	getDependsOn()	Indicates that the container relies on the status of other containers in the same container group during startup and shutdown sequences.
default Object	getEnvironmentOverride()	A set of environment variables that's passed to the container on startup.
String	getImageUri()	The URI to the image that Amazon GameLift uses when deploying this container to a container fleet.
default Object	getMountPoints()	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.
default Object	getPortConfiguration()	The set of ports that are available to bind to processes in the container.
default String	getResolvedImageDigest()	A unique and immutable identifier for the container image.
String	getServerSdkVersion()	The Amazon GameLift server SDK version that the game server is integrated with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerName

@Stability(Stable)
@NotNull
String getContainerName()

The container definition identifier.

Container names are unique within a container group definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-containername

getImageUri

@Stability(Stable)
@NotNull
String getImageUri()

The URI to the image that Amazon GameLift uses when deploying this container to a container fleet.

For a more specific identifier, see ResolvedImageDigest .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-imageuri

getServerSdkVersion

@Stability(Stable)
@NotNull
String getServerSdkVersion()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-serversdkversion

getDependsOn

@Stability(Stable)
@Nullable
default Object getDependsOn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-dependson

getEnvironmentOverride

@Stability(Stable)
@Nullable
default Object getEnvironmentOverride()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-environmentoverride

getMountPoints

@Stability(Stable)
@Nullable
default Object getMountPoints()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-mountpoints

getPortConfiguration

@Stability(Stable)
@Nullable
default Object getPortConfiguration()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-portconfiguration

getResolvedImageDigest

@Stability(Stable)
@Nullable
default String getResolvedImageDigest()

A unique and immutable identifier for the container image.

The digest is a SHA 256 hash of the container image manifest.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-gameservercontainerdefinition.html#cfn-gamelift-containergroupdefinition-gameservercontainerdefinition-resolvedimagedigest

builder

@Stability(Stable)
static CfnContainerGroupDefinition.GameServerContainerDefinitionProperty.Builder builder()

Returns:

a CfnContainerGroupDefinition.GameServerContainerDefinitionProperty.Builder of CfnContainerGroupDefinition.GameServerContainerDefinitionProperty