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

Specifies the information required to run game servers with this container group.

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()	A descriptive label for the container definition.
default Object	getDependsOn()	A list of container dependencies that determines when this container starts up and shuts down.
default Object	getEnvironmentOverride()	The environment variables to pass to a container.
String	getImageUri()	Specifies the image URI of this container.
default Object	getMountPoints()	A list of mount point configurations to be used in a container.
default Object	getPortConfiguration()	Defines the ports on a container.
default String	getResolvedImageDigest()	The digest of the container image.
String	getServerSdkVersion()	The version of the server SDK used in this container group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerName

@Stability(Stable)
@NotNull
String getContainerName()

A descriptive label for the container definition.

Container definition names must be unique with 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()

Specifies the image URI of this container.

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 version of the server SDK used in this container group.

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()

A list of container dependencies that determines when this container starts up and shuts down.

For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the 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()

The environment variables to pass to a container.

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 list of mount point configurations to be used in a container.

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()

Defines the ports on a container.

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()

The digest of the container image.

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