Skip to content

HealthCheckConfiguration

Used by
Source code in docs_src/capo_apprunner/types/health_check_configuration.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class HealthCheckConfiguration(TypedDict, closed=True):
    protocol: NotRequired[
        "capo_apprunner.types.health_check_protocol.HealthCheckProtocol"
    ]
    """<p>The IP protocol that App Runner uses to perform health checks for your service.</p> <p>If you set <code>Protocol</code> to <code>HTTP</code>, App Runner sends health check requests to the HTTP path specified by <code>Path</code>.</p> <p>Default: <code>TCP</code> </p>"""
    path: NotRequired["capo_apprunner.types.health_check_path.HealthCheckPath"]
    """<p>The URL that health check requests are sent to.</p> <p> <code>Path</code> is only applicable when you set <code>Protocol</code> to <code>HTTP</code>.</p> <p>Default: <code>"/"</code> </p>"""
    interval: NotRequired[
        "capo_apprunner.types.health_check_interval.HealthCheckInterval"
    ]
    """<p>The time interval, in seconds, between health checks.</p> <p>Default: <code>5</code> </p>"""
    timeout: NotRequired["capo_apprunner.types.health_check_timeout.HealthCheckTimeout"]
    """<p>The time, in seconds, to wait for a health check response before deciding it failed.</p> <p>Default: <code>2</code> </p>"""
    healthy_threshold: NotRequired[
        "capo_apprunner.types.health_check_healthy_threshold.HealthCheckHealthyThreshold"
    ]
    """<p>The number of consecutive checks that must succeed before App Runner decides that the service is healthy.</p> <p>Default: <code>1</code> </p>"""
    unhealthy_threshold: NotRequired[
        "capo_apprunner.types.health_check_unhealthy_threshold.HealthCheckUnhealthyThreshold"
    ]
    """<p>The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.</p> <p>Default: <code>5</code> </p>"""

healthy_threshold instance-attribute 

healthy_threshold: NotRequired[HealthCheckHealthyThreshold]

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

interval instance-attribute 

interval: NotRequired[HealthCheckInterval]

The time interval, in seconds, between health checks.

Default: 5

path instance-attribute 

path: NotRequired[HealthCheckPath]

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

protocol instance-attribute 

protocol: NotRequired[HealthCheckProtocol]

The IP protocol that App Runner uses to perform health checks for your service.

If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

Default: TCP

timeout instance-attribute 

timeout: NotRequired[HealthCheckTimeout]

The time, in seconds, to wait for a health check response before deciding it failed.

Default: 2

unhealthy_threshold instance-attribute 

unhealthy_threshold: NotRequired[HealthCheckUnhealthyThreshold]

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5