ClusterSnapshot class

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/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_docdb_clustersnapshot" "example" {
  db_cluster_identifier          = exampleAwsDocdbCluster.id
  db_cluster_snapshot_identifier = "resourcetestsnapshot1234"
}
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.ArrayList;
import java.util.Arrays;
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.ClusterSnapshot using the cluster snapshot identifier. For example:

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

Constructors

ClusterSnapshot(String name, {ClusterSnapshotArgs? args, CustomResourceOptions? options})
Creates a new ClusterSnapshot. name The Pulumi resource name. args Arguments used to configure this ClusterSnapshot. The set of arguments for ClusterSnapshot. options Resource options controlling this resource's behavior.
ClusterSnapshot.reference(String urn)
Creates a typed reference to an existing ClusterSnapshot resource.

Properties

availabilityZones ↔ Output<List<String>>
List of EC2 Availability Zones that instances in the DocumentDB cluster snapshot can be restored in.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dbClusterIdentifier ↔ Output<String>
The DocumentDB Cluster Identifier from which to take the snapshot.
latefinal
dbClusterSnapshotArn ↔ Output<String>
ARN for the DocumentDB Cluster Snapshot.
latefinal
dbClusterSnapshotIdentifier ↔ Output<String>
The Identifier for the snapshot.
latefinal
engine ↔ Output<String>
Specifies the name of the database engine.
latefinal
engineVersion ↔ Output<String>
Version of the database engine for this DocumentDB cluster snapshot.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kmsKeyId ↔ Output<String>
If storageEncrypted is true, the AWS KMS key identifier for the encrypted DocumentDB cluster snapshot.
latefinal
port ↔ Output<int>
Port that the DocumentDB cluster was listening on at the time of the snapshot.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snapshotType ↔ Output<String>
latefinal
sourceDbClusterSnapshotArn ↔ Output<String>
latefinal
status ↔ Output<String>
The status of this DocumentDB Cluster Snapshot.
latefinal
storageEncrypted ↔ Output<bool>
Specifies whether the DocumentDB cluster snapshot is encrypted.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcId ↔ Output<String>
The VPC ID associated with the DocumentDB cluster snapshot.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ClusterSnapshotState? state, CustomResourceOptions? options}) → ClusterSnapshot
Gets an existing ClusterSnapshot resource's state with the given name and id.