Interface CfnContainerGroupDefinitionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnContainerGroupDefinitionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-20T14:04:25.372Z")
@Stability(Stable)
public interface CfnContainerGroupDefinitionProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnContainerGroupDefinition.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.*;
CfnContainerGroupDefinitionProps cfnContainerGroupDefinitionProps = CfnContainerGroupDefinitionProps.builder()
.name("name")
.operatingSystem("operatingSystem")
.totalMemoryLimitMebibytes(123)
.totalVcpuLimit(123)
// the properties below are optional
.containerGroupType("containerGroupType")
.gameServerContainerDefinition(GameServerContainerDefinitionProperty.builder()
.containerName("containerName")
.imageUri("imageUri")
.serverSdkVersion("serverSdkVersion")
// the properties below are optional
.dependsOn(List.of(ContainerDependencyProperty.builder()
.condition("condition")
.containerName("containerName")
.build()))
.environmentOverride(List.of(ContainerEnvironmentProperty.builder()
.name("name")
.value("value")
.build()))
.mountPoints(List.of(ContainerMountPointProperty.builder()
.instancePath("instancePath")
// the properties below are optional
.accessLevel("accessLevel")
.containerPath("containerPath")
.build()))
.portConfiguration(PortConfigurationProperty.builder()
.containerPortRanges(List.of(ContainerPortRangeProperty.builder()
.fromPort(123)
.protocol("protocol")
.toPort(123)
.build()))
.build())
.resolvedImageDigest("resolvedImageDigest")
.build())
.sourceVersionNumber(123)
.supportContainerDefinitions(List.of(SupportContainerDefinitionProperty.builder()
.containerName("containerName")
.imageUri("imageUri")
// the properties below are optional
.dependsOn(List.of(ContainerDependencyProperty.builder()
.condition("condition")
.containerName("containerName")
.build()))
.environmentOverride(List.of(ContainerEnvironmentProperty.builder()
.name("name")
.value("value")
.build()))
.essential(false)
.healthCheck(ContainerHealthCheckProperty.builder()
.command(List.of("command"))
// the properties below are optional
.interval(123)
.retries(123)
.startPeriod(123)
.timeout(123)
.build())
.memoryHardLimitMebibytes(123)
.mountPoints(List.of(ContainerMountPointProperty.builder()
.instancePath("instancePath")
// the properties below are optional
.accessLevel("accessLevel")
.containerPath("containerPath")
.build()))
.portConfiguration(PortConfigurationProperty.builder()
.containerPortRanges(List.of(ContainerPortRangeProperty.builder()
.fromPort(123)
.protocol("protocol")
.toPort(123)
.build()))
.build())
.resolvedImageDigest("resolvedImageDigest")
.vcpu(123)
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.versionDescription("versionDescription")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnContainerGroupDefinitionPropsstatic final classAn implementation forCfnContainerGroupDefinitionProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe scope of the container group.default ObjectSpecifies the information required to run game servers with this container group.getName()A descriptive identifier for the container group definition.The platform that all containers in the container group definition run on.default NumberA specific ContainerGroupDefinition version to be updated.default ObjectThe set of definitions for support containers in this group.getTags()An array of key-value pairs to apply to this resource.The total memory limit of container groups following this definition in MiB.The total amount of virtual CPUs on the container group definition.default StringThe description of this version.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
A descriptive identifier for the container group definition.The name value is unique in an AWS Region.
- See Also:
-
getOperatingSystem
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.
- See Also:
-
getTotalMemoryLimitMebibytes
The total memory limit of container groups following this definition in MiB.- See Also:
-
getTotalVcpuLimit
The total amount of virtual CPUs on the container group definition.- See Also:
-
getContainerGroupType
The scope of the container group.- See Also:
-
getGameServerContainerDefinition
Specifies the information required to run game servers with this container group.- See Also:
-
getSourceVersionNumber
A specific ContainerGroupDefinition version to be updated.- See Also:
-
getSupportContainerDefinitions
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.
- See Also:
-
getTags
An array of key-value pairs to apply to this resource.- See Also:
-
getVersionDescription
The description of this version.- See Also:
-
builder
-