/AWS1/CL_RDSDBPROXYTARGET¶
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_TARGETARN TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
IV_ENDPOINT TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The writer endpoint for the RDS DB instance or Aurora DB cluster.
IV_TRACKEDCLUSTERID TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
IV_RDSRESOURCEID TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING¶
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
IV_PORT TYPE /AWS1/RDSINTEGER /AWS1/RDSINTEGER¶
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
IV_TYPE TYPE /AWS1/RDSTARGETTYPE /AWS1/RDSTARGETTYPE¶
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
IV_ROLE TYPE /AWS1/RDSTARGETROLE /AWS1/RDSTARGETROLE¶
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
IO_TARGETHEALTH TYPE REF TO /AWS1/CL_RDSTARGETHEALTH /AWS1/CL_RDSTARGETHEALTH¶
Information about the connection health of the RDS Proxy target.
Queryable Attributes¶
TargetArn¶
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETARN() |
Getter for TARGETARN, with configurable default |
ASK_TARGETARN() |
Getter for TARGETARN w/ exceptions if field has no value |
HAS_TARGETARN() |
Determine if TARGETARN has a value |
Endpoint¶
The writer endpoint for the RDS DB instance or Aurora DB cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINT() |
Getter for ENDPOINT, with configurable default |
ASK_ENDPOINT() |
Getter for ENDPOINT w/ exceptions if field has no value |
HAS_ENDPOINT() |
Determine if ENDPOINT has a value |
TrackedClusterId¶
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRACKEDCLUSTERID() |
Getter for TRACKEDCLUSTERID, with configurable default |
ASK_TRACKEDCLUSTERID() |
Getter for TRACKEDCLUSTERID w/ exceptions if field has no va |
HAS_TRACKEDCLUSTERID() |
Determine if TRACKEDCLUSTERID has a value |
RdsResourceId¶
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RDSRESOURCEID() |
Getter for RDSRESOURCEID, with configurable default |
ASK_RDSRESOURCEID() |
Getter for RDSRESOURCEID w/ exceptions if field has no value |
HAS_RDSRESOURCEID() |
Determine if RDSRESOURCEID has a value |
Port¶
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PORT() |
Getter for PORT, with configurable default |
ASK_PORT() |
Getter for PORT w/ exceptions if field has no value |
HAS_PORT() |
Determine if PORT has a value |
Type¶
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
Role¶
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLE() |
Getter for ROLE, with configurable default |
ASK_ROLE() |
Getter for ROLE w/ exceptions if field has no value |
HAS_ROLE() |
Determine if ROLE has a value |
TargetHealth¶
Information about the connection health of the RDS Proxy target.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETHEALTH() |
Getter for TARGETHEALTH |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_TARGETLIST¶
TYPES TT_TARGETLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_RDSDBPROXYTARGET WITH DEFAULT KEY
.