Interface TcpHealthCheckOptions

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.159Z") @Stability(Stable) public interface TcpHealthCheckOptions extends
Properties used to define TCP Based healthchecks.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 TcpHealthCheckOptions tcpHealthCheckOptions = TcpHealthCheckOptions.builder()
  • 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 TcpHealthCheckOptions.Builder builder()
      a TcpHealthCheckOptions.Builder of TcpHealthCheckOptions