Cluster
Manages a DocumentDB Cluster. Changes to a DocumentDB Cluster can occur when you manually change a parameter, such as port, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).
Note: using
apply_immediatelycan result in a brief downtime as the server reboots.
Example Usage
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.Cluster;
import com.pulumi.aws.docdb.ClusterArgs;
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 docdb = new Cluster("docdb", ClusterArgs.builder()
.backupRetentionPeriod(5)
.clusterIdentifier("my-docdb-cluster")
.engine("docdb")
.masterPassword("mustbeeightchars")
.masterUsername("foo")
.preferredBackupWindow("07:00-09:00")
.skipFinalSnapshot(true)
.build());
}
}Import
Using pulumi import, import DocumentDB Clusters using the cluster_identifier. For example:
$ pulumi import aws:docdb/cluster:Cluster docdb_cluster docdb-prod-clusterConstructors
Functions
Properties
Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.