1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. redshiftserverless
  5. getSnapshot

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi

aws-native.redshiftserverless.getSnapshot

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi

    Resource Type definition for AWS::RedshiftServerless::Snapshot Resource Type.

    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?: InvokeOptions): Output<GetSnapshotResult>
    def get_snapshot(snapshot_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
    def get_snapshot_output(snapshot_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = 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 CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:redshiftserverless:getSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SnapshotName string
    The name of the snapshot.
    SnapshotName string
    The name of the snapshot.
    snapshotName String
    The name of the snapshot.
    snapshotName string
    The name of the snapshot.
    snapshot_name str
    The name of the snapshot.
    snapshotName String
    The name of the snapshot.

    getSnapshot Result

    The following output properties are available:

    OwnerAccount string
    The owner account of the snapshot.
    RetentionPeriod int
    The retention period of the snapshot.
    SnapshotValue Pulumi.AwsNative.RedshiftServerless.Outputs.Snapshot
    Definition for snapshot resource
    OwnerAccount string
    The owner account of the snapshot.
    RetentionPeriod int
    The retention period of the snapshot.
    Snapshot SnapshotType
    Definition for snapshot resource
    ownerAccount String
    The owner account of the snapshot.
    retentionPeriod Integer
    The retention period of the snapshot.
    snapshot Snapshot
    Definition for snapshot resource
    ownerAccount string
    The owner account of the snapshot.
    retentionPeriod number
    The retention period of the snapshot.
    snapshot Snapshot
    Definition for snapshot resource
    owner_account str
    The owner account of the snapshot.
    retention_period int
    The retention period of the snapshot.
    snapshot Snapshot
    Definition for snapshot resource
    ownerAccount String
    The owner account of the snapshot.
    retentionPeriod Number
    The retention period of the snapshot.
    snapshot Property Map
    Definition for snapshot resource

    Supporting Types

    Snapshot

    AdminUsername string
    The username of the database within a snapshot.
    KmsKeyId string
    The unique identifier of the KMS key used to encrypt the snapshot.
    NamespaceArn string
    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
    NamespaceName string
    The name of the namepsace.
    OwnerAccount string
    The owner AWS ; account of the snapshot.
    RetentionPeriod int
    SnapshotArn string
    The Amazon Resource Name (ARN) of the snapshot.
    SnapshotCreateTime string
    The timestamp of when the snapshot was created.
    SnapshotName string
    The name of the snapshot.
    Status Pulumi.AwsNative.RedshiftServerless.SnapshotStatus
    The status of the snapshot.
    AdminUsername string
    The username of the database within a snapshot.
    KmsKeyId string
    The unique identifier of the KMS key used to encrypt the snapshot.
    NamespaceArn string
    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
    NamespaceName string
    The name of the namepsace.
    OwnerAccount string
    The owner AWS ; account of the snapshot.
    RetentionPeriod int
    SnapshotArn string
    The Amazon Resource Name (ARN) of the snapshot.
    SnapshotCreateTime string
    The timestamp of when the snapshot was created.
    SnapshotName string
    The name of the snapshot.
    Status SnapshotStatus
    The status of the snapshot.
    adminUsername String
    The username of the database within a snapshot.
    kmsKeyId String
    The unique identifier of the KMS key used to encrypt the snapshot.
    namespaceArn String
    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
    namespaceName String
    The name of the namepsace.
    ownerAccount String
    The owner AWS ; account of the snapshot.
    retentionPeriod Integer
    snapshotArn String
    The Amazon Resource Name (ARN) of the snapshot.
    snapshotCreateTime String
    The timestamp of when the snapshot was created.
    snapshotName String
    The name of the snapshot.
    status SnapshotStatus
    The status of the snapshot.
    adminUsername string
    The username of the database within a snapshot.
    kmsKeyId string
    The unique identifier of the KMS key used to encrypt the snapshot.
    namespaceArn string
    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
    namespaceName string
    The name of the namepsace.
    ownerAccount string
    The owner AWS ; account of the snapshot.
    retentionPeriod number
    snapshotArn string
    The Amazon Resource Name (ARN) of the snapshot.
    snapshotCreateTime string
    The timestamp of when the snapshot was created.
    snapshotName string
    The name of the snapshot.
    status SnapshotStatus
    The status of the snapshot.
    admin_username str
    The username of the database within a snapshot.
    kms_key_id str
    The unique identifier of the KMS key used to encrypt the snapshot.
    namespace_arn str
    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
    namespace_name str
    The name of the namepsace.
    owner_account str
    The owner AWS ; account of the snapshot.
    retention_period int
    snapshot_arn str
    The Amazon Resource Name (ARN) of the snapshot.
    snapshot_create_time str
    The timestamp of when the snapshot was created.
    snapshot_name str
    The name of the snapshot.
    status SnapshotStatus
    The status of the snapshot.
    adminUsername String
    The username of the database within a snapshot.
    kmsKeyId String
    The unique identifier of the KMS key used to encrypt the snapshot.
    namespaceArn String
    The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
    namespaceName String
    The name of the namepsace.
    ownerAccount String
    The owner AWS ; account of the snapshot.
    retentionPeriod Number
    snapshotArn String
    The Amazon Resource Name (ARN) of the snapshot.
    snapshotCreateTime String
    The timestamp of when the snapshot was created.
    snapshotName String
    The name of the snapshot.
    status "AVAILABLE" | "CREATING" | "DELETED" | "CANCELLED" | "FAILED" | "COPYING"
    The status of the snapshot.

    SnapshotStatus

    Package Details

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

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

    AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi