TargetGroupHealthCheck class
Constructors
-
TargetGroupHealthCheck({Input<bool?>? enabled, Input<int?>? healthyThreshold, Input<int?>? interval, Input<String?>? matcher, Input<String?>? path, Input<String?>? port, Input<String?>? protocol, Input<int?>? timeout, Input<int?>? unhealthyThreshold})
-
Creates a new TargetGroupHealthCheck.
enabled Whether health checks are enabled. Defaults to true.
healthyThreshold Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
interval Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For lambda target groups, it needs to be greater than the timeout of the underlying lambda. Defaults to 30.
matcher The HTTP or gRPC codes to use when checking for a successful response from a target.
path Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
port The port the load balancer uses when performing health checks on targets.
protocol Protocol the load balancer uses when performing health checks on targets.
timeout Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
unhealthyThreshold Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
const
-
TargetGroupHealthCheck.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
enabled
→ Input<bool?>?
-
Whether health checks are enabled. Defaults to
true.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
healthyThreshold
→ Input<int?>?
-
Number of consecutive health check successes required before considering a target healthy. The range is 2-10. Defaults to 3.
final
-
interval
→ Input<int?>?
-
Approximate amount of time, in seconds, between health checks of an individual target. The range is 5-300. For
lambda target groups, it needs to be greater than the timeout of the underlying lambda. Defaults to 30.
final
-
matcher
→ Input<String?>?
-
The HTTP or gRPC codes to use when checking for a successful response from a target.
The
health_check.protocol must be one of HTTP or HTTPS or the targetType must be lambda.
Values can be comma-separated individual values (e.g., "200,202") or a range of values (e.g., "200-299").
Once the value has been set, removing it has no effect. To unset it, set it to an empty string "".
final
-
path
→ Input<String?>?
-
Destination for the health check request. Required for HTTP/HTTPS ALB and HTTP NLB. Only applies to HTTP/HTTPS.
Once the value has been set, removing it has no effect. To unset it, set it to an empty string
"".
final
-
port
→ Input<String?>?
-
The port the load balancer uses when performing health checks on targets.
Valid values are either
traffic-port, to use the same port as the target group, or a valid port number between 1 and 65536.
Default is traffic-port.
final
-
protocol
→ Input<String?>?
-
Protocol the load balancer uses when performing health checks on targets.
Must be one of
TCP, HTTP, or HTTPS.
The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS.
Default is HTTP.
Cannot be specified when the targetType is lambda.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeout
→ Input<int?>?
-
Amount of time, in seconds, during which no response from a target means a failed health check. The range is 2–120 seconds. For target groups with a protocol of HTTP, the default is 6 seconds. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds. For target groups with a protocol of GENEVE, the default is 5 seconds. If the target type is lambda, the default is 30 seconds.
final
-
unhealthyThreshold
→ Input<int?>?
-
Number of consecutive health check failures required before considering a target unhealthy. The range is 2-10. Defaults to 3.
final