AWS::GameLift::ContainerGroupDefinition ContainerDependency

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

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: ContainerDefinition

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Condition" : String,
  "ContainerName" : String
}

YAML

  Condition: String
  ContainerName: String

Properties

Condition

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.

Required: Yes

Type: String

Allowed values: START | COMPLETE | SUCCESS | HEALTHY

Update requires: Replacement

ContainerName

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-]+$

Minimum: 1

Maximum: 128

Update requires: Replacement