software.amazon.awscdk.services.appmesh

Class HealthCheck.Builder

java.lang.Object

software.amazon.awscdk.services.appmesh.HealthCheck.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HealthCheck>

Enclosing interface:

HealthCheck

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

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	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(Protocol 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 Detail

Builder

public Builder()

Method Detail

healthyThreshold

@Stability(value=Experimental)
public HealthCheck.Builder healthyThreshold(Number healthyThreshold)

Sets the value of HealthCheck.getHealthyThreshold()

Parameters:

healthyThreshold - Number of successful attempts before considering the node UP.

Returns:

this

interval

@Stability(value=Experimental)
public HealthCheck.Builder interval(Duration interval)

Sets the value of HealthCheck.getInterval()

Parameters:

interval - Interval in milliseconds to re-check.

Returns:

this

path

@Stability(value=Experimental)
public HealthCheck.Builder path(String path)

Sets the value of HealthCheck.getPath()

Parameters:

path - The path where the application expects any health-checks, this can also be the application path.

Returns:

this

port

@Stability(value=Experimental)
public HealthCheck.Builder port(Number port)

Sets the value of HealthCheck.getPort()

Parameters:

port - The TCP port number for the healthcheck.

Returns:

this

protocol

@Stability(value=Experimental)
public HealthCheck.Builder protocol(Protocol protocol)

Sets the value of HealthCheck.getProtocol()

Parameters:

protocol - The protocol to use for the healthcheck, for convinience a const enum has been defined. Protocol.HTTP or Protocol.TCP

Returns:

this

timeout

@Stability(value=Experimental)
public HealthCheck.Builder timeout(Duration timeout)

Sets the value of HealthCheck.getTimeout()

Parameters:

timeout - Timeout in milli-seconds for the healthcheck to be considered a fail.

Returns:

this

unhealthyThreshold

@Stability(value=Experimental)
public HealthCheck.Builder unhealthyThreshold(Number unhealthyThreshold)

Sets the value of HealthCheck.getUnhealthyThreshold()

Parameters:

unhealthyThreshold - Number of failed attempts before considering the node DOWN.

Returns:

this

build

@Stability(value=Experimental)
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