Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. rds
  6. Snapshot
Viewing docs for AWS v7.47.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.rds.Snapshot

aws logo aws logo
Viewing docs for AWS v7.47.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
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",
});

    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")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}

    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",
    });

});

    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.ArrayList;
import java.util.Arrays;
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());

    }
}

    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

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_instance" "bar" {
  allocated_storage       = 10
  engine                  = "mysql"
  engine_version          = "5.6.21"
  instance_class          = "db.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"
}
resource "aws_rds_snapshot" "test" {
  db_instance_identifier = aws_rds_instance.bar.identifier
  db_snapshot_identifier = "testsnapshot1234"
}

    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,
             region: 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.


    resource "aws_rds_snapshot" "name" {
    # resource properties
}

    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.

    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",
    Region = "string",
    SharedAccounts = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := rds.NewSnapshot(ctx, "examplesnapshotResourceResourceFromRdssnapshot", &rds.SnapshotArgs{
	DbInstanceIdentifier: pulumi.String("string"),
	DbSnapshotIdentifier: pulumi.String("string"),
	Region:               pulumi.String("string"),
	SharedAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    resource "aws_rds_snapshot" "examplesnapshotResourceResourceFromRdssnapshot" {
  lifecycle {
    create_before_destroy = true
  }
  db_instance_identifier = "string"
  db_snapshot_identifier = "string"
  region                 = "string"
  shared_accounts        = ["string"]
  tags = {
    "string" = "string"
  }
}

    var examplesnapshotResourceResourceFromRdssnapshot = new com.pulumi.aws.rds.Snapshot("examplesnapshotResourceResourceFromRdssnapshot", com.pulumi.aws.rds.SnapshotArgs.builder()
    .dbInstanceIdentifier("string")
    .dbSnapshotIdentifier("string")
    .region("string")
    .sharedAccounts("string")
    .tags(Map.of("string", "string"))
    .build());

    examplesnapshot_resource_resource_from_rdssnapshot = aws.rds.Snapshot("examplesnapshotResourceResourceFromRdssnapshot",
    db_instance_identifier="string",
    db_snapshot_identifier="string",
    region="string",
    shared_accounts=["string"],
    tags={
        "string": "string",
    })

    const examplesnapshotResourceResourceFromRdssnapshot = new aws.rds.Snapshot("examplesnapshotResourceResourceFromRdssnapshot", {
    dbInstanceIdentifier: "string",
    dbSnapshotIdentifier: "string",
    region: "string",
    sharedAccounts: ["string"],
    tags: {
        string: "string",
    },
});

    type: aws:rds:Snapshot
properties:
    dbInstanceIdentifier: string
    dbSnapshotIdentifier: string
    region: string
    sharedAccounts:
        - string
    tags:
        string: string

    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 string
    DB instance identifier from which to take the snapshot.
    DbSnapshotIdentifier string
    Identifier for the snapshot.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    DbInstanceIdentifier string
    DB instance identifier from which to take the snapshot.
    DbSnapshotIdentifier string
    Identifier for the snapshot.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    db_instance_identifier string
    DB instance identifier from which to take the snapshot.
    db_snapshot_identifier string
    Identifier for the snapshot.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    shared_accounts 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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dbInstanceIdentifier String
    DB instance identifier from which to take the snapshot.
    dbSnapshotIdentifier String
    Identifier for the snapshot.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dbInstanceIdentifier string
    DB instance identifier from which to take the snapshot.
    dbSnapshotIdentifier string
    Identifier for the snapshot.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    db_instance_identifier str
    DB instance identifier from which to take the snapshot.
    db_snapshot_identifier str
    Identifier for the snapshot.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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 defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dbInstanceIdentifier String
    DB instance identifier from which to take the snapshot.
    dbSnapshotIdentifier String
    Identifier for the snapshot.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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 defaultTags 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
    Allocated storage size in gigabytes (GB).
    AvailabilityZone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    DbSnapshotArn string
    ARN for the DB snapshot.
    Encrypted bool
    Whether the DB snapshot is encrypted.
    Engine string
    Name of the database engine.
    EngineVersion string
    Version of the database engine.
    Id string
    The provider-assigned unique ID for this managed resource.
    Iops int
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    KmsKeyId string
    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
    Port that the DB snapshot listens on.
    SnapshotType string
    Type of the DB snapshot.
    SourceDbSnapshotIdentifier string
    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
    Region that the DB snapshot was created in or copied from.
    Status string
    Status of this DB snapshot.
    StorageType string
    Storage type associated with DB snapshot.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    VpcId string
    Provides the VPC ID associated with the DB snapshot.
    AllocatedStorage int
    Allocated storage size in gigabytes (GB).
    AvailabilityZone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    DbSnapshotArn string
    ARN for the DB snapshot.
    Encrypted bool
    Whether the DB snapshot is encrypted.
    Engine string
    Name of the database engine.
    EngineVersion string
    Version of the database engine.
    Id string
    The provider-assigned unique ID for this managed resource.
    Iops int
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    KmsKeyId string
    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
    Port that the DB snapshot listens on.
    SnapshotType string
    Type of the DB snapshot.
    SourceDbSnapshotIdentifier string
    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
    Region that the DB snapshot was created in or copied from.
    Status string
    Status of this DB snapshot.
    StorageType string
    Storage type associated with DB snapshot.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    VpcId string
    Provides the VPC ID associated with the DB snapshot.
    allocated_storage number
    Allocated storage size in gigabytes (GB).
    availability_zone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    db_snapshot_arn string
    ARN for the DB snapshot.
    encrypted bool
    Whether the DB snapshot is encrypted.
    engine string
    Name of the database engine.
    engine_version string
    Version of the database engine.
    id string
    The provider-assigned unique ID for this managed resource.
    iops number
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kms_key_id string
    ARN for the KMS encryption key.
    license_model string
    License model information for the restored DB instance.
    option_group_name string
    Provides the option group name for the DB snapshot.
    port number
    Port that the DB snapshot listens on.
    snapshot_type string
    Type of the DB snapshot.
    source_db_snapshot_identifier string
    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 string
    Region that the DB snapshot was created in or copied from.
    status string
    Status of this DB snapshot.
    storage_type string
    Storage type associated with DB snapshot.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpc_id string
    Provides the VPC ID associated with the DB snapshot.
    allocatedStorage Integer
    Allocated storage size in gigabytes (GB).
    availabilityZone String
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbSnapshotArn String
    ARN for the DB snapshot.
    encrypted Boolean
    Whether the DB snapshot is encrypted.
    engine String
    Name of the database engine.
    engineVersion String
    Version of the database engine.
    id String
    The provider-assigned unique ID for this managed resource.
    iops Integer
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kmsKeyId String
    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
    Port that the DB snapshot listens on.
    snapshotType String
    Type of the DB snapshot.
    sourceDbSnapshotIdentifier String
    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
    Region that the DB snapshot was created in or copied from.
    status String
    Status of this DB snapshot.
    storageType String
    Storage type associated with DB snapshot.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpcId String
    Provides the VPC ID associated with the DB snapshot.
    allocatedStorage number
    Allocated storage size in gigabytes (GB).
    availabilityZone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbSnapshotArn string
    ARN for the DB snapshot.
    encrypted boolean
    Whether the DB snapshot is encrypted.
    engine string
    Name of the database engine.
    engineVersion string
    Version of the database engine.
    id string
    The provider-assigned unique ID for this managed resource.
    iops number
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kmsKeyId string
    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
    Port that the DB snapshot listens on.
    snapshotType string
    Type of the DB snapshot.
    sourceDbSnapshotIdentifier string
    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
    Region that the DB snapshot was created in or copied from.
    status string
    Status of this DB snapshot.
    storageType string
    Storage type associated with DB snapshot.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpcId string
    Provides the VPC ID associated with the DB snapshot.
    allocated_storage int
    Allocated storage size in gigabytes (GB).
    availability_zone str
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    db_snapshot_arn str
    ARN for the DB snapshot.
    encrypted bool
    Whether the DB snapshot is encrypted.
    engine str
    Name of the database engine.
    engine_version str
    Version of the database engine.
    id str
    The provider-assigned unique ID for this managed resource.
    iops int
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kms_key_id str
    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
    Port that the DB snapshot listens on.
    snapshot_type str
    Type of the DB snapshot.
    source_db_snapshot_identifier str
    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
    Region that the DB snapshot was created in or copied from.
    status str
    Status of this DB snapshot.
    storage_type str
    Storage type associated with DB snapshot.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpc_id str
    Provides the VPC ID associated with the DB snapshot.
    allocatedStorage Number
    Allocated storage size in gigabytes (GB).
    availabilityZone String
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbSnapshotArn String
    ARN for the DB snapshot.
    encrypted Boolean
    Whether the DB snapshot is encrypted.
    engine String
    Name of the database engine.
    engineVersion String
    Version of the database engine.
    id String
    The provider-assigned unique ID for this managed resource.
    iops Number
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kmsKeyId String
    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
    Port that the DB snapshot listens on.
    snapshotType String
    Type of the DB snapshot.
    sourceDbSnapshotIdentifier String
    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
    Region that the DB snapshot was created in or copied from.
    status String
    Status of this DB snapshot.
    storageType String
    Storage type associated with DB snapshot.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    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,
        region: Optional[str] = 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}
    import {
  to = aws_rds_snapshot.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    Allocated storage size in gigabytes (GB).
    AvailabilityZone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    DbInstanceIdentifier string
    DB instance identifier from which to take the snapshot.
    DbSnapshotArn string
    ARN for the DB snapshot.
    DbSnapshotIdentifier string
    Identifier for the snapshot.
    Encrypted bool
    Whether the DB snapshot is encrypted.
    Engine string
    Name of the database engine.
    EngineVersion string
    Version of the database engine.
    Iops int
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    KmsKeyId string
    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
    Port that the DB snapshot listens on.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SharedAccounts List<string>
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    SnapshotType string
    Type of the DB snapshot.
    SourceDbSnapshotIdentifier string
    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
    Region that the DB snapshot was created in or copied from.
    Status string
    Status of this DB snapshot.
    StorageType string
    Storage type associated with DB snapshot.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    VpcId string
    Provides the VPC ID associated with the DB snapshot.
    AllocatedStorage int
    Allocated storage size in gigabytes (GB).
    AvailabilityZone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    DbInstanceIdentifier string
    DB instance identifier from which to take the snapshot.
    DbSnapshotArn string
    ARN for the DB snapshot.
    DbSnapshotIdentifier string
    Identifier for the snapshot.
    Encrypted bool
    Whether the DB snapshot is encrypted.
    Engine string
    Name of the database engine.
    EngineVersion string
    Version of the database engine.
    Iops int
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    KmsKeyId string
    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
    Port that the DB snapshot listens on.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SharedAccounts []string
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    SnapshotType string
    Type of the DB snapshot.
    SourceDbSnapshotIdentifier string
    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
    Region that the DB snapshot was created in or copied from.
    Status string
    Status of this DB snapshot.
    StorageType string
    Storage type associated with DB snapshot.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    VpcId string
    Provides the VPC ID associated with the DB snapshot.
    allocated_storage number
    Allocated storage size in gigabytes (GB).
    availability_zone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    db_instance_identifier string
    DB instance identifier from which to take the snapshot.
    db_snapshot_arn string
    ARN for the DB snapshot.
    db_snapshot_identifier string
    Identifier for the snapshot.
    encrypted bool
    Whether the DB snapshot is encrypted.
    engine string
    Name of the database engine.
    engine_version string
    Version of the database engine.
    iops number
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kms_key_id string
    ARN for the KMS encryption key.
    license_model string
    License model information for the restored DB instance.
    option_group_name string
    Provides the option group name for the DB snapshot.
    port number
    Port that the DB snapshot listens on.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    shared_accounts list(string)
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshot_type string
    Type of the DB snapshot.
    source_db_snapshot_identifier string
    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 string
    Region that the DB snapshot was created in or copied from.
    status string
    Status of this DB snapshot.
    storage_type string
    Storage type associated with DB snapshot.
    tags map(string)
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpc_id string
    Provides the VPC ID associated with the DB snapshot.
    allocatedStorage Integer
    Allocated storage size in gigabytes (GB).
    availabilityZone String
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbInstanceIdentifier String
    DB instance identifier from which to take the snapshot.
    dbSnapshotArn String
    ARN for the DB snapshot.
    dbSnapshotIdentifier String
    Identifier for the snapshot.
    encrypted Boolean
    Whether the DB snapshot is encrypted.
    engine String
    Name of the database engine.
    engineVersion String
    Version of the database engine.
    iops Integer
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kmsKeyId String
    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
    Port that the DB snapshot listens on.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sharedAccounts List<String>
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshotType String
    Type of the DB snapshot.
    sourceDbSnapshotIdentifier String
    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
    Region that the DB snapshot was created in or copied from.
    status String
    Status of this DB snapshot.
    storageType String
    Storage type associated with DB snapshot.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpcId String
    Provides the VPC ID associated with the DB snapshot.
    allocatedStorage number
    Allocated storage size in gigabytes (GB).
    availabilityZone string
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbInstanceIdentifier string
    DB instance identifier from which to take the snapshot.
    dbSnapshotArn string
    ARN for the DB snapshot.
    dbSnapshotIdentifier string
    Identifier for the snapshot.
    encrypted boolean
    Whether the DB snapshot is encrypted.
    engine string
    Name of the database engine.
    engineVersion string
    Version of the database engine.
    iops number
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kmsKeyId string
    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
    Port that the DB snapshot listens on.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sharedAccounts string[]
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshotType string
    Type of the DB snapshot.
    sourceDbSnapshotIdentifier string
    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
    Region that the DB snapshot was created in or copied from.
    status string
    Status of this DB snapshot.
    storageType string
    Storage type associated with DB snapshot.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpcId string
    Provides the VPC ID associated with the DB snapshot.
    allocated_storage int
    Allocated storage size in gigabytes (GB).
    availability_zone str
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    db_instance_identifier str
    DB instance identifier from which to take the snapshot.
    db_snapshot_arn str
    ARN for the DB snapshot.
    db_snapshot_identifier str
    Identifier for the snapshot.
    encrypted bool
    Whether the DB snapshot is encrypted.
    engine str
    Name of the database engine.
    engine_version str
    Version of the database engine.
    iops int
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kms_key_id str
    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
    Port that the DB snapshot listens on.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    shared_accounts Sequence[str]
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshot_type str
    Type of the DB snapshot.
    source_db_snapshot_identifier str
    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
    Region that the DB snapshot was created in or copied from.
    status str
    Status of this DB snapshot.
    storage_type str
    Storage type associated with DB snapshot.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpc_id str
    Provides the VPC ID associated with the DB snapshot.
    allocatedStorage Number
    Allocated storage size in gigabytes (GB).
    availabilityZone String
    Name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
    dbInstanceIdentifier String
    DB instance identifier from which to take the snapshot.
    dbSnapshotArn String
    ARN for the DB snapshot.
    dbSnapshotIdentifier String
    Identifier for the snapshot.
    encrypted Boolean
    Whether the DB snapshot is encrypted.
    engine String
    Name of the database engine.
    engineVersion String
    Version of the database engine.
    iops Number
    Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
    kmsKeyId String
    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
    Port that the DB snapshot listens on.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sharedAccounts List<String>
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshotType String
    Type of the DB snapshot.
    sourceDbSnapshotIdentifier String
    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
    Region that the DB snapshot was created in or copied from.
    status String
    Status of this DB snapshot.
    storageType String
    Storage type associated with DB snapshot.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vpcId String
    Provides the VPC ID associated with the DB snapshot.

    Import

    Using pulumi import, import aws.rds.Snapshot using the snapshot identifier. For example:

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

    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 logo aws logo
    Viewing docs for AWS v7.47.0
    published on Thursday, Sep 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial