Class CfnContainerGroupDefinition.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnContainerGroupDefinition>
- Enclosing class:
CfnContainerGroupDefinition
CfnContainerGroupDefinition
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
containerDefinitions
(List<? extends Object> containerDefinitions) The set of container definitions that are included in the container group.containerDefinitions
(IResolvable containerDefinitions) The set of container definitions that are included in the container group.A descriptive identifier for the container group definition.operatingSystem
(String operatingSystem) The platform required for all containers in the container group definition.schedulingStrategy
(String schedulingStrategy) The method for deploying the container group across fleet instances.sourceVersionNumber
(Number sourceVersionNumber) A specific ContainerGroupDefinition version to be updated.supportContainerDefinitions
(List<? extends Object> supportContainerDefinitions) A collection of support container definitions that define the containers in this group.supportContainerDefinitions
(IResolvable supportContainerDefinitions) A collection of support container definitions that define the containers in this group.An array of key-value pairs to apply to this resource.totalCpuLimit
(Number totalCpuLimit) The amount of CPU units on a fleet instance to allocate for the container group.totalMemoryLimit
(Number totalMemoryLimit) The amount of memory (in MiB) on a fleet instance to allocate for the container group.
-
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:
-
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:
-
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:
-
operatingSystem
@Stability(Stable) public CfnContainerGroupDefinition.Builder operatingSystem(String operatingSystem) The platform required for all containers in the container group definition.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 required for all containers in the container group definition. This parameter is required.- Returns:
this
- See Also:
-
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:
-
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:
-
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:
-
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:
-
supportContainerDefinitions
@Stability(Stable) public CfnContainerGroupDefinition.Builder supportContainerDefinitions(List<? extends Object> supportContainerDefinitions) A collection of support container definitions that define the containers in this group.- Parameters:
supportContainerDefinitions
- A collection of support container definitions that define the containers in this group. This parameter is required.- Returns:
this
- See Also:
-
supportContainerDefinitions
@Stability(Stable) public CfnContainerGroupDefinition.Builder supportContainerDefinitions(IResolvable supportContainerDefinitions) A collection of support container definitions that define the containers in this group.- Parameters:
supportContainerDefinitions
- A collection of support container definitions that define the containers in this group. This parameter is required.- Returns:
this
- See Also:
-
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:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnContainerGroupDefinition>
- Returns:
- a newly built instance of
CfnContainerGroupDefinition
.
-