interface SupportContainerDefinitionProperty

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

Describes a support container in a container group.

A support container might be in a game server container group or a per-instance container group. Support containers don't run game server processes.

You can update a support container definition and deploy the updates to an existing fleet. When creating or updating a game server container group definition, use the property GameServerContainerDefinitionInput .

Part of: ContainerGroupDefinition

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 { aws_gamelift as gamelift } from 'aws-cdk-lib';
const supportContainerDefinitionProperty: gamelift.CfnContainerGroupDefinition.SupportContainerDefinitionProperty = {
  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,
};

Properties

Name	Type	Description
containerName	`string`	The container definition identifier.
imageUri	`string`	The URI to the image that Amazon GameLift Servers deploys to a container fleet.
dependsOn?	`IResolvable` `\|` `IResolvable` `\|` `ContainerDependencyProperty[]`	Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.
environmentOverride?	`IResolvable` `\|` `IResolvable` `\|` `ContainerEnvironmentProperty[]`	A set of environment variables that's passed to the container on startup.
essential?	`boolean \|` `IResolvable`	Indicates whether the container is vital to the container group.
healthCheck?	`IResolvable` `\|` `ContainerHealthCheckProperty`	A configuration for a non-terminal health check.
memoryHardLimitMebibytes?	`number`	The amount of memory that Amazon GameLift Servers makes available to the container.
mountPoints?	`IResolvable` `\|` `IResolvable` `\|` `ContainerMountPointProperty[]`	A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.
portConfiguration?	`IResolvable` `\|` `PortConfigurationProperty`	A set of ports that allow access to the container from external users.
resolvedImageDigest?	`string`	A unique and immutable identifier for the container image.
vcpu?	`number`	The number of vCPU units that are reserved for the container.

containerName

Type: string

The container definition identifier.

Container names are unique within a container group definition.

imageUri

Type: string

The URI to the image that Amazon GameLift Servers deploys to a container fleet.

For a more specific identifier, see ResolvedImageDigest .

dependsOn?

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

Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences.

A container might have dependencies on multiple containers.

environmentOverride?

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

A set of environment variables that's passed to the container on startup.

See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference .

essential?

Type: boolean | IResolvable (optional)

Indicates whether the container is vital to the container group.

If an essential container fails, the entire container group restarts.

healthCheck?

Type: IResolvable | ContainerHealthCheckProperty (optional)

A configuration for a non-terminal health check.

A support container automatically restarts if it stops functioning or if it fails this health check.

memoryHardLimitMebibytes?

Type: number (optional)

The amount of memory that Amazon GameLift Servers makes available to the container.

If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

mountPoints?

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

A mount point that binds a path inside the container to a file or directory on the host system and lets it access the file or directory.

portConfiguration?

Type: IResolvable | PortConfigurationProperty (optional)

A set of ports that allow access to the container from external users.

Processes running in the container can bind to a one of these ports. Container ports aren't directly accessed by inbound traffic. Amazon GameLift Servers maps these container ports to externally accessible connection ports, which are assigned as needed from the container fleet's ConnectionPortRange .

resolvedImageDigest?

Type: string (optional)

A unique and immutable identifier for the container image.

The digest is a SHA 256 hash of the container image manifest.

vcpu?

Type: number (optional)

The number of vCPU units that are reserved for the container.

If no resources are reserved, the container shares the total vCPU limit for the container group.

Related data type: ContainerGroupDefinition TotalVcpuLimit