Skip to content

HealthCheck

Used by
Source code in docs_src/capo_elastic_load_balancing/types/health_check.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class HealthCheck(TypedDict, closed=True):
    target: "capo_elastic_load_balancing.types.health_check_target.HealthCheckTarget"
    """<p>The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.</p> <p>TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.</p> <p>SSL is also specified as SSL: port pair, for example, SSL:5000.</p> <p>For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.</p> <p>The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.</p>"""
    interval: (
        "capo_elastic_load_balancing.types.health_check_interval.HealthCheckInterval"
    )
    """<p>The approximate interval, in seconds, between health checks of an individual instance.</p>"""
    timeout: "capo_elastic_load_balancing.types.health_check_timeout.HealthCheckTimeout"
    """<p>The amount of time, in seconds, during which no response means a failed health check.</p> <p>This value must be less than the <code>Interval</code> value.</p>"""
    unhealthy_threshold: (
        "capo_elastic_load_balancing.types.unhealthy_threshold.UnhealthyThreshold"
    )
    """<p>The number of consecutive health check failures required before moving the instance to the <code>Unhealthy</code> state.</p>"""
    healthy_threshold: (
        "capo_elastic_load_balancing.types.healthy_threshold.HealthyThreshold"
    )
    """<p>The number of consecutive health checks successes required before moving the instance to the <code>Healthy</code> state.</p>"""

healthy_threshold instance-attribute 

healthy_threshold: HealthyThreshold

The number of consecutive health checks successes required before moving the instance to the Healthy state.

interval instance-attribute 

interval: HealthCheckInterval

The approximate interval, in seconds, between health checks of an individual instance.

target instance-attribute 

target: HealthCheckTarget

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

timeout instance-attribute 

timeout: HealthCheckTimeout

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

unhealthy_threshold instance-attribute 

unhealthy_threshold: UnhealthyThreshold

The number of consecutive health check failures required before moving the instance to the Unhealthy state.