Amazon DocumentDB Construct Library

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 vpc_subnets attribute to control whether your instances will be launched privately or publicly:

vpc = nil # AWSCDK::EC2::VPC

cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
         # NOTE: 'admin' is reserved by DocumentDB
        exclude_characters: "\"@/:",
         # optional, defaults to the set "\"@/" and is also used for eventually created rotations
        secret_name: "/myapp/mydocdb/masteruser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    copy_tags_to_snapshot: true,
})

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.

Serverless Clusters

DocumentDB supports serverless clusters that automatically scale capacity based on your application's needs. To create a serverless cluster, specify the serverless_v2_scaling_configuration instead of instance_type:

vpc = nil # AWSCDK::EC2::VPC

cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    vpc: vpc,
    serverless_v2_scaling_configuration: {
        min_capacity: 0.5,
        max_capacity: 2,
    },
    engine_version: "5.0.0",
})

Note: DocumentDB serverless requires engine version 5.0.0 or higher and is not compatible with all features. See the AWS documentation for limitations.

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:

cluster = nil # AWSCDK::DocDB::DatabaseCluster

cluster.connections.allow_default_port_from_any_ipv4("Open to the world")

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

cluster = nil # AWSCDK::DocDB::DatabaseCluster

write_address = cluster.cluster_endpoint.socket_address

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

vpc = nil # AWSCDK::EC2::VPC
cluster = nil # AWSCDK::DocDB::DatabaseCluster


security_group = AWSCDK::EC2::SecurityGroup.new(self, "SecurityGroup", {
    vpc: vpc,
})
cluster.add_security_groups(security_group)

Deletion protection

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

vpc = nil # AWSCDK::EC2::VPC

cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    deletion_protection: true,
})

Rotating credentials

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

cluster = nil # AWSCDK::DocDB::DatabaseCluster

cluster.add_rotation_single_user

cluster = AWSCDK::DocDB::DatabaseCluster.new(stack, "Database", {
    master_user: {
        username: "docdb",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::R5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc: vpc,
    removal_policy: AWSCDK::RemovalPolicy::DESTROY,
})

cluster.add_rotation_single_user

The multi user rotation scheme is also available:

require 'aws-cdk-lib'

my_imported_secret = nil # AWSCDK::SecretsManager::Secret
cluster = nil # AWSCDK::DocDB::DatabaseCluster


cluster.add_rotation_multi_user("MyUser", {
    secret: my_imported_secret,
})

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

cluster = nil # AWSCDK::DocDB::DatabaseCluster

my_user_secret = AWSCDK::DocDB::DatabaseSecret.new(self, "MyUserSecret", {
    username: "myuser",
    master_secret: cluster.secret,
})
my_user_secret_attached = my_user_secret.attach(cluster) # Adds DB connections information in the secret

cluster.add_rotation_multi_user("MyUser", {
     # Add rotation using the multi user scheme
    secret: my_user_secret_attached,
})

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-lib/aws-secretsmanager for credentials rotation of existing clusters.

Audit and profiler Logs

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

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

require 'aws-cdk-lib'

my_logs_publishing_role = nil # AWSCDK::IAM::Role
vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    export_profiler_logs_to_cloud_watch: true,
     # Enable sending profiler logs
    export_audit_logs_to_cloud_watch: true,
     # Enable sending audit logs
    cloud_watch_logs_retention: AWSCDK::Logs::RetentionDays::THREE_MONTHS,
     # Optional - default is to never expire logs
    cloud_watch_logs_retention_role: my_logs_publishing_role,
})

Enable Performance Insights

By enabling this feature it will be cascaded and enabled in all instances inside the cluster:

vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    enable_performance_insights: true,
})

 Removal Policy

This resource supports the snapshot removal policy. To specify it use the removal_policy property:

vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    removal_policy: AWSCDK::RemovalPolicy::SNAPSHOT,
})

Note: A RemovalPolicy.DESTROY removal policy will be applied to the cluster's instances and security group by default as they don't support the snapshot removal policy.

Visit DeletionPolicy for more details.

To specify a custom removal policy for the cluster's instances, use the instance_removal_policy property:

vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    removal_policy: AWSCDK::RemovalPolicy::SNAPSHOT,
    instance_removal_policy: AWSCDK::RemovalPolicy::RETAIN,
})

To specify a custom removal policy for the cluster's security group, use the security_group_removal_policy property:

vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    removal_policy: AWSCDK::RemovalPolicy::SNAPSHOT,
    security_group_removal_policy: AWSCDK::RemovalPolicy::RETAIN,
})

CA certificate

Use the ca_certificate property to specify the CA certificate to use for all instances inside the cluster:

vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc_subnets: {
        subnet_type: AWSCDK::EC2::SubnetType::PUBLIC,
    },
    vpc: vpc,
    ca_certificate: AWSCDK::RDS::CaCertificate.RDS_CA_RSA4096_G1,
})

Storage Type

You can specify storage type for the cluster.

vpc = nil # AWSCDK::EC2::VPC


cluster = AWSCDK::DocDB::DatabaseCluster.new(self, "Database", {
    master_user: {
        username: "myuser",
    },
    instance_type: AWSCDK::EC2::InstanceType.of(AWSCDK::EC2::InstanceClass::MEMORY5, AWSCDK::EC2::InstanceSize::LARGE),
    vpc: vpc,
    storage_type: AWSCDK::DocDB::StorageType::IOPT1,
})

Note: StorageType.IOPT1 is supported starting with engine version 5.0.0.

Note: For serverless clusters, storage type is managed automatically and cannot be specified.