Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. Snapshot
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.Snapshot

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Manages an RDS database instance snapshot. For managing RDS database cluster snapshots, see the aws.rds.ClusterSnapshot resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = new aws.rds.Instance("bar", {
    allocatedStorage: 10,
    engine: "mysql",
    engineVersion: "5.6.21",
    instanceClass: aws.rds.InstanceType.T2_Micro,
    dbName: "baz",
    password: "barbarbarbar",
    username: "foo",
    maintenanceWindow: "Fri:09:00-Fri:09:30",
    backupRetentionPeriod: 0,
    parameterGroupName: "default.mysql5.6",
});
const test = new aws.rds.Snapshot("test", {
    dbInstanceIdentifier: bar.identifier,
    dbSnapshotIdentifier: "testsnapshot1234",
});
Copy
import pulumi
import pulumi_aws as aws

bar = aws.rds.Instance("bar",
    allocated_storage=10,
    engine="mysql",
    engine_version="5.6.21",
    instance_class=aws.rds.InstanceType.T2_MICRO,
    db_name="baz",
    password="barbarbarbar",
    username="foo",
    maintenance_window="Fri:09:00-Fri:09:30",
    backup_retention_period=0,
    parameter_group_name="default.mysql5.6")
test = aws.rds.Snapshot("test",
    db_instance_identifier=bar.identifier,
    db_snapshot_identifier="testsnapshot1234")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		bar, err := rds.NewInstance(ctx, "bar", &rds.InstanceArgs{
			AllocatedStorage:      pulumi.Int(10),
			Engine:                pulumi.String("mysql"),
			EngineVersion:         pulumi.String("5.6.21"),
			InstanceClass:         pulumi.String(rds.InstanceType_T2_Micro),
			DbName:                pulumi.String("baz"),
			Password:              pulumi.String("barbarbarbar"),
			Username:              pulumi.String("foo"),
			MaintenanceWindow:     pulumi.String("Fri:09:00-Fri:09:30"),
			BackupRetentionPeriod: pulumi.Int(0),
			ParameterGroupName:    pulumi.String("default.mysql5.6"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewSnapshot(ctx, "test", &rds.SnapshotArgs{
			DbInstanceIdentifier: bar.Identifier,
			DbSnapshotIdentifier: pulumi.String("testsnapshot1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var bar = new Aws.Rds.Instance("bar", new()
    {
        AllocatedStorage = 10,
        Engine = "mysql",
        EngineVersion = "5.6.21",
        InstanceClass = Aws.Rds.InstanceType.T2_Micro,
        DbName = "baz",
        Password = "barbarbarbar",
        Username = "foo",
        MaintenanceWindow = "Fri:09:00-Fri:09:30",
        BackupRetentionPeriod = 0,
        ParameterGroupName = "default.mysql5.6",
    });

    var test = new Aws.Rds.Snapshot("test", new()
    {
        DbInstanceIdentifier = bar.Identifier,
        DbSnapshotIdentifier = "testsnapshot1234",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.rds.Snapshot;
import com.pulumi.aws.rds.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bar = new Instance("bar", InstanceArgs.builder()
            .allocatedStorage(10)
            .engine("mysql")
            .engineVersion("5.6.21")
            .instanceClass("db.t2.micro")
            .dbName("baz")
            .password("barbarbarbar")
            .username("foo")
            .maintenanceWindow("Fri:09:00-Fri:09:30")
            .backupRetentionPeriod(0)
            .parameterGroupName("default.mysql5.6")
            .build());

        var test = new Snapshot("test", SnapshotArgs.builder()
            .dbInstanceIdentifier(bar.identifier())
            .dbSnapshotIdentifier("testsnapshot1234")
            .build());

    }
}
Copy
resources:
  bar:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 10
      engine: mysql
      engineVersion: 5.6.21
      instanceClass: db.t2.micro
      dbName: baz
      password: barbarbarbar
      username: foo
      maintenanceWindow: Fri:09:00-Fri:09:30
      backupRetentionPeriod: 0
      parameterGroupName: default.mysql5.6
  test:
    type: aws:rds:Snapshot
    properties:
      dbInstanceIdentifier: ${bar.identifier}
      dbSnapshotIdentifier: testsnapshot1234
Copy

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

@overload
def Snapshot(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             db_instance_identifier: Optional[str] = None,
             db_snapshot_identifier: Optional[str] = None,
             shared_accounts: Optional[Sequence[str]] = None,
             tags: Optional[Mapping[str, str]] = None)
func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)
public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplesnapshotResourceResourceFromRdssnapshot = new Aws.Rds.Snapshot("examplesnapshotResourceResourceFromRdssnapshot", new()
{
    DbInstanceIdentifier = "string",
    DbSnapshotIdentifier = "string",
    SharedAccounts = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rds.NewSnapshot(ctx, "examplesnapshotResourceResourceFromRdssnapshot", &rds.SnapshotArgs{
	DbInstanceIdentifier: pulumi.String("string"),
	DbSnapshotIdentifier: pulumi.String("string"),
	SharedAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var examplesnapshotResourceResourceFromRdssnapshot = new Snapshot("examplesnapshotResourceResourceFromRdssnapshot", SnapshotArgs.builder()
    .dbInstanceIdentifier("string")
    .dbSnapshotIdentifier("string")
    .sharedAccounts("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
examplesnapshot_resource_resource_from_rdssnapshot = aws.rds.Snapshot("examplesnapshotResourceResourceFromRdssnapshot",
    db_instance_identifier="string",
    db_snapshot_identifier="string",
    shared_accounts=["string"],
    tags={
        "string": "string",
    })
Copy
const examplesnapshotResourceResourceFromRdssnapshot = new aws.rds.Snapshot("examplesnapshotResourceResourceFromRdssnapshot", {
    dbInstanceIdentifier: "string",
    dbSnapshotIdentifier: "string",
    sharedAccounts: ["string"],
    tags: {
        string: "string",
    },
});
Copy
type: aws:rds:Snapshot
properties:
    dbInstanceIdentifier: string
    dbSnapshotIdentifier: string
    sharedAccounts:
        - string
    tags:
        string: string
Copy

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:

DbInstanceIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The DB Instance Identifier from which to take the snapshot.
DbSnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The Identifier for the snapshot.
SharedAccounts List<string>
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
Tags Dictionary<string, string>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
DbInstanceIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The DB Instance Identifier from which to take the snapshot.
DbSnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The Identifier for the snapshot.
SharedAccounts []string
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
Tags map[string]string
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
dbInstanceIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The DB Instance Identifier from which to take the snapshot.
dbSnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The Identifier for the snapshot.
sharedAccounts List<String>
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
tags Map<String,String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
dbInstanceIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The DB Instance Identifier from which to take the snapshot.
dbSnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
string
The Identifier for the snapshot.
sharedAccounts string[]
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
tags {[key: string]: string}
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
db_instance_identifier
This property is required.
Changes to this property will trigger replacement.
str
The DB Instance Identifier from which to take the snapshot.
db_snapshot_identifier
This property is required.
Changes to this property will trigger replacement.
str
The Identifier for the snapshot.
shared_accounts Sequence[str]
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
tags Mapping[str, str]
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
dbInstanceIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The DB Instance Identifier from which to take the snapshot.
dbSnapshotIdentifier
This property is required.
Changes to this property will trigger replacement.
String
The Identifier for the snapshot.
sharedAccounts List<String>
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
tags Map<String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

AllocatedStorage int
Specifies the allocated storage size in gigabytes (GB).
AvailabilityZone string
Specifies 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.
Encrypted bool
Specifies whether the DB snapshot is encrypted.
Engine string
Specifies the name of the database engine.
EngineVersion string
Specifies the version of the database engine.
Id string
The provider-assigned unique ID for this managed resource.
Iops int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
KmsKeyId string
The ARN for the KMS encryption key.
LicenseModel string
License model information for the restored DB instance.
OptionGroupName string
Provides the option group name for the DB snapshot.
Port int
SnapshotType string
SourceDbSnapshotIdentifier string
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
SourceRegion string
The region that the DB snapshot was created in or copied from.
Status string
Specifies the status of this DB snapshot.
StorageType string
Specifies the storage type associated with DB snapshot.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
Provides the VPC ID associated with the DB snapshot.
AllocatedStorage int
Specifies the allocated storage size in gigabytes (GB).
AvailabilityZone string
Specifies 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.
Encrypted bool
Specifies whether the DB snapshot is encrypted.
Engine string
Specifies the name of the database engine.
EngineVersion string
Specifies the version of the database engine.
Id string
The provider-assigned unique ID for this managed resource.
Iops int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
KmsKeyId string
The ARN for the KMS encryption key.
LicenseModel string
License model information for the restored DB instance.
OptionGroupName string
Provides the option group name for the DB snapshot.
Port int
SnapshotType string
SourceDbSnapshotIdentifier string
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
SourceRegion string
The region that the DB snapshot was created in or copied from.
Status string
Specifies the status of this DB snapshot.
StorageType string
Specifies the storage type associated with DB snapshot.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
Provides the VPC ID associated with the DB snapshot.
allocatedStorage Integer
Specifies the allocated storage size in gigabytes (GB).
availabilityZone String
Specifies 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.
encrypted Boolean
Specifies whether the DB snapshot is encrypted.
engine String
Specifies the name of the database engine.
engineVersion String
Specifies the version of the database engine.
id String
The provider-assigned unique ID for this managed resource.
iops Integer
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyId String
The ARN for the KMS encryption key.
licenseModel String
License model information for the restored DB instance.
optionGroupName String
Provides the option group name for the DB snapshot.
port Integer
snapshotType String
sourceDbSnapshotIdentifier String
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
sourceRegion String
The region that the DB snapshot was created in or copied from.
status String
Specifies the status of this DB snapshot.
storageType String
Specifies the storage type associated with DB snapshot.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
Provides the VPC ID associated with the DB snapshot.
allocatedStorage number
Specifies the allocated storage size in gigabytes (GB).
availabilityZone string
Specifies 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.
encrypted boolean
Specifies whether the DB snapshot is encrypted.
engine string
Specifies the name of the database engine.
engineVersion string
Specifies the version of the database engine.
id string
The provider-assigned unique ID for this managed resource.
iops number
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyId string
The ARN for the KMS encryption key.
licenseModel string
License model information for the restored DB instance.
optionGroupName string
Provides the option group name for the DB snapshot.
port number
snapshotType string
sourceDbSnapshotIdentifier string
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
sourceRegion string
The region that the DB snapshot was created in or copied from.
status string
Specifies the status of this DB snapshot.
storageType string
Specifies the storage type associated with DB snapshot.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId string
Provides the VPC ID associated with the DB snapshot.
allocated_storage int
Specifies the allocated storage size in gigabytes (GB).
availability_zone str
Specifies 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.
encrypted bool
Specifies whether the DB snapshot is encrypted.
engine str
Specifies the name of the database engine.
engine_version str
Specifies the version of the database engine.
id str
The provider-assigned unique ID for this managed resource.
iops int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kms_key_id str
The ARN for the KMS encryption key.
license_model str
License model information for the restored DB instance.
option_group_name str
Provides the option group name for the DB snapshot.
port int
snapshot_type str
source_db_snapshot_identifier str
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
source_region str
The region that the DB snapshot was created in or copied from.
status str
Specifies the status of this DB snapshot.
storage_type str
Specifies the storage type associated with DB snapshot.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpc_id str
Provides the VPC ID associated with the DB snapshot.
allocatedStorage Number
Specifies the allocated storage size in gigabytes (GB).
availabilityZone String
Specifies 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.
encrypted Boolean
Specifies whether the DB snapshot is encrypted.
engine String
Specifies the name of the database engine.
engineVersion String
Specifies the version of the database engine.
id String
The provider-assigned unique ID for this managed resource.
iops Number
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyId String
The ARN for the KMS encryption key.
licenseModel String
License model information for the restored DB instance.
optionGroupName String
Provides the option group name for the DB snapshot.
port Number
snapshotType String
sourceDbSnapshotIdentifier String
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
sourceRegion String
The region that the DB snapshot was created in or copied from.
status String
Specifies the status of this DB snapshot.
storageType String
Specifies the storage type associated with DB snapshot.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
Provides the VPC ID associated with the DB snapshot.

Look up Existing Snapshot Resource

Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SnapshotState, opts?: CustomResourceOptions): Snapshot
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        availability_zone: Optional[str] = None,
        db_instance_identifier: Optional[str] = None,
        db_snapshot_arn: Optional[str] = None,
        db_snapshot_identifier: Optional[str] = None,
        encrypted: Optional[bool] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        iops: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        license_model: Optional[str] = None,
        option_group_name: Optional[str] = None,
        port: Optional[int] = None,
        shared_accounts: Optional[Sequence[str]] = None,
        snapshot_type: Optional[str] = None,
        source_db_snapshot_identifier: Optional[str] = None,
        source_region: Optional[str] = None,
        status: Optional[str] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> Snapshot
func GetSnapshot(ctx *Context, name string, id IDInput, state *SnapshotState, opts ...ResourceOption) (*Snapshot, error)
public static Snapshot Get(string name, Input<string> id, SnapshotState? state, CustomResourceOptions? opts = null)
public static Snapshot get(String name, Output<String> id, SnapshotState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:Snapshot    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllocatedStorage int
Specifies the allocated storage size in gigabytes (GB).
AvailabilityZone string
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
DbInstanceIdentifier Changes to this property will trigger replacement. string
The DB Instance Identifier from which to take the snapshot.
DbSnapshotArn string
The Amazon Resource Name (ARN) for the DB snapshot.
DbSnapshotIdentifier Changes to this property will trigger replacement. string
The Identifier for the snapshot.
Encrypted bool
Specifies whether the DB snapshot is encrypted.
Engine string
Specifies the name of the database engine.
EngineVersion string
Specifies the version of the database engine.
Iops int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
KmsKeyId string
The ARN for the KMS encryption key.
LicenseModel string
License model information for the restored DB instance.
OptionGroupName string
Provides the option group name for the DB snapshot.
Port int
SharedAccounts List<string>
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
SnapshotType string
SourceDbSnapshotIdentifier string
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
SourceRegion string
The region that the DB snapshot was created in or copied from.
Status string
Specifies the status of this DB snapshot.
StorageType string
Specifies the storage type associated with DB snapshot.
Tags Dictionary<string, string>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
Provides the VPC ID associated with the DB snapshot.
AllocatedStorage int
Specifies the allocated storage size in gigabytes (GB).
AvailabilityZone string
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
DbInstanceIdentifier Changes to this property will trigger replacement. string
The DB Instance Identifier from which to take the snapshot.
DbSnapshotArn string
The Amazon Resource Name (ARN) for the DB snapshot.
DbSnapshotIdentifier Changes to this property will trigger replacement. string
The Identifier for the snapshot.
Encrypted bool
Specifies whether the DB snapshot is encrypted.
Engine string
Specifies the name of the database engine.
EngineVersion string
Specifies the version of the database engine.
Iops int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
KmsKeyId string
The ARN for the KMS encryption key.
LicenseModel string
License model information for the restored DB instance.
OptionGroupName string
Provides the option group name for the DB snapshot.
Port int
SharedAccounts []string
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
SnapshotType string
SourceDbSnapshotIdentifier string
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
SourceRegion string
The region that the DB snapshot was created in or copied from.
Status string
Specifies the status of this DB snapshot.
StorageType string
Specifies the storage type associated with DB snapshot.
Tags map[string]string
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

VpcId string
Provides the VPC ID associated with the DB snapshot.
allocatedStorage Integer
Specifies the allocated storage size in gigabytes (GB).
availabilityZone String
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
dbInstanceIdentifier Changes to this property will trigger replacement. String
The DB Instance Identifier from which to take the snapshot.
dbSnapshotArn String
The Amazon Resource Name (ARN) for the DB snapshot.
dbSnapshotIdentifier Changes to this property will trigger replacement. String
The Identifier for the snapshot.
encrypted Boolean
Specifies whether the DB snapshot is encrypted.
engine String
Specifies the name of the database engine.
engineVersion String
Specifies the version of the database engine.
iops Integer
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyId String
The ARN for the KMS encryption key.
licenseModel String
License model information for the restored DB instance.
optionGroupName String
Provides the option group name for the DB snapshot.
port Integer
sharedAccounts List<String>
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
snapshotType String
sourceDbSnapshotIdentifier String
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
sourceRegion String
The region that the DB snapshot was created in or copied from.
status String
Specifies the status of this DB snapshot.
storageType String
Specifies the storage type associated with DB snapshot.
tags Map<String,String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
Provides the VPC ID associated with the DB snapshot.
allocatedStorage number
Specifies the allocated storage size in gigabytes (GB).
availabilityZone string
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
dbInstanceIdentifier Changes to this property will trigger replacement. string
The DB Instance Identifier from which to take the snapshot.
dbSnapshotArn string
The Amazon Resource Name (ARN) for the DB snapshot.
dbSnapshotIdentifier Changes to this property will trigger replacement. string
The Identifier for the snapshot.
encrypted boolean
Specifies whether the DB snapshot is encrypted.
engine string
Specifies the name of the database engine.
engineVersion string
Specifies the version of the database engine.
iops number
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyId string
The ARN for the KMS encryption key.
licenseModel string
License model information for the restored DB instance.
optionGroupName string
Provides the option group name for the DB snapshot.
port number
sharedAccounts string[]
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
snapshotType string
sourceDbSnapshotIdentifier string
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
sourceRegion string
The region that the DB snapshot was created in or copied from.
status string
Specifies the status of this DB snapshot.
storageType string
Specifies the storage type associated with DB snapshot.
tags {[key: string]: string}
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId string
Provides the VPC ID associated with the DB snapshot.
allocated_storage int
Specifies the allocated storage size in gigabytes (GB).
availability_zone str
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
db_instance_identifier Changes to this property will trigger replacement. str
The DB Instance Identifier from which to take the snapshot.
db_snapshot_arn str
The Amazon Resource Name (ARN) for the DB snapshot.
db_snapshot_identifier Changes to this property will trigger replacement. str
The Identifier for the snapshot.
encrypted bool
Specifies whether the DB snapshot is encrypted.
engine str
Specifies the name of the database engine.
engine_version str
Specifies the version of the database engine.
iops int
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kms_key_id str
The ARN for the KMS encryption key.
license_model str
License model information for the restored DB instance.
option_group_name str
Provides the option group name for the DB snapshot.
port int
shared_accounts Sequence[str]
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
snapshot_type str
source_db_snapshot_identifier str
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
source_region str
The region that the DB snapshot was created in or copied from.
status str
Specifies the status of this DB snapshot.
storage_type str
Specifies the storage type associated with DB snapshot.
tags Mapping[str, str]
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpc_id str
Provides the VPC ID associated with the DB snapshot.
allocatedStorage Number
Specifies the allocated storage size in gigabytes (GB).
availabilityZone String
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
dbInstanceIdentifier Changes to this property will trigger replacement. String
The DB Instance Identifier from which to take the snapshot.
dbSnapshotArn String
The Amazon Resource Name (ARN) for the DB snapshot.
dbSnapshotIdentifier Changes to this property will trigger replacement. String
The Identifier for the snapshot.
encrypted Boolean
Specifies whether the DB snapshot is encrypted.
engine String
Specifies the name of the database engine.
engineVersion String
Specifies the version of the database engine.
iops Number
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
kmsKeyId String
The ARN for the KMS encryption key.
licenseModel String
License model information for the restored DB instance.
optionGroupName String
Provides the option group name for the DB snapshot.
port Number
sharedAccounts List<String>
List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
snapshotType String
sourceDbSnapshotIdentifier String
The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
sourceRegion String
The region that the DB snapshot was created in or copied from.
status String
Specifies the status of this DB snapshot.
storageType String
Specifies the storage type associated with DB snapshot.
tags Map<String>
Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

vpcId String
Provides the VPC ID associated with the DB snapshot.

Import

Using pulumi import, import aws_db_snapshot using the snapshot identifier. For example:

$ pulumi import aws:rds/snapshot:Snapshot example my-snapshot
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws