AWS::RedshiftServerless::Snapshot Snapshot - AWS CloudFormation
SyntaxProperties

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

AWS::RedshiftServerless::Snapshot Snapshot

A snapshot object that contains databases.

Syntax

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

JSON

{
  "AdminUsername" : String,
  "KmsKeyId" : String,
  "NamespaceArn" : String,
  "NamespaceName" : String,
  "OwnerAccount" : String,
  "RetentionPeriod" : Integer,
  "SnapshotArn" : String,
  "SnapshotCreateTime" : String,
  "SnapshotName" : String,
  "Status" : String
}

YAML

  AdminUsername: String
  KmsKeyId: String
  NamespaceArn: String
  NamespaceName: String
  OwnerAccount: String
  RetentionPeriod: Integer
  SnapshotArn: String
  SnapshotCreateTime: String
  SnapshotName: String
  Status: String

Properties

AdminUsername

The username of the database within a snapshot.

Required: No

Type: String

Update requires: No interruption

KmsKeyId

The unique identifier of the KMS key used to encrypt the snapshot.

Required: No

Type: String

Update requires: No interruption

NamespaceArn

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

Required: No

Type: String

Update requires: No interruption

NamespaceName

The name of the namepsace.

Required: No

Type: String

Pattern: ^[a-z0-9-]+$

Minimum: 3

Maximum: 64

Update requires: No interruption

OwnerAccount

The owner AWS; account of the snapshot.

Required: No

Type: String

Update requires: No interruption

RetentionPeriod

Property description not available.

Required: No

Type: Integer

Update requires: No interruption

SnapshotArn

The Amazon Resource Name (ARN) of the snapshot.

Required: No

Type: String

Update requires: No interruption

SnapshotCreateTime

The timestamp of when the snapshot was created.

Required: No

Type: String

Update requires: No interruption

SnapshotName

The name of the snapshot.

Required: No

Type: String

Pattern: ^[a-z0-9-]+$

Minimum: 3

Maximum: 64

Update requires: No interruption

Status

The status of the snapshot.

Required: No

Type: String

Allowed values: AVAILABLE | CREATING | DELETED | CANCELLED | FAILED | COPYING

Update requires: No interruption