AWS::Redshift::Snapshot

Redshift Snapshot

Resource Type definition for AWS::Redshift::Snapshot. Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

Properties

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

Filter:

Property	Type	Flags
`ClusterIdentifier`	`string`	RequiredCreate-only
`SnapshotIdentifier`	`string`	RequiredCreate-only
`ManualSnapshotRetentionPeriod`	`integer`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AvailabilityZone`	`string`	The Availability Zone in which the cluster was created.
`ClusterCreateTime`	`string`	The time (UTC) when the cluster was originally created.
`ClusterVersion`	`string`	The version ID of the Amazon Redshift engine that is running on the cluster.
`DBName`	`string`	The name of the database that was created when the cluster was created.
`Encrypted`	`boolean`	If true, the data in the snapshot is encrypted at rest.
`EncryptedWithHSM`	`boolean`	A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
`EngineFullVersion`	`string`	The engine full version of the cluster at the time the snapshot was taken.
`EnhancedVpcRouting`	`boolean`	An option that specifies whether to create the cluster with enhanced VPC routing enabled.
`KmsKeyId`	`string`	The 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`	`string`	The name of the maintenance track for the snapshot.
`MasterUsername`	`string`	The admin user name for the cluster.
`NodeType`	`string`	The node type that the cluster is provisioned with.
`NumberOfNodes`	`integer`	The number of nodes in the cluster.
`OwnerAccount`	`string`	The Amazon Web Services account that owns the snapshot.
`Port`	`integer`	The port that the cluster is listening on.
`SnapshotArn`	`string`	The Amazon Resource Name (ARN) of the snapshot.
`SnapshotCreateTime`	`string`	The time (in UTC format) when Amazon Redshift began the snapshot.
`SnapshotType`	`string`	The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type manual.
`Status`	`string`	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`	`string`	The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

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

Resources:
  MyResource:
    Type: AWS::Redshift::Snapshot
    Properties:
      SnapshotIdentifier: "my-snapshotidentifier"
      ClusterIdentifier: "my-clusteridentifier"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

redshift:CreateClusterSnapshotredshift:DescribeClusterSnapshotsredshift:CreateTagsredshift:DescribeClusters

read

redshift:DescribeClusterSnapshots

update

redshift:ModifyClusterSnapshotredshift:DescribeClusterSnapshotsredshift:CreateTagsredshift:DeleteTags

delete

redshift:DeleteClusterSnapshotredshift:DescribeClusterSnapshotsredshift:DescribeClusters

list

redshift:DescribeClusterSnapshots

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

ServiceRedshift

Properties24

Required2

TaggingSupported

Primary IDSnapshotArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

SnapshotIdentifierClusterIdentifier

Related Resources

External Links

AWS Documentation