Skip to content

ContainerDependency

Source code in docs_src/capo_gamelift/types/container_dependency.py 
12
13
14
15
16
17
18
19
20
class ContainerDependency(TypedDict, closed=True):
    container_name: NotRequired[
        "capo_gamelift.types.non_zero_and128_max_ascii_string.NonZeroAnd128MaxAsciiString"
    ]
    """<p>A descriptive label for the container definition that this container depends on.</p>"""
    condition: NotRequired[
        "capo_gamelift.types.container_dependency_condition.ContainerDependencyCondition"
    ]
    """<p>The condition that the dependency container must reach before the dependent container can start. Valid conditions include: </p> <ul> <li> <p>START - The dependency container must have started. </p> </li> <li> <p>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. </p> </li> <li> <p>SUCCESS - The dependency container has run to completion and exited with a zero status. The dependency container can't be an essential container. </p> </li> <li> <p>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.</p> </li> </ul>"""

condition instance-attribute 

condition: NotRequired[ContainerDependencyCondition]

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.

container_name instance-attribute 

container_name: NotRequired[NonZeroAnd128MaxAsciiString]

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