1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. redshift
  6. Snapshot

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
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:

    ClusterIdentifier string
    The cluster identifier for which you want a snapshot.
    SnapshotIdentifier 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. The value must be either -1 or an integer between 1 and 3653.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tag instances.
    ClusterIdentifier string
    The cluster identifier for which you want a snapshot.
    SnapshotIdentifier 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. The value must be either -1 or an integer between 1 and 3653.
    Tags TagArgs
    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_retention_period number
    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.
    tags list(object)
    A list of tag instances.
    clusterIdentifier String
    The cluster identifier for which you want a snapshot.
    snapshotIdentifier 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. The value must be either -1 or an integer between 1 and 3653.
    tags List<Tag>
    A list of tag instances.
    clusterIdentifier string
    The cluster identifier for which you want a snapshot.
    snapshotIdentifier 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. The value must be either -1 or an integer between 1 and 3653.
    tags 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_retention_period int
    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.
    tags Sequence[TagArgs]
    A list of tag instances.
    clusterIdentifier String
    The cluster identifier for which you want a snapshot.
    snapshotIdentifier 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. The value must be either -1 or an integer between 1 and 3653.
    tags 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:

    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 bool
    If true, the data in the snapshot is encrypted at rest.
    EncryptedWithHsm bool
    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 bool
    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.
    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 int
    The number of nodes in the cluster.
    OwnerAccount string
    The Amazon Web Services account that owns the snapshot.
    Port int
    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.
    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 bool
    If true, the data in the snapshot is encrypted at rest.
    EncryptedWithHsm bool
    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 bool
    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.
    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 int
    The number of nodes in the cluster.
    OwnerAccount string
    The Amazon Web Services account that owns the snapshot.
    Port int
    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.
    availability_zone string
    The Availability Zone in which the cluster was created.
    cluster_create_time string
    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_hsm bool
    A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
    engine_full_version string
    The engine full version of the cluster at the time the snapshot was taken.
    enhanced_vpc_routing bool
    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_id 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.
    maintenance_track_name string
    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_nodes number
    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_time string
    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.
    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.
    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.
    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.
    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.
    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.
    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 number
    The number of nodes in the cluster.
    ownerAccount string
    The Amazon Web Services account that owns the snapshot.
    port number
    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.
    availability_zone str
    The Availability Zone in which the cluster was created.
    cluster_create_time str
    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_hsm bool
    A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster.
    engine_full_version str
    The engine full version of the cluster at the time the snapshot was taken.
    enhanced_vpc_routing bool
    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_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.
    maintenance_track_name str
    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_nodes int
    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_time str
    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.
    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.
    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.
    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 Number
    The number of nodes in the cluster.
    ownerAccount String
    The Amazon Web Services account that owns the snapshot.
    port Number
    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.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial