DescribeSnapshotsRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeSnapshots operation. Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation is valid for Redis only.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.DescribeSnapshotsRequest

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

Syntax

public class DescribeSnapshotsRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The DescribeSnapshotsRequest type exposes the following members

Constructors

	Name	Description
	DescribeSnapshotsRequest()

Properties

Name	Type	Description
CacheClusterId	System.String	Gets and sets the property CacheClusterId. A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
Marker	System.String	Gets and sets the property Marker. An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.
ReplicationGroupId	System.String	Gets and sets the property ReplicationGroupId. A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
ShowNodeGroupConfig	System.Boolean	Gets and sets the property ShowNodeGroupConfig. A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
SnapshotName	System.String	Gets and sets the property SnapshotName. A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
SnapshotSource	System.String	Gets and sets the property SnapshotSource. If set to `system`, the output shows snapshots that were automatically created by ElastiCache. If set to `user` the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Examples

Returns information about the snapshot mysnapshot. By default.

DescribeSnapshots


var client = new AmazonElastiCacheClient();
var response = client.DescribeSnapshots(new DescribeSnapshotsRequest 
{
    SnapshotName = "snapshot-20161212"
});

string marker = response.Marker;
List<Snapshot> snapshots = response.Snapshots;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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