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

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.DbSnapshot

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 instance.

    Create DbSnapshot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DbSnapshot(name: string, args: DbSnapshotArgs, opts?: CustomResourceOptions);
    @overload
def DbSnapshot(resource_name: str,
               args: DbSnapshotArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def DbSnapshot(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               db_instance_identifier: Optional[str] = None,
               db_snapshot_identifier: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDbSnapshot(ctx *Context, name string, args DbSnapshotArgs, opts ...ResourceOption) (*DbSnapshot, error)
    public DbSnapshot(string name, DbSnapshotArgs args, CustomResourceOptions? opts = null)
    public DbSnapshot(String name, DbSnapshotArgs args)
public DbSnapshot(String name, DbSnapshotArgs args, CustomResourceOptions options)

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


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

    Parameters

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

    DbSnapshot 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 DbSnapshot resource accepts the following input properties:

    DbInstanceIdentifier string
    The identifier of the DB instance that you want to create the snapshot of.
    DbSnapshotIdentifier string
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.
    DbInstanceIdentifier string
    The identifier of the DB instance that you want to create the snapshot of.
    DbSnapshotIdentifier string
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.
    db_instance_identifier string
    The identifier of the DB instance that you want to create the snapshot of.
    db_snapshot_identifier string
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.
    dbInstanceIdentifier String
    The identifier of the DB instance that you want to create the snapshot of.
    dbSnapshotIdentifier String
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.
    dbInstanceIdentifier string
    The identifier of the DB instance that you want to create the snapshot of.
    dbSnapshotIdentifier string
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.
    db_instance_identifier str
    The identifier of the DB instance that you want to create the snapshot of.
    db_snapshot_identifier str
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.
    dbInstanceIdentifier String
    The identifier of the DB instance that you want to create the snapshot of.
    dbSnapshotIdentifier String
    The identifier for the DB snapshot. Must contain from 1 to 255 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 snapshot.

    Outputs

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

    AllocatedStorage int
    The allocated storage size in gibibytes (GiB).
    AvailabilityZone string
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    DbSnapshotArn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    DbiResourceId string
    The identifier for the source DB instance, which is unique to an AWS Region.
    Encrypted bool
    Indicates whether the DB snapshot is encrypted.
    Engine string
    The name of the database engine.
    EngineVersion string
    The version of the database engine.
    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.
    InstanceCreateTime string
    The time when the DB instance was created, in UTC.
    Iops int
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    KmsKeyId string
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    LicenseModel string
    License model information for the restored DB instance.
    MasterUsername string
    The master username for the DB snapshot.
    OptionGroupName string
    The option group name for the DB snapshot.
    OriginalSnapshotCreateTime string
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    Port int
    The port that the database engine was listening on at the time of the snapshot.
    SnapshotCreateTime string
    The time when the snapshot was taken, in UTC.
    SnapshotType string
    The type of the DB snapshot.
    Status string
    The status of this DB snapshot.
    StorageThroughput int
    The storage throughput for the DB snapshot.
    StorageType string
    The storage type associated with the DB snapshot.
    VpcId string
    The VPC ID associated with the DB snapshot.
    AllocatedStorage int
    The allocated storage size in gibibytes (GiB).
    AvailabilityZone string
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    DbSnapshotArn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    DbiResourceId string
    The identifier for the source DB instance, which is unique to an AWS Region.
    Encrypted bool
    Indicates whether the DB snapshot is encrypted.
    Engine string
    The name of the database engine.
    EngineVersion string
    The version of the database engine.
    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.
    InstanceCreateTime string
    The time when the DB instance was created, in UTC.
    Iops int
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    KmsKeyId string
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    LicenseModel string
    License model information for the restored DB instance.
    MasterUsername string
    The master username for the DB snapshot.
    OptionGroupName string
    The option group name for the DB snapshot.
    OriginalSnapshotCreateTime string
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    Port int
    The port that the database engine was listening on at the time of the snapshot.
    SnapshotCreateTime string
    The time when the snapshot was taken, in UTC.
    SnapshotType string
    The type of the DB snapshot.
    Status string
    The status of this DB snapshot.
    StorageThroughput int
    The storage throughput for the DB snapshot.
    StorageType string
    The storage type associated with the DB snapshot.
    VpcId string
    The VPC ID associated with the DB snapshot.
    allocated_storage number
    The allocated storage size in gibibytes (GiB).
    availability_zone string
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    db_snapshot_arn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    dbi_resource_id string
    The identifier for the source DB instance, which is unique to an AWS Region.
    encrypted bool
    Indicates whether the DB snapshot is encrypted.
    engine string
    The name of the database engine.
    engine_version string
    The version of the database engine.
    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.
    instance_create_time string
    The time when the DB instance was created, in UTC.
    iops number
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    kms_key_id string
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    license_model string
    License model information for the restored DB instance.
    master_username string
    The master username for the DB snapshot.
    option_group_name string
    The option group name for the DB snapshot.
    original_snapshot_create_time string
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    port number
    The port that the database engine was listening on at the time of the snapshot.
    snapshot_create_time string
    The time when the snapshot was taken, in UTC.
    snapshot_type string
    The type of the DB snapshot.
    status string
    The status of this DB snapshot.
    storage_throughput number
    The storage throughput for the DB snapshot.
    storage_type string
    The storage type associated with the DB snapshot.
    vpc_id string
    The VPC ID associated with the DB snapshot.
    allocatedStorage Integer
    The allocated storage size in gibibytes (GiB).
    availabilityZone String
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbSnapshotArn String
    The Amazon Resource Name (ARN) for the DB snapshot.
    dbiResourceId String
    The identifier for the source DB instance, which is unique to an AWS Region.
    encrypted Boolean
    Indicates whether the DB snapshot is encrypted.
    engine String
    The name of the database engine.
    engineVersion String
    The version of the database engine.
    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.
    instanceCreateTime String
    The time when the DB instance was created, in UTC.
    iops Integer
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    kmsKeyId String
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    licenseModel String
    License model information for the restored DB instance.
    masterUsername String
    The master username for the DB snapshot.
    optionGroupName String
    The option group name for the DB snapshot.
    originalSnapshotCreateTime String
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    port Integer
    The port that the database engine was listening on at the time of the snapshot.
    snapshotCreateTime String
    The time when the snapshot was taken, in UTC.
    snapshotType String
    The type of the DB snapshot.
    status String
    The status of this DB snapshot.
    storageThroughput Integer
    The storage throughput for the DB snapshot.
    storageType String
    The storage type associated with the DB snapshot.
    vpcId String
    The VPC ID associated with the DB snapshot.
    allocatedStorage number
    The allocated storage size in gibibytes (GiB).
    availabilityZone string
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbSnapshotArn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    dbiResourceId string
    The identifier for the source DB instance, which is unique to an AWS Region.
    encrypted boolean
    Indicates whether the DB snapshot is encrypted.
    engine string
    The name of the database engine.
    engineVersion string
    The version of the database engine.
    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.
    instanceCreateTime string
    The time when the DB instance was created, in UTC.
    iops number
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    kmsKeyId string
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    licenseModel string
    License model information for the restored DB instance.
    masterUsername string
    The master username for the DB snapshot.
    optionGroupName string
    The option group name for the DB snapshot.
    originalSnapshotCreateTime string
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    port number
    The port that the database engine was listening on at the time of the snapshot.
    snapshotCreateTime string
    The time when the snapshot was taken, in UTC.
    snapshotType string
    The type of the DB snapshot.
    status string
    The status of this DB snapshot.
    storageThroughput number
    The storage throughput for the DB snapshot.
    storageType string
    The storage type associated with the DB snapshot.
    vpcId string
    The VPC ID associated with the DB snapshot.
    allocated_storage int
    The allocated storage size in gibibytes (GiB).
    availability_zone str
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    db_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB snapshot.
    dbi_resource_id str
    The identifier for the source DB instance, which is unique to an AWS Region.
    encrypted bool
    Indicates whether the DB snapshot is encrypted.
    engine str
    The name of the database engine.
    engine_version str
    The version of the database engine.
    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.
    instance_create_time str
    The time when the DB instance was created, in UTC.
    iops int
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    kms_key_id str
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    license_model str
    License model information for the restored DB instance.
    master_username str
    The master username for the DB snapshot.
    option_group_name str
    The option group name for the DB snapshot.
    original_snapshot_create_time str
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    port int
    The port that the database engine was listening on at the time of the snapshot.
    snapshot_create_time str
    The time when the snapshot was taken, in UTC.
    snapshot_type str
    The type of the DB snapshot.
    status str
    The status of this DB snapshot.
    storage_throughput int
    The storage throughput for the DB snapshot.
    storage_type str
    The storage type associated with the DB snapshot.
    vpc_id str
    The VPC ID associated with the DB snapshot.
    allocatedStorage Number
    The allocated storage size in gibibytes (GiB).
    availabilityZone String
    The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbSnapshotArn String
    The Amazon Resource Name (ARN) for the DB snapshot.
    dbiResourceId String
    The identifier for the source DB instance, which is unique to an AWS Region.
    encrypted Boolean
    Indicates whether the DB snapshot is encrypted.
    engine String
    The name of the database engine.
    engineVersion String
    The version of the database engine.
    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.
    instanceCreateTime String
    The time when the DB instance was created, in UTC.
    iops Number
    The Provisioned IOPS value of the DB instance at the time of the snapshot.
    kmsKeyId String
    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
    licenseModel String
    License model information for the restored DB instance.
    masterUsername String
    The master username for the DB snapshot.
    optionGroupName String
    The option group name for the DB snapshot.
    originalSnapshotCreateTime String
    The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
    port Number
    The port that the database engine was listening on at the time of the snapshot.
    snapshotCreateTime String
    The time when the snapshot was taken, in UTC.
    snapshotType String
    The type of the DB snapshot.
    status String
    The status of this DB snapshot.
    storageThroughput Number
    The storage throughput for the DB snapshot.
    storageType String
    The storage type associated with the DB snapshot.
    vpcId String
    The VPC ID associated with the DB 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