AWS::ElastiCache::SnapshotRepresents a copy of an entire cluster or replication group as of the time when the snapshot was taken.
5 configurable properties. 1 required. Click a row to see details.
| Property | Type | Flags |
|---|---|---|
SnapshotName | string | RequiredCreate-only |
CacheClusterId | string | Create-only |
KmsKeyId | string | Create-only |
ReplicationGroupId | string | Create-only |
Tags | Array<Tag> |
Values returned after the resource is created. Access these with Fn::GetAtt.
| Attribute | Type | Description |
|---|---|---|
Arn | string | The ARN (Amazon Resource Name) of the snapshot. |
AutomaticFailover | string | Indicates the status of automatic failover for the source replication group. |
AutoMinorVersionUpgrade | boolean | If true, opt-in to the next auto minor version upgrade campaign. |
CacheClusterCreateTime | string | The date and time when the source cluster was created. |
CacheNodeType | string | The name of the compute and memory capacity node type for the source cluster. |
CacheParameterGroupName | string | The cache parameter group that is associated with the source cluster. |
CacheSubnetGroupName | string | The name of the cache subnet group associated with the source cluster. |
DataTiering | string | Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. |
Engine | string | The name of the cache engine used by the source cluster. |
EngineVersion | string | The version of the cache engine version used by the source cluster. |
NodeSnapshots | Array<NodeSnapshot> | A list of the cache nodes in the source cluster. |
NumCacheNodes | integer | The number of cache nodes in the source cluster. |
NumNodeGroups | integer | The number of node groups (shards) in this snapshot. |
Port | integer | The port number used by each cache nodes in the source cluster. |
PreferredAvailabilityZone | string | The name of the Availability Zone in which the source cluster is located. |
PreferredMaintenanceWindow | string | Specifies the weekly time range during which maintenance on the cluster is performed. |
ReplicationGroupDescription | string | A description of the source replication group. |
SnapshotRetentionLimit | integer | For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. |
SnapshotSource | string | Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual). |
SnapshotStatus | string | The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted. |
SnapshotWindow | string | The daily time range during which ElastiCache takes daily snapshots of the source cluster. |
TopicArn | string | The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications. |
VpcId | string | The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster. |
A minimal template with required properties and common optional ones.
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ElastiCache::Snapshot
Resources:
MyResource:
Type: AWS::ElastiCache::Snapshot
Properties:
SnapshotName: "my-snapshotname"
Tags:
- Key: Environment
Value: ProductionPermissions CloudFormation needs in your IAM role to manage this resource.
elasticache:CreateSnapshotelasticache:DescribeSnapshotselasticache:AddTagsToResourceelasticache:ListTagsForResourcekms:CreateGrantkms:DescribeKeyelasticache:DescribeSnapshotselasticache:ListTagsForResourceelasticache:DescribeSnapshotselasticache:AddTagsToResourceelasticache:RemoveTagsFromResourceelasticache:ListTagsForResourceelasticache:DeleteSnapshotelasticache:DescribeSnapshotselasticache:DescribeSnapshotsOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterArnThese properties cannot be changed after the resource is created. Updating them triggers a replacement.
SnapshotNameCacheClusterIdReplicationGroupIdKmsKeyId