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.

Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

Inheritance Hierarchy

System.Object
  Amazon.ElastiCache.Model.Snapshot

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

Syntax

C#
public class Snapshot

The Snapshot type exposes the following members

Constructors

NameDescription
Public Method Snapshot()

Properties

NameTypeDescription
Public Property AutomaticFailover Amazon.ElastiCache.AutomaticFailoverStatus

Gets and sets the property AutomaticFailover.

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 and T2 cache node types.

  • Redis (cluster mode enabled): T1 node types.

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

This parameter is currently disabled.

Public Property CacheClusterCreateTime System.DateTime

Gets and sets the property CacheClusterCreateTime.

The date and time when the source cluster was created.

Public Property CacheClusterId System.String

Gets and sets the property CacheClusterId.

The user-supplied identifier of the source cluster.

Public Property CacheNodeType System.String

Gets and sets the property CacheNodeType.

The name of the compute and memory capacity node type for the source cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      T2 node types:cache.t2.micro, cache.t2.small, cache.t2.medium

      M3 node types:cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      M4 node types:cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: (not recommended)

      T1 node types:cache.t1.micro

      M1 node types:cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types:cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R3 node types:cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: (not recommended)

      M2 node types:cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Public Property CacheParameterGroupName System.String

Gets and sets the property CacheParameterGroupName.

The cache parameter group that is associated with the source cluster.

Public Property CacheSubnetGroupName System.String

Gets and sets the property CacheSubnetGroupName.

The name of the cache subnet group associated with the source cluster.

Public Property Engine System.String

Gets and sets the property Engine.

The name of the cache engine (memcached or redis) used by the source cluster.

Public Property EngineVersion System.String

Gets and sets the property EngineVersion.

The version of the cache engine version that is used by the source cluster.

Public Property NodeSnapshots System.Collections.Generic.List<Amazon.ElastiCache.Model.NodeSnapshot>

Gets and sets the property NodeSnapshots.

A list of the cache nodes in the source cluster.

Public Property NumCacheNodes System.Int32

Gets and sets the property NumCacheNodes.

The number of cache nodes in the source cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Public Property NumNodeGroups System.Int32

Gets and sets the property NumNodeGroups.

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

Public Property Port System.Int32

Gets and sets the property Port.

The port number used by each cache nodes in the source cluster.

Public Property PreferredAvailabilityZone System.String

Gets and sets the property PreferredAvailabilityZone.

The name of the Availability Zone in which the source cluster is located.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

Public Property ReplicationGroupDescription System.String

Gets and sets the property ReplicationGroupDescription.

A description of the source replication group.

Public Property ReplicationGroupId System.String

Gets and sets the property ReplicationGroupId.

The unique identifier of the source replication group.

Public Property SnapshotName System.String

Gets and sets the property SnapshotName.

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

Public Property SnapshotRetentionLimit System.Int32

Gets and sets the property SnapshotRetentionLimit.

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Public Property SnapshotSource System.String

Gets and sets the property SnapshotSource.

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

Public Property SnapshotStatus System.String

Gets and sets the property SnapshotStatus.

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Public Property SnapshotWindow System.String

Gets and sets the property SnapshotWindow.

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

Public Property TopicArn System.String

Gets and sets the property TopicArn.

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

Public Property VpcId System.String

Gets and sets the property VpcId.

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

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