How to use IBM® App Connect with Amazon DynamoDB
Amazon DynamoDB is a fully managed key-value and document database. It is a NoSQL database that provides fast and predictable performance with seamless scalability.
- App Connect Enterprise as a Service connector
-
Local
connector in containers (Continuous Delivery release) 11.0.0.11-r1 or later -
Local connector in containers (Long Term Support release)
-
Local connector in containers (Long Term Support Cycle-2 release)
Supported product and API versions
To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.
Connecting to Amazon DynamoDB
Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your Amazon DynamoDB administrator to obtain these values.
| Connection field | Description |
|---|---|
| Secret access key | The secret access key of your Amazon DynamoDB account. Get the secret access key from the Security Credentials page in the AWS Management Console. |
| Access key ID | The access key ID of your Amazon DynamoDB account. Get the access key ID from the Security Credentials page in the AWS Management Console. |
| Region | The region of your Amazon DynamoDB instance, for example,
us-east-1.You can find the value for the Region parameter at the end of the URL when you are logged in to the AWS Management Console (for example, https://us-east-2.console.aws.amazon.com/console/home?region=us-east-2#). |
To obtain the connection values for Amazon DynamoDB, see Obtaining connection values for Amazon DynamoDB.
To connect to a Amazon DynamoDB endpoint from the App Connect Designer Catalog page for the first time, expand Amazon DynamoDB, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with Amazon DynamoDB, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Catalog page of the App Connect Designer.
For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Amazon DynamoDB events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Amazon DynamoDB actions
Your flow completes these actions on this application.
- Backups
-
- Create backup
- Retrieve backups
- Delete backup
- Restore table from backup
- Get continuous backup information
- Add or remove continuous backup
- Restore table to point in time
- Items
-
- Retrieve items
- Update or create item
- Delete item
- Regions
-
- Get limits
- Tables
-
- Create table
- Retrieve tables
- Delete table
- Add or remove time to live
- Get time to live
- Tags
-
- Retrieve tags
- Add tags
- Remove tags
Examples
Use templates to quickly create flows for Amazon DynamoDB
Learn how to use App Connect templates to quickly create flows that perform actions on Amazon DynamoDB. For example, open the Templates gallery, and then search for Amazon DynamoDB.
