Skip to content

TargetHealth

Source code in docs_src/capo_rds/types/target_health.py 
15
16
17
18
19
20
21
class TargetHealth(TypedDict, closed=True):
    state: NotRequired["capo_rds.types.target_state.TargetState"]
    """<p>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:</p> <p> <code>registering</code> &gt; <code>unavailable</code> &gt; <code>available</code> &gt; <code>unavailable</code> &gt; <code>available</code> </p>"""
    reason: NotRequired["capo_rds.types.target_health_reason.TargetHealthReason"]
    """<p>The reason for the current health <code>State</code> of the RDS Proxy target.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>A description of the health of the RDS Proxy target. If the <code>State</code> is <code>AVAILABLE</code>, a description is not included.</p>"""

description instance-attribute 

description: NotRequired[String]

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

reason instance-attribute 

reason: NotRequired[TargetHealthReason]

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

state instance-attribute 

state: NotRequired[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