pulumi-aws-kotlin/com.pulumi.aws.docdb.kotlin/Cluster

Cluster

Manages a DocDB Cluster. Changes to a DocDB 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());
    }
}

Import

DocDB Clusters can be imported using the cluster_identifier, e.g.,

$ pulumi import aws:docdb/cluster:Cluster docdb_cluster docdb-prod-cluster

Properties

applyImmediately

val applyImmediately: Output<Boolean>

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

arn

val arn: Output<String>

Amazon Resource Name (ARN) of cluster

availabilityZones

val availabilityZones: Output<List<String>>

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriod

val backupRetentionPeriod: Output<Int>?

The days to retain backups for. Default 1

clusterIdentifier

val clusterIdentifier: Output<String>

The cluster identifier. If omitted, the provider will assign a random, unique identifier.

clusterIdentifierPrefix

val clusterIdentifierPrefix: Output<String>

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

clusterMembers

val clusterMembers: Output<List<String>>

List of DocDB Instances that are a part of this cluster

clusterResourceId

val clusterResourceId: Output<String>

The DocDB Cluster Resource ID

dbClusterParameterGroupName

val dbClusterParameterGroupName: Output<String>

A cluster parameter group to associate with the cluster.

dbSubnetGroupName

val dbSubnetGroupName: Output<String>

A DB subnet group to associate with this DB instance.

deletionProtection

val deletionProtection: Output<Boolean>?

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enabledCloudwatchLogsExports

val enabledCloudwatchLogsExports: Output<List<String>>?

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.

endpoint

val endpoint: Output<String>

The DNS address of the DocDB instance

engine

val engine: Output<String>?

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb

engineVersion

val engineVersion: Output<String>

The database engine version. Updating this argument results in an outage.

finalSnapshotIdentifier

val finalSnapshotIdentifier: Output<String>?

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

globalClusterIdentifier

val globalClusterIdentifier: Output<String>?

The global cluster identifier specified on aws.docdb.GlobalCluster.

hostedZoneId

val hostedZoneId: Output<String>

The Route53 Hosted Zone ID of the endpoint

val id: Output<String>

kmsKeyId

val kmsKeyId: Output<String>

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

masterPassword

val masterPassword: Output<String>?

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 DocDB Naming Constraints.

masterUsername

val masterUsername: Output<String>

Username for the master DB user.

port

val port: Output<Int>?

The port on which the DB accepts connections

preferredBackupWindow

val preferredBackupWindow: Output<String>

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

preferredMaintenanceWindow

val preferredMaintenanceWindow: Output<String>

The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

readerEndpoint

val readerEndpoint: Output<String>

A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas

skipFinalSnapshot

val skipFinalSnapshot: Output<Boolean>?

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.

snapshotIdentifier

val snapshotIdentifier: Output<String>?

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.

storageEncrypted

val storageEncrypted: Output<Boolean>?

Specifies whether the DB cluster is encrypted. The default is false.