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

Interface HttpHealthCheckOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpHealthCheckOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:59.982Z")
@Stability(Experimental)
public interface HttpHealthCheckOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties used to define HTTP Based healthchecks.

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

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

Method Summary

Modifier and Type	Method	Description
static HttpHealthCheckOptions.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 String	getPath()	(experimental) The URL that health check requests are sent to.
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)

getPath

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

(experimental) The URL that health check requests are sent to.

Default: /

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 HttpHealthCheckOptions.Builder builder()

Returns:

a HttpHealthCheckOptions.Builder of HttpHealthCheckOptions