Package software.amazon.awscdk.services.gamelift

Interface CfnContainerGroupDefinition.SupportContainerDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerGroupDefinition.SupportContainerDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnContainerGroupDefinition

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

Describes a support container in a container group.

A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.

You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput .

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.*;
 SupportContainerDefinitionProperty supportContainerDefinitionProperty = SupportContainerDefinitionProperty.builder()
         .containerName("containerName")
         .imageUri("imageUri")
         // 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()))
         .essential(false)
         .healthCheck(ContainerHealthCheckProperty.builder()
                 .command(List.of("command"))
                 // the properties below are optional
                 .interval(123)
                 .retries(123)
                 .startPeriod(123)
                 .timeout(123)
                 .build())
         .memoryHardLimitMebibytes(123)
         .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")
         .vcpu(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainerGroupDefinition.SupportContainerDefinitionProperty.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 its startup and shutdown sequences.
default Object	getEnvironmentOverride()	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 Amazon GameLift Servers deploys to a container fleet.
default Number	getMemoryHardLimitMebibytes()	The amount of memory that Amazon GameLift Servers makes available to the container.
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()	A set of ports that allow access to the container from external users.
default String	getResolvedImageDigest()	A unique and immutable identifier for the container image.
default Number	getVcpu()	The number of vCPU units that are reserved for the container.

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

getImageUri

@Stability(Stable)
@NotNull
String getImageUri()

The URI to the image that Amazon GameLift Servers deploys 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-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-imageuri

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContainerGroupDefinition.ContainerDependencyProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContainerGroupDefinition.ContainerEnvironmentProperty>

See Also:

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

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 restarts.

Returns union: either Boolean or IResolvable

See Also:

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

getHealthCheck

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

A configuration for a non-terminal health check.

A support container automatically restarts if it stops functioning or if it fails this health check.

Returns union: either IResolvable or CfnContainerGroupDefinition.ContainerHealthCheckProperty

See Also:

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

getMemoryHardLimitMebibytes

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

The amount of memory that Amazon GameLift Servers 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 TotalMemoryLimitMebibytes

See Also:

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

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnContainerGroupDefinition.ContainerMountPointProperty>

See Also:

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

getPortConfiguration

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

A set of ports that allow access to the container from external users.

Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange .

Returns union: either IResolvable or CfnContainerGroupDefinition.PortConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containergroupdefinition-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-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-supportcontainerdefinition.html#cfn-gamelift-containergroupdefinition-supportcontainerdefinition-resolvedimagedigest

getVcpu

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

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

If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit

See Also:

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

builder

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

Returns:

a CfnContainerGroupDefinition.SupportContainerDefinitionProperty.Builder of CfnContainerGroupDefinition.SupportContainerDefinitionProperty