interface HealthCheckProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins.CfnVirtualNodePropsMixin.HealthCheckProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappmesh/mixins#CfnVirtualNodePropsMixin_HealthCheckProperty
Java	software.amazon.awscdk.mixins.preview.services.appmesh.mixins.CfnVirtualNodePropsMixin.HealthCheckProperty
Python	aws_cdk.mixins_preview.aws_appmesh.mixins.CfnVirtualNodePropsMixin.HealthCheckProperty
TypeScript	@aws-cdk/mixins-preview » aws_appmesh » mixins » CfnVirtualNodePropsMixin » HealthCheckProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appmesh_mixins } from '@aws-cdk/mixins-preview/aws-appmesh';
const healthCheckProperty: appmesh_mixins.CfnVirtualNodePropsMixin.HealthCheckProperty = {
  healthyThreshold: 123,
  intervalMillis: 123,
  path: 'path',
  port: 123,
  protocol: 'protocol',
  timeoutMillis: 123,
  unhealthyThreshold: 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.
path?	string	The destination path for the health check request.
port?	number	The destination port for the health check request.
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.

---

healthyThreshold?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-healthythreshold

---

intervalMillis?

Type: number (optional)

The time period in milliseconds between each health check execution.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-intervalmillis

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-path

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-port

---

protocol?

Type: string (optional)

The protocol for the health check request.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-protocol

---

timeoutMillis?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-timeoutmillis

---

unhealthyThreshold?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-unhealthythreshold