Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppRunner.Types.HealthCheckConfiguration

Description

Documentation

data HealthCheckConfiguration Source #

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

See: newHealthCheckConfiguration smart constructor.

Constructors

HealthCheckConfiguration'

Fields

healthyThreshold :: Maybe Natural
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
path :: Maybe Text
The URL that health check requests are sent to.
Path is only applicable when you set Protocol to HTTP.
Default: "/"
protocol :: Maybe HealthCheckProtocol
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
interval :: Maybe Natural
The time interval, in seconds, between health checks.
Default: 5
timeout :: Maybe Natural
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
unhealthyThreshold :: Maybe Natural
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5

Instances

Instances details

Eq HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods (==) :: HealthCheckConfiguration -> HealthCheckConfiguration -> Bool # (/=) :: HealthCheckConfiguration -> HealthCheckConfiguration -> Bool #
Read HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods readsPrec :: Int -> ReadS HealthCheckConfiguration # readList :: ReadS [HealthCheckConfiguration] # readPrec :: ReadPrec HealthCheckConfiguration # readListPrec :: ReadPrec [HealthCheckConfiguration] #
Show HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods showsPrec :: Int -> HealthCheckConfiguration -> ShowS # show :: HealthCheckConfiguration -> String # showList :: [HealthCheckConfiguration] -> ShowS #
Generic HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Associated Types type Rep HealthCheckConfiguration :: Type -> Type # Methods from :: HealthCheckConfiguration -> Rep HealthCheckConfiguration x # to :: Rep HealthCheckConfiguration x -> HealthCheckConfiguration #
NFData HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods rnf :: HealthCheckConfiguration -> () #
Hashable HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods hashWithSalt :: Int -> HealthCheckConfiguration -> Int # hash :: HealthCheckConfiguration -> Int #
ToJSON HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods toJSON :: HealthCheckConfiguration -> Value # toEncoding :: HealthCheckConfiguration -> Encoding # toJSONList :: [HealthCheckConfiguration] -> Value # toEncodingList :: [HealthCheckConfiguration] -> Encoding #
FromJSON HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration Methods parseJSON :: Value -> Parser HealthCheckConfiguration # parseJSONList :: Value -> Parser [HealthCheckConfiguration] #
type Rep HealthCheckConfiguration Source #
Instance details Defined in Amazonka.AppRunner.Types.HealthCheckConfiguration type Rep HealthCheckConfiguration = D1 ('MetaData "HealthCheckConfiguration" "Amazonka.AppRunner.Types.HealthCheckConfiguration" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "HealthCheckConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "healthyThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HealthCheckProtocol)))) :: (S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "unhealthyThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newHealthCheckConfiguration :: HealthCheckConfiguration Source #

Create a value of HealthCheckConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:healthyThreshold:HealthCheckConfiguration', healthCheckConfiguration_healthyThreshold - The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

$sel:path:HealthCheckConfiguration', healthCheckConfiguration_path - The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

$sel:protocol:HealthCheckConfiguration', healthCheckConfiguration_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

$sel:interval:HealthCheckConfiguration', healthCheckConfiguration_interval - The time interval, in seconds, between health checks.

Default: 5

$sel:timeout:HealthCheckConfiguration', healthCheckConfiguration_timeout - The time, in seconds, to wait for a health check response before deciding it failed.

Default: 2

$sel:unhealthyThreshold:HealthCheckConfiguration', healthCheckConfiguration_unhealthyThreshold - The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5

healthCheckConfiguration_healthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

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

Default: 1

healthCheckConfiguration_path :: Lens' HealthCheckConfiguration (Maybe Text) Source #

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

healthCheckConfiguration_protocol :: Lens' HealthCheckConfiguration (Maybe HealthCheckProtocol) Source #

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

healthCheckConfiguration_interval :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

The time interval, in seconds, between health checks.

Default: 5

healthCheckConfiguration_timeout :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

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

Default: 2

healthCheckConfiguration_unhealthyThreshold :: Lens' HealthCheckConfiguration (Maybe Natural) Source #

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

Default: 5