We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
Resource Type definition for AWS::Redshift::Snapshot. Creates a manual snapshot of the specified cluster. The cluster must be in the available state.
Create Snapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);@overload
def Snapshot(resource_name: str,
args: SnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Snapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_identifier: Optional[str] = None,
snapshot_identifier: Optional[str] = None,
manual_snapshot_retention_period: Optional[int] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)
type: aws-native:redshift:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_redshift_snapshot" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SnapshotArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Snapshot Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Snapshot resource accepts the following input properties:
- Cluster
Identifier string - The cluster identifier for which you want a snapshot.
- Snapshot
Identifier string - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- Manual
Snapshot intRetention Period - 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 3653.
-
List<Pulumi.
Aws Native. Inputs. Tag> - A list of tag instances.
- Cluster
Identifier string - The cluster identifier for which you want a snapshot.
- Snapshot
Identifier string - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- Manual
Snapshot intRetention Period - 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 3653.
-
Tag
Args - A list of tag instances.
- cluster_
identifier string - The cluster identifier for which you want a snapshot.
- snapshot_
identifier string - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- manual_
snapshot_ numberretention_ period - 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 3653.
- list(object)
- A list of tag instances.
- cluster
Identifier String - The cluster identifier for which you want a snapshot.
- snapshot
Identifier String - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- manual
Snapshot IntegerRetention Period - 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 3653.
- List<Tag>
- A list of tag instances.
- cluster
Identifier string - The cluster identifier for which you want a snapshot.
- snapshot
Identifier string - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- manual
Snapshot numberRetention Period - 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 3653.
- Tag[]
- A list of tag instances.
- cluster_
identifier str - The cluster identifier for which you want a snapshot.
- snapshot_
identifier str - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- manual_
snapshot_ intretention_ period - 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 3653.
-
Sequence[Tag
Args] - A list of tag instances.
- cluster
Identifier String - The cluster identifier for which you want a snapshot.
- snapshot
Identifier String - A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
- manual
Snapshot NumberRetention Period - 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 3653.
- List<Property Map>
- A list of tag instances.
Outputs
All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:
- Availability
Zone string - The Availability Zone in which the cluster was created.
- Cluster
Create stringTime - The time (UTC) when the cluster was originally created.
- Cluster
Version string - The version ID of the Amazon Redshift engine that is running on the cluster.
- Db
Name string - The name of the database that was created when the cluster was created.
- Encrypted bool
- If true, the data in the snapshot is encrypted at rest.
- Encrypted
With boolHsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- Engine
Full stringVersion - The engine full version of the cluster at the time the snapshot was taken.
- Enhanced
Vpc boolRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Key stringId - 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.
- Maintenance
Track stringName - The name of the maintenance track for the snapshot.
- Master
Username string - The admin user name for the cluster.
- Node
Type string - The node type that the cluster is provisioned with.
- Number
Of intNodes - The number of nodes in the cluster.
- Owner
Account string - The Amazon Web Services account that owns the snapshot.
- Port int
- The port that the cluster is listening on.
- Snapshot
Arn string - The Amazon Resource Name (ARN) of the snapshot.
- Snapshot
Create stringTime - The time (in UTC format) when Amazon Redshift began the snapshot.
- Snapshot
Type 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.
- Vpc
Id string - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
- Availability
Zone string - The Availability Zone in which the cluster was created.
- Cluster
Create stringTime - The time (UTC) when the cluster was originally created.
- Cluster
Version string - The version ID of the Amazon Redshift engine that is running on the cluster.
- Db
Name string - The name of the database that was created when the cluster was created.
- Encrypted bool
- If true, the data in the snapshot is encrypted at rest.
- Encrypted
With boolHsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- Engine
Full stringVersion - The engine full version of the cluster at the time the snapshot was taken.
- Enhanced
Vpc boolRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Key stringId - 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.
- Maintenance
Track stringName - The name of the maintenance track for the snapshot.
- Master
Username string - The admin user name for the cluster.
- Node
Type string - The node type that the cluster is provisioned with.
- Number
Of intNodes - The number of nodes in the cluster.
- Owner
Account string - The Amazon Web Services account that owns the snapshot.
- Port int
- The port that the cluster is listening on.
- Snapshot
Arn string - The Amazon Resource Name (ARN) of the snapshot.
- Snapshot
Create stringTime - The time (in UTC format) when Amazon Redshift began the snapshot.
- Snapshot
Type 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.
- Vpc
Id string - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
- availability_
zone string - The Availability Zone in which the cluster was created.
- cluster_
create_ stringtime - The time (UTC) when the cluster was originally created.
- cluster_
version string - The version ID of the Amazon Redshift engine that is running on the cluster.
- db_
name string - The name of the database that was created when the cluster was created.
- encrypted bool
- If true, the data in the snapshot is encrypted at rest.
- encrypted_
with_ boolhsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- engine_
full_ stringversion - The engine full version of the cluster at the time the snapshot was taken.
- enhanced_
vpc_ boolrouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- id string
- The provider-assigned unique ID for this managed resource.
- kms_
key_ stringid - 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.
- maintenance_
track_ stringname - The name of the maintenance track for the snapshot.
- master_
username string - The admin user name for the cluster.
- node_
type string - The node type that the cluster is provisioned with.
- number_
of_ numbernodes - The number of nodes in the cluster.
- owner_
account string - The Amazon Web Services account that owns the snapshot.
- port number
- The port that the cluster is listening on.
- snapshot_
arn string - The Amazon Resource Name (ARN) of the snapshot.
- snapshot_
create_ stringtime - The time (in UTC format) when Amazon Redshift began the snapshot.
- snapshot_
type 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.
- vpc_
id string - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
- availability
Zone String - The Availability Zone in which the cluster was created.
- cluster
Create StringTime - The time (UTC) when the cluster was originally created.
- cluster
Version String - The version ID of the Amazon Redshift engine that is running on the cluster.
- db
Name 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.
- encrypted
With BooleanHsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- engine
Full StringVersion - The engine full version of the cluster at the time the snapshot was taken.
- enhanced
Vpc BooleanRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringId - 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.
- maintenance
Track StringName - The name of the maintenance track for the snapshot.
- master
Username String - The admin user name for the cluster.
- node
Type String - The node type that the cluster is provisioned with.
- number
Of IntegerNodes - The number of nodes in the cluster.
- owner
Account String - The Amazon Web Services account that owns the snapshot.
- port Integer
- The port that the cluster is listening on.
- snapshot
Arn String - The Amazon Resource Name (ARN) of the snapshot.
- snapshot
Create StringTime - The time (in UTC format) when Amazon Redshift began the snapshot.
- snapshot
Type 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.
- vpc
Id String - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
- availability
Zone string - The Availability Zone in which the cluster was created.
- cluster
Create stringTime - The time (UTC) when the cluster was originally created.
- cluster
Version string - The version ID of the Amazon Redshift engine that is running on the cluster.
- db
Name 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.
- encrypted
With booleanHsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- engine
Full stringVersion - The engine full version of the cluster at the time the snapshot was taken.
- enhanced
Vpc booleanRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- id string
- The provider-assigned unique ID for this managed resource.
- kms
Key stringId - 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.
- maintenance
Track stringName - The name of the maintenance track for the snapshot.
- master
Username string - The admin user name for the cluster.
- node
Type string - The node type that the cluster is provisioned with.
- number
Of numberNodes - The number of nodes in the cluster.
- owner
Account string - The Amazon Web Services account that owns the snapshot.
- port number
- The port that the cluster is listening on.
- snapshot
Arn string - The Amazon Resource Name (ARN) of the snapshot.
- snapshot
Create stringTime - The time (in UTC format) when Amazon Redshift began the snapshot.
- snapshot
Type 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.
- vpc
Id string - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
- availability_
zone str - The Availability Zone in which the cluster was created.
- cluster_
create_ strtime - The time (UTC) when the cluster was originally created.
- cluster_
version str - The version ID of the Amazon Redshift engine that is running on the cluster.
- db_
name str - The name of the database that was created when the cluster was created.
- encrypted bool
- If true, the data in the snapshot is encrypted at rest.
- encrypted_
with_ boolhsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- engine_
full_ strversion - The engine full version of the cluster at the time the snapshot was taken.
- enhanced_
vpc_ boolrouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- id str
- The provider-assigned unique ID for this managed resource.
- kms_
key_ strid - 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.
- maintenance_
track_ strname - The name of the maintenance track for the snapshot.
- master_
username str - The admin user name for the cluster.
- node_
type str - The node type that the cluster is provisioned with.
- number_
of_ intnodes - The number of nodes in the cluster.
- owner_
account str - The Amazon Web Services account that owns the snapshot.
- port int
- The port that the cluster is listening on.
- snapshot_
arn str - The Amazon Resource Name (ARN) of the snapshot.
- snapshot_
create_ strtime - The time (in UTC format) when Amazon Redshift began the snapshot.
- snapshot_
type str - The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type manual.
- status str
- 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.
- vpc_
id str - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
- availability
Zone String - The Availability Zone in which the cluster was created.
- cluster
Create StringTime - The time (UTC) when the cluster was originally created.
- cluster
Version String - The version ID of the Amazon Redshift engine that is running on the cluster.
- db
Name 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.
- encrypted
With BooleanHsm - A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
- engine
Full StringVersion - The engine full version of the cluster at the time the snapshot was taken.
- enhanced
Vpc BooleanRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled.
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringId - 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.
- maintenance
Track StringName - The name of the maintenance track for the snapshot.
- master
Username String - The admin user name for the cluster.
- node
Type String - The node type that the cluster is provisioned with.
- number
Of NumberNodes - The number of nodes in the cluster.
- owner
Account String - The Amazon Web Services account that owns the snapshot.
- port Number
- The port that the cluster is listening on.
- snapshot
Arn String - The Amazon Resource Name (ARN) of the snapshot.
- snapshot
Create StringTime - The time (in UTC format) when Amazon Redshift began the snapshot.
- snapshot
Type 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.
- vpc
Id String - The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi