source_regions

Creates, updates, deletes, gets or lists a source_regions resource.

Overview

Name	source_regions
Type	Resource
Id	aws.rds.source_regions

Fields

The following fields are returned by SELECT queries:

describe_source_regions

Name	Datatype	Description
endpoint	string	The endpoint for the source Amazon Web Services Region endpoint.
region_name	string	The name of the source Amazon Web Services Region.
status	string	The status of the source Amazon Web Services Region.
supports_db_instance_automated_backups_replication	boolean	Indicates whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_source_regions	select	region	RegionName, MaxRecords, Marker, Filters	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
Filters	array	This parameter isn't currently supported.
Marker	string	An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	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.
RegionName	string	The source Amazon Web Services Region name. For example, us-east-1. Constraints: Must specify a valid Amazon Web Services Region name.

SELECT examples

describe_source_regions

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.

SELECT
endpoint,
region_name,
status,
supports_db_instance_automated_backups_replication
FROM aws.rds.source_regions
WHERE region = '{{ region }}' -- required
AND RegionName = '{{ RegionName }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND Filters = '{{ Filters }}'
;