Package software.amazon.awscdk.services.gamelift

Class CfnContainerGroupDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnContainerGroupDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerGroupDefinition>

Enclosing class:

CfnContainerGroupDefinition

@Stability(Stable)
public static final class CfnContainerGroupDefinition.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainerGroupDefinition>

A fluent builder for CfnContainerGroupDefinition.

Method Summary

Modifier and Type	Method	Description
CfnContainerGroupDefinition	build()
CfnContainerGroupDefinition.Builder	containerDefinitions(List<? extends Object> containerDefinitions)	The set of container definitions that are included in the container group.
CfnContainerGroupDefinition.Builder	containerDefinitions(IResolvable containerDefinitions)	The set of container definitions that are included in the container group.
static CfnContainerGroupDefinition.Builder	create(software.constructs.Construct scope, String id)
CfnContainerGroupDefinition.Builder	name(String name)	A descriptive identifier for the container group definition.
CfnContainerGroupDefinition.Builder	operatingSystem(String operatingSystem)	The platform required for all containers in the container group definition.
CfnContainerGroupDefinition.Builder	schedulingStrategy(String schedulingStrategy)	The method for deploying the container group across fleet instances.
CfnContainerGroupDefinition.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnContainerGroupDefinition.Builder	totalCpuLimit(Number totalCpuLimit)	The amount of CPU units on a fleet instance to allocate for the container group.
CfnContainerGroupDefinition.Builder	totalMemoryLimit(Number totalMemoryLimit)	The amount of memory (in MiB) on a fleet instance to allocate for the container group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnContainerGroupDefinition.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnContainerGroupDefinition.Builder.

containerDefinitions

@Stability(Stable)
public CfnContainerGroupDefinition.Builder containerDefinitions(IResolvable containerDefinitions)

The set of container definitions that are included in the container group.

Parameters:

containerDefinitions - The set of container definitions that are included in the container group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinitions

containerDefinitions

@Stability(Stable)
public CfnContainerGroupDefinition.Builder containerDefinitions(List<? extends Object> containerDefinitions)

The set of container definitions that are included in the container group.

Parameters:

containerDefinitions - The set of container definitions that are included in the container group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-containerdefinitions

name

@Stability(Stable)
public CfnContainerGroupDefinition.Builder name(String name)

A descriptive identifier for the container group definition.

The name value is unique in an AWS Region.

Parameters:

name - A descriptive identifier for the container group definition. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-name

operatingSystem

@Stability(Stable)
public CfnContainerGroupDefinition.Builder operatingSystem(String operatingSystem)

The platform required for all containers in the container group definition.

Parameters:

operatingSystem - The platform required for all containers in the container group definition. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-operatingsystem

totalCpuLimit

@Stability(Stable)
public CfnContainerGroupDefinition.Builder totalCpuLimit(Number totalCpuLimit)

The amount of CPU units on a fleet instance to allocate for the container group.

All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units).

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.

For more details on memory allocation, see the Container fleet design guide .

Parameters:

totalCpuLimit - The amount of CPU units on a fleet instance to allocate for the container group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalcpulimit

totalMemoryLimit

@Stability(Stable)
public CfnContainerGroupDefinition.Builder totalMemoryLimit(Number totalMemoryLimit)

The amount of memory (in MiB) on a fleet instance to allocate for the container group.

All containers in the group share these resources.

You can set additional limits for each ContainerDefinition in the group. If individual containers have limits, this value must meet the following requirements:

• Equal to or greater than the sum of all container-specific soft memory limits in the group.
• Equal to or greater than any container-specific hard limits in the group.

For more details on memory allocation, see the Container fleet design guide .

Parameters:

totalMemoryLimit - The amount of memory (in MiB) on a fleet instance to allocate for the container group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimit

schedulingStrategy

@Stability(Stable)
public CfnContainerGroupDefinition.Builder schedulingStrategy(String schedulingStrategy)

The method for deploying the container group across fleet instances.

A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.

Parameters:

schedulingStrategy - The method for deploying the container group across fleet instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-schedulingstrategy

tags

@Stability(Stable)
public CfnContainerGroupDefinition.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-tags

build

@Stability(Stable)
public CfnContainerGroupDefinition build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainerGroupDefinition>

Returns:

a newly built instance of CfnContainerGroupDefinition.