TargetHealth - Amazon Relational Database Service

TargetHealth

Information about the connection health of an RDS Proxy target.

Contents

Description

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

Type: String

Required: No

Reason

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

Type: String

Valid Values: UNREACHABLE | CONNECTION_FAILED | AUTH_FAILURE | PENDING_PROXY_CAPACITY | INVALID_REPLICATION_STATE

Required: No

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

Type: String

Valid Values: REGISTERING | AVAILABLE | UNAVAILABLE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: