AmazonElastiCacheClient.CreateSnapshot Method (CreateSnapshotRequest)

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

This operation is valid for Redis only.

Note:

For .NET Core 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

public virtual CreateSnapshotResponse CreateSnapshot(
         CreateSnapshotRequest request
)

Parameters

request: Type: Amazon.ElastiCache.Model.CreateSnapshotRequest

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

Return Value

Type: CreateSnapshotResponse

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

Exceptions

Exception	Condition
CacheClusterNotFoundException	The requested cluster ID does not refer to an existing cluster.
InvalidCacheClusterStateException	The requested 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 cluster running on a cache.t1.micro cache node. Creating a snapshot of a 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.
TagQuotaPerResourceExceededException	The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

Examples

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

CreateSnapshot - NonClustered Redis, no read-replicas


var client = new AmazonElastiCacheClient();
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 client = new AmazonElastiCacheClient();
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 client = new AmazonElastiCacheClient();
var response = client.CreateSnapshot(new CreateSnapshotRequest 
{
    ReplicationGroupId = "clusteredredis",
    SnapshotName = "snapshot-2x5"
});

Snapshot snapshot = response.Snapshot;

Version Information

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

AmazonElastiCacheClient.CreateSnapshot (CreateSnapshotRequest)

Method