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 DescribeSnapshots operation. Returns information about cache 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

C#
public class DescribeSnapshotsRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The DescribeSnapshotsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeSnapshotsRequest()

Properties

NameTypeDescription
Public Property 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 cache cluster are described.

Public Property 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.

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 marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

Public Property 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.

Public Property 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.

Public Property 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.

Public Property 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 response = client.DescribeSnapshots(new DescribeSnapshotsRequest 
{
    SnapshotName = "snapshot-20161212"
});

string marker = response.Marker;
List snapshots = response.Snapshots;

            

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