software.amazon.awscdk.services.appmesh

Interface HealthCheck

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HealthCheck.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:25.709Z")
 @Stability(value=Experimental)
public interface HealthCheck
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties used to define healthchecks when creating virtual nodes.

All values have a default if only specified as {} when creating. If property not set, then no healthchecks will be defined.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HealthCheck.Builder A builder for HealthCheck
static class	HealthCheck.Jsii$Proxy An implementation for HealthCheck

Method Summary

Modifier and Type	Method and Description
static HealthCheck.Builder	builder()
default Number	getHealthyThreshold() (experimental) Number of successful attempts before considering the node UP.
default Duration	getInterval() (experimental) Interval in milliseconds to re-check.
default String	getPath() (experimental) The path where the application expects any health-checks, this can also be the application path.
default Number	getPort() (experimental) The TCP port number for the healthcheck.
default Protocol	getProtocol() (experimental) The protocol to use for the healthcheck, for convinience a const enum has been defined.
default Duration	getTimeout() (experimental) Timeout in milli-seconds for the healthcheck to be considered a fail.
default Number	getUnhealthyThreshold() (experimental) Number of failed attempts before considering the node DOWN.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHealthyThreshold

@Stability(value=Experimental)
 @Nullable
default Number getHealthyThreshold()

(experimental) Number of successful attempts before considering the node UP.

Default: 2

getInterval

@Stability(value=Experimental)
 @Nullable
default Duration getInterval()

(experimental) Interval in milliseconds to re-check.

Default: 5 seconds

getPath

@Stability(value=Experimental)
 @Nullable
default String getPath()

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

Default: /

getPort

@Stability(value=Experimental)
 @Nullable
default Number getPort()

(experimental) The TCP port number for the healthcheck.

Default: - same as corresponding port mapping

getProtocol

@Stability(value=Experimental)
 @Nullable
default Protocol getProtocol()

(experimental) The protocol to use for the healthcheck, for convinience a const enum has been defined.

Protocol.HTTP or Protocol.TCP

Default: - same as corresponding port mapping

getTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()

(experimental) Timeout in milli-seconds for the healthcheck to be considered a fail.

Default: 2 seconds

getUnhealthyThreshold

@Stability(value=Experimental)
 @Nullable
default Number getUnhealthyThreshold()

(experimental) Number of failed attempts before considering the node DOWN.

Default: 2

builder

@Stability(value=Experimental)
static HealthCheck.Builder builder()

Returns:

a HealthCheck.Builder of HealthCheck