rds_describe_db_snapshot_tenant_databases {paws.database} | R Documentation |
Describes the tenant databases that exist in a DB snapshot
Description
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.
See https://www.paws-r-sdk.com/docs/rds_describe_db_snapshot_tenant_databases/ for full documentation.
Usage
rds_describe_db_snapshot_tenant_databases(
DBInstanceIdentifier = NULL,
DBSnapshotIdentifier = NULL,
SnapshotType = NULL,
Filters = NULL,
MaxRecords = NULL,
Marker = NULL,
DbiResourceId = NULL
)
Arguments
DBInstanceIdentifier |
The ID of the DB instance used to create the DB snapshots. This
parameter isn't case-sensitive.
Constraints:
|
DBSnapshotIdentifier |
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 .
|
SnapshotType |
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.
|
Filters |
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.
|
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 you can retrieve the
remaining results.
|
Marker |
An optional pagination token provided by a previous
describe_db_snapshot_tenant_databases
request. If this parameter is specified, the response includes only
records beyond the marker, up to the value specified by MaxRecords .
|
DbiResourceId |
A specific DB resource identifier to describe.
|
[Package
paws.database version 0.7.0
Index]