software.amazon.awscdk.services.servicediscovery

Interface HealthCheckConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HealthCheckConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:48.050Z")
 @Stability(value=Experimental)
public interface HealthCheckConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Settings for an optional Amazon Route 53 health check.

If you specify settings for a health check, AWS Cloud Map associates the health check with all the records that you specify in DnsConfig. Only valid with a PublicDnsNamespace.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HealthCheckConfig.Builder	builder()
default Number	getFailureThreshold() (experimental) The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
default String	getResourcePath() (experimental) The path that you want Route 53 to request when performing health checks.
default HealthCheckType	getType() (experimental) The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailureThreshold

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

(experimental) The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

Default: 1

getResourcePath

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

(experimental) The path that you want Route 53 to request when performing health checks.

Do not use when health check type is TCP.

Default: '/'

getType

@Stability(value=Experimental)
 @Nullable
default HealthCheckType getType()

(experimental) The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

Cannot be modified once created. Supported values are HTTP, HTTPS, and TCP.

Default: HTTP

builder

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

Returns:

a HealthCheckConfig.Builder of HealthCheckConfig