Skip to content

ContainerHealthCheck

Source code in docs_src/capo_gamelift/types/container_health_check.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ContainerHealthCheck(TypedDict, closed=True):
    command: NotRequired[
        "capo_gamelift.types.container_command_string_list.ContainerCommandStringList"
    ]
    """<p>A string array that specifies the command that the container runs to determine if it's healthy.</p>"""
    interval: NotRequired[
        "capo_gamelift.types.container_health_check_interval.ContainerHealthCheckInterval"
    ]
    """<p>The time period (in seconds) between each health check.</p>"""
    retries: NotRequired[
        "capo_gamelift.types.container_health_check_retries.ContainerHealthCheckRetries"
    ]
    """<p>The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.</p>"""
    start_period: NotRequired[
        "capo_gamelift.types.container_health_check_start_period.ContainerHealthCheckStartPeriod"
    ]
    """<p>The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.</p>"""
    timeout: NotRequired[
        "capo_gamelift.types.container_health_check_timeout.ContainerHealthCheckTimeout"
    ]
    """<p>The time period (in seconds) to wait for a health check to succeed before counting a failed health check. </p>"""

command instance-attribute 

command: NotRequired[ContainerCommandStringList]

A string array that specifies the command that the container runs to determine if it's healthy.

interval instance-attribute 

interval: NotRequired[ContainerHealthCheckInterval]

The time period (in seconds) between each health check.

retries instance-attribute 

retries: NotRequired[ContainerHealthCheckRetries]

The number of times to retry a failed health check before flagging the container unhealthy. The first run of the command does not count as a retry.

start_period instance-attribute 

start_period: NotRequired[ContainerHealthCheckStartPeriod]

The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

timeout instance-attribute 

timeout: NotRequired[ContainerHealthCheckTimeout]

The time period (in seconds) to wait for a health check to succeed before counting a failed health check.