aws-cdk-lib.aws_appmesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty

interface VirtualGatewayHealthCheckPolicyProperty

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnVirtualGateway_VirtualGatewayHealthCheckPolicyProperty
Javasoftware.amazon.awscdk.services.appmesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
Pythonaws_cdk.aws_appmesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
TypeScript aws-cdk-lib » aws_appmesh » CfnVirtualGateway » VirtualGatewayHealthCheckPolicyProperty

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

Example

// 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 virtualGatewayHealthCheckPolicyProperty: appmesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty = {
  healthyThreshold: 123,
  intervalMillis: 123,
  protocol: 'protocol',
  timeoutMillis: 123,
  unhealthyThreshold: 123,

  // the properties below are optional
  path: 'path',
  port: 123,
};

Properties

NameTypeDescription
healthyThresholdnumberThe number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillisnumberThe time period in milliseconds between each health check execution.
protocolstringThe protocol for the health check request.
timeoutMillisnumberThe amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThresholdnumberThe number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
path?stringThe destination path for the health check request.
port?numberThe destination port for the health check request.

healthyThreshold

Type: number

The number of consecutive successful health checks that must occur before declaring the 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 gateway 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.