AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeDBSnapshotTenantDatabases operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.DescribeDBSnapshotTenantDatabasesRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeDBSnapshotTenantDatabasesRequest : AmazonRDSRequest
         IAmazonWebServiceRequest

The DescribeDBSnapshotTenantDatabasesRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DBInstanceIdentifier System.String

Gets and sets the property 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.

Public Property DbiResourceId System.String

Gets and sets the property DbiResourceId.

A specific DB resource identifier to describe.

Public Property DBSnapshotIdentifier System.String

Gets and sets the property 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.

Public Property Filters System.Collections.Generic.List<Amazon.RDS.Model.Filter>

Gets and sets the property 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.

Public Property Marker System.String

Gets and sets the property Marker.

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.

Public Property MaxRecords System.Int32

Gets and sets the property 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.

Public Property SnapshotType System.String

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5