AWS::RedshiftServerless::Snapshot - AWS CloudFormation
SyntaxPropertiesReturn values

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

A snapshot object that contains databases.

Syntax

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

JSON

{
  "Type" : "AWS::RedshiftServerless::Snapshot",
  "Properties" : {
      "NamespaceName" : String,
      "RetentionPeriod" : Integer,
      "SnapshotName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::RedshiftServerless::Snapshot
Properties:
  NamespaceName: String
  RetentionPeriod: Integer
  SnapshotName: String
  Tags: 
    - Tag

Properties

NamespaceName

The name of the namepsace.

Required: No

Type: String

Pattern: ^(?=^[a-z0-9-]+$).{3,64}$

Minimum: 3

Maximum: 64

Update requires: Replacement

RetentionPeriod

The retention period of the snapshot created by the scheduled action.

Required: No

Type: Integer

Update requires: No interruption

SnapshotName

The name of the snapshot.

Required: Yes

Type: String

Pattern: ^(?=^[a-z0-9-]+$).{3,64}$

Minimum: 3

Maximum: 64

Update requires: Replacement

Tags

An array of Tag objects to associate with the snapshot.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: Replacement

Return values

Ref

Fn::GetAtt

OwnerAccount

The owner AWS; account of the snapshot.

Snapshot.AdminUsername

The username of the database within a snapshot.

Snapshot.KmsKeyId

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

Snapshot.NamespaceArn

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

Snapshot.NamespaceName

The name of the namepsace.

Snapshot.OwnerAccount

The owner AWS; account of the snapshot.

Snapshot.RetentionPeriod

The retention period of the snapshot created by the scheduled action.

Snapshot.SnapshotArn

The Amazon Resource Name (ARN) of the snapshot.

Snapshot.SnapshotCreateTime

The timestamp of when the snapshot was created.

Snapshot.SnapshotName

The name of the snapshot.

Snapshot.Status

The status of the snapshot.