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 DescribeDBSnapshots operation. Returns information about DB snapshots. This API action supports pagination.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeDBSnapshotsRequest : AmazonRDSRequest
         IAmazonWebServiceRequest

The DescribeDBSnapshotsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeDBSnapshotsRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Properties

NameTypeDescription
Public Property DBInstanceIdentifier System.String

Gets and sets the property DBInstanceIdentifier.

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Public Property DBSnapshotIdentifier System.String

Gets and sets the property DBSnapshotIdentifier.

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

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

Gets and sets the property Filters.

This parameter is not currently supported.

Public Property IncludePublic System.Boolean

Gets and sets the property IncludePublic.

Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Public Property IncludeShared System.Boolean

Gets and sets the property IncludeShared.

Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Public Property Marker System.String

Gets and sets the property Marker.

An optional pagination token provided by a previous DescribeDBSnapshots 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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Public Property SnapshotType System.String

Gets and sets the property SnapshotType.

The type of snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms