Amazonka.RDS.Types.TargetHealth

Documentation

data TargetHealth

Information about the connection health of an RDS Proxy target.

See: newTargetHealth smart constructor.

Constructors

TargetHealth'

Fields

• description :: Maybe Text

  A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

• reason :: Maybe TargetHealthReason

  The reason for the current health State of the RDS Proxy target.

• state :: Maybe TargetState

  The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

  registering > unavailable > available > unavailable > available

Instances

FromXML TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Methods

parseXML :: [Node] -> Either String TargetHealth

Generic TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Associated Types

type Rep TargetHealth :: Type -> Type

Methods

from :: TargetHealth -> Rep TargetHealth x

to :: Rep TargetHealth x -> TargetHealth

Read TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Methods

readsPrec :: Int -> ReadS TargetHealth

readList :: ReadS [TargetHealth]

readPrec :: ReadPrec TargetHealth

readListPrec :: ReadPrec [TargetHealth]

Show TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Methods

showsPrec :: Int -> TargetHealth -> ShowS

show :: TargetHealth -> String

showList :: [TargetHealth] -> ShowS

NFData TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Methods

rnf :: TargetHealth -> ()

Eq TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Methods

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

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

Hashable TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

Methods

hashWithSalt :: Int -> TargetHealth -> Int

hash :: TargetHealth -> Int

type Rep TargetHealth

Defined in Amazonka.RDS.Types.TargetHealth

type Rep TargetHealth = D1 ('MetaData "TargetHealth" "Amazonka.RDS.Types.TargetHealth" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "TargetHealth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetHealthReason)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetState)))))

newTargetHealth :: TargetHealth

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:description:TargetHealth', targetHealth_description - A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

$sel:reason:TargetHealth', targetHealth_reason - The reason for the current health State of the RDS Proxy target.

$sel:state:TargetHealth', targetHealth_state - The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

registering > unavailable > available > unavailable > available

targetHealth_description :: Lens' TargetHealth (Maybe Text)

A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

targetHealth_reason :: Lens' TargetHealth (Maybe TargetHealthReason)

The reason for the current health State of the RDS Proxy target.

targetHealth_state :: Lens' TargetHealth (Maybe TargetState)

The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

registering > unavailable > available > unavailable > available