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 total memory limit of container groups following this definition in MiB.
totalVcpuLimit	`number`	The total amount of virtual CPUs on the container group definition.
containerGroupType?	`string`	The scope of the container group.
gameServerContainerDefinition?	`IResolvable` `\|` `GameServerContainerDefinitionProperty`	Specifies the information required to run game servers with this container 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`	The description of this version.

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 total memory limit of container groups following this definition in MiB.

totalVcpuLimit

Type: number

The total amount of virtual CPUs on the container group definition.

containerGroupType?

Type: string (optional)

The scope of the container group.

gameServerContainerDefinition?

Type: IResolvable | GameServerContainerDefinitionProperty (optional)

Specifies the information required to run game servers with this container group.

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)

The description of this version.