aws-cdk-lib.aws_appmesh.GrpcHealthCheckOptions

interface GrpcHealthCheckOptions

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.GrpcHealthCheckOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#GrpcHealthCheckOptions
Javasoftware.amazon.awscdk.services.appmesh.GrpcHealthCheckOptions
Pythonaws_cdk.aws_appmesh.GrpcHealthCheckOptions
TypeScript (source)aws-cdk-lib » aws_appmesh » GrpcHealthCheckOptions

Properties used to define GRPC Based healthchecks.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_appmesh as appmesh } from 'aws-cdk-lib';
const grpcHealthCheckOptions: appmesh.GrpcHealthCheckOptions = {
  healthyThreshold: 123,
  interval: cdk.Duration.minutes(30),
  timeout: cdk.Duration.minutes(30),
  unhealthyThreshold: 123,
};

Properties

NameTypeDescription
healthyThreshold?numberThe number of consecutive successful health checks that must occur before declaring listener healthy.
interval?DurationThe time period between each health check execution.
timeout?DurationThe amount of time to wait when receiving a response from the health check.
unhealthyThreshold?numberThe number of consecutive failed health checks that must occur before declaring a listener unhealthy.

healthyThreshold?

Type: number (optional, default: 2)

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


interval?

Type: Duration (optional, default: Duration.seconds(5))

The time period between each health check execution.


timeout?

Type: Duration (optional, default: Duration.seconds(2))

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


unhealthyThreshold?

Type: number (optional, default: 2)

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