AWS::MemoryDB::Snapshot

MemoryDB Snapshot

Resource Type definition for AWS::MemoryDB::Snapshot. Represents a copy of an entire cluster as of the time when the snapshot was taken.

Properties

4 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`ClusterName`	`string`	RequiredCreate-only
`SnapshotName`	`string`	RequiredCreate-only
`KmsKeyId`	`string`	Create-only
`Tags`	`Array<Tag>`

Return Values

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.
`ClusterConfiguration`	`ClusterConfiguration`	The configuration of the cluster from which the snapshot was taken.
`DataTiering`	`string`	Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
`Source`	`string`	Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
`Status`	`string`	The status of the snapshot. Valid values: creating \| available \| restoring \| copying \| deleting.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::MemoryDB::Snapshot

Resources:
  MyResource:
    Type: AWS::MemoryDB::Snapshot
    Properties:
      SnapshotName: "my-snapshotname"
      ClusterName: "my-clustername"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

memorydb:CreateSnapshotmemorydb:DescribeSnapshotsmemorydb:TagResourcememorydb:ListTagskms:CreateGrantkms:DescribeKey

read

memorydb:DescribeSnapshotsmemorydb:ListTags

update

memorydb:DescribeSnapshotsmemorydb:TagResourcememorydb:UntagResourcememorydb:ListTags

delete

memorydb:DeleteSnapshotmemorydb:DescribeSnapshots

list

memorydb:DescribeSnapshots

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceMemoryDB

Properties9

Required2

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SnapshotNameClusterNameKmsKeyId

Related Resources

External Links

AWS Documentation