Cluster
Provides an DocumentDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a 1. You do not designate a primary and subsequent replicas. Instead, you simply add DocumentDB Instances and DocumentDB manages the replication. You can use the 3 meta-parameter to make multiple instances and join them all to the same DocumentDB Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.
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 com.pulumi.aws.docdb.ClusterInstance;
import com.pulumi.aws.docdb.ClusterInstanceArgs;
import com.pulumi.codegen.internal.KeyedValue;
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 default_ = new Cluster("default", ClusterArgs.builder()
.clusterIdentifier("docdb-cluster-demo")
.availabilityZones(
"us-west-2a",
"us-west-2b",
"us-west-2c")
.masterUsername("foo")
.masterPassword("barbut8chars")
.build());
for (var i = 0; i < 2; i++) {
new ClusterInstance("clusterInstances-" + i, ClusterInstanceArgs.builder()
.identifier(String.format("docdb-cluster-demo-%s", range.value()))
.clusterIdentifier(default_.id())
.instanceClass("db.r5.large")
.build());
}
}
}Import
DocumentDB Cluster Instances can be imported using the identifier, e.g.,
$ pulumi import aws:docdb/clusterInstance:ClusterInstance prod_instance_1 aurora-cluster-instance-1Properties
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.
The EC2 Availability Zone that the DB instance is created in. See docs about the details.
(Optional) The identifier of the CA certificate for the DB instance.
The identifier of the aws.docdb.Cluster in which to launch this instance.
The region-unique, immutable identifier for the DB instance.
The DB subnet group to associate with this DB instance.
A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See docs (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.
The database engine version
The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.
The daily time range during which automated backups are created if automated backups are enabled.
The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
Specifies whether the DB cluster is encrypted.