interface HealthCheckProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppMesh.CfnVirtualNode.HealthCheckProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnVirtualNode_HealthCheckProperty |
![]() | software.amazon.awscdk.services.appmesh.CfnVirtualNode.HealthCheckProperty |
![]() | aws_cdk.aws_appmesh.CfnVirtualNode.HealthCheckProperty |
![]() | aws-cdk-lib » 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 { 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
Name | Type | Description |
---|---|---|
healthy | number | The number of consecutive successful health checks that must occur before declaring listener healthy. |
interval | number | The time period in milliseconds between each health check execution. |
protocol | string | The protocol for the health check request. |
timeout | number | The amount of time to wait when receiving a response from the health check, in milliseconds. |
unhealthy | 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.