Interface GrpcHealthCheckOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GrpcHealthCheckOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:56.920Z") @Stability(Stable) public interface GrpcHealthCheckOptions extends software.amazon.jsii.JsiiSerializable
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.*;
 import software.amazon.awscdk.services.appmesh.*;
 GrpcHealthCheckOptions grpcHealthCheckOptions = GrpcHealthCheckOptions.builder()
         .healthyThreshold(123)
         .interval(Duration.minutes(30))
         .timeout(Duration.minutes(30))
         .unhealthyThreshold(123)
         .build();
 
  • Method Details

    • getHealthyThreshold

      @Stability(Stable) @Nullable default Number getHealthyThreshold()
      The number of consecutive successful health checks that must occur before declaring listener healthy.

      Default: 2

    • getInterval

      @Stability(Stable) @Nullable default Duration getInterval()
      The time period between each health check execution.

      Default: Duration.seconds(5)

    • getTimeout

      @Stability(Stable) @Nullable default Duration getTimeout()
      The amount of time to wait when receiving a response from the health check.

      Default: Duration.seconds(2)

    • getUnhealthyThreshold

      @Stability(Stable) @Nullable default Number getUnhealthyThreshold()
      The number of consecutive failed health checks that must occur before declaring a listener unhealthy.

      Default: - 2

    • builder

      @Stability(Stable) static GrpcHealthCheckOptions.Builder builder()
      Returns:
      a GrpcHealthCheckOptions.Builder of GrpcHealthCheckOptions