Describes the health check configuration of a target group. Health check configurations
aren't used for target groups of type LAMBDA
or ALB
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Enabled" : Boolean
,
"HealthCheckIntervalSeconds" : Integer
,
"HealthCheckTimeoutSeconds" : Integer
,
"HealthyThresholdCount" : Integer
,
"Matcher" : Matcher
,
"Path" : String
,
"Port" : Integer
,
"Protocol" : String
,
"ProtocolVersion" : String
,
"UnhealthyThresholdCount" : Integer
}
YAML
Enabled: Boolean
HealthCheckIntervalSeconds: Integer
HealthCheckTimeoutSeconds: Integer
HealthyThresholdCount: Integer
Matcher:
Matcher
Path: String
Port: Integer
Protocol: String
ProtocolVersion: String
UnhealthyThresholdCount: Integer
Properties
Enabled
-
Indicates whether health checking is enabled.
Required: No
Type: Boolean
Update requires: No interruption
HealthCheckIntervalSeconds
-
The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.
Required: No
Type: Integer
Minimum:
5
Maximum:
300
Update requires: No interruption
HealthCheckTimeoutSeconds
-
The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.
Required: No
Type: Integer
Minimum:
1
Maximum:
120
Update requires: No interruption
HealthyThresholdCount
-
The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
Required: No
Type: Integer
Minimum:
2
Maximum:
10
Update requires: No interruption
Matcher
-
The codes to use when checking for a successful response from a target.
Required: No
Type: Matcher
Update requires: No interruption
Path
-
The destination for health checks on the targets. If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI.Required: No
Type: String
Pattern:
(^/[a-zA-Z0-9@:%_+.~#?&/=-]*$|(^$))
Minimum:
0
Maximum:
2048
Update requires: No interruption
Port
-
The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
Required: No
Type: Integer
Minimum:
1
Maximum:
65535
Update requires: No interruption
Protocol
-
The protocol used when performing health checks on targets. The possible protocols are
HTTP
andHTTPS
. The default isHTTP
.Required: No
Type: String
Allowed values:
HTTP | HTTPS
Update requires: No interruption
ProtocolVersion
-
The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1
andHTTP2
.Required: No
Type: String
Allowed values:
HTTP1 | HTTP2
Update requires: No interruption
UnhealthyThresholdCount
-
The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
Required: No
Type: Integer
Minimum:
2
Maximum:
10
Update requires: No interruption