Menu
Amazon ElastiCache
API Reference (API Version 2015-02-02)

Snapshot

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

Contents

Note

In the following list, the required parameters are described first.

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.

Type: String

Valid Values: enabled | disabled | enabling | disabling

Required: No

AutoMinorVersionUpgrade

This parameter is currently disabled.

Type: Boolean

Required: No

CacheClusterCreateTime

The date and time when the source cluster was created.

Type: Timestamp

Required: No

CacheClusterId

The user-supplied identifier of the source cluster.

Type: String

Required: No

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

      R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • 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.

Type: String

Required: No

CacheParameterGroupName

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

Type: String

Required: No

CacheSubnetGroupName

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

Type: String

Required: No

Engine

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

Type: String

Required: No

EngineVersion

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

Type: String

Required: No

NodeSnapshots.NodeSnapshot.N

A list of the cache nodes in the source cluster.

Type: Array of NodeSnapshot objects

Required: No

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.

Type: Integer

Required: No

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.

Type: Integer

Required: No

Port

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

Type: Integer

Required: No

PreferredAvailabilityZone

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

Type: String

Required: No

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

Type: String

Required: No

ReplicationGroupDescription

A description of the source replication group.

Type: String

Required: No

ReplicationGroupId

The unique identifier of the source replication group.

Type: String

Required: No

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.

Type: String

Required: No

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.

Type: Integer

Required: No

SnapshotSource

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

Type: String

Required: No

SnapshotStatus

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

Type: String

Required: No

SnapshotWindow

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

Type: String

Required: No

TopicArn

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

Type: String

Required: No

VpcId

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: