Package software.amazon.awscdk.services.elasticloadbalancing

Class HealthCheck.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancing.HealthCheck.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HealthCheck>

Enclosing interface:

HealthCheck

@Stability(Stable)
public static final class HealthCheck.Builder
extends Object
implements software.amazon.jsii.Builder<HealthCheck>

A builder for HealthCheck

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HealthCheck	build()	Builds the configured instance.
HealthCheck.Builder	healthyThreshold(Number healthyThreshold)	Sets the value of HealthCheck.getHealthyThreshold()
HealthCheck.Builder	interval(Duration interval)	Sets the value of HealthCheck.getInterval()
HealthCheck.Builder	path(String path)	Sets the value of HealthCheck.getPath()
HealthCheck.Builder	port(Number port)	Sets the value of HealthCheck.getPort()
HealthCheck.Builder	protocol(LoadBalancingProtocol protocol)	Sets the value of HealthCheck.getProtocol()
HealthCheck.Builder	timeout(Duration timeout)	Sets the value of HealthCheck.getTimeout()
HealthCheck.Builder	unhealthyThreshold(Number unhealthyThreshold)	Sets the value of HealthCheck.getUnhealthyThreshold()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

port

@Stability(Stable)
public HealthCheck.Builder port(Number port)

Sets the value of HealthCheck.getPort()

Parameters:

port - What port number to health check on. This parameter is required.

Returns:

this

healthyThreshold

@Stability(Stable)
public HealthCheck.Builder healthyThreshold(Number healthyThreshold)

Sets the value of HealthCheck.getHealthyThreshold()

Parameters:

healthyThreshold - After how many successful checks is an instance considered healthy.

Returns:

this

interval

@Stability(Stable)
public HealthCheck.Builder interval(Duration interval)

Sets the value of HealthCheck.getInterval()

Parameters:

interval - Number of seconds between health checks.

Returns:

this

path

@Stability(Stable)
public HealthCheck.Builder path(String path)

Sets the value of HealthCheck.getPath()

Parameters:

path - What path to use for HTTP or HTTPS health check (must return 200). For SSL and TCP health checks, accepting connections is enough to be considered healthy.

Returns:

this

protocol

@Stability(Stable)
public HealthCheck.Builder protocol(LoadBalancingProtocol protocol)

Sets the value of HealthCheck.getProtocol()

Parameters:

protocol - What protocol to use for health checking. The protocol is automatically determined from the port if it's not supplied.

Returns:

this

timeout

@Stability(Stable)
public HealthCheck.Builder timeout(Duration timeout)

Sets the value of HealthCheck.getTimeout()

Parameters:

timeout - Health check timeout.

Returns:

this

unhealthyThreshold

@Stability(Stable)
public HealthCheck.Builder unhealthyThreshold(Number unhealthyThreshold)

Sets the value of HealthCheck.getUnhealthyThreshold()

Parameters:

unhealthyThreshold - After how many unsuccessful checks is an instance considered unhealthy.

Returns:

this

build

@Stability(Stable)
public HealthCheck build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<HealthCheck>

Returns:

a new instance of HealthCheck

Throws:

NullPointerException - if any required attribute was not provided