# Amazon DynamoDB

This article outlines the integration with the Amazon DynamoDB connector, enabling streamlined metadata management through features such as crawling, data preview, data quality, and manual lineage building. It also ensures secure authentication via Credential Manager.

<figure><img src="https://content.gitbook.com/content/ztcvwwOJCeaE1n6oHp4C/blobs/aghdtx6KHM0L2DQruWGS/image.png" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                                  | NoSQL            |
| ----------------------------------------------------------------------------------- | ---------------- |
| Connector Version                                                                   | Release 7.1.1    |
| Releases Supported (Available from)                                                 | Release6.0       |
| <p>Connectivity</p><p>\[How the connection is established with Amazon DynamoDB]</p> | AWS DynamoDB SDK |

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ❌      |
| Query Sheet                                  |       ❌      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ✅      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from Amazon DynamoDB and mapped to the corresponding UI assets.

<table><thead><tr><th width="185.25006103515625">Amazon DynamoDB Object</th><th width="180.75">Amazon DynamoDB Attribute</th><th width="195.5">OvalEdge Attribute</th><th width="164.5">OvaEdge Category</th><th width="169.25">OvalEdge Type</th></tr></thead><tbody><tr><td>Schema</td><td>Schema name</td><td>Schema</td><td>Databases</td><td>Schema</td></tr><tr><td>Schema</td><td>Schema comment</td><td>Source Description</td><td>Databases</td><td>Schema</td></tr><tr><td>Table</td><td>Table Name</td><td>Table</td><td>Tables</td><td>Ttable</td></tr><tr><td>Table</td><td>Table Type</td><td>Type</td><td>Tables</td><td>Table</td></tr><tr><td>Table</td><td>Table Comments</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td>Column Name</td><td>Column</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Data Type</td><td>Column Type</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Description</td><td>Source Description</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Ordinal Position</td><td>Column Position</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Length</td><td>Data Type Size</td><td>Table Columns</td><td>Columns</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection.

### **Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻Who can provide these permissions? These permissions are typically granted by the Amazon DynamoDB administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th width="201.4166259765625">Objects</th><th>System Tables</th><th>Access Permission</th></tr></thead><tbody><tr><td>Tables</td><td>getRemoteTables</td><td>dynamodb:ListTables dynamodb:DescribeTable dynamodb:ListTagsOfResource</td></tr><tr><td>Columns</td><td>getRemoteColumns</td><td>dynamodb:Scan</td></tr><tr><td>Connector Validation</td><td>validateConnection</td><td>dynamodb:ListTables</td></tr><tr><td>profile</td><td>getSampleProfileResults</td><td>dynamodb:Scan</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.<br>
{% endhint %}

1. Log into **OvalEdge**, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Amazon DynamoDB**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="221.41668701171875">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Amazon DynamoDB" is displayed as the selected connector type.</td></tr><tr><td>Authentication</td><td><p>The following two types of authentication are supported for Amazon DynamoDB:</p><ul><li>Role Based</li><li>IAM User-based</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="Role Based Authentication" %}

<table><thead><tr><th width="212.3333740234375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><p></p><ul><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Amazon DynamoDB connection              </p><p>(Example: "AmazonDynamoDB").</p></td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Cross Account Role ARN</td><td>Amazon Resource Name (ARN) of the IAM role used to enable cross-account access to DynamoDB.</td></tr><tr><td>Database Region*</td><td>AWS region where the DynamoDB instance is hosted. Select the appropriate region to establish the connection.</td></tr><tr><td>Filter by Tags</td><td>An optional field to filter and connect only to DynamoDB resources that match the specified AWS tags.</td></tr></tbody></table>
{% endtab %}

{% tab title="IAM Based Authentication" %}

<table><thead><tr><th width="199.33331298828125">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><p></p><ul><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Amazon DynamoDB connection              </p><p>(Example: "AmazonDynamoDB").</p></td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Access Key*</td><td>AWS Access Key ID used for authentication to connect to DynamoDB. </td></tr><tr><td>Secret Key*</td><td>AWS Secret Access Key paired with the Access Key for authentication.</td></tr><tr><td>Database Region*</td><td>AWS region where the DynamoDB instance is hosted. Select the appropriate region to establish the connection.</td></tr><tr><td>Filter by Tags</td><td>An optional field to filter and connect only to DynamoDB resources that match the specified AWS tags.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

<table><thead><tr><th width="221.33331298828125">Default Governance Roles</th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.</td></tr><tr><td><strong>Admin Roles</strong></td><td></td></tr><tr><td>Admin Roles*</td><td><p>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured</p><p>in the security settings are available for selection.</p></td></tr><tr><td><strong>No of Archive Objects</strong></td><td></td></tr><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr><tr><td><strong>Bridge</strong></td><td></td></tr><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p><br></p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the schemas to be crawled.
3. The Crawl option is selected by default. To perform both operations, select the **Crawl & Profile** radio button.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog > Databases** tab.

### Other Operations

The **Connectors** page provides a centralized view of all configured connectors, along with their health status.

**Managing connectors includes:**

* **Connectors Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the **Eye** icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the **Nine Dots** menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.
  * **Profiler:** Customize data profiling rules and methods.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
  * **Others:** Configure notification recipients for metadata changes.
* **Delete Connector:** Remove a connector with confirmation.

## Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="67.66668701171875">S.No.</th><th width="252.5">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td><p>Error occurred while validating the DynamoDB connection:</p><p>The security token included in the request is invalid.</p></td><td><p>Description: Connection validation failed because the provided AWS Access Key is incorrect or invalid.</p><p><br></p><p>Resolution: Verify and re-enter the correct AWS Access Key in the configuration settings.</p></td></tr><tr><td>2</td><td>Error occurred while validating the DynamoDB connection: Check your AWS Secret Access Key and signing method.</td><td><p>Description: Connection validation failed because the AWS Secret Key does not match the expected signature.</p><p><br></p><p>Resolution: Verify and re-enter the correct AWS Secret Access Key, and ensure the correct signing method is used.</p></td></tr><tr><td>3</td><td><p>Error occurred while validating the DynamoDB connection:</p><p>Check your AWS Secret Access Key and signing method.</p></td><td><p>Description: The connected AWS user account lacks the required permissions to list tables in DynamoDB.</p><p><br></p><p>Resolution: Grant the IAM user or role the dynamodb: ListTables permission in AWS IAM policies, then retry the connection.</p></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA