interface HealthCheckConfigProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Lightsail.CfnContainer.HealthCheckConfigProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awslightsail#CfnContainer_HealthCheckConfigProperty |
 Java | software.amazon.awscdk.services.lightsail.CfnContainer.HealthCheckConfigProperty |
 Python | aws_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
| Name | Type | Description |
|---|---|---|
| healthy | number | The number of consecutive health check successes required before moving the container to the Healthy state. |
| interval | number | The approximate interval, in seconds, between health checks of an individual container. |
| path? | string | The path on the container on which to perform the health check. |
| success | string | The HTTP codes to use when checking for a successful response from a container. |
| timeout | number | The amount of time, in seconds, during which no response means a failed health check. |
| unhealthy | number | The 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 .