Package software.amazon.awscdk.services.apprunner.alpha

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-06T23:25:18.746Z")
@Stability(Experimental)
public interface TcpHealthCheckOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.services.apprunner.alpha.*;
 import software.amazon.awscdk.*;
 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()	(experimental) The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
default Duration	getInterval()	(experimental) The time interval, in seconds, between health checks.
default Duration	getTimeout()	(experimental) The time, in seconds, to wait for a health check response before deciding it failed.
default Number	getUnhealthyThreshold()	(experimental) The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHealthyThreshold

@Stability(Experimental)
@Nullable
default Number getHealthyThreshold()

(experimental) The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

getInterval

@Stability(Experimental)
@Nullable
default Duration getInterval()

(experimental) The time interval, in seconds, between health checks.

Default: Duration.seconds(5)

getTimeout

@Stability(Experimental)
@Nullable
default Duration getTimeout()

(experimental) The time, in seconds, to wait for a health check response before deciding it failed.

Default: Duration.seconds(2)

getUnhealthyThreshold

@Stability(Experimental)
@Nullable
default Number getUnhealthyThreshold()

(experimental) The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5

builder

@Stability(Experimental)
static TcpHealthCheckOptions.Builder builder()

Returns:

a TcpHealthCheckOptions.Builder of TcpHealthCheckOptions