Skip to content

Resource: awsDocdbClusterSnapshot

Manages a DocDB database cluster snapshot for DocDB clusters.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.docdbClusterSnapshot.DocdbClusterSnapshot(this, "example", {
  dbClusterIdentifier: "${aws_docdb_cluster.example.id}",
  dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});

Argument Reference

The following arguments are supported:

  • dbClusterIdentifier - (Required) The DocDB Cluster Identifier from which to take the snapshot.
  • dbClusterSnapshotIdentifier - (Required) The Identifier for the snapshot.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • availabilityZones - List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.
  • dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.
  • engine - Specifies the name of the database engine.
  • engineVersion - Version of the database engine for this DocDB cluster snapshot.
  • kmsKeyId - If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.
  • port - Port that the DocDB cluster was listening on at the time of the snapshot.
  • sourceDbClusterSnapshotIdentifier - The DocDB Cluster Snapshot Arn that the DocDB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy.
  • storageEncrypted - Specifies whether the DocDB cluster snapshot is encrypted.
  • status - The status of this DocDB Cluster Snapshot.
  • vpcId - The VPC ID associated with the DocDB cluster snapshot.

Timeouts

Configuration options:

  • create - (Default 20M)

Import

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

$ terraform import aws_docdb_cluster_snapshot.example my-cluster-snapshot