VirtualGatewayHealthCheckPolicy - Amazon App Mesh
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

VirtualGatewayHealthCheckPolicy

An object that represents the health check policy for a virtual gateway's listener.

Contents

healthyThreshold

The number of consecutive successful health checks that must occur before declaring the listener healthy.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: Yes

intervalMillis

The time period in milliseconds between each health check execution.

Type: Long

Valid Range: Minimum value of 5000. Maximum value of 300000.

Required: Yes

protocol

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Type: String

Valid Values: http | http2 | grpc

Required: Yes

timeoutMillis

The amount of time to wait when receiving a response from the health check, in milliseconds.

Type: Long

Valid Range: Minimum value of 2000. Maximum value of 60000.

Required: Yes

unhealthyThreshold

The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

Type: Integer

Valid Range: Minimum value of 2. Maximum value of 10.

Required: Yes

path

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.

Type: String

Required: No

port

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: