Register Db Proxy Targets

rds_register_db_proxy_targets

R Documentation

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup¶

Description¶

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Usage¶

rds_register_db_proxy_targets(DBProxyName, TargetGroupName,
  DBInstanceIdentifiers, DBClusterIdentifiers)

Arguments¶

DBProxyName: [required] The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
TargetGroupName: The identifier of the DBProxyTargetGroup.
DBInstanceIdentifiers: One or more DB instance identifiers.
DBClusterIdentifiers: One or more DB cluster identifiers.

Value¶

A list with the following syntax:

list(
  DBProxyTargets = 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",
        Reason = "UNREACHABLE"|"CONNECTION_FAILED"|"AUTH_FAILURE"|"PENDING_PROXY_CAPACITY"|"INVALID_REPLICATION_STATE",
        Description = "string"
      )
    )
  )
)

Request syntax¶

svc$register_db_proxy_targets(
  DBProxyName = "string",
  TargetGroupName = "string",
  DBInstanceIdentifiers = list(
    "string"
  ),
  DBClusterIdentifiers = list(
    "string"
  )
)