AWS SDK Version 2 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.

.NET Framework 4.5
 
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

Inheritance Hierarchy

System.Object
  Amazon.ElastiCache.Model.Snapshot

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class Snapshot : Object

The Snapshot type exposes the following members

Constructors

NameDescription
Public Method Snapshot()

Properties

NameTypeDescription
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 cache cluster was created.

Public Property CacheClusterId System.String Gets and sets the property CacheClusterId.

The user-supplied identifier of the source cache 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 cache cluster.

Valid node types are as follows:

  • General purpose:
    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  • Compute optimized: cache.c1.xlarge
  • Memory optimized
    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
  • Redis backup/restore is not supported for t2 instances.
  • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 cache cluster.

Public Property CacheSubnetGroupName System.String Gets and sets the property CacheSubnetGroupName.

The name of the cache subnet group associated with the source cache 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 cache 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 cache 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 cache cluster.

Public Property NumCacheNodes System.Int32 Gets and sets the property NumCacheNodes.

The number of cache nodes in the source cache cluster.

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

Public Property Port System.Int32 Gets and sets the property Port.

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

Public Property PreferredAvailabilityZone System.String Gets and sets the property PreferredAvailabilityZone.

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

Public Property PreferredMaintenanceWindow System.String Gets and sets the property PreferredMaintenanceWindow.

Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

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 will retain the snapshot before deleting it.

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

ImportantIf 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 cache cluster.

Public Property TopicArn System.String Gets and sets the property TopicArn.

The Amazon Resource Name (ARN) for the topic used by the source cache 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 cache cluster.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8