db_snapshot_tenant_databases

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

Overview

Name	db_snapshot_tenant_databases
Type	Resource
Id	aws.rds.db_snapshot_tenant_databases

Fields

The following fields are returned by SELECT queries:

describe_db_snapshot_tenant_databases

Name	Datatype	Description
character_set_name	string	The name of the character set of a tenant database.
db_instance_identifier	string	The ID for the DB instance that contains the tenant databases.
db_snapshot_identifier	string	The identifier for the snapshot of the DB instance.
db_snapshot_tenant_database_arn	string	The Amazon Resource Name (ARN) for the snapshot tenant database.
dbi_resource_id	string	The resource identifier of the source CDB instance. This identifier can't be changed and is unique to an Amazon Web Services Region.
engine_name	string	The name of the database engine.
master_username	string	The master username of the tenant database.
nchar_character_set_name	string	The NCHAR character set name of the tenant database.
snapshot_type	string	The type of DB snapshot.
tag_list	string	A list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
tenant_db_name	string	The name of the tenant database.
tenant_database_create_time	string	The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes.
tenant_database_resource_id	string	The resource ID of the tenant database.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_snapshot_tenant_databases	select	region	DBInstanceIdentifier, DBSnapshotIdentifier, SnapshotType, Filters, MaxRecords, Marker, DbiResourceId	Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration. You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

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)
DBInstanceIdentifier	string	The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.
DBSnapshotIdentifier	string	The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string. Constraints: If you specify this parameter, the value must match the ID of an existing DB snapshot. If you specify an automatic snapshot, you must also specify SnapshotType.
DbiResourceId	string	A specific DB resource identifier to describe.
Filters	array	A filter that specifies one or more tenant databases to describe. Supported filters: tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots. dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). db-snapshot-id - Accepts DB snapshot identifiers. snapshot-type - Accepts types of DB snapshots.
Marker	string	An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases 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 that you can retrieve the remaining results.
SnapshotType	string	The type of DB snapshots to be returned. You can specify one of the following values: automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. manual – All DB snapshots that have been taken by my Amazon Web Services account. shared – All manual DB snapshots that have been shared to my Amazon Web Services account. public – All DB snapshots that have been marked as public. awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.

SELECT examples

describe_db_snapshot_tenant_databases

Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration. You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.

SELECT
character_set_name,
db_instance_identifier,
db_snapshot_identifier,
db_snapshot_tenant_database_arn,
dbi_resource_id,
engine_name,
master_username,
nchar_character_set_name,
snapshot_type,
tag_list,
tenant_db_name,
tenant_database_create_time,
tenant_database_resource_id
FROM aws.rds.db_snapshot_tenant_databases
WHERE region = '{{ region }}' -- required
AND DBInstanceIdentifier = '{{ DBInstanceIdentifier }}'
AND DBSnapshotIdentifier = '{{ DBSnapshotIdentifier }}'
AND SnapshotType = '{{ SnapshotType }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND DbiResourceId = '{{ DbiResourceId }}'
;