Package software.amazon.awscdk.services.appmesh

Interface TcpHealthCheckOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TcpHealthCheckOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:03.379Z")
@Stability(Stable)
public interface TcpHealthCheckOptions
extends software.amazon.jsii.JsiiSerializable

Properties used to define TCP 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.*;
 TcpHealthCheckOptions tcpHealthCheckOptions = TcpHealthCheckOptions.builder()
         .healthyThreshold(123)
         .interval(Duration.minutes(30))
         .timeout(Duration.minutes(30))
         .unhealthyThreshold(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TcpHealthCheckOptions.Builder	builder()
default 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 Number	getUnhealthyThreshold()	The number of consecutive failed health checks that must occur before declaring a listener unhealthy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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()

Returns:

a TcpHealthCheckOptions.Builder of TcpHealthCheckOptions