DescribeDBClusterSnapshotsRequest Class

Container for the parameters to the DescribeDBClusterSnapshots operation. Returns information about DB cluster snapshots. This API action supports pagination.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.DescribeDBClusterSnapshotsRequest

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

Syntax

public class DescribeDBClusterSnapshotsRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The DescribeDBClusterSnapshotsRequest type exposes the following members

Constructors

	Name	Description
	DescribeDBClusterSnapshotsRequest()

Properties

Name	Type	Description
DBClusterIdentifier	System.String	Gets and sets the property DBClusterIdentifier. The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the `DBClusterSnapshotIdentifier` parameter. This parameter is not case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster.
DBClusterSnapshotIdentifier	System.String	Gets and sets the property DBClusterSnapshotIdentifier. A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the `DBClusterIdentifier` parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the `SnapshotType` parameter must also be specified.
Filters	System.Collections.Generic.List<Amazon.Neptune.Model.Filter>	Gets and sets the property Filters. This parameter is not currently supported.
IncludePublic	System.Boolean	Gets and sets the property IncludePublic. True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is `false`. The default is false. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
IncludeShared	System.Boolean	Gets and sets the property IncludeShared. True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is `false`. You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.
Marker	System.String	Gets and sets the property Marker. An optional pagination token provided by a previous `DescribeDBClusterSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.
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.
SnapshotType	System.String	Gets and sets the property SnapshotType. The type of DB cluster snapshots to be returned. You can specify one of the following values: `automated` - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account. `manual` - Return all DB cluster snapshots that have been taken by my Amazon account. `shared` - Return all manual DB cluster snapshots that have been shared to my Amazon account. `public` - Return all DB cluster snapshots that have been marked as public. If you don't specify a `SnapshotType` value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the `IncludeShared` parameter to `true`. You can include public DB cluster 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`.

Examples

This example lists settings for the specified, manually-created cluster snapshot.

To list DB cluster snapshots


var response = client.DescribeDBClusterSnapshots(new DescribeDBClusterSnapshotsRequest 
{
    DBClusterSnapshotIdentifier = "mydbclustersnapshot",
    SnapshotType = "manual"
});

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