interface TcpHealthCheckOptions

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.TcpHealthCheckOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#TcpHealthCheckOptions
Java	software.amazon.awscdk.services.appmesh.TcpHealthCheckOptions
Python	aws_cdk.aws_appmesh.TcpHealthCheckOptions
TypeScript (source)	aws-cdk-lib » aws_appmesh » TcpHealthCheckOptions

Properties used to define TCP 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 tcpHealthCheckOptions: appmesh.TcpHealthCheckOptions = {
  healthyThreshold: 123,
  interval: cdk.Duration.minutes(30),
  timeout: cdk.Duration.minutes(30),
  unhealthyThreshold: 123,
};

Properties

Name	Type	Description
healthyThreshold?	number	The number of consecutive successful health checks that must occur before declaring listener healthy.
interval?	Duration	The time period between each health check execution.
timeout?	Duration	The amount of time to wait when receiving a response from the health check.
unhealthyThreshold?	number	The 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.