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.AppMesh.Types.HealthCheckPolicy

Description

Documentation

data HealthCheckPolicy Source #

An object that represents the health check policy for a virtual node's listener.

See: newHealthCheckPolicy smart constructor.

Constructors

HealthCheckPolicy'

Fields

path :: Maybe Text
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port :: Maybe Natural
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
healthyThreshold :: Natural
The number of consecutive successful health checks that must occur before declaring listener healthy.
intervalMillis :: Natural
The time period in milliseconds between each health check execution.
protocol :: PortProtocol
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis :: Natural
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold :: Natural
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

Instances

Instances details

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

newHealthCheckPolicy Source #

Arguments

:: Natural	`$sel:healthyThreshold:HealthCheckPolicy'`
-> Natural	`$sel:intervalMillis:HealthCheckPolicy'`
-> PortProtocol	`$sel:protocol:HealthCheckPolicy'`
-> Natural	`$sel:timeoutMillis:HealthCheckPolicy'`
-> Natural	`$sel:unhealthyThreshold:HealthCheckPolicy'`
-> HealthCheckPolicy

Create a value of HealthCheckPolicy 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:path:HealthCheckPolicy', healthCheckPolicy_path - The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

$sel:port:HealthCheckPolicy', healthCheckPolicy_port - The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

$sel:healthyThreshold:HealthCheckPolicy', healthCheckPolicy_healthyThreshold - The number of consecutive successful health checks that must occur before declaring listener healthy.

$sel:intervalMillis:HealthCheckPolicy', healthCheckPolicy_intervalMillis - The time period in milliseconds between each health check execution.

$sel:protocol:HealthCheckPolicy', healthCheckPolicy_protocol - The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

$sel:timeoutMillis:HealthCheckPolicy', healthCheckPolicy_timeoutMillis - The amount of time to wait when receiving a response from the health check, in milliseconds.

$sel:unhealthyThreshold:HealthCheckPolicy', healthCheckPolicy_unhealthyThreshold - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

healthCheckPolicy_path :: Lens' HealthCheckPolicy (Maybe Text) Source #

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

healthCheckPolicy_port :: Lens' HealthCheckPolicy (Maybe Natural) Source #

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

healthCheckPolicy_healthyThreshold :: Lens' HealthCheckPolicy Natural Source #

The number of consecutive successful health checks that must occur before declaring listener healthy.

healthCheckPolicy_intervalMillis :: Lens' HealthCheckPolicy Natural Source #

The time period in milliseconds between each health check execution.

healthCheckPolicy_protocol :: Lens' HealthCheckPolicy PortProtocol Source #

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

healthCheckPolicy_timeoutMillis :: Lens' HealthCheckPolicy Natural Source #

The amount of time to wait when receiving a response from the health check, in milliseconds.

healthCheckPolicy_unhealthyThreshold :: Lens' HealthCheckPolicy Natural Source #

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.