Package software.amazon.awscdk.services.elasticloadbalancing

Class CfnLoadBalancer.HealthCheckProperty.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancing.CfnLoadBalancer.HealthCheckProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLoadBalancer.HealthCheckProperty>

Enclosing interface:

CfnLoadBalancer.HealthCheckProperty

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

A builder for CfnLoadBalancer.HealthCheckProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLoadBalancer.HealthCheckProperty	build()	Builds the configured instance.
CfnLoadBalancer.HealthCheckProperty.Builder	healthyThreshold(String healthyThreshold)	Sets the value of CfnLoadBalancer.HealthCheckProperty.getHealthyThreshold()
CfnLoadBalancer.HealthCheckProperty.Builder	interval(String interval)	Sets the value of CfnLoadBalancer.HealthCheckProperty.getInterval()
CfnLoadBalancer.HealthCheckProperty.Builder	target(String target)	Sets the value of CfnLoadBalancer.HealthCheckProperty.getTarget()
CfnLoadBalancer.HealthCheckProperty.Builder	timeout(String timeout)	Sets the value of CfnLoadBalancer.HealthCheckProperty.getTimeout()
CfnLoadBalancer.HealthCheckProperty.Builder	unhealthyThreshold(String unhealthyThreshold)	Sets the value of CfnLoadBalancer.HealthCheckProperty.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

healthyThreshold

@Stability(Stable)
public CfnLoadBalancer.HealthCheckProperty.Builder healthyThreshold(String healthyThreshold)

Sets the value of CfnLoadBalancer.HealthCheckProperty.getHealthyThreshold()

Parameters:

healthyThreshold - The number of consecutive health checks successes required before moving the instance to the Healthy state. This parameter is required.

Returns:

this

interval

@Stability(Stable)
public CfnLoadBalancer.HealthCheckProperty.Builder interval(String interval)

Sets the value of CfnLoadBalancer.HealthCheckProperty.getInterval()

Parameters:

interval - The approximate interval, in seconds, between health checks of an individual instance. This parameter is required.

Returns:

this

target

@Stability(Stable)
public CfnLoadBalancer.HealthCheckProperty.Builder target(String target)

Sets the value of CfnLoadBalancer.HealthCheckProperty.getTarget()

Parameters:

target - The instance being checked. This parameter is required. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

Returns:

this

timeout

@Stability(Stable)
public CfnLoadBalancer.HealthCheckProperty.Builder timeout(String timeout)

Sets the value of CfnLoadBalancer.HealthCheckProperty.getTimeout()

Parameters:

timeout - The amount of time, in seconds, during which no response means a failed health check. This parameter is required. This value must be less than the Interval value.

Returns:

this

unhealthyThreshold

@Stability(Stable)
public CfnLoadBalancer.HealthCheckProperty.Builder unhealthyThreshold(String unhealthyThreshold)

Sets the value of CfnLoadBalancer.HealthCheckProperty.getUnhealthyThreshold()

Parameters:

unhealthyThreshold - The number of consecutive health check failures required before moving the instance to the Unhealthy state. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CfnLoadBalancer.HealthCheckProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLoadBalancer.HealthCheckProperty>

Returns:

a new instance of CfnLoadBalancer.HealthCheckProperty

Throws:

NullPointerException - if any required attribute was not provided