Returns information about DBProxyTarget objects¶

Description¶

Returns information about DBProxyTarget objects. This API supports pagination.

Usage¶

rds_describe_db_proxy_targets(DBProxyName, TargetGroupName, Filters,
  Marker, MaxRecords)

Arguments¶

DBProxyName

[required] The identifier of the DBProxyTarget to describe.
TargetGroupName

The identifier of the DBProxyTargetGroup to describe.
Filters

This parameter is not currently supported.
Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Value¶

A list with the following syntax:

list(
  Targets = list(
    list(
      TargetArn = "string",
      Endpoint = "string",
      TrackedClusterId = "string",
      RdsResourceId = "string",
      Port = 123,
      Type = "RDS_INSTANCE"|"RDS_SERVERLESS_ENDPOINT"|"TRACKED_CLUSTER",
      Role = "READ_WRITE"|"READ_ONLY"|"UNKNOWN",
      TargetHealth = list(
        State = "REGISTERING"|"AVAILABLE"|"UNAVAILABLE"|"UNUSED",
        Reason = "UNREACHABLE"|"CONNECTION_FAILED"|"AUTH_FAILURE"|"PENDING_PROXY_CAPACITY"|"INVALID_REPLICATION_STATE"|"PROMOTED",
        Description = "string"
      )
    )
  ),
  Marker = "string"
)

Request syntax¶

svc$describe_db_proxy_targets(
  DBProxyName = "string",
  TargetGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123
)