interface HealthCheckProperty

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.CfnVirtualNode.HealthCheckProperty
Java	software.amazon.awscdk.services.appmesh.CfnVirtualNode.HealthCheckProperty
Python	aws_cdk.aws_appmesh.CfnVirtualNode.HealthCheckProperty
TypeScript	@aws-cdk/aws-appmesh » CfnVirtualNode » HealthCheckProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appmesh from '@aws-cdk/aws-appmesh';
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

Name	Type	Description
healthyThreshold	number	The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis	number	The time period in milliseconds between each health check execution.
protocol	string	The protocol for the health check request.
timeoutMillis	number	The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold	number	The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
path?	string	The destination path for the health check request.
port?	number	The destination port for the health check request.

---

healthyThreshold

Type: number

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

---

intervalMillis

Type: number

The time period in milliseconds between each health check execution.

---

protocol

Type: string

The protocol for the health check request.

If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .

---

timeoutMillis

Type: number

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

---

unhealthyThreshold

Type: number

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

---

path?

Type: string (optional)

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?

Type: number (optional)

The destination port for the health check request.

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