HealthCheckConfig ¶

class HealthCheckConfig(TypedDict, closed=True):
    enabled: NotRequired["capo_vpc_lattice.types.boolean.Boolean"]
    """<p>Indicates whether health checking is enabled.</p>"""
    protocol: NotRequired[
        "capo_vpc_lattice.types.target_group_protocol.TargetGroupProtocol"
    ]
    """<p>The protocol used when performing health checks on targets. The possible protocols are <code>HTTP</code> and <code>HTTPS</code>. The default is <code>HTTP</code>.</p>"""
    protocol_version: NotRequired[
        "capo_vpc_lattice.types.health_check_protocol_version.HealthCheckProtocolVersion"
    ]
    """<p>The protocol version used when performing health checks on targets. The possible protocol versions are <code>HTTP1</code> and <code>HTTP2</code>.</p>"""
    port: NotRequired["capo_vpc_lattice.types.health_check_port.HealthCheckPort"]
    """<p>The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.</p>"""
    path: NotRequired["capo_vpc_lattice.types.health_check_path.HealthCheckPath"]
    """<p>The destination for health checks on the targets. If the protocol version is <code>HTTP/1.1</code> or <code>HTTP/2</code>, specify a valid URI (for example, <code>/path?query</code>). The default path is <code>/</code>. Health checks are not supported if the protocol version is <code>gRPC</code>, however, you can choose <code>HTTP/1.1</code> or <code>HTTP/2</code> and specify a valid URI.</p>"""
    health_check_interval_seconds: NotRequired[
        "capo_vpc_lattice.types.health_check_interval_seconds.HealthCheckIntervalSeconds"
    ]
    """<p>The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.</p>"""
    health_check_timeout_seconds: NotRequired[
        "capo_vpc_lattice.types.health_check_timeout_seconds.HealthCheckTimeoutSeconds"
    ]
    """<p>The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.</p>"""
    healthy_threshold_count: NotRequired[
        "capo_vpc_lattice.types.healthy_threshold_count.HealthyThresholdCount"
    ]
    """<p>The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.</p>"""
    unhealthy_threshold_count: NotRequired[
        "capo_vpc_lattice.types.unhealthy_threshold_count.UnhealthyThresholdCount"
    ]
    """<p>The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.</p>"""
    matcher: NotRequired["capo_vpc_lattice.types.matcher.Matcher"]
    """<p>The codes to use when checking for a successful response from a target.</p>"""