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	containerGroupType(String containerGroupType)	The scope of the container group.
static CfnContainerGroupDefinition.Builder	create(software.constructs.Construct scope, String id)
CfnContainerGroupDefinition.Builder	gameServerContainerDefinition(IResolvable gameServerContainerDefinition)	Specifies the information required to run game servers with this container group.
CfnContainerGroupDefinition.Builder	gameServerContainerDefinition(CfnContainerGroupDefinition.GameServerContainerDefinitionProperty gameServerContainerDefinition)	Specifies the information required to run game servers with this container group.
CfnContainerGroupDefinition.Builder	name(String name)	A descriptive identifier for the container group definition.
CfnContainerGroupDefinition.Builder	operatingSystem(String operatingSystem)	The platform that all containers in the container group definition run on.
CfnContainerGroupDefinition.Builder	sourceVersionNumber(Number sourceVersionNumber)	A specific ContainerGroupDefinition version to be updated.
CfnContainerGroupDefinition.Builder	supportContainerDefinitions(List<? extends Object> supportContainerDefinitions)	The set of definitions for support containers in this group.
CfnContainerGroupDefinition.Builder	supportContainerDefinitions(IResolvable supportContainerDefinitions)	The set of definitions for support containers in this group.
CfnContainerGroupDefinition.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnContainerGroupDefinition.Builder	totalMemoryLimitMebibytes(Number totalMemoryLimitMebibytes)	The total memory limit of container groups following this definition in MiB.
CfnContainerGroupDefinition.Builder	totalVcpuLimit(Number totalVcpuLimit)	The total amount of virtual CPUs on the container group definition.
CfnContainerGroupDefinition.Builder	versionDescription(String versionDescription)	The description of this version.

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.

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 that all containers in the container group definition run on.

Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.

Parameters:

operatingSystem - The platform that all containers in the container group definition run on. 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

totalMemoryLimitMebibytes

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

The total memory limit of container groups following this definition in MiB.

Parameters:

totalMemoryLimitMebibytes - The total memory limit of container groups following this definition in MiB. This parameter is required.

Returns:

this

See Also:

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

totalVcpuLimit

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

The total amount of virtual CPUs on the container group definition.

Parameters:

totalVcpuLimit - The total amount of virtual CPUs on 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-totalvcpulimit

containerGroupType

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

The scope of the container group.

Parameters:

containerGroupType - The scope of 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-containergrouptype

gameServerContainerDefinition

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

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

Parameters:

gameServerContainerDefinition - Specifies the information required to run game servers with this 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-gameservercontainerdefinition

gameServerContainerDefinition

@Stability(Stable)
public CfnContainerGroupDefinition.Builder gameServerContainerDefinition(CfnContainerGroupDefinition.GameServerContainerDefinitionProperty gameServerContainerDefinition)

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

Parameters:

gameServerContainerDefinition - Specifies the information required to run game servers with this 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-gameservercontainerdefinition

sourceVersionNumber

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

A specific ContainerGroupDefinition version to be updated.

Parameters:

sourceVersionNumber - A specific ContainerGroupDefinition version to be updated. This parameter is required.

Returns:

this

See Also:

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

supportContainerDefinitions

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

The set of definitions for support containers in this group.

A container group definition might have zero support container definitions. Support container can be used in any type of container group.

Parameters:

supportContainerDefinitions - The set of definitions for support containers in this 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-supportcontainerdefinitions

supportContainerDefinitions

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

The set of definitions for support containers in this group.

A container group definition might have zero support container definitions. Support container can be used in any type of container group.

Parameters:

supportContainerDefinitions - The set of definitions for support containers in this 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-supportcontainerdefinitions

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

versionDescription

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

The description of this version.

Parameters:

versionDescription - The description of this version. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnContainerGroupDefinition build()

Specified by:

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

Returns:

a newly built instance of CfnContainerGroupDefinition.