Package software.amazon.awscdk.services.gamelift

Class CfnContainerGroupDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnContainerGroupDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerGroupDefinitionProps>

Enclosing interface:

CfnContainerGroupDefinitionProps

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

A builder for CfnContainerGroupDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnContainerGroupDefinitionProps	build()	Builds the configured instance.
CfnContainerGroupDefinitionProps.Builder	containerGroupType(String containerGroupType)	Sets the value of CfnContainerGroupDefinitionProps.getContainerGroupType()
CfnContainerGroupDefinitionProps.Builder	gameServerContainerDefinition(IResolvable gameServerContainerDefinition)	Sets the value of CfnContainerGroupDefinitionProps.getGameServerContainerDefinition()
CfnContainerGroupDefinitionProps.Builder	gameServerContainerDefinition(CfnContainerGroupDefinition.GameServerContainerDefinitionProperty gameServerContainerDefinition)	Sets the value of CfnContainerGroupDefinitionProps.getGameServerContainerDefinition()
CfnContainerGroupDefinitionProps.Builder	name(String name)	Sets the value of CfnContainerGroupDefinitionProps.getName()
CfnContainerGroupDefinitionProps.Builder	operatingSystem(String operatingSystem)	Sets the value of CfnContainerGroupDefinitionProps.getOperatingSystem()
CfnContainerGroupDefinitionProps.Builder	sourceVersionNumber(Number sourceVersionNumber)	Sets the value of CfnContainerGroupDefinitionProps.getSourceVersionNumber()
CfnContainerGroupDefinitionProps.Builder	supportContainerDefinitions(List<? extends Object> supportContainerDefinitions)	Sets the value of CfnContainerGroupDefinitionProps.getSupportContainerDefinitions()
CfnContainerGroupDefinitionProps.Builder	supportContainerDefinitions(IResolvable supportContainerDefinitions)	Sets the value of CfnContainerGroupDefinitionProps.getSupportContainerDefinitions()
CfnContainerGroupDefinitionProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnContainerGroupDefinitionProps.getTags()
CfnContainerGroupDefinitionProps.Builder	totalMemoryLimitMebibytes(Number totalMemoryLimitMebibytes)	Sets the value of CfnContainerGroupDefinitionProps.getTotalMemoryLimitMebibytes()
CfnContainerGroupDefinitionProps.Builder	totalVcpuLimit(Number totalVcpuLimit)	Sets the value of CfnContainerGroupDefinitionProps.getTotalVcpuLimit()
CfnContainerGroupDefinitionProps.Builder	versionDescription(String versionDescription)	Sets the value of CfnContainerGroupDefinitionProps.getVersionDescription()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

name

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

Sets the value of CfnContainerGroupDefinitionProps.getName()

Parameters:

name - A descriptive identifier for the container group definition. This parameter is required. The name value is unique in an AWS Region.

Returns:

this

operatingSystem

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

Sets the value of CfnContainerGroupDefinitionProps.getOperatingSystem()

Parameters:

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

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.

Returns:

this

totalMemoryLimitMebibytes

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

Sets the value of CfnContainerGroupDefinitionProps.getTotalMemoryLimitMebibytes()

Parameters:

totalMemoryLimitMebibytes - The amount of memory (in MiB) on a fleet instance to allocate for the container group. This parameter is required. All containers in the group share these resources.

You can set a limit for each container definition in the group. If individual containers have limits, this total value must be greater than any individual container's memory limit.

Returns:

this

totalVcpuLimit

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

Sets the value of CfnContainerGroupDefinitionProps.getTotalVcpuLimit()

Parameters:

totalVcpuLimit - The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units). This parameter is required. All containers in the group share these resources. You can set a limit for each container definition in the group. If individual containers have limits, this total value must be equal to or greater than the sum of the limits for each container in the group.

Returns:

this

containerGroupType

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

Sets the value of CfnContainerGroupDefinitionProps.getContainerGroupType()

Parameters:

containerGroupType - The type of container group. Container group type determines how Amazon GameLift deploys the container group on each fleet instance.

Returns:

this

gameServerContainerDefinition

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

Sets the value of CfnContainerGroupDefinitionProps.getGameServerContainerDefinition()

Parameters:

gameServerContainerDefinition - The definition for the game server container in this group. This property is used only when the container group type is GAME_SERVER . This container definition specifies a container image with the game server build.

Returns:

this

gameServerContainerDefinition

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

Sets the value of CfnContainerGroupDefinitionProps.getGameServerContainerDefinition()

Parameters:

gameServerContainerDefinition - The definition for the game server container in this group. This property is used only when the container group type is GAME_SERVER . This container definition specifies a container image with the game server build.

Returns:

this

sourceVersionNumber

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

Sets the value of CfnContainerGroupDefinitionProps.getSourceVersionNumber()

Parameters:

sourceVersionNumber - A specific ContainerGroupDefinition version to be updated.

Returns:

this

supportContainerDefinitions

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

Sets the value of CfnContainerGroupDefinitionProps.getSupportContainerDefinitions()

Parameters:

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.

Returns:

this

supportContainerDefinitions

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

Sets the value of CfnContainerGroupDefinitionProps.getSupportContainerDefinitions()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnContainerGroupDefinitionProps.getTags()

Parameters:

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

Returns:

this

versionDescription

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

Sets the value of CfnContainerGroupDefinitionProps.getVersionDescription()

Parameters:

versionDescription - An optional description that was provided for a container group definition update. Each version can have a unique description.

Returns:

this

build

@Stability(Stable)
public CfnContainerGroupDefinitionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnContainerGroupDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided