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

Class HealthCheck

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apprunner.alpha.HealthCheck

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:49.547Z")
@Stability(Experimental)
public class HealthCheck
extends software.amazon.jsii.JsiiObject

(experimental) Contains static factory methods for creating health checks for different protocols.

Example:

 Service.Builder.create(this, "Service")
         .source(Source.fromEcrPublic(EcrPublicProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                 .build()))
         .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                 .healthyThreshold(5)
                 .interval(Duration.seconds(10))
                 .path("/")
                 .timeout(Duration.seconds(10))
                 .unhealthyThreshold(10)
                 .build()))
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HealthCheck(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
CfnService.HealthCheckConfigurationProperty	bind()
HealthCheckProtocolType	getHealthCheckProtocolType()
Number	getHealthyThreshold()
Duration	getInterval()
String	getPath()
Duration	getTimeout()
Number	getUnhealthyThreshold()
static HealthCheck	http()	(experimental) Construct a HTTP health check.
static HealthCheck	http(HttpHealthCheckOptions options)	(experimental) Construct a HTTP health check.
static HealthCheck	tcp()	(experimental) Construct a TCP health check.
static HealthCheck	tcp(TcpHealthCheckOptions options)	(experimental) Construct a TCP health check.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

HealthCheck

protected HealthCheck(software.amazon.jsii.JsiiObjectRef objRef)

HealthCheck

protected HealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Details

http

@Stability(Experimental)
@NotNull
public static HealthCheck http(@Nullable
 HttpHealthCheckOptions options)

(experimental) Construct a HTTP health check.

Parameters:

options -

http

@Stability(Experimental)
@NotNull
public static HealthCheck http()

(experimental) Construct a HTTP health check.

tcp

@Stability(Experimental)
@NotNull
public static HealthCheck tcp(@Nullable
 TcpHealthCheckOptions options)

(experimental) Construct a TCP health check.

Parameters:

options -

tcp

@Stability(Experimental)
@NotNull
public static HealthCheck tcp()

(experimental) Construct a TCP health check.

bind

@Stability(Experimental)
@NotNull
public CfnService.HealthCheckConfigurationProperty bind()

getHealthCheckProtocolType

@Stability(Experimental)
@NotNull
public HealthCheckProtocolType getHealthCheckProtocolType()

getHealthyThreshold

@Stability(Experimental)
@NotNull
public Number getHealthyThreshold()

getInterval

@Stability(Experimental)
@NotNull
public Duration getInterval()

getTimeout

@Stability(Experimental)
@NotNull
public Duration getTimeout()

getUnhealthyThreshold

@Stability(Experimental)
@NotNull
public Number getUnhealthyThreshold()

getPath

@Stability(Experimental)
@Nullable
public String getPath()