Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. redshift
  6. getSnapshot

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
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.redshift.getSnapshot

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
Schema (JSON)
pulumi/pulumi-aws-native

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

    Using getSnapshot

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOutputOptions): Output<GetSnapshotResult>
    def get_snapshot(snapshot_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(snapshot_arn: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

    > Note: This function is named LookupSnapshot in the Go SDK.

    public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:redshift:getSnapshot
  arguments:
    # arguments dictionary
    data "aws-native_redshift_get_snapshot" "name" {
    # arguments
}

    The following arguments are supported:

    SnapshotArn string
    The Amazon Resource Name (ARN) of the snapshot.
    SnapshotArn string
    The Amazon Resource Name (ARN) of the snapshot.
    snapshot_arn string
    The Amazon Resource Name (ARN) of the snapshot.
    snapshotArn String
    The Amazon Resource Name (ARN) of the snapshot.
    snapshotArn string
    The Amazon Resource Name (ARN) of the snapshot.
    snapshot_arn str
    The Amazon Resource Name (ARN) of the snapshot.
    snapshotArn String
    The Amazon Resource Name (ARN) of the snapshot.

    getSnapshot Result

    The following output properties are available:

    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.
    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.
    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.
    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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tag instances.
    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.
    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.
    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.
    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.
    Tags Tag
    A list of tag instances.
    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.
    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.
    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.
    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.
    tags list(object)
    A list of tag instances.
    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.
    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.
    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.
    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.
    tags List<Tag>
    A list of tag instances.
    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.
    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.
    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.
    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.
    tags Tag[]
    A list of tag instances.
    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.
    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.
    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.
    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.
    tags Sequence[root_Tag]
    A list of tag instances.
    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.
    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.
    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.
    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.
    tags List<Property Map>
    A list of tag instances.
    vpcId String
    The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.

    Supporting Types

    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 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
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial