Interface CfnService.HealthCheckConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnService.HealthCheckConfigurationProperty extends
Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 HealthCheckConfigurationProperty healthCheckConfigurationProperty = HealthCheckConfigurationProperty.builder()
  • 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

    • getInterval

      @Stability(Stable) @Nullable default Number getInterval()
      The time interval, in seconds, between health checks.

      Default: 5

    • 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: "/"

    • 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

    • getTimeout

      @Stability(Stable) @Nullable default Number getTimeout()
      The time, in seconds, to wait for a health check response before deciding it failed.

      Default: 2

    • 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

    • builder

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