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.

Creates a copy of an entire cache cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

Note:

For PCL this operation is only available in asynchronous form. Please refer to CreateSnapshotAsync.

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

Syntax

C#
public abstract CreateSnapshotResponse CreateSnapshot(
         CreateSnapshotRequest request
)
Parameters
request
Type: Amazon.ElastiCache.Model.CreateSnapshotRequest

Container for the necessary parameters to execute the CreateSnapshot service method.

Return Value
The response from the CreateSnapshot service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
CacheClusterNotFoundException The requested cache cluster ID does not refer to an existing cache cluster.
InvalidCacheClusterStateException The requested cache cluster is not in the available state.
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.
InvalidReplicationGroupStateException The requested replication group is not in the available state.
ReplicationGroupNotFoundException The specified replication group does not exist.
SnapshotAlreadyExistsException You already have a snapshot with the given name.
SnapshotFeatureNotSupportedException You attempted one of the following operations: Creating a snapshot of a Redis cache cluster running on a cache.t1.micro cache node. Creating a snapshot of a cache cluster that is running Memcached rather than Redis. Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException The request cannot be processed because it would exceed the maximum number of snapshots.

Examples

Creates a snapshot of a non-clustered Redis cluster that has only one node.

CreateSnapshot - NonClustered Redis, no read-replicas


var response = client.CreateSnapshot(new CreateSnapshotRequest 
{
    CacheClusterId = "onenoderedis",
    SnapshotName = "snapshot-1"
});

Snapshot snapshot = response.Snapshot;

            

Creates a snapshot of a non-clustered Redis cluster that has only three nodes, primary and two read-replicas. CacheClusterId must be a specific node in the cluster.

CreateSnapshot - NonClustered Redis, 2 read-replicas


var response = client.CreateSnapshot(new CreateSnapshotRequest 
{
    CacheClusterId = "onenoderedis",
    SnapshotName = "snapshot-1"
});

Snapshot snapshot = response.Snapshot;

            

Creates a snapshot of a clustered Redis cluster that has 2 shards, each with a primary and 4 read-replicas.

CreateSnapshot-clustered Redis


var response = client.CreateSnapshot(new CreateSnapshotRequest 
{
    ReplicationGroupId = "clusteredredis",
    SnapshotName = "snapshot-2x5"
});


            

Version Information

.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

See Also