Skip to content

ContainerServiceHealthCheckConfig

Source code in docs_src/capo_lightsail/types/container_service_health_check_config.py
class ContainerServiceHealthCheckConfig(TypedDict, closed=True):
    healthy_threshold: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The number of consecutive health checks successes required before moving the container to the <code>Healthy</code> state. The default value is <code>2</code>.</p>"""
    unhealthy_threshold: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The number of consecutive health check failures required before moving the container to the <code>Unhealthy</code> state. The default value is <code>2</code>.</p>"""
    timeout_seconds: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is <code>2</code>.</p>"""
    interval_seconds: NotRequired["capo_lightsail.types.integer.integer"]
    """<p>The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is <code>5</code>.</p>"""
    path: NotRequired["capo_lightsail.types.string.string"]
    """<p>The path on the container on which to perform the health check. The default value is <code>/</code>.</p>"""
    success_codes: NotRequired["capo_lightsail.types.string.string"]
    """<p>The HTTP codes to use when checking for a successful response from a container. You can specify values between <code>200</code> and <code>499</code>. You can specify multiple values (for example, <code>200,202</code>) or a range of values (for example, <code>200-299</code>).</p>"""

healthy_threshold instance-attribute

healthy_threshold: NotRequired[integer]

The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

interval_seconds instance-attribute

interval_seconds: NotRequired[integer]

The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

path instance-attribute

path: NotRequired[string]

The path on the container on which to perform the health check. The default value is /.

success_codes instance-attribute

success_codes: NotRequired[string]

The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

timeout_seconds instance-attribute

timeout_seconds: NotRequired[integer]

The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

unhealthy_threshold instance-attribute

unhealthy_threshold: NotRequired[integer]

The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.