Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. SnapshotCopy
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.SnapshotCopy

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Manages an RDS database instance snapshot copy. 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 example = new aws.rds.Instance("example", {
    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 exampleSnapshot = new aws.rds.Snapshot("example", {
    dbInstanceIdentifier: example.identifier,
    dbSnapshotIdentifier: "testsnapshot1234",
});
const exampleSnapshotCopy = new aws.rds.SnapshotCopy("example", {
    sourceDbSnapshotIdentifier: exampleSnapshot.dbSnapshotArn,
    targetDbSnapshotIdentifier: "testsnapshot1234-copy",
});

    import pulumi
import pulumi_aws as aws

example = aws.rds.Instance("example",
    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")
example_snapshot = aws.rds.Snapshot("example",
    db_instance_identifier=example.identifier,
    db_snapshot_identifier="testsnapshot1234")
example_snapshot_copy = aws.rds.SnapshotCopy("example",
    source_db_snapshot_identifier=example_snapshot.db_snapshot_arn,
    target_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 {
		example, err := rds.NewInstance(ctx, "example", &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
		}
		exampleSnapshot, err := rds.NewSnapshot(ctx, "example", &rds.SnapshotArgs{
			DbInstanceIdentifier: example.Identifier,
			DbSnapshotIdentifier: pulumi.String("testsnapshot1234"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewSnapshotCopy(ctx, "example", &rds.SnapshotCopyArgs{
			SourceDbSnapshotIdentifier: exampleSnapshot.DbSnapshotArn,
			TargetDbSnapshotIdentifier: pulumi.String("testsnapshot1234-copy"),
		})
		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 example = new Aws.Rds.Instance("example", 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 exampleSnapshot = new Aws.Rds.Snapshot("example", new()
    {
        DbInstanceIdentifier = example.Identifier,
        DbSnapshotIdentifier = "testsnapshot1234",
    });

    var exampleSnapshotCopy = new Aws.Rds.SnapshotCopy("example", new()
    {
        SourceDbSnapshotIdentifier = exampleSnapshot.DbSnapshotArn,
        TargetDbSnapshotIdentifier = "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 com.pulumi.aws.rds.SnapshotCopy;
import com.pulumi.aws.rds.SnapshotCopyArgs;
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 example = new Instance("example", 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 exampleSnapshot = new Snapshot("exampleSnapshot", SnapshotArgs.builder()
            .dbInstanceIdentifier(example.identifier())
            .dbSnapshotIdentifier("testsnapshot1234")
            .build());

        var exampleSnapshotCopy = new SnapshotCopy("exampleSnapshotCopy", SnapshotCopyArgs.builder()
            .sourceDbSnapshotIdentifier(exampleSnapshot.dbSnapshotArn())
            .targetDbSnapshotIdentifier("testsnapshot1234-copy")
            .build());

    }
}

    resources:
  example:
    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
  exampleSnapshot:
    type: aws:rds:Snapshot
    name: example
    properties:
      dbInstanceIdentifier: ${example.identifier}
      dbSnapshotIdentifier: testsnapshot1234
  exampleSnapshotCopy:
    type: aws:rds:SnapshotCopy
    name: example
    properties:
      sourceDbSnapshotIdentifier: ${exampleSnapshot.dbSnapshotArn}
      targetDbSnapshotIdentifier: testsnapshot1234-copy

    Create SnapshotCopy Resource

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

    Constructor syntax

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

@overload
def SnapshotCopy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 source_db_snapshot_identifier: Optional[str] = None,
                 target_db_snapshot_identifier: Optional[str] = None,
                 copy_tags: Optional[bool] = None,
                 destination_region: Optional[str] = None,
                 kms_key_id: Optional[str] = None,
                 option_group_name: Optional[str] = None,
                 presigned_url: Optional[str] = None,
                 shared_accounts: Optional[Sequence[str]] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 target_custom_availability_zone: Optional[str] = None)
    func NewSnapshotCopy(ctx *Context, name string, args SnapshotCopyArgs, opts ...ResourceOption) (*SnapshotCopy, error)
    public SnapshotCopy(string name, SnapshotCopyArgs args, CustomResourceOptions? opts = null)
    public SnapshotCopy(String name, SnapshotCopyArgs args)
public SnapshotCopy(String name, SnapshotCopyArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args SnapshotCopyArgs
    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 SnapshotCopyArgs
    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 SnapshotCopyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnapshotCopyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnapshotCopyArgs
    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 awsSnapshotCopyResource = new Aws.Rds.SnapshotCopy("awsSnapshotCopyResource", new()
{
    SourceDbSnapshotIdentifier = "string",
    TargetDbSnapshotIdentifier = "string",
    CopyTags = false,
    DestinationRegion = "string",
    KmsKeyId = "string",
    OptionGroupName = "string",
    PresignedUrl = "string",
    SharedAccounts = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    TargetCustomAvailabilityZone = "string",
});

    example, err := rds.NewSnapshotCopy(ctx, "awsSnapshotCopyResource", &rds.SnapshotCopyArgs{
	SourceDbSnapshotIdentifier: pulumi.String("string"),
	TargetDbSnapshotIdentifier: pulumi.String("string"),
	CopyTags:                   pulumi.Bool(false),
	DestinationRegion:          pulumi.String("string"),
	KmsKeyId:                   pulumi.String("string"),
	OptionGroupName:            pulumi.String("string"),
	PresignedUrl:               pulumi.String("string"),
	SharedAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TargetCustomAvailabilityZone: pulumi.String("string"),
})

    var awsSnapshotCopyResource = new SnapshotCopy("awsSnapshotCopyResource", SnapshotCopyArgs.builder()
    .sourceDbSnapshotIdentifier("string")
    .targetDbSnapshotIdentifier("string")
    .copyTags(false)
    .destinationRegion("string")
    .kmsKeyId("string")
    .optionGroupName("string")
    .presignedUrl("string")
    .sharedAccounts("string")
    .tags(Map.of("string", "string"))
    .targetCustomAvailabilityZone("string")
    .build());

    aws_snapshot_copy_resource = aws.rds.SnapshotCopy("awsSnapshotCopyResource",
    source_db_snapshot_identifier="string",
    target_db_snapshot_identifier="string",
    copy_tags=False,
    destination_region="string",
    kms_key_id="string",
    option_group_name="string",
    presigned_url="string",
    shared_accounts=["string"],
    tags={
        "string": "string",
    },
    target_custom_availability_zone="string")

    const awsSnapshotCopyResource = new aws.rds.SnapshotCopy("awsSnapshotCopyResource", {
    sourceDbSnapshotIdentifier: "string",
    targetDbSnapshotIdentifier: "string",
    copyTags: false,
    destinationRegion: "string",
    kmsKeyId: "string",
    optionGroupName: "string",
    presignedUrl: "string",
    sharedAccounts: ["string"],
    tags: {
        string: "string",
    },
    targetCustomAvailabilityZone: "string",
});

    type: aws:rds:SnapshotCopy
properties:
    copyTags: false
    destinationRegion: string
    kmsKeyId: string
    optionGroupName: string
    presignedUrl: string
    sharedAccounts:
        - string
    sourceDbSnapshotIdentifier: string
    tags:
        string: string
    targetCustomAvailabilityZone: string
    targetDbSnapshotIdentifier: string

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

    SourceDbSnapshotIdentifier string
    Snapshot identifier of the source snapshot.
    TargetDbSnapshotIdentifier string
    The Identifier for the snapshot.
    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DestinationRegion string
    The Destination region to place snapshot copy.
    KmsKeyId string
    KMS key ID.
    OptionGroupName string
    The name of an option group to associate with the copy of the snapshot.
    PresignedUrl string
    he URL that contains a Signature Version 4 signed request.
    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.
    TargetCustomAvailabilityZone string
    The external custom Availability Zone.
    SourceDbSnapshotIdentifier string
    Snapshot identifier of the source snapshot.
    TargetDbSnapshotIdentifier string
    The Identifier for the snapshot.
    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DestinationRegion string
    The Destination region to place snapshot copy.
    KmsKeyId string
    KMS key ID.
    OptionGroupName string
    The name of an option group to associate with the copy of the snapshot.
    PresignedUrl string
    he URL that contains a Signature Version 4 signed request.
    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.
    TargetCustomAvailabilityZone string
    The external custom Availability Zone.
    sourceDbSnapshotIdentifier String
    Snapshot identifier of the source snapshot.
    targetDbSnapshotIdentifier String
    The Identifier for the snapshot.
    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    destinationRegion String
    The Destination region to place snapshot copy.
    kmsKeyId String
    KMS key ID.
    optionGroupName String
    The name of an option group to associate with the copy of the snapshot.
    presignedUrl String
    he URL that contains a Signature Version 4 signed request.
    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.
    targetCustomAvailabilityZone String
    The external custom Availability Zone.
    sourceDbSnapshotIdentifier string
    Snapshot identifier of the source snapshot.
    targetDbSnapshotIdentifier string
    The Identifier for the snapshot.
    copyTags boolean
    Whether to copy existing tags. Defaults to false.
    destinationRegion string
    The Destination region to place snapshot copy.
    kmsKeyId string
    KMS key ID.
    optionGroupName string
    The name of an option group to associate with the copy of the snapshot.
    presignedUrl string
    he URL that contains a Signature Version 4 signed request.
    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.
    targetCustomAvailabilityZone string
    The external custom Availability Zone.
    source_db_snapshot_identifier str
    Snapshot identifier of the source snapshot.
    target_db_snapshot_identifier str
    The Identifier for the snapshot.
    copy_tags bool
    Whether to copy existing tags. Defaults to false.
    destination_region str
    The Destination region to place snapshot copy.
    kms_key_id str
    KMS key ID.
    option_group_name str
    The name of an option group to associate with the copy of the snapshot.
    presigned_url str
    he URL that contains a Signature Version 4 signed request.
    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.
    target_custom_availability_zone str
    The external custom Availability Zone.
    sourceDbSnapshotIdentifier String
    Snapshot identifier of the source snapshot.
    targetDbSnapshotIdentifier String
    The Identifier for the snapshot.
    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    destinationRegion String
    The Destination region to place snapshot copy.
    kmsKeyId String
    KMS key ID.
    optionGroupName String
    The name of an option group to associate with the copy of the snapshot.
    presignedUrl String
    he URL that contains a Signature Version 4 signed request.
    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.
    targetCustomAvailabilityZone String
    The external custom Availability Zone.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SnapshotCopy 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.
    LicenseModel string
    License model information for the restored DB instance.
    Port int
    SnapshotType string
    SourceRegion string
    The region that the DB snapshot was created in or copied from.
    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.
    LicenseModel string
    License model information for the restored DB instance.
    Port int
    SnapshotType string
    SourceRegion string
    The region that the DB snapshot was created in or copied from.
    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.
    licenseModel String
    License model information for the restored DB instance.
    port Integer
    snapshotType String
    sourceRegion String
    The region that the DB snapshot was created in or copied from.
    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.
    licenseModel string
    License model information for the restored DB instance.
    port number
    snapshotType string
    sourceRegion string
    The region that the DB snapshot was created in or copied from.
    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.
    license_model str
    License model information for the restored DB instance.
    port int
    snapshot_type str
    source_region str
    The region that the DB snapshot was created in or copied from.
    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.
    licenseModel String
    License model information for the restored DB instance.
    port Number
    snapshotType String
    sourceRegion String
    The region that the DB snapshot was created in or copied from.
    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 SnapshotCopy Resource

    Get an existing SnapshotCopy 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?: SnapshotCopyState, opts?: CustomResourceOptions): SnapshotCopy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        availability_zone: Optional[str] = None,
        copy_tags: Optional[bool] = None,
        db_snapshot_arn: Optional[str] = None,
        destination_region: 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,
        presigned_url: 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,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_custom_availability_zone: Optional[str] = None,
        target_db_snapshot_identifier: Optional[str] = None,
        vpc_id: Optional[str] = None) -> SnapshotCopy
    func GetSnapshotCopy(ctx *Context, name string, id IDInput, state *SnapshotCopyState, opts ...ResourceOption) (*SnapshotCopy, error)
    public static SnapshotCopy Get(string name, Input<string> id, SnapshotCopyState? state, CustomResourceOptions? opts = null)
    public static SnapshotCopy get(String name, Output<String> id, SnapshotCopyState state, CustomResourceOptions options)
    resources:  _:    type: aws:rds:SnapshotCopy    get:      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
    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.
    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DbSnapshotArn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    DestinationRegion string
    The Destination region to place snapshot copy.
    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
    KMS key ID.
    LicenseModel string
    License model information for the restored DB instance.
    OptionGroupName string
    The name of an option group to associate with the copy of the snapshot.
    Port int
    PresignedUrl string
    he URL that contains a Signature Version 4 signed request.
    SharedAccounts List<string>
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    SnapshotType string
    SourceDbSnapshotIdentifier string
    Snapshot identifier of the source snapshot.
    SourceRegion string
    The region that the DB snapshot was created in or copied from.
    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.

    TargetCustomAvailabilityZone string
    The external custom Availability Zone.
    TargetDbSnapshotIdentifier string
    The Identifier for the snapshot.
    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.
    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DbSnapshotArn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    DestinationRegion string
    The Destination region to place snapshot copy.
    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
    KMS key ID.
    LicenseModel string
    License model information for the restored DB instance.
    OptionGroupName string
    The name of an option group to associate with the copy of the snapshot.
    Port int
    PresignedUrl string
    he URL that contains a Signature Version 4 signed request.
    SharedAccounts []string
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    SnapshotType string
    SourceDbSnapshotIdentifier string
    Snapshot identifier of the source snapshot.
    SourceRegion string
    The region that the DB snapshot was created in or copied from.
    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.

    TargetCustomAvailabilityZone string
    The external custom Availability Zone.
    TargetDbSnapshotIdentifier string
    The Identifier for the snapshot.
    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.
    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    dbSnapshotArn String
    The Amazon Resource Name (ARN) for the DB snapshot.
    destinationRegion String
    The Destination region to place snapshot copy.
    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
    KMS key ID.
    licenseModel String
    License model information for the restored DB instance.
    optionGroupName String
    The name of an option group to associate with the copy of the snapshot.
    port Integer
    presignedUrl String
    he URL that contains a Signature Version 4 signed request.
    sharedAccounts List<String>
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshotType String
    sourceDbSnapshotIdentifier String
    Snapshot identifier of the source snapshot.
    sourceRegion String
    The region that the DB snapshot was created in or copied from.
    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.

    targetCustomAvailabilityZone String
    The external custom Availability Zone.
    targetDbSnapshotIdentifier String
    The Identifier for the snapshot.
    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.
    copyTags boolean
    Whether to copy existing tags. Defaults to false.
    dbSnapshotArn string
    The Amazon Resource Name (ARN) for the DB snapshot.
    destinationRegion string
    The Destination region to place snapshot copy.
    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
    KMS key ID.
    licenseModel string
    License model information for the restored DB instance.
    optionGroupName string
    The name of an option group to associate with the copy of the snapshot.
    port number
    presignedUrl string
    he URL that contains a Signature Version 4 signed request.
    sharedAccounts string[]
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshotType string
    sourceDbSnapshotIdentifier string
    Snapshot identifier of the source snapshot.
    sourceRegion string
    The region that the DB snapshot was created in or copied from.
    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.

    targetCustomAvailabilityZone string
    The external custom Availability Zone.
    targetDbSnapshotIdentifier string
    The Identifier for the snapshot.
    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.
    copy_tags bool
    Whether to copy existing tags. Defaults to false.
    db_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB snapshot.
    destination_region str
    The Destination region to place snapshot copy.
    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
    KMS key ID.
    license_model str
    License model information for the restored DB instance.
    option_group_name str
    The name of an option group to associate with the copy of the snapshot.
    port int
    presigned_url str
    he URL that contains a Signature Version 4 signed request.
    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
    Snapshot identifier of the source snapshot.
    source_region str
    The region that the DB snapshot was created in or copied from.
    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.

    target_custom_availability_zone str
    The external custom Availability Zone.
    target_db_snapshot_identifier str
    The Identifier for the snapshot.
    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.
    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    dbSnapshotArn String
    The Amazon Resource Name (ARN) for the DB snapshot.
    destinationRegion String
    The Destination region to place snapshot copy.
    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
    KMS key ID.
    licenseModel String
    License model information for the restored DB instance.
    optionGroupName String
    The name of an option group to associate with the copy of the snapshot.
    port Number
    presignedUrl String
    he URL that contains a Signature Version 4 signed request.
    sharedAccounts List<String>
    List of AWS Account IDs to share the snapshot with. Use all to make the snapshot public.
    snapshotType String
    sourceDbSnapshotIdentifier String
    Snapshot identifier of the source snapshot.
    sourceRegion String
    The region that the DB snapshot was created in or copied from.
    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.

    targetCustomAvailabilityZone String
    The external custom Availability Zone.
    targetDbSnapshotIdentifier String
    The Identifier for the snapshot.
    vpcId String
    Provides the VPC ID associated with the DB snapshot.

    Import

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

    $ pulumi import aws:rds/snapshotCopy:SnapshotCopy 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 v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws