software.amazon.awscdk.services.elasticloadbalancingv2

Class HealthCheck.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck.Builder

Enclosing interface:

HealthCheck

public static final class HealthCheck.Builder
extends java.lang.Object

A builder for HealthCheck

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HealthCheck	build() Builds the configured instance.
HealthCheck.Builder	enabled(java.lang.Boolean enabled) Sets the value of HealthCheck.getEnabled()
HealthCheck.Builder	healthyGrpcCodes(java.lang.String healthyGrpcCodes) Sets the value of HealthCheck.getHealthyGrpcCodes()
HealthCheck.Builder	healthyHttpCodes(java.lang.String healthyHttpCodes) Sets the value of HealthCheck.getHealthyHttpCodes()
HealthCheck.Builder	healthyThresholdCount(java.lang.Number healthyThresholdCount) Sets the value of HealthCheck.getHealthyThresholdCount()
HealthCheck.Builder	interval(Duration interval) Sets the value of HealthCheck.getInterval()
HealthCheck.Builder	path(java.lang.String path) Sets the value of HealthCheck.getPath()
HealthCheck.Builder	port(java.lang.String port) Sets the value of HealthCheck.getPort()
HealthCheck.Builder	protocol(Protocol protocol) Sets the value of HealthCheck.getProtocol()
HealthCheck.Builder	timeout(Duration timeout) Sets the value of HealthCheck.getTimeout()
HealthCheck.Builder	unhealthyThresholdCount(java.lang.Number unhealthyThresholdCount) Sets the value of HealthCheck.getUnhealthyThresholdCount()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

enabled

public HealthCheck.Builder enabled(java.lang.Boolean enabled)

Sets the value of HealthCheck.getEnabled()

Parameters:

enabled - Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled.

Returns:

this

healthyGrpcCodes

public HealthCheck.Builder healthyGrpcCodes(java.lang.String healthyGrpcCodes)

Sets the value of HealthCheck.getHealthyGrpcCodes()

Parameters:

healthyGrpcCodes - GRPC code to use when checking for a successful response from a target. You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5").

Returns:

this

healthyHttpCodes

public HealthCheck.Builder healthyHttpCodes(java.lang.String healthyHttpCodes)

Sets the value of HealthCheck.getHealthyHttpCodes()

Parameters:

healthyHttpCodes - HTTP code to use when checking for a successful response from a target. For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

Returns:

this

healthyThresholdCount

public HealthCheck.Builder healthyThresholdCount(java.lang.Number healthyThresholdCount)

Sets the value of HealthCheck.getHealthyThresholdCount()

Parameters:

healthyThresholdCount - The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.

Returns:

this

interval

public HealthCheck.Builder interval(Duration interval)

Sets the value of HealthCheck.getInterval()

Parameters:

interval - The approximate number of seconds between health checks for an individual target.

Returns:

this

path

public HealthCheck.Builder path(java.lang.String path)

Sets the value of HealthCheck.getPath()

Parameters:

path - The ping path destination where Elastic Load Balancing sends health check requests.

Returns:

this

port

public HealthCheck.Builder port(java.lang.String port)

Sets the value of HealthCheck.getPort()

Parameters:

port - The port that the load balancer uses when performing health checks on the targets.

Returns:

this

protocol

public HealthCheck.Builder protocol(Protocol protocol)

Sets the value of HealthCheck.getProtocol()

Parameters:

protocol - The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

Returns:

this

timeout

public HealthCheck.Builder timeout(Duration timeout)

Sets the value of HealthCheck.getTimeout()

Parameters:

timeout - The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2-60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.

Returns:

this

unhealthyThresholdCount

public HealthCheck.Builder unhealthyThresholdCount(java.lang.Number unhealthyThresholdCount)

Sets the value of HealthCheck.getUnhealthyThresholdCount()

Parameters:

unhealthyThresholdCount - The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.

Returns:

this

build

public HealthCheck build()

Builds the configured instance.

Returns:

a new instance of HealthCheck

Throws:

java.lang.NullPointerException - if any required attribute was not provided