Cluster Args
data class ClusterArgs(val applyImmediately: Output<Boolean>? = null, val availabilityZones: Output<List<String>>? = null, val backupRetentionPeriod: Output<Int>? = null, val clusterIdentifier: Output<String>? = null, val clusterIdentifierPrefix: Output<String>? = null, val clusterMembers: Output<List<String>>? = null, val dbClusterParameterGroupName: Output<String>? = null, val dbSubnetGroupName: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val enabledCloudwatchLogsExports: Output<List<String>>? = null, val engine: Output<String>? = null, val engineVersion: Output<String>? = null, val finalSnapshotIdentifier: Output<String>? = null, val globalClusterIdentifier: Output<String>? = null, val kmsKeyId: Output<String>? = null, val masterPassword: Output<String>? = null, val masterUsername: Output<String>? = null, val port: Output<Int>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val skipFinalSnapshot: Output<Boolean>? = null, val snapshotIdentifier: Output<String>? = null, val storageEncrypted: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ClusterArgs>
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_immediately
can 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());
}
}
Content copied to clipboard
Import
DocumentDB Clusters can be imported using the cluster_identifier
, e.g.,
$ pulumi import aws:docdb/cluster:Cluster docdb_cluster docdb-prod-cluster
Content copied to clipboard
Constructors
Link copied to clipboard
fun ClusterArgs(applyImmediately: Output<Boolean>? = null, availabilityZones: Output<List<String>>? = null, backupRetentionPeriod: Output<Int>? = null, clusterIdentifier: Output<String>? = null, clusterIdentifierPrefix: Output<String>? = null, clusterMembers: Output<List<String>>? = null, dbClusterParameterGroupName: Output<String>? = null, dbSubnetGroupName: Output<String>? = null, deletionProtection: Output<Boolean>? = null, enabledCloudwatchLogsExports: Output<List<String>>? = null, engine: Output<String>? = null, engineVersion: Output<String>? = null, finalSnapshotIdentifier: Output<String>? = null, globalClusterIdentifier: Output<String>? = null, kmsKeyId: Output<String>? = null, masterPassword: Output<String>? = null, masterUsername: Output<String>? = null, port: Output<Int>? = null, preferredBackupWindow: Output<String>? = null, preferredMaintenanceWindow: Output<String>? = null, skipFinalSnapshot: Output<Boolean>? = null, snapshotIdentifier: Output<String>? = null, storageEncrypted: Output<Boolean>? = null, tags: Output<Map<String, String>>? = null, vpcSecurityGroupIds: Output<List<String>>? = null)
Functions
Properties
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard