aws-cdk-lib.aws_lightsail.CfnContainer.HealthCheckConfigProperty

interface HealthCheckConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Lightsail.CfnContainer.HealthCheckConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnContainer_HealthCheckConfigProperty
Javasoftware.amazon.awscdk.services.lightsail.CfnContainer.HealthCheckConfigProperty
Pythonaws_cdk.aws_lightsail.CfnContainer.HealthCheckConfigProperty
TypeScript aws-cdk-lib » aws_lightsail » CfnContainer » HealthCheckConfigProperty

HealthCheckConfig is a property of the PublicEndpoint property. It describes the healthcheck configuration of a container deployment on a container service.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lightsail as lightsail } from 'aws-cdk-lib';
const healthCheckConfigProperty: lightsail.CfnContainer.HealthCheckConfigProperty = {
  healthyThreshold: 123,
  intervalSeconds: 123,
  path: 'path',
  successCodes: 'successCodes',
  timeoutSeconds: 123,
  unhealthyThreshold: 123,
};

Properties

NameTypeDescription
healthyThreshold?numberThe number of consecutive health check successes required before moving the container to the Healthy state.
intervalSeconds?numberThe approximate interval, in seconds, between health checks of an individual container.
path?stringThe path on the container on which to perform the health check.
successCodes?stringThe HTTP codes to use when checking for a successful response from a container.
timeoutSeconds?numberThe amount of time, in seconds, during which no response means a failed health check.
unhealthyThreshold?numberThe number of consecutive health check failures required before moving the container to the Unhealthy state.

healthyThreshold?

Type: number (optional)

The number of consecutive health check successes required before moving the container to the Healthy state.

The default value is 2 .


intervalSeconds?

Type: number (optional)

The approximate interval, in seconds, between health checks of an individual container.

You can specify between 5 and 300 seconds. The default value is 5 .


path?

Type: string (optional)

The path on the container on which to perform the health check.

The default value is / .


successCodes?

Type: string (optional)

The HTTP codes to use when checking for a successful response from a container.

You can specify values between 200 and 499 . You can specify multiple values (for example, 200,202 ) or a range of values (for example, 200-299 ).


timeoutSeconds?

Type: number (optional)

The amount of time, in seconds, during which no response means a failed health check.

You can specify between 2 and 60 seconds. The default value is 2 .


unhealthyThreshold?

Type: number (optional)

The number of consecutive health check failures required before moving the container to the Unhealthy state.

The default value is 2 .