Package software.amazon.awscdk.mixins.preview.services.gamelift.mixins

Class CfnContainerGroupDefinitionMixinProps.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.gamelift.mixins.CfnContainerGroupDefinitionMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerGroupDefinitionMixinProps>

Enclosing interface:

CfnContainerGroupDefinitionMixinProps

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

A builder for CfnContainerGroupDefinitionMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

containerGroupType

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

Sets the value of CfnContainerGroupDefinitionMixinProps.getContainerGroupType()

Parameters:

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

Returns:

this

gameServerContainerDefinition

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

Sets the value of CfnContainerGroupDefinitionMixinProps.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 CfnContainerGroupDefinitionMixinProps.Builder gameServerContainerDefinition(CfnContainerGroupDefinitionPropsMixin.GameServerContainerDefinitionProperty gameServerContainerDefinition)

Sets the value of CfnContainerGroupDefinitionMixinProps.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

name

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

Sets the value of CfnContainerGroupDefinitionMixinProps.getName()

Parameters:

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

Returns:

this

operatingSystem

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

Sets the value of CfnContainerGroupDefinitionMixinProps.getOperatingSystem()

Parameters:

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/2026. See more details in the Amazon Linux 2 FAQs . For game servers that are hosted on AL2 and use server SDK version 4.x for Amazon GameLift Servers, first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to server SDK version 5.

Returns:

this

sourceVersionNumber

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

Sets the value of CfnContainerGroupDefinitionMixinProps.getSourceVersionNumber()

Parameters:

sourceVersionNumber - A specific ContainerGroupDefinition version to be updated.

Returns:

this

supportContainerDefinitions

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

Sets the value of CfnContainerGroupDefinitionMixinProps.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 CfnContainerGroupDefinitionMixinProps.Builder supportContainerDefinitions(List<? extends Object> supportContainerDefinitions)

Sets the value of CfnContainerGroupDefinitionMixinProps.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 CfnContainerGroupDefinitionMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnContainerGroupDefinitionMixinProps.getTags()

Parameters:

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

Returns:

this

totalMemoryLimitMebibytes

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

Sets the value of CfnContainerGroupDefinitionMixinProps.getTotalMemoryLimitMebibytes()

Parameters:

totalMemoryLimitMebibytes - 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 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 CfnContainerGroupDefinitionMixinProps.Builder totalVcpuLimit(Number totalVcpuLimit)

Sets the value of CfnContainerGroupDefinitionMixinProps.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). 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

versionDescription

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

Sets the value of CfnContainerGroupDefinitionMixinProps.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 CfnContainerGroupDefinitionMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnContainerGroupDefinitionMixinProps

Throws:

NullPointerException - if any required attribute was not provided