software.amazon.awscdk.services.appmesh

Interface GrpcHealthCheckOptions

All Known Implementing Classes:

GrpcHealthCheckOptions.Jsii$Proxy

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

Properties used to define GRPC Based healthchecks.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 import software.amazon.awscdk.core.*;
 GrpcHealthCheckOptions grpcHealthCheckOptions = GrpcHealthCheckOptions.builder()
         .healthyThreshold(123)
         .interval(Duration.minutes(30))
         .timeout(Duration.minutes(30))
         .unhealthyThreshold(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static GrpcHealthCheckOptions.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 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)

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 GrpcHealthCheckOptions.Builder builder()

Returns:

a GrpcHealthCheckOptions.Builder of GrpcHealthCheckOptions