# HealthCheckProperty

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

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## 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

- `healthyThreshold`: number (required) — The number of consecutive successful health checks that must occur before declaring listener healthy.

- `intervalMillis`: number (required) — The time period in milliseconds between each health check execution.

- `path`: string — 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.

- `port`: number — The destination port for the health check request.

  This port must match the port defined in the `PortMapping` for the listener.

- `protocol`: string (required) — The protocol for the health check request.

  If you specify `grpc` , then your service must conform to the [GRPC Health Checking Protocol](https://docs.aws.amazon.com/https://github.com/grpc/grpc/blob/master/doc/health-checking.md) .

- `timeoutMillis`: number (required) — The amount of time to wait when receiving a response from the health check, in milliseconds.

- `unhealthyThreshold`: number (required) — The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.