Interface CfnContainerGroupDefinitionMixinProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnContainerGroupDefinitionMixinProps.Jsii$Proxy
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cfnpropertymixins.services.gamelift.*;
CfnContainerGroupDefinitionMixinProps cfnContainerGroupDefinitionMixinProps = CfnContainerGroupDefinitionMixinProps.builder()
.containerGroupType("containerGroupType")
.gameServerContainerDefinition(GameServerContainerDefinitionProperty.builder()
.containerName("containerName")
.dependsOn(List.of(ContainerDependencyProperty.builder()
.condition("condition")
.containerName("containerName")
.build()))
.environmentOverride(List.of(ContainerEnvironmentProperty.builder()
.name("name")
.value("value")
.build()))
.imageUri("imageUri")
.mountPoints(List.of(ContainerMountPointProperty.builder()
.accessLevel("accessLevel")
.containerPath("containerPath")
.instancePath("instancePath")
.build()))
.portConfiguration(PortConfigurationProperty.builder()
.containerPortRanges(List.of(ContainerPortRangeProperty.builder()
.fromPort(123)
.protocol("protocol")
.toPort(123)
.build()))
.build())
.resolvedImageDigest("resolvedImageDigest")
.serverSdkVersion("serverSdkVersion")
.build())
.name("name")
.operatingSystem("operatingSystem")
.sourceVersionNumber(123)
.supportContainerDefinitions(List.of(SupportContainerDefinitionProperty.builder()
.containerName("containerName")
.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"))
.interval(123)
.retries(123)
.startPeriod(123)
.timeout(123)
.build())
.imageUri("imageUri")
.memoryHardLimitMebibytes(123)
.mountPoints(List.of(ContainerMountPointProperty.builder()
.accessLevel("accessLevel")
.containerPath("containerPath")
.instancePath("instancePath")
.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()))
.totalMemoryLimitMebibytes(123)
.totalVcpuLimit(123)
.versionDescription("versionDescription")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnContainerGroupDefinitionMixinPropsstatic final classAn implementation forCfnContainerGroupDefinitionMixinProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe type of container group.default ObjectThe definition for the game server container in this group.default StringgetName()A descriptive identifier for the container group definition.default StringThe 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.default NumberThe amount of memory (in MiB) on a fleet instance to allocate for the container group.default NumberThe amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).default StringAn optional description that was provided for a container group definition update.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getContainerGroupType
The type of container group.Container group type determines how Amazon GameLift Servers deploys the container group on each fleet instance.
- See Also:
-
getGameServerContainerDefinition
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 union: either
IResolvableorCfnContainerGroupDefinitionPropsMixin.GameServerContainerDefinitionProperty- See Also:
-
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/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.
- 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.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnContainerGroupDefinitionPropsMixin.SupportContainerDefinitionProperty>- See Also:
-
getTags
An array of key-value pairs to apply to this resource.- See Also:
-
getTotalMemoryLimitMebibytes
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.
- See Also:
-
getTotalVcpuLimit
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.
- See Also:
-
getVersionDescription
An optional description that was provided for a container group definition update.Each version can have a unique description.
- See Also:
-
builder
-