Cinchy Platform Documentation
Cinchy v5.6
Search
K

DynamoDB

1. Overview

Amazon DynamoDB is a managed NoSQL database service that is offered by Amazon as part of the AWS portfolio.
Example Use Case: You currently use DynamoDB to store metrics on product use and growth, but being stuck in the DynamoDB silo means that you can't easily use this data across a range of business use cases or teams. You can use a batch sync in order to liberate your data into Cinchy.
The DynamoDB source supports batch syncs.

2. Info Tab

You can review the parameters that can be found in the info tab below (Image 1).

Values

Parameter
Description
Example
Title
Mandatory. Input a name for your data sync
Product Metrics
Version
Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.
1.0.0
Parameters
Optional. Review our documentation on Parameters here for more information about this field.
Image 1: The Info Tab

3. Source Tab

The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).
Source Details
Schema
Filter
The following parameters will help to define your data sync source and how it functions.
Parameter
Description
Example
Source
Mandatory. Select your source from the drop down menu.
DynamoDB
Entity
Mandatory. The name of the entity you want to sync as it appears in DynamoDB.
Metrics
AWS Access Key (Client ID)
Mandatory. The encrypted AWS Access Key (Client ID) used to access your DynamoDB.
AWS Secret (Client Secret)
Mandatory. The encrypted AWS Secret (Client Secret) used to access your DynamoDB.
AWS Region
Mandatory. The name of the region for your AWS instance.
US-East-1
Username
Mandatory. The name of a user with access to connect to your DynamoDB server.
Password
Mandatory. The password associated with the above user.
AuthType
This field defines the authentication type for your data sync. Cinchy supports "Access Key" and "IAM" role. When selecting "Access Key", you must provide the key and key secret. When selecting "IAM role", a new field will appear for you to paste in the role's Amazon Resource Name (ARN). You also must ensure that:
The Schema section is where you define which source columns you want to sync in your connection. You can repeat the values for multiple columns.
Parameter
Description
Example
Name
Mandatory. The name of your column as it appears in the source.
Name
Alias
Optional. You may choose to use an alias on your column so that it has a different name in the data sync.
Data Type
Mandatory. The data type of the column values.
Text
Description
Optional. You may choose to add a description to your column.
There are other options available for the Schema section if you click on Show Advanced.
Parameter
Description
Example
Mandatory
  • If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected
  • If just Mandatory is checked on a column, then all rows are synced with the execution log status of failed, and the source error of "Mandatory Rule Violation"
  • If just Validated is checked on a column, then all rows are synced.
Validate Data
  • If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected
  • If just Validated is checked on a column, then all rows are synced.
Trim Whitespace
Optional if data type = text. If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters).
Max Length
Optional if data type = text. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution Log).
You can choose to add in a Transformation > String Replacement by inputting the following:
Parameter
Description
Example
Pattern
Mandatory if using a Transformation. The pattern for your string replacement, i.e. the string that will be searched and replaced.
Replacement
What you want to replace your pattern with.
Note that you can have more than one String Replacement
You have the option to add a source filter to your data sync. Please review the documentation here for more information on source filters.
Image 2: The Source Tab

4. Next Steps