public static interface HealthCheckConfig.Builder extends SdkPojo, CopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
| Modifier and Type | Method and Description |
|---|---|
HealthCheckConfig.Builder |
enabled(Boolean enabled)
Indicates whether health checking is enabled.
|
HealthCheckConfig.Builder |
healthCheckIntervalSeconds(Integer healthCheckIntervalSeconds)
The approximate amount of time, in seconds, between health checks of an individual target.
|
HealthCheckConfig.Builder |
healthCheckTimeoutSeconds(Integer healthCheckTimeoutSeconds)
The amount of time, in seconds, to wait before reporting a target as unhealthy.
|
HealthCheckConfig.Builder |
healthyThresholdCount(Integer healthyThresholdCount)
The number of consecutive successful health checks required before considering an unhealthy target healthy.
|
default HealthCheckConfig.Builder |
matcher(Consumer<Matcher.Builder> matcher)
The codes to use when checking for a successful response from a target.
|
HealthCheckConfig.Builder |
matcher(Matcher matcher)
The codes to use when checking for a successful response from a target.
|
HealthCheckConfig.Builder |
path(String path)
The destination for health checks on the targets.
|
HealthCheckConfig.Builder |
port(Integer port)
The port used when performing health checks on targets.
|
HealthCheckConfig.Builder |
protocol(String protocol)
The protocol used when performing health checks on targets.
|
HealthCheckConfig.Builder |
protocol(TargetGroupProtocol protocol)
The protocol used when performing health checks on targets.
|
HealthCheckConfig.Builder |
protocolVersion(HealthCheckProtocolVersion protocolVersion)
The protocol version used when performing health checks on targets.
|
HealthCheckConfig.Builder |
protocolVersion(String protocolVersion)
The protocol version used when performing health checks on targets.
|
HealthCheckConfig.Builder |
unhealthyThresholdCount(Integer unhealthyThresholdCount)
The number of consecutive failed health checks required before considering a target unhealthy.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildHealthCheckConfig.Builder enabled(Boolean enabled)
Indicates whether health checking is enabled.
enabled - Indicates whether health checking is enabled.HealthCheckConfig.Builder healthCheckIntervalSeconds(Integer 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.
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.HealthCheckConfig.Builder healthCheckTimeoutSeconds(Integer 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.
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.HealthCheckConfig.Builder healthyThresholdCount(Integer healthyThresholdCount)
The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
healthyThresholdCount - The number of consecutive successful health checks required before considering an unhealthy target
healthy. The range is 2–10. The default is 5.HealthCheckConfig.Builder matcher(Matcher matcher)
The codes to use when checking for a successful response from a target. These are called Success codes in the console.
matcher - The codes to use when checking for a successful response from a target. These are called Success
codes in the console.default HealthCheckConfig.Builder matcher(Consumer<Matcher.Builder> matcher)
The codes to use when checking for a successful response from a target. These are called Success codes in the console.
This is a convenience method that creates an instance of theMatcher.Builder avoiding the need to
create one manually via Matcher.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to matcher(Matcher).
matcher - a consumer that will call methods on Matcher.Buildermatcher(Matcher)HealthCheckConfig.Builder path(String path)
The destination for health checks on the targets. If the protocol version is HTTP/1.1 or
HTTP/2, specify a valid URI (for example, /path?query). The default path is
/. Health checks are not supported if the protocol version is gRPC, however, you
can choose HTTP/1.1 or HTTP/2 and specify a valid URI.
path - The destination for health checks on the targets. If the protocol version is HTTP/1.1 or
HTTP/2, specify a valid URI (for example, /path?query). The default path is
/. Health checks are not supported if the protocol version is gRPC, however,
you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.HealthCheckConfig.Builder port(Integer port)
The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
port - The port used when performing health checks on targets. The default setting is the port that a target
receives traffic on.HealthCheckConfig.Builder protocol(String protocol)
The protocol used when performing health checks on targets. The possible protocols are HTTP and
HTTPS. The default is HTTP.
protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP and HTTPS. The default is HTTP.TargetGroupProtocol,
TargetGroupProtocolHealthCheckConfig.Builder protocol(TargetGroupProtocol protocol)
The protocol used when performing health checks on targets. The possible protocols are HTTP and
HTTPS. The default is HTTP.
protocol - The protocol used when performing health checks on targets. The possible protocols are
HTTP and HTTPS. The default is HTTP.TargetGroupProtocol,
TargetGroupProtocolHealthCheckConfig.Builder protocolVersion(String protocolVersion)
The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1 and HTTP2.
protocolVersion - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1 and HTTP2.HealthCheckProtocolVersion,
HealthCheckProtocolVersionHealthCheckConfig.Builder protocolVersion(HealthCheckProtocolVersion protocolVersion)
The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1 and HTTP2.
protocolVersion - The protocol version used when performing health checks on targets. The possible protocol versions are
HTTP1 and HTTP2.HealthCheckProtocolVersion,
HealthCheckProtocolVersionHealthCheckConfig.Builder unhealthyThresholdCount(Integer unhealthyThresholdCount)
The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
unhealthyThresholdCount - The number of consecutive failed health checks required before considering a target unhealthy. The
range is 2–10. The default is 2.Copyright © 2023. All rights reserved.