Describes the health check configuration of a target group. Health check configurations
aren't used for target groups of type LAMBDA or ALB.
Contents
- enabled
-
Indicates whether health checking is enabled.
Type: Boolean
Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 300.
Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 120.
Required: No
- healthyThresholdCount
-
The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10.
Required: No
- matcher
-
The codes to use when checking for a successful response from a target.
Type: Matcher object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- path
-
The destination for health checks on the targets. If the protocol version is
HTTP/1.1orHTTP/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.1orHTTP/2and specify a valid URI.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
(^/[a-zA-Z0-9@:%_+.~#?&/=-]*$|(^$))Required: No
- port
-
The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65535.
Required: No
- protocol
-
The protocol used when performing health checks on targets. The possible protocols are
HTTPandHTTPS. The default isHTTP.Type: String
Valid Values:
HTTP | HTTPS | TCPRequired: No
- protocolVersion
-
The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1andHTTP2.Type: String
Valid Values:
HTTP1 | HTTP2Required: No
- unhealthyThresholdCount
-
The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 10.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
