How to use IBM App Connect with Amazon Kinesis
Amazon Kinesis is an Amazon Web Service (AWS) used for processing data in real time. It is a managed, scalable, cloud-based service that enables the processing of large volumes of streaming data in real-time.
- App Connect Enterprise as a Service connector
Local
connector in containers (Continuous Delivery release) 12.0.7.0-r5 or
later-
Local connector in containers (Long Term Support Cycle-2 release)
Connecting to Amazon Kinesis
Complete the connection fields that you see in the App Connect Designer page (previously the Catalog page) or flow editor. If necessary, work with your Amazon Kinesis administrator to obtain these values.
| Connection field | Description |
|---|---|
| Secret access key | The secret access key of your Amazon Kinesis 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 Kinesis account. Get the access key ID from the Security Credentials page in the AWS Management Console. |
| Region | The region of your Amazon Kinesis instance, for example,
us-east-1.
|
To obtain the connection values for Amazon Kinesis, see Obtaining connection values for Amazon Kinesis.
To connect to an Amazon Kinesis endpoint from the App Connect Designer Applications and APIs page for the first time, expand Amazon Kinesis, 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 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 Kinesis, 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 Kinesis events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Amazon Kinesis actions
Your flow completes these actions on this application.
- Applications
-
- Retrieve application snapshots
- Retrieve application versions
- Retrieve applications
- Start application
- Stop application
- Data stream records
-
- Retrieve data stream records
- Add multiple records
- Add record
- Data streams
-
- Create data stream
- Retrieve data streams
- Delete data stream
- Decrease stream retention period
- Increase stream retention period
- Update shard count
- Update stream mode
- Delivery streams
-
- Create delivery stream
- Retrieve delivery streams
- Delete delivery stream
- Add multiple records
- Update destination
- Shards
-
- Retrieve shards
- Get shard iterator
- Merge shards
- Split shard
- Tags
-
- Retrieve tags
- Add tags
- Remove tags
Examples
Use templates to quickly create flows for Amazon Kinesis
Learn how to use App Connect templates to quickly create flows that perform actions on Amazon Kinesis. For example, open the Templates gallery, and then search for Amazon Kinesis.
Use IBM® App Connect to build flows that integrate with Amazon Kinesis.
Read the blog in the IBM Community to learn how to filter records with speed limit violations and add these records to Amazon S3 via the Amazon Kinesis delivery stream. Click Read the blog to go to the blog.