You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::TargetHealth

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about the connection health of an RDS Proxy target.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)

    A description of the health of the RDS Proxy target.

#reasonString

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

Possible values:

  • UNREACHABLE
  • CONNECTION_FAILED
  • AUTH_FAILURE
  • PENDING_PROXY_CAPACITY

Returns:

  • (String)

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

#stateString

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

Possible values:

  • REGISTERING
  • AVAILABLE
  • UNAVAILABLE

Returns:

  • (String)

    The current state of the connection health lifecycle for the RDS Proxy target.