HealthCheckProperty Struct
An object that represents the health check policy for a virtual node's listener.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';
const healthCheckProperty: appmesh.CfnVirtualNode.HealthCheckProperty = {
healthyThreshold: 123,
intervalMillis: 123,
protocol: 'protocol',
timeoutMillis: 123,
unhealthyThreshold: 123,
// the properties below are optional
path: 'path',
port: 123,
};
Properties
healthyThresholdnumberhealthy_thresholdint | floathealthyThresholdNumberHealthyThresholddoubleHealthyThreshold*float64required#The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillisnumberinterval_millisint | floatintervalMillisNumberIntervalMillisdoubleIntervalMillis*float64required#The time period in milliseconds between each health check execution.
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.
The destination port for the health check request.
This port must match the port defined in the PortMapping for the listener.
The protocol for the health check request.
If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .
timeoutMillisnumbertimeout_millisint | floattimeoutMillisNumberTimeoutMillisdoubleTimeoutMillis*float64required#The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThresholdnumberunhealthy_thresholdint | floatunhealthyThresholdNumberUnhealthyThresholddoubleUnhealthyThreshold*float64required#The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.