class Aws::AppMesh::Types::HealthCheckPolicy
An object that represents the health check policy for a virtual node's listener.
@note When making an API call, you may pass HealthCheckPolicy
data as a hash: { healthy_threshold: 1, # required interval_millis: 1, # required path: "String", port: 1, protocol: "http", # required, accepts http, tcp, http2, grpc timeout_millis: 1, # required unhealthy_threshold: 1, # required }
@!attribute [rw] healthy_threshold
The number of consecutive successful health checks that must occur before declaring listener healthy. @return [Integer]
@!attribute [rw] interval_millis
The time period in milliseconds between each health check execution. @return [Integer]
@!attribute [rw] 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. @return [String]
@!attribute [rw] port
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener. @return [Integer]
@!attribute [rw] protocol
The protocol for the health check request. If you specify `grpc`, then your service must conform to the [GRPC Health Checking Protocol][1]. [1]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md @return [String]
@!attribute [rw] timeout_millis
The amount of time to wait when receiving a response from the health check, in milliseconds. @return [Integer]
@!attribute [rw] unhealthy_threshold
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/appmesh-2019-01-25/HealthCheckPolicy AWS API Documentation
Constants
- SENSITIVE