Skip to content

Describe Db Snapshot Tenant Databases

rds_describe_db_snapshot_tenant_databases 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.

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.

Usage

rds_describe_db_snapshot_tenant_databases(DBInstanceIdentifier,
  DBSnapshotIdentifier, SnapshotType, Filters, MaxRecords, Marker,
  DbiResourceId)

Arguments

DBInstanceIdentifier

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

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.

Value

A list with the following syntax:

list(
  Marker = "string",
  DBSnapshotTenantDatabases = list(
    list(
      DBSnapshotIdentifier = "string",
      DBInstanceIdentifier = "string",
      DbiResourceId = "string",
      EngineName = "string",
      SnapshotType = "string",
      TenantDatabaseCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      TenantDBName = "string",
      MasterUsername = "string",
      TenantDatabaseResourceId = "string",
      CharacterSetName = "string",
      DBSnapshotTenantDatabaseARN = "string",
      NcharCharacterSetName = "string",
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_db_snapshot_tenant_databases(
  DBInstanceIdentifier = "string",
  DBSnapshotIdentifier = "string",
  SnapshotType = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string",
  DbiResourceId = "string"
)