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

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

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.rds.ClusterSnapshot

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates a snapshot of a DB cluster.

    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,
                    db_cluster_identifier: Optional[str] = None,
                    db_cluster_snapshot_identifier: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:rds:ClusterSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws-native_rds_cluster_snapshot" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ClusterSnapshotArgs
    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 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 string
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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:

    DbClusterIdentifier string
    The identifier of the DB cluster to create a snapshot for.
    DbClusterSnapshotIdentifier string
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to be assigned to the DB cluster snapshot.
    DbClusterIdentifier string
    The identifier of the DB cluster to create a snapshot for.
    DbClusterSnapshotIdentifier string
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    Tags TagArgs
    The tags to be assigned to the DB cluster snapshot.
    db_cluster_identifier string
    The identifier of the DB cluster to create a snapshot for.
    db_cluster_snapshot_identifier string
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    tags list(object)
    The tags to be assigned to the DB cluster snapshot.
    dbClusterIdentifier String
    The identifier of the DB cluster to create a snapshot for.
    dbClusterSnapshotIdentifier String
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    tags List<Tag>
    The tags to be assigned to the DB cluster snapshot.
    dbClusterIdentifier string
    The identifier of the DB cluster to create a snapshot for.
    dbClusterSnapshotIdentifier string
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    tags Tag[]
    The tags to be assigned to the DB cluster snapshot.
    db_cluster_identifier str
    The identifier of the DB cluster to create a snapshot for.
    db_cluster_snapshot_identifier str
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    tags Sequence[TagArgs]
    The tags to be assigned to the DB cluster snapshot.
    dbClusterIdentifier String
    The identifier of the DB cluster to create a snapshot for.
    dbClusterSnapshotIdentifier String
    The identifier for the DB cluster snapshot. Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
    tags List<Property Map>
    The tags to be assigned to the DB cluster snapshot.

    Outputs

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

    AllocatedStorage int
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    AvailabilityZones List<string>
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    ClusterCreateTime string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    DbClusterResourceId string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    Engine string
    The name of the database engine for this DB cluster snapshot.
    EngineMode string
    The engine mode of the database engine for this DB cluster snapshot.
    EngineVersion string
    The version of the database engine for this DB cluster snapshot.
    IamDatabaseAuthenticationEnabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    LicenseModel string
    The license model information for this DB cluster snapshot.
    MasterUsername string
    The master username for this DB cluster snapshot.
    Port int
    The port that the DB cluster was listening on at the time of the snapshot.
    SnapshotCreateTime string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    SnapshotType string
    The type of the DB cluster snapshot.
    Status string
    The status of this DB cluster snapshot.
    StorageEncrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    VpcId string
    The VPC ID associated with the DB cluster snapshot.
    AllocatedStorage int
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    AvailabilityZones []string
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    ClusterCreateTime string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    DbClusterResourceId string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    Engine string
    The name of the database engine for this DB cluster snapshot.
    EngineMode string
    The engine mode of the database engine for this DB cluster snapshot.
    EngineVersion string
    The version of the database engine for this DB cluster snapshot.
    IamDatabaseAuthenticationEnabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    LicenseModel string
    The license model information for this DB cluster snapshot.
    MasterUsername string
    The master username for this DB cluster snapshot.
    Port int
    The port that the DB cluster was listening on at the time of the snapshot.
    SnapshotCreateTime string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    SnapshotType string
    The type of the DB cluster snapshot.
    Status string
    The status of this DB cluster snapshot.
    StorageEncrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    VpcId string
    The VPC ID associated with the DB cluster snapshot.
    allocated_storage number
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availability_zones list(string)
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    cluster_create_time string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    db_cluster_resource_id string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    db_cluster_snapshot_arn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine string
    The name of the database engine for this DB cluster snapshot.
    engine_mode string
    The engine mode of the database engine for this DB cluster snapshot.
    engine_version string
    The version of the database engine for this DB cluster snapshot.
    iam_database_authentication_enabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    id string
    The provider-assigned unique ID for this managed resource.
    kms_key_id string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    license_model string
    The license model information for this DB cluster snapshot.
    master_username string
    The master username for this DB cluster snapshot.
    port number
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshot_create_time string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshot_type string
    The type of the DB cluster snapshot.
    status string
    The status of this DB cluster snapshot.
    storage_encrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    vpc_id string
    The VPC ID associated with the DB cluster snapshot.
    allocatedStorage Integer
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availabilityZones List<String>
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    clusterCreateTime String
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    dbClusterResourceId String
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine String
    The name of the database engine for this DB cluster snapshot.
    engineMode String
    The engine mode of the database engine for this DB cluster snapshot.
    engineVersion String
    The version of the database engine for this DB cluster snapshot.
    iamDatabaseAuthenticationEnabled Boolean
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    licenseModel String
    The license model information for this DB cluster snapshot.
    masterUsername String
    The master username for this DB cluster snapshot.
    port Integer
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshotCreateTime String
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshotType String
    The type of the DB cluster snapshot.
    status String
    The status of this DB cluster snapshot.
    storageEncrypted Boolean
    Indicates whether the DB cluster snapshot is encrypted.
    vpcId String
    The VPC ID associated with the DB cluster snapshot.
    allocatedStorage number
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availabilityZones string[]
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    clusterCreateTime string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    dbClusterResourceId string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    dbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine string
    The name of the database engine for this DB cluster snapshot.
    engineMode string
    The engine mode of the database engine for this DB cluster snapshot.
    engineVersion string
    The version of the database engine for this DB cluster snapshot.
    iamDatabaseAuthenticationEnabled boolean
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyId string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    licenseModel string
    The license model information for this DB cluster snapshot.
    masterUsername string
    The master username for this DB cluster snapshot.
    port number
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshotCreateTime string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshotType string
    The type of the DB cluster snapshot.
    status string
    The status of this DB cluster snapshot.
    storageEncrypted boolean
    Indicates whether the DB cluster snapshot is encrypted.
    vpcId string
    The VPC ID associated with the DB cluster snapshot.
    allocated_storage int
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availability_zones Sequence[str]
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    cluster_create_time str
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    db_cluster_resource_id str
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    db_cluster_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine str
    The name of the database engine for this DB cluster snapshot.
    engine_mode str
    The engine mode of the database engine for this DB cluster snapshot.
    engine_version str
    The version of the database engine for this DB cluster snapshot.
    iam_database_authentication_enabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    license_model str
    The license model information for this DB cluster snapshot.
    master_username str
    The master username for this DB cluster snapshot.
    port int
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshot_create_time str
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshot_type str
    The type of the DB cluster snapshot.
    status str
    The status of this DB cluster snapshot.
    storage_encrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    vpc_id str
    The VPC ID associated with the DB cluster snapshot.
    allocatedStorage Number
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availabilityZones List<String>
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    clusterCreateTime String
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    dbClusterResourceId String
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine String
    The name of the database engine for this DB cluster snapshot.
    engineMode String
    The engine mode of the database engine for this DB cluster snapshot.
    engineVersion String
    The version of the database engine for this DB cluster snapshot.
    iamDatabaseAuthenticationEnabled Boolean
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    licenseModel String
    The license model information for this DB cluster snapshot.
    masterUsername String
    The master username for this DB cluster snapshot.
    port Number
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshotCreateTime String
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshotType String
    The type of the DB cluster snapshot.
    status String
    The status of this DB cluster snapshot.
    storageEncrypted Boolean
    Indicates whether the DB cluster snapshot is encrypted.
    vpcId String
    The VPC ID associated with the DB cluster snapshot.

    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.79.0
    published on Monday, Sep 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial