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

Supports the function of the main 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.*;
 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()	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.
default Object	getEssential()	Specifies if the container is essential.
default Object	getHealthCheck()	Specifies how the process manager checks the health of containers.
String	getImageUri()	Specifies the image URI of this container.
default Number	getMemoryHardLimitMebibytes()	The total memory limit of container groups following this definition in MiB.
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.
default Number	getVcpu()	The number of virtual CPUs to give to the support 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.

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

Specifies the image URI of this container.

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

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

getEssential

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

Specifies if the container is essential.

If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group.

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

Specifies how the process manager checks the health of containers.

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 total memory limit of container groups following this definition in MiB.

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

getVcpu

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

The number of virtual CPUs to give to the support group.

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