VirtualGatewayHealthCheckPolicy ¶

class VirtualGatewayHealthCheckPolicy(TypedDict, closed=True):
    timeout_millis: "capo_app_mesh.types.virtual_gateway_health_check_timeout_millis.VirtualGatewayHealthCheckTimeoutMillis"
    """<p>The amount of time to wait when receiving a response from the health check, in milliseconds.</p>"""
    interval_millis: "capo_app_mesh.types.virtual_gateway_health_check_interval_millis.VirtualGatewayHealthCheckIntervalMillis"
    """<p>The time period in milliseconds between each health check execution.</p>"""
    protocol: (
        "capo_app_mesh.types.virtual_gateway_port_protocol.VirtualGatewayPortProtocol"
    )
    """<p>The protocol for the health check request. If you specify <code>grpc</code>, then your service must conform to the <a href="https://github.com/grpc/grpc/blob/master/doc/health-checking.md">GRPC Health Checking Protocol</a>.</p>"""
    port: NotRequired["capo_app_mesh.types.port_number.PortNumber"]
    """<p>The destination port for the health check request. This port must match the port defined in the <a>PortMapping</a> for the listener.</p>"""
    path: NotRequired["str"]
    """<p>The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>"""
    healthy_threshold: "capo_app_mesh.types.virtual_gateway_health_check_threshold.VirtualGatewayHealthCheckThreshold"
    """<p>The number of consecutive successful health checks that must occur before declaring the listener healthy.</p>"""
    unhealthy_threshold: "capo_app_mesh.types.virtual_gateway_health_check_threshold.VirtualGatewayHealthCheckThreshold"
    """<p>The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.</p>"""