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 CreateSnapshot operation. Creates a copy of an entire cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateSnapshotRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The CreateSnapshotRequest type exposes the following members

Constructors

NameDescription
Public Method CreateSnapshotRequest()

Properties

NameTypeDescription
Public Property CacheClusterId System.String

Gets and sets the property CacheClusterId.

The identifier of an existing cluster. The snapshot is created from this cluster.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The ID of the KMS key used to encrypt the snapshot.

Public Property ReplicationGroupId System.String

Gets and sets the property ReplicationGroupId.

The identifier of an existing replication group. The snapshot is created from this replication group.

Public Property SnapshotName System.String

Gets and sets the property SnapshotName.

A name for the snapshot being created.

Public Property Tags System.Collections.Generic.List<Amazon.ElastiCache.Model.Tag>

Gets and sets the property Tags.

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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