Package software.amazon.awscdk.services.gamelift

Interface CfnContainerGroupDefinition.ContainerDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerGroupDefinition.ContainerDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnContainerGroupDefinition

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

This data type is used with the Amazon GameLift containers feature, which is currently in public preview..

Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also ContainerDefinitionInput .

Part of: ContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition , ListContainerGroupDefinitions

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.*;
 ContainerDefinitionProperty containerDefinitionProperty = ContainerDefinitionProperty.builder()
         .containerName("containerName")
         .imageUri("imageUri")
         // the properties below are optional
         .command(List.of("command"))
         .cpu(123)
         .dependsOn(List.of(ContainerDependencyProperty.builder()
                 .condition("condition")
                 .containerName("containerName")
                 .build()))
         .entryPoint(List.of("entryPoint"))
         .environment(List.of(ContainerEnvironmentProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .essential(false)
         .healthCheck(ContainerHealthCheckProperty.builder()
                 .command(List.of("command"))
                 // the properties below are optional
                 .interval(123)
                 .retries(123)
                 .startPeriod(123)
                 .timeout(123)
                 .build())
         .memoryLimits(MemoryLimitsProperty.builder()
                 .hardLimit(123)
                 .softLimit(123)
                 .build())
         .portConfiguration(PortConfigurationProperty.builder()
                 .containerPortRanges(List.of(ContainerPortRangeProperty.builder()
                         .fromPort(123)
                         .protocol("protocol")
                         .toPort(123)
                         .build()))
                 .build())
         .resolvedImageDigest("resolvedImageDigest")
         .workingDirectory("workingDirectory")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	builder()
default List<String>	getCommand()	A command that's passed to the container on startup.
String	getContainerName()	The container definition identifier.
default Number	getCpu()	The number of CPU units that are reserved for the container.
default Object	getDependsOn()	Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
default List<String>	getEntryPoint()	The entry point that's passed to the container on startup.
default Object	getEnvironment()	A set of environment variables that's passed to the container on startup.
default Object	getEssential()	Indicates whether the container is vital to the container group.
default Object	getHealthCheck()	A configuration for a non-terminal health check.
String	getImageUri()	The URI to the image that $short;
default Object	getMemoryLimits()	The amount of memory that Amazon GameLift makes available to the container.
default Object	getPortConfiguration()	Defines the ports that are available to assign to processes in the container.
default String	getResolvedImageDigest()	A unique and immutable identifier for the container image that is deployed to a container fleet.
default String	getWorkingDirectory()	The directory in the container where commands are run.

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-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-containername

getImageUri

@Stability(Stable)
@NotNull
String getImageUri()

The URI to the image that $short;

copied and deployed 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-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-imageuri

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

A command that's passed to the container on startup.

Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

See Also:

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

getCpu

@Stability(Stable)
@Nullable
default Number getCpu()

The number of CPU units that are reserved for the container.

Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

Related data type: ContainerGroupDefinition$TotalCpuLimit

See Also:

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

getDependsOn

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

Indicates that the container relies on the status of other containers in the same container group during its 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-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-dependson

getEntryPoint

@Stability(Stable)
@Nullable
default List<String> getEntryPoint()

The entry point that's passed to the container on startup.

If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference .

See Also:

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

getEnvironment

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

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-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-environment

getEssential

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

Indicates whether the container is vital to the container group.

If an essential container fails, the entire container group is restarted.

See Also:

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

getHealthCheck

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

A configuration for a non-terminal health check.

A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

See Also:

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

getMemoryLimits

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

The amount of memory that Amazon GameLift makes available to the container.

If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition$TotalMemoryLimit

See Also:

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

getPortConfiguration

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

Defines the ports that are available to assign 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-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-portconfiguration

getResolvedImageDigest

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

A unique and immutable identifier for the container image that is deployed to a container fleet.

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-containerdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinition-resolvedimagedigest

getWorkingDirectory

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

The directory in the container where commands are run.

See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference .

See Also:

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

builder

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

Returns:

a CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder of CfnContainerGroupDefinition.ContainerDefinitionProperty