interface ContainerDependencyProperty

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

A container's dependency on another container in the same container group.

The dependency impacts how the dependent container is able to start or shut down based the status of the other container.

For example, ContainerA is configured with the following dependency: a START dependency on ContainerB . This means that ContainerA can't start until ContainerB has started. It also means that ContainerA must shut down before ContainerB .

Part of: GameServerContainerDefinition , GameServerContainerDefinitionInput , SupportContainerDefinition , SupportContainerDefinitionInput

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 containerDependencyProperty: gamelift.CfnContainerGroupDefinition.ContainerDependencyProperty = {
  condition: 'condition',
  containerName: 'containerName',
};

Properties

Name	Type	Description
condition	`string`	The condition that the dependency container must reach before the dependent container can start. Valid conditions include:.
containerName	`string`	A descriptive label for the container definition that this container depends on.

condition

Type: string

The condition that the dependency container must reach before the dependent container can start. Valid conditions include:.

START - The dependency container must have started.
COMPLETE - The dependency container has run to completion (exits). Use this condition with nonessential containers, such as those that run a script and then exit. The dependency container can't be an essential container.
SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container.
HEALTHY - The dependency container has passed its Docker health check. Use this condition with dependency containers that have health checks configured. This condition is confirmed at container group startup only.

containerName

Type: string

A descriptive label for the container definition that this container depends on.