Skip to content

Describe Source Regions

rds_describe_source_regions R Documentation

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from

Description

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.

Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.

To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation DescribeRegions. For more information, see DescribeRegions in the Amazon EC2 API Reference.

Usage

rds_describe_source_regions(RegionName, MaxRecords, Marker, Filters)

Arguments

RegionName

The source Amazon Web Services Region name. For example, us-east-1.

Constraints:

  • Must specify a valid Amazon Web Services Region name.
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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.
Marker

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

This parameter isn't currently supported.

Value

A list with the following syntax:

list(
  Marker = "string",
  SourceRegions = list(
    list(
      RegionName = "string",
      Endpoint = "string",
      Status = "string",
      SupportsDBInstanceAutomatedBackupsReplication = TRUE|FALSE
    )
  )
)

Request syntax

svc$describe_source_regions(
  RegionName = "string",
  MaxRecords = 123,
  Marker = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  )
)

Examples

## Not run: 
# To list the AWS regions where a Read Replica can be created.
svc$describe_source_regions()

## End(Not run)