aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition

CfnContainerGroupDefinition L1 construct

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

Construct›CfnElement›CfnRefElement›CfnResource›CfnContainerGroupDefinition

implements

• IInspectable,
• ITaggableV2,
• IEnvironmentAware,
• 3 more

  • IContainerGroupDefinitionRef,
  • IConstruct,
  • IDependable

CloudFormation

AWS::GameLift::ContainerGroupDefinition

Source

Generated code

Type last changed

v2.273.0 · 8 Oct 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnContainerGroupDefinition = new gamelift.CfnContainerGroupDefinition(this, 'MyCfnContainerGroupDefinition', {
  name: 'name',
  operatingSystem: 'operatingSystem',
  totalMemoryLimitMebibytes: 123,

  // the properties below are optional
  containerGroupType: 'containerGroupType',
  gameServerContainerDefinition: {
    containerName: 'containerName',
    imageUri: 'imageUri',
    serverSdkVersion: 'serverSdkVersion',

    // the properties below are optional
    dependsOn: [{
      condition: 'condition',
      containerName: 'containerName',
    }],
    environmentOverride: [{
      name: 'name',
      value: 'value',
    }],
    linuxCapabilities: {
      include: ['include'],
    },
    mountPoints: [{
      instancePath: 'instancePath',

      // the properties below are optional
      accessLevel: 'accessLevel',
      containerPath: 'containerPath',
    }],
    portConfiguration: {
      containerPortRanges: [{
        fromPort: 123,
        protocol: 'protocol',
        toPort: 123,
      }],
    },
    resolvedImageDigest: 'resolvedImageDigest',
    vcpu: 123,
  },
  sourceVersionNumber: 123,
  supportContainerDefinitions: [{
    containerName: 'containerName',
    imageUri: 'imageUri',

    // the properties below are optional
    dependsOn: [{
      condition: 'condition',
      containerName: 'containerName',
    }],
    environmentOverride: [{
      name: 'name',
      value: 'value',
    }],
    essential: false,
    healthCheck: {
      command: ['command'],

      // the properties below are optional
      interval: 123,
      retries: 123,
      startPeriod: 123,
      timeout: 123,
    },
    linuxCapabilities: {
      include: ['include'],
    },
    memoryHardLimitMebibytes: 123,
    mountPoints: [{
      instancePath: 'instancePath',

      // the properties below are optional
      accessLevel: 'accessLevel',
      containerPath: 'containerPath',
    }],
    portConfiguration: {
      containerPortRanges: [{
        fromPort: 123,
        protocol: 'protocol',
        toPort: 123,
      }],
    },
    resolvedImageDigest: 'resolvedImageDigest',
    vcpu: 123,
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  totalVcpuLimit: 123,
  versionDescription: 'versionDescription',
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_gamelift as gamelift

cfn_container_group_definition = gamelift.CfnContainerGroupDefinition(self, "MyCfnContainerGroupDefinition",
    name="name",
    operating_system="operatingSystem",
    total_memory_limit_mebibytes=123,

    # the properties below are optional
    container_group_type="containerGroupType",
    game_server_container_definition=gamelift.CfnContainerGroupDefinition.GameServerContainerDefinitionProperty(
        container_name="containerName",
        image_uri="imageUri",
        server_sdk_version="serverSdkVersion",

        # the properties below are optional
        depends_on=[gamelift.CfnContainerGroupDefinition.ContainerDependencyProperty(
            condition="condition",
            container_name="containerName"
        )],
        environment_override=[gamelift.CfnContainerGroupDefinition.ContainerEnvironmentProperty(
            name="name",
            value="value"
        )],
        linux_capabilities=gamelift.CfnContainerGroupDefinition.LinuxCapabilitiesProperty(
            include=["include"]
        ),
        mount_points=[gamelift.CfnContainerGroupDefinition.ContainerMountPointProperty(
            instance_path="instancePath",

            # the properties below are optional
            access_level="accessLevel",
            container_path="containerPath"
        )],
        port_configuration=gamelift.CfnContainerGroupDefinition.PortConfigurationProperty(
            container_port_ranges=[gamelift.CfnContainerGroupDefinition.ContainerPortRangeProperty(
                from_port=123,
                protocol="protocol",
                to_port=123
            )]
        ),
        resolved_image_digest="resolvedImageDigest",
        vcpu=123
    ),
    source_version_number=123,
    support_container_definitions=[gamelift.CfnContainerGroupDefinition.SupportContainerDefinitionProperty(
        container_name="containerName",
        image_uri="imageUri",

        # the properties below are optional
        depends_on=[gamelift.CfnContainerGroupDefinition.ContainerDependencyProperty(
            condition="condition",
            container_name="containerName"
        )],
        environment_override=[gamelift.CfnContainerGroupDefinition.ContainerEnvironmentProperty(
            name="name",
            value="value"
        )],
        essential=False,
        health_check=gamelift.CfnContainerGroupDefinition.ContainerHealthCheckProperty(
            command=["command"],

            # the properties below are optional
            interval=123,
            retries=123,
            start_period=123,
            timeout=123
        ),
        linux_capabilities=gamelift.CfnContainerGroupDefinition.LinuxCapabilitiesProperty(
            include=["include"]
        ),
        memory_hard_limit_mebibytes=123,
        mount_points=[gamelift.CfnContainerGroupDefinition.ContainerMountPointProperty(
            instance_path="instancePath",

            # the properties below are optional
            access_level="accessLevel",
            container_path="containerPath"
        )],
        port_configuration=gamelift.CfnContainerGroupDefinition.PortConfigurationProperty(
            container_port_ranges=[gamelift.CfnContainerGroupDefinition.ContainerPortRangeProperty(
                from_port=123,
                protocol="protocol",
                to_port=123
            )]
        ),
        resolved_image_digest="resolvedImageDigest",
        vcpu=123
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    total_vcpu_limit=123,
    version_description="versionDescription"
)

// 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.*;

CfnContainerGroupDefinition cfnContainerGroupDefinition = CfnContainerGroupDefinition.Builder.create(this, "MyCfnContainerGroupDefinition")
        .name("name")
        .operatingSystem("operatingSystem")
        .totalMemoryLimitMebibytes(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()))
                .linuxCapabilities(LinuxCapabilitiesProperty.builder()
                        .include(List.of("include"))
                        .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")
                .vcpu(123)
                .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())
                .linuxCapabilities(LinuxCapabilitiesProperty.builder()
                        .include(List.of("include"))
                        .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()))
        .totalVcpuLimit(123)
        .versionDescription("versionDescription")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;

var cfnContainerGroupDefinition = new CfnContainerGroupDefinition(this, "MyCfnContainerGroupDefinition", new CfnContainerGroupDefinitionProps {
    Name = "name",
    OperatingSystem = "operatingSystem",
    TotalMemoryLimitMebibytes = 123,

    // the properties below are optional
    ContainerGroupType = "containerGroupType",
    GameServerContainerDefinition = new GameServerContainerDefinitionProperty {
        ContainerName = "containerName",
        ImageUri = "imageUri",
        ServerSdkVersion = "serverSdkVersion",

        // the properties below are optional
        DependsOn = new [] { new ContainerDependencyProperty {
            Condition = "condition",
            ContainerName = "containerName"
        } },
        EnvironmentOverride = new [] { new ContainerEnvironmentProperty {
            Name = "name",
            Value = "value"
        } },
        LinuxCapabilities = new LinuxCapabilitiesProperty {
            Include = new [] { "include" }
        },
        MountPoints = new [] { new ContainerMountPointProperty {
            InstancePath = "instancePath",

            // the properties below are optional
            AccessLevel = "accessLevel",
            ContainerPath = "containerPath"
        } },
        PortConfiguration = new PortConfigurationProperty {
            ContainerPortRanges = new [] { new ContainerPortRangeProperty {
                FromPort = 123,
                Protocol = "protocol",
                ToPort = 123
            } }
        },
        ResolvedImageDigest = "resolvedImageDigest",
        Vcpu = 123
    },
    SourceVersionNumber = 123,
    SupportContainerDefinitions = new [] { new SupportContainerDefinitionProperty {
        ContainerName = "containerName",
        ImageUri = "imageUri",

        // the properties below are optional
        DependsOn = new [] { new ContainerDependencyProperty {
            Condition = "condition",
            ContainerName = "containerName"
        } },
        EnvironmentOverride = new [] { new ContainerEnvironmentProperty {
            Name = "name",
            Value = "value"
        } },
        Essential = false,
        HealthCheck = new ContainerHealthCheckProperty {
            Command = new [] { "command" },

            // the properties below are optional
            Interval = 123,
            Retries = 123,
            StartPeriod = 123,
            Timeout = 123
        },
        LinuxCapabilities = new LinuxCapabilitiesProperty {
            Include = new [] { "include" }
        },
        MemoryHardLimitMebibytes = 123,
        MountPoints = new [] { new ContainerMountPointProperty {
            InstancePath = "instancePath",

            // the properties below are optional
            AccessLevel = "accessLevel",
            ContainerPath = "containerPath"
        } },
        PortConfiguration = new PortConfigurationProperty {
            ContainerPortRanges = new [] { new ContainerPortRangeProperty {
                FromPort = 123,
                Protocol = "protocol",
                ToPort = 123
            } }
        },
        ResolvedImageDigest = "resolvedImageDigest",
        Vcpu = 123
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TotalVcpuLimit = 123,
    VersionDescription = "versionDescription"
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnContainerGroupDefinition := awscdk.Aws_gamelift.NewCfnContainerGroupDefinition(this, jsii.String("MyCfnContainerGroupDefinition"), &CfnContainerGroupDefinitionProps{
	Name: jsii.String("name"),
	OperatingSystem: jsii.String("operatingSystem"),
	TotalMemoryLimitMebibytes: jsii.Number(123),

	// the properties below are optional
	ContainerGroupType: jsii.String("containerGroupType"),
	GameServerContainerDefinition: &GameServerContainerDefinitionProperty{
		ContainerName: jsii.String("containerName"),
		ImageUri: jsii.String("imageUri"),
		ServerSdkVersion: jsii.String("serverSdkVersion"),

		// the properties below are optional
		DependsOn: []interface{}{
			&ContainerDependencyProperty{
				Condition: jsii.String("condition"),
				ContainerName: jsii.String("containerName"),
			},
		},
		EnvironmentOverride: []interface{}{
			&ContainerEnvironmentProperty{
				Name: jsii.String("name"),
				Value: jsii.String("value"),
			},
		},
		LinuxCapabilities: &LinuxCapabilitiesProperty{
			Include: []*string{
				jsii.String("include"),
			},
		},
		MountPoints: []interface{}{
			&ContainerMountPointProperty{
				InstancePath: jsii.String("instancePath"),

				// the properties below are optional
				AccessLevel: jsii.String("accessLevel"),
				ContainerPath: jsii.String("containerPath"),
			},
		},
		PortConfiguration: &PortConfigurationProperty{
			ContainerPortRanges: []interface{}{
				&ContainerPortRangeProperty{
					FromPort: jsii.Number(123),
					Protocol: jsii.String("protocol"),
					ToPort: jsii.Number(123),
				},
			},
		},
		ResolvedImageDigest: jsii.String("resolvedImageDigest"),
		Vcpu: jsii.Number(123),
	},
	SourceVersionNumber: jsii.Number(123),
	SupportContainerDefinitions: []interface{}{
		&SupportContainerDefinitionProperty{
			ContainerName: jsii.String("containerName"),
			ImageUri: jsii.String("imageUri"),

			// the properties below are optional
			DependsOn: []interface{}{
				&ContainerDependencyProperty{
					Condition: jsii.String("condition"),
					ContainerName: jsii.String("containerName"),
				},
			},
			EnvironmentOverride: []interface{}{
				&ContainerEnvironmentProperty{
					Name: jsii.String("name"),
					Value: jsii.String("value"),
				},
			},
			Essential: jsii.Boolean(false),
			HealthCheck: &ContainerHealthCheckProperty{
				Command: []*string{
					jsii.String("command"),
				},

				// the properties below are optional
				Interval: jsii.Number(123),
				Retries: jsii.Number(123),
				StartPeriod: jsii.Number(123),
				Timeout: jsii.Number(123),
			},
			LinuxCapabilities: &LinuxCapabilitiesProperty{
				Include: []*string{
					jsii.String("include"),
				},
			},
			MemoryHardLimitMebibytes: jsii.Number(123),
			MountPoints: []interface{}{
				&ContainerMountPointProperty{
					InstancePath: jsii.String("instancePath"),

					// the properties below are optional
					AccessLevel: jsii.String("accessLevel"),
					ContainerPath: jsii.String("containerPath"),
				},
			},
			PortConfiguration: &PortConfigurationProperty{
				ContainerPortRanges: []interface{}{
					&ContainerPortRangeProperty{
						FromPort: jsii.Number(123),
						Protocol: jsii.String("protocol"),
						ToPort: jsii.Number(123),
					},
				},
			},
			ResolvedImageDigest: jsii.String("resolvedImageDigest"),
			Vcpu: jsii.Number(123),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TotalVcpuLimit: jsii.Number(123),
	VersionDescription: jsii.String("versionDescription"),
})

Initializer

new CfnContainerGroupDefinition(scope: Construct, id: string, props: CfnContainerGroupDefinitionProps)

CfnContainerGroupDefinition(scope: Construct, id: str, props: CfnContainerGroupDefinitionProps)

new CfnContainerGroupDefinition(Construct scope, String id, CfnContainerGroupDefinitionProps props)

new CfnContainerGroupDefinition(Construct scope, string id, CfnContainerGroupDefinitionProps props)

NewCfnContainerGroupDefinition(Scope Construct, Id *string, Props CfnContainerGroupDefinitionProps)

Construct Props

containerGroupType?optionalstringcontainer_group_type?optionalstrcontainerGroupType?optionalStringContainerGroupType?optionalstringContainerGroupType?optional*string#

The type of container group.

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

gameServerContainerDefinition?optionalIResolvable | CfnContainerGroupDefinition.GameServerContainerDefinitionPropertygame_server_container_definition?optionaltyping.Union[IResolvable, GameServerContainerDefinitionProperty]gameServerContainerDefinition?optionalIResolvableGameServerContainerDefinition?optionalIResolvableGameServerContainerDefinition?optionalinterface{}#

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.

namestringnamestrnameStringNamestringName*stringrequired#

A descriptive identifier for the container group definition.

The name value is unique in an AWS Region.

operatingSystemstringoperating_systemstroperatingSystemStringOperatingSystemstringOperatingSystem*stringrequired#

The platform that all containers in the container group definition run on.

notes

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.

sourceVersionNumber?optionalnumbersource_version_number?optionalint | floatsourceVersionNumber?optionalNumberSourceVersionNumber?optionaldoubleSourceVersionNumber?optional*float64#

A specific ContainerGroupDefinition version to be updated.

supportContainerDefinitions?optionalIResolvable | IResolvable | CfnContainerGroupDefinition.SupportContainerDefinitionProperty[]support_container_definitions?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SupportContainerDefinitionProperty]]]supportContainerDefinitions?optionalIResolvableSupportContainerDefinitions?optionalIResolvableSupportContainerDefinitions?optionalinterface{}#

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.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

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

totalMemoryLimitMebibytesnumbertotal_memory_limit_mebibytesint | floattotalMemoryLimitMebibytesNumberTotalMemoryLimitMebibytesdoubleTotalMemoryLimitMebibytes*float64required#

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.

totalVcpuLimit?optionalnumbertotal_vcpu_limit?optionalint | floattotalVcpuLimit?optionalNumberTotalVcpuLimit?optionaldoubleTotalVcpuLimit?optional*float64#

The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).

notes

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.

versionDescription?optionalstringversion_description?optionalstrversionDescription?optionalStringVersionDescription?optionalstringVersionDescription?optional*string#

An optional description that was provided for a container group definition update.

Each version can have a unique description.

Properties

attrContainerGroupDefinitionArnstringattr_container_group_definition_arnstrattrContainerGroupDefinitionArnStringAttrContainerGroupDefinitionArnstringAttrContainerGroupDefinitionArn*string#

The Amazon Resource Name ( [ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) that is assigned to an Amazon GameLift Servers `ContainerGroupDefinition` resource. It uniquely identifies the resource across all AWS Regions. Format is `arn:aws:gamelift:[region]::containergroupdefinition/[container group definition name]:[version]` .

attrCreationTimestringattr_creation_timestrattrCreationTimeStringAttrCreationTimestringAttrCreationTime*string#

A time stamp indicating when this data object was created.

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

attrStatusstringattr_statusstrattrStatusStringAttrStatusstringAttrStatus*string#

Current status of the container group definition resource. Values include:.

notes

• COPYING -- Amazon GameLift Servers is in the process of making copies of all container images that are defined in the group. While in this state, the resource can't be used to create a container fleet.
• READY -- Amazon GameLift Servers has copied the registry images for all containers that are defined in the group. You can use a container group definition in this status to create a container fleet.
• FAILED -- Amazon GameLift Servers failed to create a valid container group definition resource. For more details on the cause of the failure, see StatusReason . A container group definition resource in failed status will be deleted within a few minutes.

attrStatusReasonstringattr_status_reasonstrattrStatusReasonStringAttrStatusReasonstringAttrStatusReason*string#

Additional information about a container group definition that's in `FAILED` status. Possible reasons include:.

notes

• An internal issue prevented Amazon GameLift Servers from creating the container group definition resource. Delete the failed resource and call CreateContainerGroupDefinition again.
• An access-denied message means that you don't have permissions to access the container image on ECR. See IAM permission examples for help setting up required IAM permissions for Amazon GameLift Servers.
• The ImageUri value for at least one of the containers in the container group definition was invalid or not found in the current AWS account.
• At least one of the container images referenced in the container group definition exceeds the allowed size. For size limits, see Amazon GameLift Servers endpoints and quotas .
• At least one of the container images referenced in the container group definition uses a different operating system than the one defined for the container group.

attrVersionNumbernumberattr_version_numberint | floatattrVersionNumberNumberAttrVersionNumberdoubleAttrVersionNumber*float64#

Indicates the version of a particular container group definition.

This number is incremented automatically when you update a container group definition. You can view, update, or delete individual versions or the entire container group definition.

cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManager#

Tag Manager which manages the tags for this resource.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

containerGroupDefinitionRefContainerGroupDefinitionReferencecontainer_group_definition_refContainerGroupDefinitionReferencecontainerGroupDefinitionRefContainerGroupDefinitionReferenceContainerGroupDefinitionRefContainerGroupDefinitionReferenceContainerGroupDefinitionRefContainerGroupDefinitionReference#

A reference to a ContainerGroupDefinition resource.

containerGroupType?may be undefinedstringcontainer_group_type?may be undefinedstrcontainerGroupType?may be undefinedStringContainerGroupType?may be undefinedstringContainerGroupType?may be undefined*string#

The type of container group.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

gameServerContainerDefinition?may be undefinedIResolvable | CfnContainerGroupDefinition.GameServerContainerDefinitionPropertygame_server_container_definition?may be undefinedtyping.Union[IResolvable, GameServerContainerDefinitionProperty]gameServerContainerDefinition?may be undefinedIResolvableGameServerContainerDefinition?may be undefinedIResolvableGameServerContainerDefinition?may be undefinedinterface{}#

The definition for the game server container in this group.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

namestringnamestrnameStringNamestringName*string#

A descriptive identifier for the container group definition.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

operatingSystemstringoperating_systemstroperatingSystemStringOperatingSystemstringOperatingSystem*string#

The platform that all containers in the container group definition run on.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

sourceVersionNumber?may be undefinednumbersource_version_number?may be undefinedint | floatsourceVersionNumber?may be undefinedNumberSourceVersionNumber?may be undefineddoubleSourceVersionNumber?may be undefined*float64#

A specific ContainerGroupDefinition version to be updated.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

supportContainerDefinitions?may be undefinedIResolvable | IResolvable | CfnContainerGroupDefinition.SupportContainerDefinitionProperty[]support_container_definitions?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SupportContainerDefinitionProperty]]]supportContainerDefinitions?may be undefinedIResolvableSupportContainerDefinitions?may be undefinedIResolvableSupportContainerDefinitions?may be undefinedinterface{}#

The set of definitions for support containers in this group.

tags?may be undefinedCfnTag[]tags?may be undefinedtyping.List[CfnTag]tags?may be undefinedList<CfnTag>Tags?may be undefinedCfnTag[]Tags?may be undefined*[]CfnTag#

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

totalMemoryLimitMebibytesnumbertotal_memory_limit_mebibytesint | floattotalMemoryLimitMebibytesNumberTotalMemoryLimitMebibytesdoubleTotalMemoryLimitMebibytes*float64#

The amount of memory (in MiB) on a fleet instance to allocate for the container group.

totalVcpuLimit?may be undefinednumbertotal_vcpu_limit?may be undefinedint | floattotalVcpuLimit?may be undefinedNumberTotalVcpuLimit?may be undefineddoubleTotalVcpuLimit?may be undefined*float64#

The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).

versionDescription?may be undefinedstringversion_description?may be undefinedstrversionDescription?may be undefinedStringVersionDescription?may be undefinedstringVersionDescription?may be undefined*string#

An optional description that was provided for a container group definition update.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForContainerGroupDefinition(resource: IContainerGroupDefinitionRef): string@staticmethod def arn_for_container_group_definition(resource: IContainerGroupDefinitionRef) -> strpublic static String arnForContainerGroupDefinition(IContainerGroupDefinitionRef resource)public static string ArnForContainerGroupDefinition(IContainerGroupDefinitionRef resource)func ArnForContainerGroupDefinition(Resource IContainerGroupDefinitionRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnContainerGroupDefinition(x: any): boolean@staticmethod def is_cfn_container_group_definition(x: Any) -> boolpublic static Boolean isCfnContainerGroupDefinition(Object x)public static bool IsCfnContainerGroupDefinition(object x)func IsCfnContainerGroupDefinition(X interface{}) *boolstatic#

Checks whether the given object is a CfnContainerGroupDefinition.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.