Amazon DocumentDB

Last updated on Oct 21, 2024

Amazon DocumentDB is a fast, secure, scalable, and fully managed database service that is compatible with MongoDB. It allows you to store and query JSON data, as well as set up, operate, and scale MongoDB-compatible databases in the cloud. Amazon DocumentDB also supports the same application code, drivers, and tools as MongoDB.

Hevo uses DocumentDB Change Streams to ingest data from your Amazon DocumentDB database and replicate it into the Destination of your choice.


(Optional) Updating the Server Certificate of your DocumentDB Instance

In August 2024, Amazon will start updating the CA certificates for existing DocumentDB clusters. Hence, if any instances in your DocumentDB cluster are using the older (rds-ca-2019) CA certificate, you must update it to one of the new certificates, namely, rds-ca-rsa2048-g1, rds-ca-rsa4096-g1, or rds-ca-ecc384-g1.

Perform the following steps to update the server certificate of all the instances in an existing Amazon DocumentDB cluster:

  1. Log in to your Amazon DocumentDB console.

  2. At the top right corner of the page, select the region of your Amazon DocumentDB cluster from the drop-down. For example, Asia Pacific (Singapore).

    Select the Cluster Region

  3. In the left navigation pane, click Clusters.

  4. On the Clusters page, scroll right to the Certificate authority column to identify the DocumentDB instances using the old server certificate, rds-ca-2019.

    Identify DocumentDB Instance

  5. Click the check box next to the DocumentDB instance whose certificate you want to update.

    Select Instance to Modify

  6. Click Actions and select Modify from the drop-down.

  7. On the Modify instance: <instance name> page:

    1. In the Certificate authority section, select the new server certificate for your instance and click Continue.

      Select New Server Certificate

    2. Review the changed values that are displayed in the Summary of modifications section.

      Review Changes and Modify Instance

    3. In the Scheduling of modifications section, select one of the following options for when to apply the changes:

      • Apply during the next scheduled maintenance window

      • Apply immediately

        Note: When you select the Apply immediately option, any other modifications made earlier to the instance are also applied. This may affect the connectivity to your DocumentDB instance if any pending changes require the instance to be rebooted.

    4. Scroll to the bottom of the page and click Modify instance. You are redirected to the Clusters page.

  8. Repeat steps 5-7 for all the instances identified in step 4.


Source Considerations

  • DocumentDB does not support reading change streams from replica instances, so Hevo cannot connect to DocumentDB replica instances.

  • DocumentDB does not support null values for the _id field. The _id field in a DocumentDB collection serves as its primary key. Therefore, commands that use _id as a parameter, such as commands to fetch, sort, or update data, do not run successfully if you provide a null value in the _id field.

    For example, when you run the following command in DocumentDB to select and sort data according to their _id values, you get a null pointer exception while fetching the document if the _id field does not hold a value:

    db.collection.aggregate({
        $group : {
            _id : {$type:"$_id"},
            type: {$min:"$_id"}
        }
    });
    
    
  • DocumentDB does not support BSON documents larger than 16 MB in change streams. The change streams response documents must adhere to the 16 MB limit for BSON documents. In case the size of the document exceeds 16 MB, the Pipeline is paused and an error is displayed stating, Failed to read documents from the Change Stream. Documents larger than 16 MB are not supported. This applies to scenarios such as when the update operation in Change Streams is configured to return the full updated document, or an insert or replace operation is performed within a document that is at or just below the specified size limit.


See Also


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Aug-12-2024 2.26.2 - Updated section, Configure Amazon DocumentDB Connection Settings to add information about the new CA certificates for SSL-enabled Pipelines.
- Added section Updating the Server Certificate of your DocumentDB Instance to provide steps for modifying the server certificate.
Nov-03-2023 NA Updated section, Prerequisites to add information about creating a cluster parameter group.
Sep-07-2022 NA Updated section, Configure Amazon DocumentDB Connection Settings to reflect the latest Hevo UI.
Jul-15-2022 1.92 New document.

Tell us what went wrong