Describe Db Proxy Endpoints

rds_describe_db_proxy_endpoints

R Documentation

Returns information about DB proxy endpoints

Description

Returns information about DB proxy endpoints.

Usage

rds_describe_db_proxy_endpoints(DBProxyName, DBProxyEndpointName,
  Filters, Marker, MaxRecords)

Arguments

DBProxyName

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

DBProxyEndpointName

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

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(
  DBProxyEndpoints = list(
    list(
      DBProxyEndpointName = "string",
      DBProxyEndpointArn = "string",
      DBProxyName = "string",
      Status = "available"|"modifying"|"incompatible-network"|"insufficient-resource-limits"|"creating"|"deleting",
      VpcId = "string",
      VpcSecurityGroupIds = list(
        "string"
      ),
      VpcSubnetIds = list(
        "string"
      ),
      Endpoint = "string",
      CreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      TargetRole = "READ_WRITE"|"READ_ONLY",
      IsDefault = TRUE|FALSE
    )
  ),
  Marker = "string"
)

Request syntax

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