How to use App Connect with Amazon EventBridge
Amazon EventBridge is a serverless event bus service that simplifies your application architecture by allowing you to create scalable events from your applications that can integrate with Amazon Web Services (AWS).
- App Connect connector
-
Local
connector in containers (Continuous Delivery release) 12.0.7.0-r3 or later -
Local connector in containers (Long Term Support Cycle-2 release)
Connecting to Amazon EventBridge
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 EventBridge administrator to obtain these values.
- BASIC
- Secret access key: The secret access key of your Amazon EventBridge account. Get the secret access key from the Security Credentials page in the AWS Management Console.
- BASIC OIDC
- Region: The region of your Amazon EventBridge 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#).
- OIDC WEB
- Region: The region of your Amazon EventBridge 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 EventBridge, see Obtaining connection values for Amazon EventBridge.
To connect to an Amazon EventBridge endpoint from the App Connect Designer Applications and APIs page for the first time, expand Amazon EventBridge, 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.
What should I consider first?
- There are two types of events (data events and management events) logged in AWS CloudTrail.
- Data events (for example, in Amazon S3 object-level events,
Amazon DynamoDB, and AWS Lambda) must have trails that are configured to receive those
events. By default, trails don't log data events, and data events aren't viewable in CloudTrail Event history. To activate data event logging, you
must explicitly add the supported resources or resource types to a trail.
For instructions to activate data event logging, see Logging data events for trails.
For more information about how specific AWS services integrate with AWS CloudTrail, see CloudTrail supported services and integrations.
- To use an API destination as a target, you must provide an IAM Role ARN with the correct
permissions. For more information, see Permissions required for EventBridge to access targets using IAM
roles . The following is an example of a sample policy to be used in a role that works for
any App Connect API destination that is created through the
Webhooks connector:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "events:InvokeApiDestination" ], "Resource": [ "arn:aws:events:*:*:api-destination/appconnect*/*" ] } ] } - For Amazon S3 events to get triggered through Amazon EventBridge, you must explicitly enable Amazon EventBridge event delivery in Amazon S3. For more information, see Enabling Amazon EventBridge.
- (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 EventBridge events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
| Object | Event | Description |
|---|---|---|
| AWS events | New AWS event | Specifies a new event in AWS |
| Custom events | New custom event | Specifies a new custom event |
Amazon EventBridge actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Event buses | Create event bus | Creates a new event bus within your account |
| Delete event bus | Deletes the specified custom event bus or partner event bus | |
| Retrieve event buses | Retrieves all the event buses in your account | |
| Events | Send events | Sends the AWS events |
Examples
Use templates to quickly create flows for Amazon EventBridge
Learn how to use App Connect templates to quickly create flows that perform actions on Amazon EventBridge. For example, open Discover, and then search for Amazon EventBridge.
Use App Connect to build flows that integrate with Amazon EventBridge.
Read the blog in the IBM® Community to learn how to send events from Amazon EventBridge whenever a Salesforce lead is successfully created or whenever a Salesforce lead creation fails. Click Read the blog to go to the blog.