DynamoDB Setup Guide

Follow our setup guide to connect DynamoDB to Fivetran.

Prerequisiteslink

To connect your DynamoDB database to Fivetran, you need an AWS account with administrator privileges.

Setup instructionslink

Find External IDlink

Find the automatically-generated External ID in your connector setup form and make a note of it. You will need it to configure AWS to connect with Fivetran.

Create an IAM Policylink

This step allows Fivetran to access your DynamoDB database.

1. Open the Amazon IAM console.

2. Select Policies.

3. Click Create Policy.

4. Navigate to the JSON tab.

5. Copy the policy below into the JSON tab, then click Review Policy.

    {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Effect": "Allow",
                "Action": [
                    "dynamodb:DescribeStream",
                    "dynamodb:DescribeTable",
                    "dynamodb:GetItem",
                    "dynamodb:GetRecords",
                    "dynamodb:GetShardIterator",
                    "dynamodb:ListStreams",
                    "dynamodb:ListTables",
                    "dynamodb:Scan"
                ],
                "Resource": [
                    "*"
                ]
            }
        ]
    }
   

6. On the Review policy page, name the policy “Fivetran-Dynamo-Access” and provide a description if you’d like.

7. Click Create Policy.

Create an IAM rolelink

1. Open the Amazon IAM console.

2. Click Roles in the left menu, then click Create New Role.

3. Select Another AWS account as the type of trusted entity. In the Account ID field, enter Fivetran’s account ID 834469178297.

4. Click Options.

5. In the External ID field, enter the External ID from your Fivetran setup form.

6. Click Next: Permissions.

7. Find and select the “Fivetran-Dynamo-Access” policy that you created in Step 1, then click Next: Review.

8. Name the role “Fivetran”, then click Create Role.

9. Click the role you just created (it may take a few seconds to populate). Find the “Role ARN” and copy it. Enter this value in the Role ARN field of your connector setup form.

Enable Streams for DynamoDB tableslink

In this step, you’ll enable streams for all the tables that you want to sync through Fivetran.

1. In your AWS console, select the DynamoDB service, then select Tables.
2. Select a table.
3. Click on the Manage Stream option.
4. Select New and old images - both the new and the old images of the item.
5. Click Enable.
6. Repeat steps 1-5 for every table that you want to sync via Fivetran.

(Optional) Configure AWS PrivateLink BETAlink

IMPORTANT: You must have a Business Critical plan to use AWS PrivateLink.

AWS PrivateLink allows VPCs and AWS-hosted or on-premises services to communicate with one another without exposing traffic to the public internet. PrivateLink is the most secure connection method. Learn more in AWS’ PrivateLink documentation.

Follow our AWS PrivateLink setup guide to configure PrivateLink for your database.

Finish Fivetran Configurationlink

1. Enter your chosen destination schema name in the connector setup form.

2. Select your AWS region.

3. Select your sync mode:

   • If your table has more than 1000 first-level keys, you must select packed as your sync mode. If you anticipate the number of first-level keys will exceed 1000 in the future, you should also select packed mode. Once you select packed mode, you will see your tables and can select which ones to sync in packed mode.
   • If your table has fewer than 1000 first-level keys, you can select either packed or unpacked as your sync mode.

4. (Optional) To always connect using AWS PrivateLink, set the Require PrivateLink toggle to ON.

   NOTE: By default, we use PrivateLink to connect if your database and Fivetran are in the same region. Enabling this option ensures that we always use PrivateLink to connect. If the regions are different, Fivetran won’t create the connection. When you enable the option, the requests to your DynamoDB endpoint within the AWS Region are routed to a private DynamoDB endpoint within the Amazon network. You don’t need to modify your applications running on EC2 instances in your VPC. The endpoint name remains the same, but the route to DynamoDB stays entirely within the Amazon network and does not access the public internet.

5. Click Save & Test. Fivetran will take it from here and sync your data from your DynamoDB account.

Setup testslink

Fivetran performs the following tests to ensure that we can connect to your generic DynamoDB database:

• The Connecting to Database Test checks that we can access your DynamoDB database using the credentials you provided in the setup form.
• The Source and Destination Region Uniformity Test validates if your database and our vpc endpoint are in the same region. We skip this test if you haven’t enabled the Require PrivateLink toggle. The test fails if your source and fivetran’s vpc endpoint are in different regions.

NOTE: The tests may take a few minutes to finish running.

Related Contentlink

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connector Configuration

home Documentation Home