View a markdown version of this page

AWS::MemoryDB::Snapshot - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::MemoryDB::Snapshot

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MemoryDB::Snapshot",
  "Properties" : {
      "ClusterName" : String,
      "KmsKeyId" : String,
      "SnapshotName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::MemoryDB::Snapshot
Properties:
  ClusterName: String
  KmsKeyId: String
  SnapshotName: String
  Tags: 
    - Tag

Properties

ClusterName

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

Required: Yes

Type: String

Update requires: Replacement

KmsKeyId

The ID of the KMS key used to encrypt the snapshot.

Required: No

Type: String

Update requires: Replacement

SnapshotName

The name of the snapshot

Required: Yes

Type: String

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The ARN (Amazon Resource Name) of the snapshot.

DataTiering

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Source

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

Status

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