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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const docdb = new aws.docdb.Cluster("docdb", {
clusterIdentifier: "my-docdb-cluster",
engine: "docdb",
masterUsername: "foo",
masterPassword: "mustbeeightchars",
backupRetentionPeriod: 5,
preferredBackupWindow: "07:00-09:00",
skipFinalSnapshot: true,
});import pulumi
import pulumi_aws as aws
docdb = aws.docdb.Cluster("docdb",
cluster_identifier="my-docdb-cluster",
engine="docdb",
master_username="foo",
master_password="mustbeeightchars",
backup_retention_period=5,
preferred_backup_window="07:00-09:00",
skip_final_snapshot=True)using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var docdb = new Aws.DocDB.Cluster("docdb", new()
{
ClusterIdentifier = "my-docdb-cluster",
Engine = "docdb",
MasterUsername = "foo",
MasterPassword = "mustbeeightchars",
BackupRetentionPeriod = 5,
PreferredBackupWindow = "07:00-09:00",
SkipFinalSnapshot = true,
});
});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.NewCluster(ctx, "docdb", &docdb.ClusterArgs{
ClusterIdentifier: pulumi.String("my-docdb-cluster"),
Engine: pulumi.String("docdb"),
MasterUsername: pulumi.String("foo"),
MasterPassword: pulumi.String("mustbeeightchars"),
BackupRetentionPeriod: pulumi.Int(5),
PreferredBackupWindow: pulumi.String("07:00-09:00"),
SkipFinalSnapshot: pulumi.Bool(true),
})
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.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()
.clusterIdentifier("my-docdb-cluster")
.engine("docdb")
.masterUsername("foo")
.masterPassword("mustbeeightchars")
.backupRetentionPeriod(5)
.preferredBackupWindow("07:00-09:00")
.skipFinalSnapshot(true)
.build());
}
}resources:
docdb:
type: aws:docdb:Cluster
properties:
clusterIdentifier: my-docdb-cluster
engine: docdb
masterUsername: foo
masterPassword: mustbeeightchars
backupRetentionPeriod: 5
preferredBackupWindow: 07:00-09:00
skipFinalSnapshot: trueImport
Using pulumi import, import DocumentDB Clusters using the cluster_identifier. For example:
$ pulumi import aws:docdb/cluster:Cluster docdb_cluster docdb-prod-clusterConstructors
Properties
A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
The days to retain backups for. Default 1
The cluster identifier. If omitted, the provider will assign a random, unique identifier.
Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
List of DocumentDB Instances that are a part of this cluster
A cluster parameter group to associate with the cluster.
A DB subnet group to associate with this DB instance.
A boolean value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Defaults to false.
List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.
The database engine version. Updating this argument results in an outage.
The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
The global cluster identifier specified on aws.docdb.GlobalCluster.
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints. Conflicts with master_password_wo.
Username for the master DB user.
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00
The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
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.
Specifies whether the DB cluster is encrypted. The default is false.
The storage type to associate with the DB cluster. Valid values: standard, iopt1.
List of VPC security groups to associate with the Cluster