ClusterSnapshot

class ClusterSnapshot : KotlinCustomResource

Manages a DocumentDB database cluster snapshot for DocumentDB clusters.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.docdb.ClusterSnapshot("example", {
dbClusterIdentifier: exampleAwsDocdbCluster.id,
dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});
import pulumi
import pulumi_aws as aws
example = aws.docdb.ClusterSnapshot("example",
db_cluster_identifier=example_aws_docdb_cluster["id"],
db_cluster_snapshot_identifier="resourcetestsnapshot1234")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.DocDB.ClusterSnapshot("example", new()
{
DbClusterIdentifier = exampleAwsDocdbCluster.Id,
DbClusterSnapshotIdentifier = "resourcetestsnapshot1234",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/docdb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := docdb.NewClusterSnapshot(ctx, "example", &docdb.ClusterSnapshotArgs{
DbClusterIdentifier: pulumi.Any(exampleAwsDocdbCluster.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.docdb.ClusterSnapshot;
import com.pulumi.aws.docdb.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(exampleAwsDocdbCluster.id())
.dbClusterSnapshotIdentifier("resourcetestsnapshot1234")
.build());
}
}
resources:
example:
type: aws:docdb:ClusterSnapshot
properties:
dbClusterIdentifier: ${exampleAwsDocdbCluster.id}
dbClusterSnapshotIdentifier: resourcetestsnapshot1234

Import

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

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

Properties

Link copied to clipboard

List of EC2 Availability Zones that instances in the DocumentDB cluster snapshot can be restored in.

Link copied to clipboard

The DocumentDB Cluster Identifier from which to take the snapshot.

Link copied to clipboard

The Amazon Resource Name (ARN) for the DocumentDB Cluster Snapshot.

Link copied to clipboard

The Identifier for the snapshot.

Link copied to clipboard
val engine: Output<String>

Specifies the name of the database engine.

Link copied to clipboard
val engineVersion: Output<String>

Version of the database engine for this DocumentDB cluster snapshot.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kmsKeyId: Output<String>

If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocumentDB cluster snapshot.

Link copied to clipboard
val port: Output<Int>

Port that the DocumentDB cluster was listening on at the time of the snapshot.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val snapshotType: Output<String>
Link copied to clipboard
Link copied to clipboard
val status: Output<String>

The status of this DocumentDB Cluster Snapshot.

Link copied to clipboard

Specifies whether the DocumentDB cluster snapshot is encrypted.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val vpcId: Output<String>

The VPC ID associated with the DocumentDB cluster snapshot.