Automated Continuous Cosmos DB Replication to Amazon S3

Ready to get started?

Learn more or sign up for a free trial:

CData Sync



Use CData Sync for automated, continuous, customizable Cosmos DB replication to Amazon S3.

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live Cosmos DB data into your Amazon S3 instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure Amazon S3 as a Replication Destination

Using CData Sync, you can replicate Cosmos DB data to Amazon S3. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select Amazon S3 as a destination.
  3. Enter the necessary connection properties. To connect to Amazon S3, provide the credentials for an administrator account or for an IAM user with custom permissions: Set AccessKey to the access key ID. Set SecretKey to the secret access key.

    Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.

    To obtain the credentials for an IAM user, follow the steps below:

    1. Sign into the IAM console.
    2. In the navigation pane, select Users.
    3. To create or manage the access keys for a user, select the user and then select the Security Credentials tab.

    To obtain the credentials for your AWS root account, follow the steps below:

    1. Sign into the AWS Management console with the credentials for your root account.
    2. Select your account name or number and select My Security Credentials in the menu that is displayed.
    3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

  4. Click Test Connection to ensure that the connection is configured properly.
  5. Click Save Changes.

Configure the Cosmos DB Connection

You can configure a connection to Cosmos DB from the Connections tab. To add a connection to your Cosmos DB account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (Cosmos DB).
  3. Configure the connection properties.

    To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

    • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
    • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
  4. Click Connect to ensure that the connection is configured properly.
  5. Click Save Changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

Customize Your Replication

You can use the Transform feature to customize your replication. The Transform feature allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. To customize your replication, click the Transform button in the Tables section and customize the replication.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 15 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your Cosmos DB data to Amazon S3.