AWS Classic v5.34.0, Mar 30 23

aws.rds.ClusterSnapshot

Manages an RDS database cluster snapshot for Aurora clusters. For managing RDS database instance snapshots, see the aws.rds.Snapshot resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.ClusterSnapshot("example", new()
    {
        DbClusterIdentifier = aws_rds_cluster.Example.Id,
        DbClusterSnapshotIdentifier = "resourcetestsnapshot1234",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewClusterSnapshot(ctx, "example", &rds.ClusterSnapshotArgs{
			DbClusterIdentifier:         pulumi.Any(aws_rds_cluster.Example.Id),
			DbClusterSnapshotIdentifier: pulumi.String("resourcetestsnapshot1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ClusterSnapshot;
import com.pulumi.aws.rds.ClusterSnapshotArgs;
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 ClusterSnapshot("example", ClusterSnapshotArgs.builder()        
            .dbClusterIdentifier(aws_rds_cluster.example().id())
            .dbClusterSnapshotIdentifier("resourcetestsnapshot1234")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.rds.ClusterSnapshot("example",
    db_cluster_identifier=aws_rds_cluster["example"]["id"],
    db_cluster_snapshot_identifier="resourcetestsnapshot1234")

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

const example = new aws.rds.ClusterSnapshot("example", {
    dbClusterIdentifier: aws_rds_cluster.example.id,
    dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});

resources:
  example:
    type: aws:rds:ClusterSnapshot
    properties:
      dbClusterIdentifier: ${aws_rds_cluster.example.id}
      dbClusterSnapshotIdentifier: resourcetestsnapshot1234

Create ClusterSnapshot Resource

new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: CustomResourceOptions);

@overload
def ClusterSnapshot(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    db_cluster_identifier: Optional[str] = None,
                    db_cluster_snapshot_identifier: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
@overload
def ClusterSnapshot(resource_name: str,
                    args: ClusterSnapshotArgs,
                    opts: Optional[ResourceOptions] = None)

func NewClusterSnapshot(ctx *Context, name string, args ClusterSnapshotArgs, opts ...ResourceOption) (*ClusterSnapshot, error)

public ClusterSnapshot(string name, ClusterSnapshotArgs args, CustomResourceOptions? opts = null)

public ClusterSnapshot(String name, ClusterSnapshotArgs args)
public ClusterSnapshot(String name, ClusterSnapshotArgs args, CustomResourceOptions options)

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

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

name string: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClusterSnapshotArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ClusterSnapshot Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ClusterSnapshot resource accepts the following input properties:

DbClusterIdentifier string: The DB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.
Tags Dictionary<string, string>: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

DbClusterIdentifier string: The DB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.
Tags map[string]string: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

dbClusterIdentifier String: The DB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.
tags Map<String,String>: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

dbClusterIdentifier string: The DB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotIdentifier string: The Identifier for the snapshot.
tags {[key: string]: string}: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

db_cluster_identifier str: The DB Cluster Identifier from which to take the snapshot.
db_cluster_snapshot_identifier str: The Identifier for the snapshot.
tags Mapping[str, str]: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

dbClusterIdentifier String: The DB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.
tags Map<String>: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

AllocatedStorage int: Allocated storage size in gigabytes (GB).
AvailabilityZones List<string>: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
Engine string: Name of the database engine.
EngineVersion string: Version of the database engine for this DB cluster snapshot.
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
LicenseModel string: License model information for the restored DB cluster.
Port int: Port that the DB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DB Cluster Snapshot.
StorageEncrypted bool: Whether the DB cluster snapshot is encrypted.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
VpcId string: The VPC ID associated with the DB cluster snapshot.

AllocatedStorage int: Allocated storage size in gigabytes (GB).
AvailabilityZones []string: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
Engine string: Name of the database engine.
EngineVersion string: Version of the database engine for this DB cluster snapshot.
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
LicenseModel string: License model information for the restored DB cluster.
Port int: Port that the DB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DB Cluster Snapshot.
StorageEncrypted bool: Whether the DB cluster snapshot is encrypted.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
VpcId string: The VPC ID associated with the DB cluster snapshot.

allocatedStorage Integer: Allocated storage size in gigabytes (GB).
availabilityZones List<String>: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
engine String: Name of the database engine.
engineVersion String: Version of the database engine for this DB cluster snapshot.
id String: The provider-assigned unique ID for this managed resource.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
licenseModel String: License model information for the restored DB cluster.
port Integer: Port that the DB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DB Cluster Snapshot.
storageEncrypted Boolean: Whether the DB cluster snapshot is encrypted.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcId String: The VPC ID associated with the DB cluster snapshot.

allocatedStorage number: Allocated storage size in gigabytes (GB).
availabilityZones string[]: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
dbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
engine string: Name of the database engine.
engineVersion string: Version of the database engine for this DB cluster snapshot.
id string: The provider-assigned unique ID for this managed resource.
kmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
licenseModel string: License model information for the restored DB cluster.
port number: Port that the DB cluster was listening on at the time of the snapshot.
snapshotType string
sourceDbClusterSnapshotArn string
status string: The status of this DB Cluster Snapshot.
storageEncrypted boolean: Whether the DB cluster snapshot is encrypted.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcId string: The VPC ID associated with the DB cluster snapshot.

allocated_storage int: Allocated storage size in gigabytes (GB).
availability_zones Sequence[str]: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
db_cluster_snapshot_arn str: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
engine str: Name of the database engine.
engine_version str: Version of the database engine for this DB cluster snapshot.
id str: The provider-assigned unique ID for this managed resource.
kms_key_id str: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
license_model str: License model information for the restored DB cluster.
port int: Port that the DB cluster was listening on at the time of the snapshot.
snapshot_type str
source_db_cluster_snapshot_arn str
status str: The status of this DB Cluster Snapshot.
storage_encrypted bool: Whether the DB cluster snapshot is encrypted.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpc_id str: The VPC ID associated with the DB cluster snapshot.

allocatedStorage Number: Allocated storage size in gigabytes (GB).
availabilityZones List<String>: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
engine String: Name of the database engine.
engineVersion String: Version of the database engine for this DB cluster snapshot.
id String: The provider-assigned unique ID for this managed resource.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
licenseModel String: License model information for the restored DB cluster.
port Number: Port that the DB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DB Cluster Snapshot.
storageEncrypted Boolean: Whether the DB cluster snapshot is encrypted.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcId String: The VPC ID associated with the DB cluster snapshot.

Look up Existing ClusterSnapshot Resource

Get an existing ClusterSnapshot 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?: ClusterSnapshotState, opts?: CustomResourceOptions): ClusterSnapshot

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        availability_zones: Optional[Sequence[str]] = None,
        db_cluster_identifier: Optional[str] = None,
        db_cluster_snapshot_arn: Optional[str] = None,
        db_cluster_snapshot_identifier: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        license_model: Optional[str] = None,
        port: Optional[int] = None,
        snapshot_type: Optional[str] = None,
        source_db_cluster_snapshot_arn: Optional[str] = None,
        status: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None) -> ClusterSnapshot

func GetClusterSnapshot(ctx *Context, name string, id IDInput, state *ClusterSnapshotState, opts ...ResourceOption) (*ClusterSnapshot, error)

public static ClusterSnapshot Get(string name, Input<string> id, ClusterSnapshotState? state, CustomResourceOptions? opts = null)

public static ClusterSnapshot get(String name, Output<String> id, ClusterSnapshotState 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: Allocated storage size in gigabytes (GB).
AvailabilityZones List<string>: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
DbClusterIdentifier string: The DB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.
Engine string: Name of the database engine.
EngineVersion string: Version of the database engine for this DB cluster snapshot.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
LicenseModel string: License model information for the restored DB cluster.
Port int: Port that the DB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DB Cluster Snapshot.
StorageEncrypted bool: Whether the DB cluster snapshot is encrypted.
Tags Dictionary<string, string>: A map of tags to assign to the DB cluster. 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.
VpcId string: The VPC ID associated with the DB cluster snapshot.

AllocatedStorage int: Allocated storage size in gigabytes (GB).
AvailabilityZones []string: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
DbClusterIdentifier string: The DB Cluster Identifier from which to take the snapshot.
DbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
DbClusterSnapshotIdentifier string: The Identifier for the snapshot.
Engine string: Name of the database engine.
EngineVersion string: Version of the database engine for this DB cluster snapshot.
KmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
LicenseModel string: License model information for the restored DB cluster.
Port int: Port that the DB cluster was listening on at the time of the snapshot.
SnapshotType string
SourceDbClusterSnapshotArn string
Status string: The status of this DB Cluster Snapshot.
StorageEncrypted bool: Whether the DB cluster snapshot is encrypted.
Tags map[string]string: A map of tags to assign to the DB cluster. 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.
VpcId string: The VPC ID associated with the DB cluster snapshot.

allocatedStorage Integer: Allocated storage size in gigabytes (GB).
availabilityZones List<String>: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
dbClusterIdentifier String: The DB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.
engine String: Name of the database engine.
engineVersion String: Version of the database engine for this DB cluster snapshot.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
licenseModel String: License model information for the restored DB cluster.
port Integer: Port that the DB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DB Cluster Snapshot.
storageEncrypted Boolean: Whether the DB cluster snapshot is encrypted.
tags Map<String,String>: A map of tags to assign to the DB cluster. 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.
vpcId String: The VPC ID associated with the DB cluster snapshot.

allocatedStorage number: Allocated storage size in gigabytes (GB).
availabilityZones string[]: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
dbClusterIdentifier string: The DB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotArn string: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
dbClusterSnapshotIdentifier string: The Identifier for the snapshot.
engine string: Name of the database engine.
engineVersion string: Version of the database engine for this DB cluster snapshot.
kmsKeyId string: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
licenseModel string: License model information for the restored DB cluster.
port number: Port that the DB cluster was listening on at the time of the snapshot.
snapshotType string
sourceDbClusterSnapshotArn string
status string: The status of this DB Cluster Snapshot.
storageEncrypted boolean: Whether the DB cluster snapshot is encrypted.
tags {[key: string]: string}: A map of tags to assign to the DB cluster. 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.
vpcId string: The VPC ID associated with the DB cluster snapshot.

allocated_storage int: Allocated storage size in gigabytes (GB).
availability_zones Sequence[str]: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
db_cluster_identifier str: The DB Cluster Identifier from which to take the snapshot.
db_cluster_snapshot_arn str: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
db_cluster_snapshot_identifier str: The Identifier for the snapshot.
engine str: Name of the database engine.
engine_version str: Version of the database engine for this DB cluster snapshot.
kms_key_id str: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
license_model str: License model information for the restored DB cluster.
port int: Port that the DB cluster was listening on at the time of the snapshot.
snapshot_type str
source_db_cluster_snapshot_arn str
status str: The status of this DB Cluster Snapshot.
storage_encrypted bool: Whether the DB cluster snapshot is encrypted.
tags Mapping[str, str]: A map of tags to assign to the DB cluster. 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.
vpc_id str: The VPC ID associated with the DB cluster snapshot.

allocatedStorage Number: Allocated storage size in gigabytes (GB).
availabilityZones List<String>: List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
dbClusterIdentifier String: The DB Cluster Identifier from which to take the snapshot.
dbClusterSnapshotArn String: The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
dbClusterSnapshotIdentifier String: The Identifier for the snapshot.
engine String: Name of the database engine.
engineVersion String: Version of the database engine for this DB cluster snapshot.
kmsKeyId String: If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
licenseModel String: License model information for the restored DB cluster.
port Number: Port that the DB cluster was listening on at the time of the snapshot.
snapshotType String
sourceDbClusterSnapshotArn String
status String: The status of this DB Cluster Snapshot.
storageEncrypted Boolean: Whether the DB cluster snapshot is encrypted.
tags Map<String>: A map of tags to assign to the DB cluster. 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.
vpcId String: The VPC ID associated with the DB cluster snapshot.

Import

aws_db_cluster_snapshot can be imported by using the cluster snapshot identifier, e.g.,

 $ pulumi import aws:rds/clusterSnapshot:ClusterSnapshot example my-cluster-snapshot

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.