libZSservicesZSamazonka-elbZSamazonka-elb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ELB.Types.HealthCheck

Description

 
Synopsis

Documentation

data HealthCheck Source #

Information about a health check.

See: newHealthCheck smart constructor.

Constructors

HealthCheck' 

Fields

  • target :: Text

    The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

    TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

    SSL is also specified as SSL: port pair, for example, SSL:5000.

    For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

    The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

  • interval :: Natural

    The approximate interval, in seconds, between health checks of an individual instance.

  • timeout :: Natural

    The amount of time, in seconds, during which no response means a failed health check.

    This value must be less than the Interval value.

  • unhealthyThreshold :: Natural

    The number of consecutive health check failures required before moving the instance to the Unhealthy state.

  • healthyThreshold :: Natural

    The number of consecutive health checks successes required before moving the instance to the Healthy state.

Instances

Instances details
Eq HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

(==) :: HealthCheck -> HealthCheck -> Bool #

(/=) :: HealthCheck -> HealthCheck -> Bool #

Read HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

readsPrec :: Int -> ReadS HealthCheck #

readList :: ReadS [HealthCheck] #

readPrec :: ReadPrec HealthCheck #

readListPrec :: ReadPrec [HealthCheck] #

Show HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

showsPrec :: Int -> HealthCheck -> ShowS #

show :: HealthCheck -> String #

showList :: [HealthCheck] -> ShowS #

Generic HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Associated Types

type Rep HealthCheck :: Type -> Type #

Methods

from :: HealthCheck -> Rep HealthCheck x #

to :: Rep HealthCheck x -> HealthCheck #

NFData HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

rnf :: HealthCheck -> () #

Hashable HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

hashWithSalt :: Int -> HealthCheck -> Int #

hash :: HealthCheck -> Int #

ToQuery HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

toQuery :: HealthCheck -> QueryString #

FromXML HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

Methods

parseXML :: [Node] -> Either String HealthCheck #

type Rep HealthCheck Source # 
Instance details

Defined in Amazonka.ELB.Types.HealthCheck

type Rep HealthCheck = D1 ('MetaData "HealthCheck" "Amazonka.ELB.Types.HealthCheck" "libZSservicesZSamazonka-elbZSamazonka-elb" 'False) (C1 ('MetaCons "HealthCheck'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "unhealthyThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "healthyThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))

newHealthCheck Source #

Arguments

:: Text

$sel:target:HealthCheck'

-> Natural

$sel:interval:HealthCheck'

-> Natural

$sel:timeout:HealthCheck'

-> Natural

$sel:unhealthyThreshold:HealthCheck'

-> Natural

$sel:healthyThreshold:HealthCheck'

-> HealthCheck 

Create a value of HealthCheck 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:target:HealthCheck', healthCheck_target - The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

$sel:interval:HealthCheck', healthCheck_interval - The approximate interval, in seconds, between health checks of an individual instance.

$sel:timeout:HealthCheck', healthCheck_timeout - The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

$sel:unhealthyThreshold:HealthCheck', healthCheck_unhealthyThreshold - The number of consecutive health check failures required before moving the instance to the Unhealthy state.

$sel:healthyThreshold:HealthCheck', healthCheck_healthyThreshold - The number of consecutive health checks successes required before moving the instance to the Healthy state.

healthCheck_target :: Lens' HealthCheck Text Source #

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

healthCheck_interval :: Lens' HealthCheck Natural Source #

The approximate interval, in seconds, between health checks of an individual instance.

healthCheck_timeout :: Lens' HealthCheck Natural Source #

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

healthCheck_unhealthyThreshold :: Lens' HealthCheck Natural Source #

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

healthCheck_healthyThreshold :: Lens' HealthCheck Natural Source #

The number of consecutive health checks successes required before moving the instance to the Healthy state.