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.

Availability:

App Connect Enterprise as a Service connector
Local connector in containers (Long Term Support Cycle-3 release) 13.0.7.0-r1 or later
Local connector in containers (Continuous Delivery release) 11.0.0.11-r1 or later
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 Connect > Applications and APIs page or flow editor. If necessary, work with your Amazon DynamoDB administrator to obtain these values.

Amazon DynamoDB authorization types and connection fields:

BASIC: 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#).
Tip: For more information, see AWS service endpoints on the AWS documentation page.; Role ARN: The Amazon Resource Name (ARN) that specifies an IAM role in AWS.

BASIC OIDC: 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#).
Tip: For more information, see AWS service endpoints on the AWS documentation page.; Client ID: Specify the unique identifier assigned to an application within an OpenID Connect (OIDC) system.; Client secret: Specify the client secret that is used to authenticate the client application.; ID token: The security token in OpenID Connect (OIDC) that contains claims about the authentication of a user, such as their identity and session validity, typically represented as a JSON Web Token (JWT).; Refresh token: The refresh token that is generated from the application client ID and client secret.; Role ARN: The Amazon Resource Name (ARN) of the IAM role that defines the permissions that are applied when the role is assumed.; OIDC server URL: Specify the URL of the OpenID Connect (OIDC) server or identity provider that handles authentication and provides tokens for clients.

AWS PKI: 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#).
Tip: For more information, see AWS service endpoints on the AWS documentation page.; Client certificate: The X.509 certificate used to authenticate your workload with IAM Roles Anywhere.; Client key password: The password for the encrypted Client private key. Required only if the Client private key is protected by a password.; Client private key: The private key that is associated with the client certificate and used to sign authentication requests.; Profile ARN: The Amazon Resource Name (ARN) of the IAM Roles Anywhere profile that determines the IAM roles that a workload can assume.; Role ARN: The Amazon Resource Name (ARN) of the IAM role that defines the permissions that are applied when the role is assumed.; Trust anchor ARN: The Amazon Resource Name (ARN) of the trust anchor that represents the certificate authority (CA) trusted by IAM Roles Anywhere to validate X.509 client certificates.

To obtain the connection values for Amazon DynamoDB using BASIC and BASIC OIDC authentication types, see Obtaining connection values for Amazon DynamoDB (BASIC and BASIC OIDC).

To obtain the connection values for Amazon DynamoDB using AWS PKI authentication type, see Obtaining connection values for Amazon DynamoDB (AWS PKI).

To connect to an Amazon DynamoDB endpoint from the App Connect Designer Applications and APIs page for the first time, expand Amazon DynamoDB, then click Connect.

Tip:

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 Applications and APIs 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 Applications and APIs page of the App Connect Designer.
For some applications, the events and actions 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.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Amazon DynamoDB actions

Your flow completes these actions on this application.

Object	Action	Description
Backups	Add or remove continuous backup	Specifies whether to enable or disable the Point-in-Time Recovery (PITR) for a table
	Create backup	Create an Amazon DynamoDB table backup
	Delete backup	Delete an Amazon DynamoDB backup
	Get continuous backup information	Check the status of the continuous backups and Point-in-Time Recovery (PITR) on a specified table
	Restore table from backup	Restore a table to a specified point in time
	Restore table to point in time	Restore a table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime
	Retrieve backups	Retrieve a list of Amazon DynamoDB table backups
Items	Create bulk items	Creates multiple items in a table in Amazon DynamoDB
	Delete bulk items	Deletes multiple items in a table in Amazon DynamoDB
	Delete item	Delete an item from the Amazon DynamoDB
	Retrieve items	Retrieve a list of items from the Amazon DynamoDB
	Update bulk items	Updates multiple items in a table in Amazon DynamoDB
	Update or create item	Update an item if it exists in the Amazon DynamoDB, or else create the item
Regions	Get limits	Retrieve the current provisioned-capacity limits for an AWS account across all your Amazon DynamoDB tables in a given region
Tables	Add or remove time to live	Specifies the controller for the Get Time To Live (Get TTL) object
	Create table	Create an Amazon DynamoDB table
	Delete table	Delete an Amazon DynamoDB table
	Get time to live	Specifies the controller for the Get Time To Live (Get TTL) object
	Retrieve tables	Retrieve a list of the Amazon DynamoDB tables
Tags	Add tags	Add a tag to a table
	Remove tags	Remove an associated tag from a table
	Retrieve tags	Retrieve tags for an Amazon DynamoDB table

Examples

Dashboard tile for a template that uses Amazon DynamoDB

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 Discover, and then search for Amazon DynamoDB.

Learn more

Model Context Protocol (MCP) support

The Amazon DynamoDB connector supports MCP, and all Amazon DynamoDB actions except for the actions that are listed for the following object can be added to an MCP server as tools. For more information on how to configure an MCP server, see Creating and managing MCP servers.

Tables