Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Class CfnContainerGroupDefinitionPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnContainerGroupDefinitionPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.592Z")
@Stability(Stable)
public class CfnContainerGroupDefinitionPropsMixin
extends Mixin
implements software.constructs.IMixin

The properties that describe a container group resource.

You can update all properties of a container group definition properties. Updates to a container group definition are saved as new versions.

Used with: CreateContainerGroupDefinition

Returned by: DescribeContainerGroupDefinition , ListContainerGroupDefinitions , UpdateContainerGroupDefinition

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnContainerGroupDefinitionPropsMixin cfnContainerGroupDefinitionPropsMixin = CfnContainerGroupDefinitionPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnContainerGroupDefinitionPropsMixin.Builder	A fluent builder for CfnContainerGroupDefinitionPropsMixin.
static interface	CfnContainerGroupDefinitionPropsMixin.ContainerDependencyProperty	A container's dependency on another container in the same container group.
static interface	CfnContainerGroupDefinitionPropsMixin.ContainerEnvironmentProperty	An environment variable to set inside a container, in the form of a key-value pair.
static interface	CfnContainerGroupDefinitionPropsMixin.ContainerHealthCheckProperty	Instructions on when and how to check the health of a support container in a container fleet.
static interface	CfnContainerGroupDefinitionPropsMixin.ContainerMountPointProperty	A mount point that binds a container to a file or directory on the host system.
static interface	CfnContainerGroupDefinitionPropsMixin.ContainerPortRangeProperty	A set of one or more port numbers that can be opened on the container, and the supported network protocol.
static interface	CfnContainerGroupDefinitionPropsMixin.GameServerContainerDefinitionProperty	Describes the game server container in an existing game server container group.
static interface	CfnContainerGroupDefinitionPropsMixin.PortConfigurationProperty	Defines the ports on a container.
static interface	CfnContainerGroupDefinitionPropsMixin.SupportContainerDefinitionProperty	Describes a support container in a container group.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnContainerGroupDefinitionPropsMixin(CfnContainerGroupDefinitionMixinProps props)	Create a mixin to apply properties to AWS::GameLift::ContainerGroupDefinition.
	CfnContainerGroupDefinitionPropsMixin(CfnContainerGroupDefinitionMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::GameLift::ContainerGroupDefinition.
protected	CfnContainerGroupDefinitionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContainerGroupDefinitionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnContainerGroupDefinitionMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnContainerGroupDefinitionPropsMixin

protected CfnContainerGroupDefinitionPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnContainerGroupDefinitionPropsMixin

protected CfnContainerGroupDefinitionPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnContainerGroupDefinitionPropsMixin

@Stability(Stable)
public CfnContainerGroupDefinitionPropsMixin(@NotNull
 CfnContainerGroupDefinitionMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::GameLift::ContainerGroupDefinition.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnContainerGroupDefinitionPropsMixin

@Stability(Stable)
public CfnContainerGroupDefinitionPropsMixin(@NotNull
 CfnContainerGroupDefinitionMixinProps props)

Create a mixin to apply properties to AWS::GameLift::ContainerGroupDefinition.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnContainerGroupDefinitionMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()