snapshots

Creates, updates, deletes, gets or lists a snapshots resource.

Overview

Name	snapshots
Type	Resource
Id	aws.elasticache.snapshots

Fields

The following fields are returned by SELECT queries:

describe_snapshots

Name	Datatype	Description
arn	string	The ARN (Amazon Resource Name) of the snapshot.
auto_minor_version_upgrade	boolean	If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
automatic_failover	string	Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
cache_cluster_create_time	string	The date and time when the source cluster was created.
cache_cluster_id	string	The user-supplied identifier of the source cluster.
cache_node_type	string	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: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge 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. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
cache_parameter_group_name	string	The cache parameter group that is associated with the source cluster.
cache_subnet_group_name	string	The name of the cache subnet group associated with the source cluster.
data_tiering	string	Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
durability	string	The durability setting of the cluster when the snapshot was taken. When restoring from this snapshot, the cluster uses this durability setting unless overridden in the restore request. For more information, see Durability.
engine	string	The name of the cache engine (memcached or redis) used by the source cluster.
engine_version	string	The version of the cache engine version that is used by the source cluster.
kms_key_id	string	The ID of the KMS key used to encrypt the snapshot.
node_snapshots	string	A list of the cache nodes in the source cluster.
num_cache_nodes	integer	The number of cache nodes in the source cluster. For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
num_node_groups	integer	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.
port	integer	The port number used by each cache nodes in the source cluster.
preferred_availability_zone	string	The name of the Availability Zone in which the source cluster is located.
preferred_maintenance_window	string	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
preferred_outpost_arn	string	The ARN (Amazon Resource Name) of the preferred outpost.
replication_group_description	string	A description of the source replication group.
replication_group_id	string	The unique identifier of the source replication group.
snapshot_name	string	The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
snapshot_retention_limit	integer	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.
snapshot_source	string	Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
snapshot_status	string	The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
snapshot_window	string	The daily time range during which ElastiCache takes daily snapshots of the source cluster.
topic_arn	string	The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
vpc_id	string	The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_snapshots	select	region	ReplicationGroupId, CacheClusterId, SnapshotName, SnapshotSource, Marker, MaxRecords, ShowNodeGroupConfig	Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Valkey or Redis OSS only.
create_snapshot	insert	SnapshotName, region	ReplicationGroupId, CacheClusterId, KmsKeyId, Tags	Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Valkey or Redis OSS only.
delete_snapshot	delete	SnapshotName, region		Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Valkey or Redis OSS only.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
SnapshotName	string	The name of the snapshot to be deleted.
region	string	AWS region (default: us-east-1)
CacheClusterId	string	The identifier of an existing cluster. The snapshot is created from this cluster.
KmsKeyId	string	The ID of the KMS key used to encrypt the snapshot.
Marker	string	An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.
ReplicationGroupId	string	The identifier of an existing replication group. The snapshot is created from this replication group.
ShowNodeGroupConfig	boolean	A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
SnapshotName	string	A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
SnapshotSource	string	If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
Tags	array	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.

SELECT examples

describe_snapshots

Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Valkey or Redis OSS only.

SELECT
arn,
auto_minor_version_upgrade,
automatic_failover,
cache_cluster_create_time,
cache_cluster_id,
cache_node_type,
cache_parameter_group_name,
cache_subnet_group_name,
data_tiering,
durability,
engine,
engine_version,
kms_key_id,
node_snapshots,
num_cache_nodes,
num_node_groups,
port,
preferred_availability_zone,
preferred_maintenance_window,
preferred_outpost_arn,
replication_group_description,
replication_group_id,
snapshot_name,
snapshot_retention_limit,
snapshot_source,
snapshot_status,
snapshot_window,
topic_arn,
vpc_id
FROM aws.elasticache.snapshots
WHERE region = '{{ region }}' -- required
AND ReplicationGroupId = '{{ ReplicationGroupId }}'
AND CacheClusterId = '{{ CacheClusterId }}'
AND SnapshotName = '{{ SnapshotName }}'
AND SnapshotSource = '{{ SnapshotSource }}'
AND Marker = '{{ Marker }}'
AND MaxRecords = '{{ MaxRecords }}'
AND ShowNodeGroupConfig = '{{ ShowNodeGroupConfig }}'
;

INSERT examples

create_snapshot

Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Valkey or Redis OSS only.

INSERT INTO aws.elasticache.snapshots (
SnapshotName,
region,
ReplicationGroupId,
CacheClusterId,
KmsKeyId,
Tags
)
SELECT 
'{{ SnapshotName }}',
'{{ region }}',
'{{ ReplicationGroupId }}',
'{{ CacheClusterId }}',
'{{ KmsKeyId }}',
'{{ Tags }}'
RETURNING
arn,
auto_minor_version_upgrade,
automatic_failover,
cache_cluster_create_time,
cache_cluster_id,
cache_node_type,
cache_parameter_group_name,
cache_subnet_group_name,
data_tiering,
durability,
engine,
engine_version,
kms_key_id,
node_snapshots,
num_cache_nodes,
num_node_groups,
port,
preferred_availability_zone,
preferred_maintenance_window,
preferred_outpost_arn,
replication_group_description,
replication_group_id,
snapshot_name,
snapshot_retention_limit,
snapshot_source,
snapshot_status,
snapshot_window,
topic_arn,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
props:
  - name: SnapshotName
    value: "{{ SnapshotName }}"
    description: Required parameter for the snapshots resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the snapshots resource.
  - name: ReplicationGroupId
    value: "{{ ReplicationGroupId }}"
    description: The identifier of an existing replication group. The snapshot is created from this replication group.
    description: The identifier of an existing replication group. The snapshot is created from this replication group.
  - name: CacheClusterId
    value: "{{ CacheClusterId }}"
    description: The identifier of an existing cluster. The snapshot is created from this cluster.
    description: The identifier of an existing cluster. The snapshot is created from this cluster.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: The ID of the KMS key used to encrypt the snapshot.
    description: The ID of the KMS key used to encrypt the snapshot.
  - name: Tags
    value: "{{ Tags }}"
    description: 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.
    description: 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.

DELETE examples

delete_snapshot

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Valkey or Redis OSS only.

DELETE FROM aws.elasticache.snapshots
WHERE SnapshotName = '{{ SnapshotName }}' --required
AND region = '{{ region }}' --required
;