HealthCheckConfig is a property of the PublicEndpoint property. It describes the healthcheck configuration of a
container deployment on a container service.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"HealthyThreshold" : Integer,
"IntervalSeconds" : Integer,
"Path" : String,
"SuccessCodes" : String,
"TimeoutSeconds" : Integer,
"UnhealthyThreshold" : Integer
}
YAML
HealthyThreshold: Integer
IntervalSeconds: Integer
Path: String
SuccessCodes: String
TimeoutSeconds: Integer
UnhealthyThreshold: Integer
Properties
HealthyThreshold-
The number of consecutive health check successes required before moving the container to the
Healthystate. The default value is2.Required: No
Type: Integer
Update requires: No interruption
IntervalSeconds-
The approximate interval, in seconds, between health checks of an individual container. You can specify between
5and300seconds. The default value is5.Required: No
Type: Integer
Update requires: No interruption
Path-
The path on the container on which to perform the health check. The default value is
/.Required: No
Type: String
Update requires: No interruption
SuccessCodes-
The HTTP codes to use when checking for a successful response from a container. You can specify values between
200and499. You can specify multiple values (for example,200,202) or a range of values (for example,200-299).Required: No
Type: String
Update requires: No interruption
TimeoutSeconds-
The amount of time, in seconds, during which no response means a failed health check. You can specify between
2and60seconds. The default value is2.Required: No
Type: Integer
Update requires: No interruption
UnhealthyThreshold-
The number of consecutive health check failures required before moving the container to the
Unhealthystate. The default value is2.Required: No
Type: Integer
Update requires: No interruption
