libZSservicesZSamazonka-elbv2ZSamazonka-elbv2
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.ELBV2.Types.TargetHealth

Description

 
Synopsis

Documentation

data TargetHealth Source #

Information about the current health of a target.

See: newTargetHealth smart constructor.

Constructors

TargetHealth' 

Fields

  • state :: Maybe TargetHealthStateEnum

    The state of the target.

  • reason :: Maybe TargetHealthReasonEnum

    The reason code.

    If the target state is healthy, a reason code is not provided.

    If the target state is initial, the reason code can be one of the following values:

    • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.
    • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

    If the target state is unhealthy, the reason code can be one of the following values:

    • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.
    • Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
    • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
    • Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

    If the target state is unused, the reason code can be one of the following values:

    • Target.NotRegistered - The target is not registered with the target group.
    • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
    • Target.InvalidState - The target is in the stopped or terminated state.
    • Target.IpUnusable - The target IP address is reserved for use by a load balancer.

    If the target state is draining, the reason code can be the following value:

    • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

    If the target state is unavailable, the reason code can be the following value:

    • Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
    • Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
  • description :: Maybe Text

    A description of the target health that provides additional details. If the state is healthy, a description is not provided.

Instances

Instances details
Eq TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Methods

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

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

Read TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Methods

readsPrec :: Int -> ReadS TargetHealth #

readList :: ReadS [TargetHealth] #

readPrec :: ReadPrec TargetHealth #

readListPrec :: ReadPrec [TargetHealth] #

Show TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Methods

showsPrec :: Int -> TargetHealth -> ShowS #

show :: TargetHealth -> String #

showList :: [TargetHealth] -> ShowS #

Generic TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Associated Types

type Rep TargetHealth :: Type -> Type #

Methods

from :: TargetHealth -> Rep TargetHealth x #

to :: Rep TargetHealth x -> TargetHealth #

NFData TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Methods

rnf :: TargetHealth -> () #

Hashable TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Methods

hashWithSalt :: Int -> TargetHealth -> Int #

hash :: TargetHealth -> Int #

FromXML TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

Methods

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

type Rep TargetHealth Source # 
Instance details

Defined in Amazonka.ELBV2.Types.TargetHealth

type Rep TargetHealth = D1 ('MetaData "TargetHealth" "Amazonka.ELBV2.Types.TargetHealth" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "TargetHealth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetHealthStateEnum)) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetHealthReasonEnum)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newTargetHealth :: TargetHealth Source #

Create a value of TargetHealth 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:state:TargetHealth', targetHealth_state - The state of the target.

$sel:reason:TargetHealth', targetHealth_reason - The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

  • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.
  • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

  • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.
  • Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
  • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
  • Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

If the target state is unused, the reason code can be one of the following values:

  • Target.NotRegistered - The target is not registered with the target group.
  • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
  • Target.InvalidState - The target is in the stopped or terminated state.
  • Target.IpUnusable - The target IP address is reserved for use by a load balancer.

If the target state is draining, the reason code can be the following value:

  • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

If the target state is unavailable, the reason code can be the following value:

  • Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
  • Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.

$sel:description:TargetHealth', targetHealth_description - A description of the target health that provides additional details. If the state is healthy, a description is not provided.

targetHealth_state :: Lens' TargetHealth (Maybe TargetHealthStateEnum) Source #

The state of the target.

targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReasonEnum) Source #

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

  • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.
  • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

  • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.
  • Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.
  • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.
  • Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

If the target state is unused, the reason code can be one of the following values:

  • Target.NotRegistered - The target is not registered with the target group.
  • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.
  • Target.InvalidState - The target is in the stopped or terminated state.
  • Target.IpUnusable - The target IP address is reserved for use by a load balancer.

If the target state is draining, the reason code can be the following value:

  • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

If the target state is unavailable, the reason code can be the following value:

  • Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.
  • Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.

targetHealth_description :: Lens' TargetHealth (Maybe Text) Source #

A description of the target health that provides additional details. If the state is healthy, a description is not provided.