Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. redshiftserverless
  5. Snapshot

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
pulumi/pulumi-aws-native

aws-native.redshiftserverless.Snapshot

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
pulumi/pulumi-aws-native

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

    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: Optional[SnapshotArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Snapshot(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             namespace_name: Optional[str] = None,
             retention_period: Optional[int] = None,
             snapshot_name: Optional[str] = None,
             tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewSnapshot(ctx *Context, name string, args *SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)
    public Snapshot(string name, SnapshotArgs? args = null, CustomResourceOptions? opts = null)
    public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)

    type: aws-native:redshiftserverless:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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:

    NamespaceName string
    The namespace the snapshot is associated with.
    RetentionPeriod int
    The retention period of the snapshot.
    SnapshotName string
    The name of the snapshot.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    An array of key-value pairs to apply to this resource.
    NamespaceName string
    The namespace the snapshot is associated with.
    RetentionPeriod int
    The retention period of the snapshot.
    SnapshotName string
    The name of the snapshot.
    Tags CreateOnlyTagArgs
    An array of key-value pairs to apply to this resource.
    namespaceName String
    The namespace the snapshot is associated with.
    retentionPeriod Integer
    The retention period of the snapshot.
    snapshotName String
    The name of the snapshot.
    tags List<CreateOnlyTag>
    An array of key-value pairs to apply to this resource.
    namespaceName string
    The namespace the snapshot is associated with.
    retentionPeriod number
    The retention period of the snapshot.
    snapshotName string
    The name of the snapshot.
    tags CreateOnlyTag[]
    An array of key-value pairs to apply to this resource.
    namespace_name str
    The namespace the snapshot is associated with.
    retention_period int
    The retention period of the snapshot.
    snapshot_name str
    The name of the snapshot.
    tags Sequence[CreateOnlyTagArgs]
    An array of key-value pairs to apply to this resource.
    namespaceName String
    The namespace the snapshot is associated with.
    retentionPeriod Number
    The retention period of the snapshot.
    snapshotName String
    The name of the snapshot.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccount string
    The owner account of the snapshot.
    SnapshotValue Pulumi.AwsNative.RedshiftServerless.Outputs.Snapshot
    Definition for snapshot resource
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccount string
    The owner account of the snapshot.
    Snapshot SnapshotType
    Definition for snapshot resource
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccount String
    The owner account of the snapshot.
    snapshot Snapshot
    Definition for snapshot resource
    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccount string
    The owner account of the snapshot.
    snapshot Snapshot
    Definition for snapshot resource
    id str
    The provider-assigned unique ID for this managed resource.
    owner_account str
    The owner account of the snapshot.
    snapshot Snapshot
    Definition for snapshot resource
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccount String
    The owner account of the snapshot.
    snapshot Property Map
    Definition for snapshot resource

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    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

    Snapshot, SnapshotArgs

    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, SnapshotStatusArgs

    Available
    AVAILABLE
    Creating
    CREATING
    Deleted
    DELETED
    Cancelled
    CANCELLED
    Failed
    FAILED
    Copying
    COPYING
    SnapshotStatusAvailable
    AVAILABLE
    SnapshotStatusCreating
    CREATING
    SnapshotStatusDeleted
    DELETED
    SnapshotStatusCancelled
    CANCELLED
    SnapshotStatusFailed
    FAILED
    SnapshotStatusCopying
    COPYING
    Available
    AVAILABLE
    Creating
    CREATING
    Deleted
    DELETED
    Cancelled
    CANCELLED
    Failed
    FAILED
    Copying
    COPYING
    Available
    AVAILABLE
    Creating
    CREATING
    Deleted
    DELETED
    Cancelled
    CANCELLED
    Failed
    FAILED
    Copying
    COPYING
    AVAILABLE
    AVAILABLE
    CREATING
    CREATING
    DELETED
    DELETED
    CANCELLED
    CANCELLED
    FAILED
    FAILED
    COPYING
    COPYING
    "AVAILABLE"
    AVAILABLE
    "CREATING"
    CREATING
    "DELETED"
    DELETED
    "CANCELLED"
    CANCELLED
    "FAILED"
    FAILED
    "COPYING"
    COPYING

    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
    pulumi/pulumi-aws-native