Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. ClusterSnapshot
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.redshift.ClusterSnapshot

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Creates a Redshift cluster snapshot

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: aws:redshift:ClusterSnapshot
    properties:
      clusterSnapshotName: example
      clusterSnapshotContent:
        fn::toJSON:
          AllowDBUserOverride: '1'
          Client_ID: ExampleClientID
          App_ID: example
Copy

Create ClusterSnapshot Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: CustomResourceOptions);
@overload
def ClusterSnapshot(resource_name: str,
                    args: ClusterSnapshotArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ClusterSnapshot(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[Mapping[str, str]] = None)
func NewClusterSnapshot(ctx *Context, name string, args ClusterSnapshotArgs, opts ...ResourceOption) (*ClusterSnapshot, error)
public ClusterSnapshot(string name, ClusterSnapshotArgs args, CustomResourceOptions? opts = null)
public ClusterSnapshot(String name, ClusterSnapshotArgs args)
public ClusterSnapshot(String name, ClusterSnapshotArgs args, CustomResourceOptions options)

type: aws:redshift:ClusterSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClusterSnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClusterSnapshotArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterSnapshotArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterSnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClusterSnapshotArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot = new Aws.RedShift.ClusterSnapshot("exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot", new()
{
    ClusterIdentifier = "string",
    SnapshotIdentifier = "string",
    ManualSnapshotRetentionPeriod = 0,
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := redshift.NewClusterSnapshot(ctx, "exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot", &redshift.ClusterSnapshotArgs{
	ClusterIdentifier:             pulumi.String("string"),
	SnapshotIdentifier:            pulumi.String("string"),
	ManualSnapshotRetentionPeriod: pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot = new ClusterSnapshot("exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot", ClusterSnapshotArgs.builder()
    .clusterIdentifier("string")
    .snapshotIdentifier("string")
    .manualSnapshotRetentionPeriod(0)
    .tags(Map.of("string", "string"))
    .build());
Copy
examplecluster_snapshot_resource_resource_from_redshiftcluster_snapshot = aws.redshift.ClusterSnapshot("exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot",
    cluster_identifier="string",
    snapshot_identifier="string",
    manual_snapshot_retention_period=0,
    tags={
        "string": "string",
    })
Copy
const exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot = new aws.redshift.ClusterSnapshot("exampleclusterSnapshotResourceResourceFromRedshiftclusterSnapshot", {
    clusterIdentifier: "string",
    snapshotIdentifier: "string",
    manualSnapshotRetentionPeriod: 0,
    tags: {
        string: "string",
    },
});
Copy
type: aws:redshift:ClusterSnapshot
properties:
    clusterIdentifier: string
    manualSnapshotRetentionPeriod: 0
    snapshotIdentifier: string
    tags:
        string: string
Copy

ClusterSnapshot 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 ClusterSnapshot resource accepts the following input properties:

ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier for which you want a snapshot.
SnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
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.
ManualSnapshotRetentionPeriod int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier for which you want a snapshot.
SnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
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.
ManualSnapshotRetentionPeriod int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The cluster identifier for which you want a snapshot.
snapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
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.
manualSnapshotRetentionPeriod Integer
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
tags Map<String,String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The cluster identifier for which you want a snapshot.
snapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
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.
manualSnapshotRetentionPeriod number
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
cluster_identifier
This property is required.
Changes to this property will trigger replacement.
str
The cluster identifier for which you want a snapshot.
snapshot_identifier
This property is required.
Changes to this property will trigger replacement.
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_retention_period int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The cluster identifier for which you want a snapshot.
snapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
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.
manualSnapshotRetentionPeriod Number
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
tags Map<String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterSnapshot resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of the snapshot.
Id string
The provider-assigned unique ID for this managed resource.
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.
OwnerAccount string
For manual snapshots, the Amazon Web Services 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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the snapshot.
Id string
The provider-assigned unique ID for this managed resource.
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.
OwnerAccount string
For manual snapshots, the Amazon Web Services 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.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the snapshot.
id String
The provider-assigned unique ID for this managed resource.
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.
ownerAccount String
For manual snapshots, the Amazon Web Services 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.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the snapshot.
id string
The provider-assigned unique ID for this managed resource.
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.
ownerAccount string
For manual snapshots, the Amazon Web Services 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.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the snapshot.
id str
The provider-assigned unique ID for this managed resource.
kms_key_id str
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.
owner_account str
For manual snapshots, the Amazon Web Services 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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the snapshot.
id String
The provider-assigned unique ID for this managed resource.
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.
ownerAccount String
For manual snapshots, the Amazon Web Services 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.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing ClusterSnapshot Resource

Get an existing ClusterSnapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterSnapshotState, opts?: CustomResourceOptions): ClusterSnapshot
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        manual_snapshot_retention_period: Optional[int] = None,
        owner_account: Optional[str] = None,
        snapshot_identifier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ClusterSnapshot
func GetClusterSnapshot(ctx *Context, name string, id IDInput, state *ClusterSnapshotState, opts ...ResourceOption) (*ClusterSnapshot, error)
public static ClusterSnapshot Get(string name, Input<string> id, ClusterSnapshotState? state, CustomResourceOptions? opts = null)
public static ClusterSnapshot get(String name, Output<String> id, ClusterSnapshotState state, CustomResourceOptions options)
resources:  _:    type: aws:redshift:ClusterSnapshot    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Amazon Resource Name (ARN) of the snapshot.
ClusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier for which you want a snapshot.
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.
ManualSnapshotRetentionPeriod int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
OwnerAccount string
For manual snapshots, the Amazon Web Services 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.
SnapshotIdentifier Changes to this property will trigger replacement. 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.
Tags Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the snapshot.
ClusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier for which you want a snapshot.
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.
ManualSnapshotRetentionPeriod int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
OwnerAccount string
For manual snapshots, the Amazon Web Services 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.
SnapshotIdentifier Changes to this property will trigger replacement. 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.
Tags map[string]string
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the snapshot.
clusterIdentifier Changes to this property will trigger replacement. String
The cluster identifier for which you want a snapshot.
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.
manualSnapshotRetentionPeriod Integer
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
ownerAccount String
For manual snapshots, the Amazon Web Services 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.
snapshotIdentifier Changes to this property will trigger replacement. 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.
tags Map<String,String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the snapshot.
clusterIdentifier Changes to this property will trigger replacement. string
The cluster identifier for which you want a snapshot.
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.
manualSnapshotRetentionPeriod number
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
ownerAccount string
For manual snapshots, the Amazon Web Services 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.
snapshotIdentifier Changes to this property will trigger replacement. 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.
tags {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the snapshot.
cluster_identifier Changes to this property will trigger replacement. str
The cluster identifier for which you want a snapshot.
kms_key_id str
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.
manual_snapshot_retention_period int
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
owner_account str
For manual snapshots, the Amazon Web Services 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.
snapshot_identifier Changes to this property will trigger replacement. 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.
tags Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the snapshot.
clusterIdentifier Changes to this property will trigger replacement. String
The cluster identifier for which you want a snapshot.
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.
manualSnapshotRetentionPeriod Number
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. Valid values are -1 and between 1 and 3653.
ownerAccount String
For manual snapshots, the Amazon Web Services 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.
snapshotIdentifier Changes to this property will trigger replacement. 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.
tags Map<String>
A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import Redshift Cluster Snapshots using snapshot_identifier. For example:

$ pulumi import aws:redshift/clusterSnapshot:ClusterSnapshot test example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws