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
Contents
Note
In the following list, the required parameters are described first.
- 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.
Type: String
Valid Values:
START | COMPLETE | SUCCESS | HEALTHYRequired: Yes
-
- ContainerName
-
A descriptive label for the container definition that this container depends on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-]+$Required: Yes
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: