software.amazon.awscdk.services.appmesh

Interface HttpHealthCheckOptions

All Known Implementing Classes:

HttpHealthCheckOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:34.359Z")
public interface HttpHealthCheckOptions

Properties used to define HTTP Based healthchecks.

Example:

 Mesh mesh;
 Vpc vpc = new Vpc(this, "vpc");
 PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
         .vpc(vpc)
         .name("domain.local")
         .build();
 Service service = namespace.createService("Svc");
 VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .port(8081)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .healthyThreshold(3)
                         .interval(Duration.seconds(5)) // minimum
                         .path("/health-check-path")
                         .timeout(Duration.seconds(2)) // minimum
                         .unhealthyThreshold(2)
                         .build()))
                 .build())))
         .accessLog(AccessLog.fromFilePath("/dev/stdout"))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HttpHealthCheckOptions.Builder	builder()
default java.lang.Number	getHealthyThreshold() The number of consecutive successful health checks that must occur before declaring listener healthy.
default Duration	getInterval() The time period between each health check execution.
default java.lang.String	getPath() The destination path for the health check request.
default Duration	getTimeout() The amount of time to wait when receiving a response from the health check.
default java.lang.Number	getUnhealthyThreshold() The number of consecutive failed health checks that must occur before declaring a listener unhealthy.

Method Detail

getHealthyThreshold

default java.lang.Number getHealthyThreshold()

The number of consecutive successful health checks that must occur before declaring listener healthy.

Default: 2

getInterval

default Duration getInterval()

The time period between each health check execution.

Default: Duration.seconds(5)

getPath

default java.lang.String getPath()

The destination path for the health check request.

Default: /

getTimeout

default Duration getTimeout()

The amount of time to wait when receiving a response from the health check.

Default: Duration.seconds(2)

getUnhealthyThreshold

default java.lang.Number getUnhealthyThreshold()

The number of consecutive failed health checks that must occur before declaring a listener unhealthy.

Default: - 2

builder

static HttpHealthCheckOptions.Builder builder()

Returns:

a HttpHealthCheckOptions.Builder of HttpHealthCheckOptions