AWS::AppRunner::Service HealthCheckConfiguration

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "HealthyThreshold" : Integer,
  "Interval" : Integer,
  "Path" : String,
  "Protocol" : String,
  "Timeout" : Integer,
  "UnhealthyThreshold" : Integer
}

YAML

  HealthyThreshold: Integer
  Interval: Integer
  Path: String
  Protocol: String
  Timeout: Integer
  UnhealthyThreshold: Integer

Properties

HealthyThreshold

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

Default: 1

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: No interruption

Interval

The time interval, in seconds, between health checks.

Default: 5

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: No interruption

Path

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

Required: No

Type: String

Minimum: 1

Update requires: No interruption

Protocol

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

Required: No

Type: String

Allowed values: TCP | HTTP

Update requires: No interruption

Timeout

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

Default: 2

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: No interruption

UnhealthyThreshold

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

Default: 5

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: No interruption