class Aws::AppRunner::Types::HealthCheckConfiguration

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

@note When making an API call, you may pass HealthCheckConfiguration

data as a hash:

    {
      protocol: "TCP", # accepts TCP, HTTP
      path: "String",
      interval: 1,
      timeout: 1,
      healthy_threshold: 1,
      unhealthy_threshold: 1,
    }

@!attribute [rw] 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`
@return [String]

@!attribute [rw] path

The URL that health check requests are sent to.

`Path` is only applicable when you set `Protocol` to `HTTP`.

Default: `"/"`
@return [String]

@!attribute [rw] interval

The time interval, in seconds, between health checks.

Default: `5`
@return [Integer]

@!attribute [rw] timeout

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

Default: `2`
@return [Integer]

@!attribute [rw] healthy_threshold

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

Default: `3`
@return [Integer]

@!attribute [rw] unhealthy_threshold

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

Default: `3`
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/apprunner-2020-05-15/HealthCheckConfiguration AWS API Documentation

Constants

SENSITIVE