View a markdown version of this page

AWS::Redshift::Snapshot - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::Redshift::Snapshot

Describes a snapshot.

Syntax

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

JSON

{
  "Type" : "AWS::Redshift::Snapshot",
  "Properties" : {
      "ClusterIdentifier" : String,
      "ManualSnapshotRetentionPeriod" : Integer,
      "SnapshotIdentifier" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Redshift::Snapshot
Properties:
  ClusterIdentifier: String
  ManualSnapshotRetentionPeriod: Integer
  SnapshotIdentifier: String
  Tags: 
    - Tag

Properties

ClusterIdentifier

The identifier of the cluster for which the snapshot was taken.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Update requires: Replacement

ManualSnapshotRetentionPeriod

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

Required: No

Type: Integer

Minimum: -1

Maximum: 3653

Update requires: No interruption

SnapshotIdentifier

The snapshot identifier that is provided in the request.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

The list of tags for the cluster snapshot.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AvailabilityZone

The Availability Zone in which the cluster was created.

ClusterCreateTime

The time (UTC) when the cluster was originally created.

ClusterVersion

The version ID of the Amazon Redshift engine that is running on the cluster.

DBName

The name of the database that was created when the cluster was created.

Encrypted

If true, the data in the snapshot is encrypted at rest.

EncryptedWithHSM

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

EngineFullVersion

The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

EnhancedVpcRouting

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

KmsKeyId

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

MaintenanceTrackName

The name of the maintenance track for the snapshot.

MasterUsername

The admin user name for the cluster.

NodeType

The node type of the nodes in the cluster.

NumberOfNodes

The number of nodes in the cluster.

OwnerAccount

For manual snapshots, the AWS account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Port

The port that the cluster is listening on.

SnapshotArn

The Amazon Resource Name (ARN) of the snapshot.

SnapshotCreateTime

The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

SnapshotType

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

Status

The snapshot status. The value of the status depends on the API operation used:

  • CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".

  • DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".

  • DeleteClusterSnapshot returns status as "deleted".

VpcId

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.