Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ClusterSnapshotCopy
AWS v6.66.3 published on Monday, Jan 13, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.ClusterSnapshotCopy

Explore with Pulumi AI

aws logo
AWS v6.66.3 published on Monday, Jan 13, 2025 by Pulumi
pulumi/pulumi-aws

    Manages an RDS database cluster snapshot copy. For managing RDS database instance snapshot copies, see the aws.rds.SnapshotCopy resource.

    Example Usage

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

const example = new aws.rds.Cluster("example", {
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "test",
    engine: aws.rds.EngineType.AuroraMysql,
    masterUsername: "tfacctest",
    masterPassword: "avoid-plaintext-passwords",
    skipFinalSnapshot: true,
});
const exampleClusterSnapshot = new aws.rds.ClusterSnapshot("example", {
    dbClusterIdentifier: example.clusterIdentifier,
    dbClusterSnapshotIdentifier: "example",
});
const exampleClusterSnapshotCopy = new aws.rds.ClusterSnapshotCopy("example", {
    sourceDbClusterSnapshotIdentifier: exampleClusterSnapshot.dbClusterSnapshotArn,
    targetDbClusterSnapshotIdentifier: "example-copy",
});

    import pulumi
import pulumi_aws as aws

example = aws.rds.Cluster("example",
    cluster_identifier="aurora-cluster-demo",
    database_name="test",
    engine=aws.rds.EngineType.AURORA_MYSQL,
    master_username="tfacctest",
    master_password="avoid-plaintext-passwords",
    skip_final_snapshot=True)
example_cluster_snapshot = aws.rds.ClusterSnapshot("example",
    db_cluster_identifier=example.cluster_identifier,
    db_cluster_snapshot_identifier="example")
example_cluster_snapshot_copy = aws.rds.ClusterSnapshotCopy("example",
    source_db_cluster_snapshot_identifier=example_cluster_snapshot.db_cluster_snapshot_arn,
    target_db_cluster_snapshot_identifier="example-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.NewCluster(ctx, "example", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
			DatabaseName:      pulumi.String("test"),
			Engine:            pulumi.String(rds.EngineTypeAuroraMysql),
			MasterUsername:    pulumi.String("tfacctest"),
			MasterPassword:    pulumi.String("avoid-plaintext-passwords"),
			SkipFinalSnapshot: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleClusterSnapshot, err := rds.NewClusterSnapshot(ctx, "example", &rds.ClusterSnapshotArgs{
			DbClusterIdentifier:         example.ClusterIdentifier,
			DbClusterSnapshotIdentifier: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewClusterSnapshotCopy(ctx, "example", &rds.ClusterSnapshotCopyArgs{
			SourceDbClusterSnapshotIdentifier: exampleClusterSnapshot.DbClusterSnapshotArn,
			TargetDbClusterSnapshotIdentifier: pulumi.String("example-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.Cluster("example", new()
    {
        ClusterIdentifier = "aurora-cluster-demo",
        DatabaseName = "test",
        Engine = Aws.Rds.EngineType.AuroraMysql,
        MasterUsername = "tfacctest",
        MasterPassword = "avoid-plaintext-passwords",
        SkipFinalSnapshot = true,
    });

    var exampleClusterSnapshot = new Aws.Rds.ClusterSnapshot("example", new()
    {
        DbClusterIdentifier = example.ClusterIdentifier,
        DbClusterSnapshotIdentifier = "example",
    });

    var exampleClusterSnapshotCopy = new Aws.Rds.ClusterSnapshotCopy("example", new()
    {
        SourceDbClusterSnapshotIdentifier = exampleClusterSnapshot.DbClusterSnapshotArn,
        TargetDbClusterSnapshotIdentifier = "example-copy",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
import com.pulumi.aws.rds.ClusterSnapshot;
import com.pulumi.aws.rds.ClusterSnapshotArgs;
import com.pulumi.aws.rds.ClusterSnapshotCopy;
import com.pulumi.aws.rds.ClusterSnapshotCopyArgs;
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 Cluster("example", ClusterArgs.builder()
            .clusterIdentifier("aurora-cluster-demo")
            .databaseName("test")
            .engine("aurora-mysql")
            .masterUsername("tfacctest")
            .masterPassword("avoid-plaintext-passwords")
            .skipFinalSnapshot(true)
            .build());

        var exampleClusterSnapshot = new ClusterSnapshot("exampleClusterSnapshot", ClusterSnapshotArgs.builder()
            .dbClusterIdentifier(example.clusterIdentifier())
            .dbClusterSnapshotIdentifier("example")
            .build());

        var exampleClusterSnapshotCopy = new ClusterSnapshotCopy("exampleClusterSnapshotCopy", ClusterSnapshotCopyArgs.builder()
            .sourceDbClusterSnapshotIdentifier(exampleClusterSnapshot.dbClusterSnapshotArn())
            .targetDbClusterSnapshotIdentifier("example-copy")
            .build());

    }
}

    resources:
  example:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: aurora-cluster-demo
      databaseName: test
      engine: aurora-mysql
      masterUsername: tfacctest
      masterPassword: avoid-plaintext-passwords
      skipFinalSnapshot: true
  exampleClusterSnapshot:
    type: aws:rds:ClusterSnapshot
    name: example
    properties:
      dbClusterIdentifier: ${example.clusterIdentifier}
      dbClusterSnapshotIdentifier: example
  exampleClusterSnapshotCopy:
    type: aws:rds:ClusterSnapshotCopy
    name: example
    properties:
      sourceDbClusterSnapshotIdentifier: ${exampleClusterSnapshot.dbClusterSnapshotArn}
      targetDbClusterSnapshotIdentifier: example-copy

    Create ClusterSnapshotCopy Resource

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

    Constructor syntax

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

@overload
def ClusterSnapshotCopy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        source_db_cluster_snapshot_identifier: Optional[str] = None,
                        target_db_cluster_snapshot_identifier: Optional[str] = None,
                        copy_tags: Optional[bool] = None,
                        destination_region: Optional[str] = None,
                        kms_key_id: Optional[str] = None,
                        presigned_url: Optional[str] = None,
                        shared_accounts: Optional[Sequence[str]] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        timeouts: Optional[ClusterSnapshotCopyTimeoutsArgs] = None)
    func NewClusterSnapshotCopy(ctx *Context, name string, args ClusterSnapshotCopyArgs, opts ...ResourceOption) (*ClusterSnapshotCopy, error)
    public ClusterSnapshotCopy(string name, ClusterSnapshotCopyArgs args, CustomResourceOptions? opts = null)
    public ClusterSnapshotCopy(String name, ClusterSnapshotCopyArgs args)
public ClusterSnapshotCopy(String name, ClusterSnapshotCopyArgs args, CustomResourceOptions options)

    type: aws:rds:ClusterSnapshotCopy
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 ClusterSnapshotCopyArgs
    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 ClusterSnapshotCopyArgs
    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 ClusterSnapshotCopyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterSnapshotCopyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterSnapshotCopyArgs
    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 clusterSnapshotCopyResource = new Aws.Rds.ClusterSnapshotCopy("clusterSnapshotCopyResource", new()
{
    SourceDbClusterSnapshotIdentifier = "string",
    TargetDbClusterSnapshotIdentifier = "string",
    CopyTags = false,
    DestinationRegion = "string",
    KmsKeyId = "string",
    PresignedUrl = "string",
    SharedAccounts = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Rds.Inputs.ClusterSnapshotCopyTimeoutsArgs
    {
        Create = "string",
    },
});

    example, err := rds.NewClusterSnapshotCopy(ctx, "clusterSnapshotCopyResource", &rds.ClusterSnapshotCopyArgs{
	SourceDbClusterSnapshotIdentifier: pulumi.String("string"),
	TargetDbClusterSnapshotIdentifier: pulumi.String("string"),
	CopyTags:                          pulumi.Bool(false),
	DestinationRegion:                 pulumi.String("string"),
	KmsKeyId:                          pulumi.String("string"),
	PresignedUrl:                      pulumi.String("string"),
	SharedAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &rds.ClusterSnapshotCopyTimeoutsArgs{
		Create: pulumi.String("string"),
	},
})

    var clusterSnapshotCopyResource = new ClusterSnapshotCopy("clusterSnapshotCopyResource", ClusterSnapshotCopyArgs.builder()
    .sourceDbClusterSnapshotIdentifier("string")
    .targetDbClusterSnapshotIdentifier("string")
    .copyTags(false)
    .destinationRegion("string")
    .kmsKeyId("string")
    .presignedUrl("string")
    .sharedAccounts("string")
    .tags(Map.of("string", "string"))
    .timeouts(ClusterSnapshotCopyTimeoutsArgs.builder()
        .create("string")
        .build())
    .build());

    cluster_snapshot_copy_resource = aws.rds.ClusterSnapshotCopy("clusterSnapshotCopyResource",
    source_db_cluster_snapshot_identifier="string",
    target_db_cluster_snapshot_identifier="string",
    copy_tags=False,
    destination_region="string",
    kms_key_id="string",
    presigned_url="string",
    shared_accounts=["string"],
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
    })

    const clusterSnapshotCopyResource = new aws.rds.ClusterSnapshotCopy("clusterSnapshotCopyResource", {
    sourceDbClusterSnapshotIdentifier: "string",
    targetDbClusterSnapshotIdentifier: "string",
    copyTags: false,
    destinationRegion: "string",
    kmsKeyId: "string",
    presignedUrl: "string",
    sharedAccounts: ["string"],
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
    },
});

    type: aws:rds:ClusterSnapshotCopy
properties:
    copyTags: false
    destinationRegion: string
    kmsKeyId: string
    presignedUrl: string
    sharedAccounts:
        - string
    sourceDbClusterSnapshotIdentifier: string
    tags:
        string: string
    targetDbClusterSnapshotIdentifier: string
    timeouts:
        create: string

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

    SourceDbClusterSnapshotIdentifier string
    Identifier of the source snapshot.
    TargetDbClusterSnapshotIdentifier string

    Identifier for the snapshot.

    The following arguments are optional:

    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DestinationRegion string
    The Destination region to place snapshot copy.
    KmsKeyId string
    KMS key ID.
    PresignedUrl string
    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.
    Timeouts ClusterSnapshotCopyTimeouts
    SourceDbClusterSnapshotIdentifier string
    Identifier of the source snapshot.
    TargetDbClusterSnapshotIdentifier string

    Identifier for the snapshot.

    The following arguments are optional:

    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DestinationRegion string
    The Destination region to place snapshot copy.
    KmsKeyId string
    KMS key ID.
    PresignedUrl string
    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.
    Timeouts ClusterSnapshotCopyTimeoutsArgs
    sourceDbClusterSnapshotIdentifier String
    Identifier of the source snapshot.
    targetDbClusterSnapshotIdentifier String

    Identifier for the snapshot.

    The following arguments are optional:

    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    destinationRegion String
    The Destination region to place snapshot copy.
    kmsKeyId String
    KMS key ID.
    presignedUrl String
    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.
    timeouts ClusterSnapshotCopyTimeouts
    sourceDbClusterSnapshotIdentifier string
    Identifier of the source snapshot.
    targetDbClusterSnapshotIdentifier string

    Identifier for the snapshot.

    The following arguments are optional:

    copyTags boolean
    Whether to copy existing tags. Defaults to false.
    destinationRegion string
    The Destination region to place snapshot copy.
    kmsKeyId string
    KMS key ID.
    presignedUrl string
    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.
    timeouts ClusterSnapshotCopyTimeouts
    source_db_cluster_snapshot_identifier str
    Identifier of the source snapshot.
    target_db_cluster_snapshot_identifier str

    Identifier for the snapshot.

    The following arguments are optional:

    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.
    presigned_url str
    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.
    timeouts ClusterSnapshotCopyTimeoutsArgs
    sourceDbClusterSnapshotIdentifier String
    Identifier of the source snapshot.
    targetDbClusterSnapshotIdentifier String

    Identifier for the snapshot.

    The following arguments are optional:

    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    destinationRegion String
    The Destination region to place snapshot copy.
    kmsKeyId String
    KMS key ID.
    presignedUrl String
    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.
    timeouts Property Map

    Outputs

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

    AllocatedStorage int
    Specifies the allocated storage size in gigabytes (GB).
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    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.
    LicenseModel string
    License model information for the restored DB instance.
    SnapshotType string
    StorageEncrypted bool
    Specifies whether the DB cluster snapshot is encrypted.
    StorageType string
    Specifies the storage type associated with DB cluster 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 cluster snapshot.
    AllocatedStorage int
    Specifies the allocated storage size in gigabytes (GB).
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    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.
    LicenseModel string
    License model information for the restored DB instance.
    SnapshotType string
    StorageEncrypted bool
    Specifies whether the DB cluster snapshot is encrypted.
    StorageType string
    Specifies the storage type associated with DB cluster 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 cluster snapshot.
    allocatedStorage Integer
    Specifies the allocated storage size in gigabytes (GB).
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    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.
    licenseModel String
    License model information for the restored DB instance.
    snapshotType String
    storageEncrypted Boolean
    Specifies whether the DB cluster snapshot is encrypted.
    storageType String
    Specifies the storage type associated with DB cluster 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 cluster snapshot.
    allocatedStorage number
    Specifies the allocated storage size in gigabytes (GB).
    dbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    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.
    licenseModel string
    License model information for the restored DB instance.
    snapshotType string
    storageEncrypted boolean
    Specifies whether the DB cluster snapshot is encrypted.
    storageType string
    Specifies the storage type associated with DB cluster 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 cluster snapshot.
    allocated_storage int
    Specifies the allocated storage size in gigabytes (GB).
    db_cluster_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    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.
    license_model str
    License model information for the restored DB instance.
    snapshot_type str
    storage_encrypted bool
    Specifies whether the DB cluster snapshot is encrypted.
    storage_type str
    Specifies the storage type associated with DB cluster 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 cluster snapshot.
    allocatedStorage Number
    Specifies the allocated storage size in gigabytes (GB).
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    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.
    licenseModel String
    License model information for the restored DB instance.
    snapshotType String
    storageEncrypted Boolean
    Specifies whether the DB cluster snapshot is encrypted.
    storageType String
    Specifies the storage type associated with DB cluster 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 cluster snapshot.

    Look up Existing ClusterSnapshotCopy Resource

    Get an existing ClusterSnapshotCopy 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?: ClusterSnapshotCopyState, opts?: CustomResourceOptions): ClusterSnapshotCopy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        copy_tags: Optional[bool] = None,
        db_cluster_snapshot_arn: Optional[str] = None,
        destination_region: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        license_model: Optional[str] = None,
        presigned_url: Optional[str] = None,
        shared_accounts: Optional[Sequence[str]] = None,
        snapshot_type: Optional[str] = None,
        source_db_cluster_snapshot_identifier: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_db_cluster_snapshot_identifier: Optional[str] = None,
        timeouts: Optional[ClusterSnapshotCopyTimeoutsArgs] = None,
        vpc_id: Optional[str] = None) -> ClusterSnapshotCopy
    func GetClusterSnapshotCopy(ctx *Context, name string, id IDInput, state *ClusterSnapshotCopyState, opts ...ResourceOption) (*ClusterSnapshotCopy, error)
    public static ClusterSnapshotCopy Get(string name, Input<string> id, ClusterSnapshotCopyState? state, CustomResourceOptions? opts = null)
    public static ClusterSnapshotCopy get(String name, Output<String> id, ClusterSnapshotCopyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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).
    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    DestinationRegion string
    The Destination region to place snapshot copy.
    Engine string
    Specifies the name of the database engine.
    EngineVersion string
    Specifies the version of the database engine.
    KmsKeyId string
    KMS key ID.
    LicenseModel string
    License model information for the restored DB instance.
    PresignedUrl string
    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
    SourceDbClusterSnapshotIdentifier string
    Identifier of the source snapshot.
    StorageEncrypted bool
    Specifies whether the DB cluster snapshot is encrypted.
    StorageType string
    Specifies the storage type associated with DB cluster 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.

    TargetDbClusterSnapshotIdentifier string

    Identifier for the snapshot.

    The following arguments are optional:

    Timeouts ClusterSnapshotCopyTimeouts
    VpcId string
    Provides the VPC ID associated with the DB cluster snapshot.
    AllocatedStorage int
    Specifies the allocated storage size in gigabytes (GB).
    CopyTags bool
    Whether to copy existing tags. Defaults to false.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    DestinationRegion string
    The Destination region to place snapshot copy.
    Engine string
    Specifies the name of the database engine.
    EngineVersion string
    Specifies the version of the database engine.
    KmsKeyId string
    KMS key ID.
    LicenseModel string
    License model information for the restored DB instance.
    PresignedUrl string
    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
    SourceDbClusterSnapshotIdentifier string
    Identifier of the source snapshot.
    StorageEncrypted bool
    Specifies whether the DB cluster snapshot is encrypted.
    StorageType string
    Specifies the storage type associated with DB cluster 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.

    TargetDbClusterSnapshotIdentifier string

    Identifier for the snapshot.

    The following arguments are optional:

    Timeouts ClusterSnapshotCopyTimeoutsArgs
    VpcId string
    Provides the VPC ID associated with the DB cluster snapshot.
    allocatedStorage Integer
    Specifies the allocated storage size in gigabytes (GB).
    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    destinationRegion String
    The Destination region to place snapshot copy.
    engine String
    Specifies the name of the database engine.
    engineVersion String
    Specifies the version of the database engine.
    kmsKeyId String
    KMS key ID.
    licenseModel String
    License model information for the restored DB instance.
    presignedUrl String
    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
    sourceDbClusterSnapshotIdentifier String
    Identifier of the source snapshot.
    storageEncrypted Boolean
    Specifies whether the DB cluster snapshot is encrypted.
    storageType String
    Specifies the storage type associated with DB cluster 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.

    targetDbClusterSnapshotIdentifier String

    Identifier for the snapshot.

    The following arguments are optional:

    timeouts ClusterSnapshotCopyTimeouts
    vpcId String
    Provides the VPC ID associated with the DB cluster snapshot.
    allocatedStorage number
    Specifies the allocated storage size in gigabytes (GB).
    copyTags boolean
    Whether to copy existing tags. Defaults to false.
    dbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    destinationRegion string
    The Destination region to place snapshot copy.
    engine string
    Specifies the name of the database engine.
    engineVersion string
    Specifies the version of the database engine.
    kmsKeyId string
    KMS key ID.
    licenseModel string
    License model information for the restored DB instance.
    presignedUrl string
    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
    sourceDbClusterSnapshotIdentifier string
    Identifier of the source snapshot.
    storageEncrypted boolean
    Specifies whether the DB cluster snapshot is encrypted.
    storageType string
    Specifies the storage type associated with DB cluster 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.

    targetDbClusterSnapshotIdentifier string

    Identifier for the snapshot.

    The following arguments are optional:

    timeouts ClusterSnapshotCopyTimeouts
    vpcId string
    Provides the VPC ID associated with the DB cluster snapshot.
    allocated_storage int
    Specifies the allocated storage size in gigabytes (GB).
    copy_tags bool
    Whether to copy existing tags. Defaults to false.
    db_cluster_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    destination_region str
    The Destination region to place snapshot copy.
    engine str
    Specifies the name of the database engine.
    engine_version str
    Specifies the version of the database engine.
    kms_key_id str
    KMS key ID.
    license_model str
    License model information for the restored DB instance.
    presigned_url str
    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_cluster_snapshot_identifier str
    Identifier of the source snapshot.
    storage_encrypted bool
    Specifies whether the DB cluster snapshot is encrypted.
    storage_type str
    Specifies the storage type associated with DB cluster 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_db_cluster_snapshot_identifier str

    Identifier for the snapshot.

    The following arguments are optional:

    timeouts ClusterSnapshotCopyTimeoutsArgs
    vpc_id str
    Provides the VPC ID associated with the DB cluster snapshot.
    allocatedStorage Number
    Specifies the allocated storage size in gigabytes (GB).
    copyTags Boolean
    Whether to copy existing tags. Defaults to false.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    destinationRegion String
    The Destination region to place snapshot copy.
    engine String
    Specifies the name of the database engine.
    engineVersion String
    Specifies the version of the database engine.
    kmsKeyId String
    KMS key ID.
    licenseModel String
    License model information for the restored DB instance.
    presignedUrl String
    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
    sourceDbClusterSnapshotIdentifier String
    Identifier of the source snapshot.
    storageEncrypted Boolean
    Specifies whether the DB cluster snapshot is encrypted.
    storageType String
    Specifies the storage type associated with DB cluster 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.

    targetDbClusterSnapshotIdentifier String

    Identifier for the snapshot.

    The following arguments are optional:

    timeouts Property Map
    vpcId String
    Provides the VPC ID associated with the DB cluster snapshot.

    Supporting Types

    ClusterSnapshotCopyTimeouts, ClusterSnapshotCopyTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import aws_rds_cluster_snapshot_copy using the id. For example:

    $ pulumi import aws:rds/clusterSnapshotCopy:ClusterSnapshotCopy 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.66.3 published on Monday, Jan 13, 2025 by Pulumi
    pulumi/pulumi-aws