Package software.amazon.awscdk.services.apprunner

Interface CfnService.HealthCheckConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.HealthCheckConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.HealthCheckConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.

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.*;
 HealthCheckConfigurationProperty healthCheckConfigurationProperty = HealthCheckConfigurationProperty.builder()
         .healthyThreshold(123)
         .interval(123)
         .path("path")
         .protocol("protocol")
         .timeout(123)
         .unhealthyThreshold(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.HealthCheckConfigurationProperty.Builder	builder()
default Number	getHealthyThreshold()	The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
default Number	getInterval()	The time interval, in seconds, between health checks.
default String	getPath()	The URL that health check requests are sent to.
default String	getProtocol()	The IP protocol that App Runner uses to perform health checks for your service.
default Number	getTimeout()	The time, in seconds, to wait for a health check response before deciding it failed.
default Number	getUnhealthyThreshold()	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(Stable)
@Nullable
default Number getHealthyThreshold()

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

Default: 1

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-healthythreshold

getInterval

@Stability(Stable)
@Nullable
default Number getInterval()

The time interval, in seconds, between health checks.

Default: 5

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-interval

getPath

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

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP .

Default: "/"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-path

getProtocol

@Stability(Stable)
@Nullable
default String getProtocol()

The IP protocol that App Runner uses to perform health checks for your service.

If you set Protocol to HTTP , App Runner sends health check requests to the HTTP path specified by Path .

Default: TCP

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-protocol

getTimeout

@Stability(Stable)
@Nullable
default Number getTimeout()

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

Default: 2

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-timeout

getUnhealthyThreshold

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

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

Default: 5

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-unhealthythreshold

builder

@Stability(Stable)
static CfnService.HealthCheckConfigurationProperty.Builder builder()

Returns:

a CfnService.HealthCheckConfigurationProperty.Builder of CfnService.HealthCheckConfigurationProperty