Amazon DocumentDB Construct Library

---

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

Starting a Clustered Database

To set up a clustered DocumentDB database, define a DatabaseCluster. You must always launch a database in a VPC. Use the vpcSubnets attribute to control whether your instances will be launched privately or publicly:

 Vpc vpc;
 
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .masterUser(Login.builder()
                 .username("myuser") // NOTE: 'admin' is reserved by DocumentDB
                 .excludeCharacters("\"@/:") // optional, defaults to the set "\"@/" and is also used for eventually created rotations
                 .secretName("/myapp/mydocdb/masteruser")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.R5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .build();

By default, the master password will be generated and stored in AWS Secrets Manager with auto-generated description.

Your cluster will be empty by default.

Connecting

To control who can access the cluster, use the .connections attribute. DocumentDB databases have a default port, so you don't need to specify the port:

 DatabaseCluster cluster;
 
 cluster.connections.allowDefaultPortFromAnyIpv4("Open to the world");

The endpoints to access your database cluster will be available as the .clusterEndpoint and .clusterReadEndpoint attributes:

 DatabaseCluster cluster;
 
 String writeAddress = cluster.getClusterEndpoint().getSocketAddress();

If you have existing security groups you would like to add to the cluster, use the addSecurityGroups method. Security groups added in this way will not be managed by the Connections object of the cluster.

 Vpc vpc;
 DatabaseCluster cluster;
 
 
 SecurityGroup securityGroup = SecurityGroup.Builder.create(this, "SecurityGroup")
         .vpc(vpc)
         .build();
 cluster.addSecurityGroups(securityGroup);

Deletion protection

Deletion protection can be enabled on an Amazon DocumentDB cluster to prevent accidental deletion of the cluster:

 Vpc vpc;
 
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .masterUser(Login.builder()
                 .username("myuser")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.R5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .deletionProtection(true)
         .build();

Rotating credentials

When the master password is generated and stored in AWS Secrets Manager, it can be rotated automatically:

 DatabaseCluster cluster;
 
 cluster.addRotationSingleUser();

 DatabaseCluster cluster = DatabaseCluster.Builder.create(stack, "Database")
         .masterUser(Login.builder()
                 .username("docdb")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.R5, InstanceSize.LARGE))
         .vpc(vpc)
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();
 
 cluster.addRotationSingleUser();

The multi user rotation scheme is also available:

 import software.amazon.awscdk.services.secretsmanager.*;
 
 Secret myImportedSecret;
 DatabaseCluster cluster;
 
 
 cluster.addRotationMultiUser("MyUser", RotationMultiUserOptions.builder()
         .secret(myImportedSecret)
         .build());

It's also possible to create user credentials together with the cluster and add rotation:

 DatabaseCluster cluster;
 
 DatabaseSecret myUserSecret = DatabaseSecret.Builder.create(this, "MyUserSecret")
         .username("myuser")
         .masterSecret(cluster.getSecret())
         .build();
 ISecret myUserSecretAttached = myUserSecret.attach(cluster); // Adds DB connections information in the secret
 
 cluster.addRotationMultiUser("MyUser", RotationMultiUserOptions.builder() // Add rotation using the multi user scheme
         .secret(myUserSecretAttached).build());

Note: This user must be created manually in the database using the master credentials. The rotation will start as soon as this user exists.

See also @aws-cdk/aws-secretsmanager for credentials rotation of existing clusters.

Audit and profiler Logs

Sending audit or profiler needs to be configured in two places:

Check / create the needed options in your ParameterGroup for audit and profiler logs.
Enable the corresponding option(s) when creating the DatabaseCluster:

 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.logs.*;
 
 Role myLogsPublishingRole;
 Vpc vpc;
 
 
 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
         .masterUser(Login.builder()
                 .username("myuser")
                 .build())
         .instanceType(InstanceType.of(InstanceClass.R5, InstanceSize.LARGE))
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .vpc(vpc)
         .exportProfilerLogsToCloudWatch(true) // Enable sending profiler logs
         .exportAuditLogsToCloudWatch(true) // Enable sending audit logs
         .cloudWatchLogsRetention(RetentionDays.THREE_MONTHS) // Optional - default is to never expire logs
         .cloudWatchLogsRetentionRole(myLogsPublishingRole)
         .build();

Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html