interface CfnContainerGroupDefinitionProps

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnContainerGroupDefinitionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnContainerGroupDefinitionProps`
Java	`software.amazon.awscdk.services.gamelift.CfnContainerGroupDefinitionProps`
Python	`aws_cdk.aws_gamelift.CfnContainerGroupDefinitionProps`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnContainerGroupDefinitionProps`

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 { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnContainerGroupDefinitionProps: gamelift.CfnContainerGroupDefinitionProps = {
  name: 'name',
  operatingSystem: 'operatingSystem',
  totalMemoryLimitMebibytes: 123,
  totalVcpuLimit: 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',
    }],
    mountPoints: [{
      instancePath: 'instancePath',

      // the properties below are optional
      accessLevel: 'accessLevel',
      containerPath: 'containerPath',
    }],
    portConfiguration: {
      containerPortRanges: [{
        fromPort: 123,
        protocol: 'protocol',
        toPort: 123,
      }],
    },
    resolvedImageDigest: 'resolvedImageDigest',
  },
  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,
    },
    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',
  }],
  versionDescription: 'versionDescription',
};

Properties

Name	Type	Description
name	`string`	A descriptive identifier for the container group definition.
operatingSystem	`string`	The platform that all containers in the container group definition run on.
totalMemoryLimitMebibytes	`number`	The amount of memory (in MiB) on a fleet instance to allocate for the container group.
totalVcpuLimit	`number`	The amount of vCPU units on a fleet instance to allocate for the container group (1 vCPU is equal to 1024 CPU units).
containerGroupType?	`string`	The type of container group.
gameServerContainerDefinition?	`IResolvable` `\|` `GameServerContainerDefinitionProperty`	The definition for the game server container in this group.
sourceVersionNumber?	`number`	A specific ContainerGroupDefinition version to be updated.
supportContainerDefinitions?	`IResolvable` `\|` `IResolvable` `\|` `SupportContainerDefinitionProperty[]`	The set of definitions for support containers in this group.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.
versionDescription?	`string`	An optional description that was provided for a container group definition update.

name

Type: string

A descriptive identifier for the container group definition.

The name value is unique in an AWS Region.

operatingSystem

Type: string

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.

totalMemoryLimitMebibytes

Type: number

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

Type: number

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.

containerGroupType?

Type: string (optional)

The type of container group.

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

gameServerContainerDefinition?

Type: IResolvable | GameServerContainerDefinitionProperty (optional)

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.

sourceVersionNumber?

Type: number (optional)

A specific ContainerGroupDefinition version to be updated.

supportContainerDefinitions?

Type: IResolvable | IResolvable | SupportContainerDefinitionProperty[] (optional)

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?

Type: CfnTag[] (optional)

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

versionDescription?

Type: string (optional)

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

Each version can have a unique description.