How to tap into events

Have more questions? Submit a request

You can integrate Atlan with Amazon EventBridge to tap into what's happening in Atlan, the moment it happens. This push-based model allows you to, for example, update a data source the moment an asset is tagged as PII in Atlan. Or the moment a schema changes in Atlan, you could notify your engineering or security teams.

πŸ€“ Who can do this? This integration is currently in beta, and only available on request. Please contact your CSM if you are interested in trying this beta functionality.

To integrate with Amazon EventBridge, complete the following steps.

Retrieve AWS account ID

To integrate with Amazon EventBridge, you need to provide your AWS account ID. You can find this 12-digit in the AWS console, by clicking your profile in the upper-right of any screen and copying the number next to Account ID.

Connect Atlan to EventBridge

To connect Atlan to EventBridge, from within Atlan:

  1. From the left menu, click Admin.
  2. Under Workspace click Integrations.
  3. In the AWS EventBridge tile, click the Connect button.
  4. Enter your AWS account details:
    1. For AWS Account ID enter your 12-digit account ID.
    2. For AWS Region enter your AWS region.
  5. Click Connect to complete the setup.

You will now have a Pending partner event source in AWS.

Associate an event bus

Before events will flow to EventBridge, you need to associate the partner event source with an event bus.

To associate the partner event source with an event bus:

  1. Navigate to the partner event source in AWS:
    • If you still have the AWS EventBridge Connected dialog open from the previous step: at the bottom of the dialog click the partner event source page link.
    • If not, navigate to your AWS console, then Services, then Amazon EventBridge, and under Integrations click Partner event sources. Finally, select the Pending partner event source that Atlan created.
  2. In the upper-right corner, click the Associate with event bus button.
  3. At the bottom-right of the next screen, click the Associate button.

You will now have a new event bus in AWS for Atlan's events.

Turn on event flow from Atlan

By default, Atlan will configure the connection to EventBridge in a paused state. This means no events will flow from Atlan to EventBridge.

To turn on the event flow from Atlan:

  1. From the left menu, click Admin.
  2. Under Workspace click Integrations.
  3. In the AWS EventBridge tile, to the right of Event source name, click the refresh arrows next to Pending. After a few seconds, this status should change to Active.
  4. Now, to the right of Pause events, toggle the switch off.

Events will now flow from Atlan to your AWS event bus, where you can subscribe any number of consumers to take action the moment things happen in Atlan! πŸŽ‰

πŸ’ͺ Did you know? Our developer portal contains details about the events you can expect.

Turn off event flow from Atlan

To turn off the event flow from Atlan to EventBridge:

  1. From the left menu, click Admin.
  2. Under Workspace click Integrations.
  3. In the AWS EventBridge tile, to the right of Pause events, toggle the switch on.

Events will now temporarily stop flowing from Atlan to your AWS event bus. The event bus and partner event source for Atlan will remain, so that you can re-enable the event flow again at any point in the future.

Disconnect EventBridge

To more permanently disconnect Atlan from EventBridge:

  1. From the left menu, click Admin.
  2. Under Workspace click Integrations.
  3. In the AWS EventBridge tile, at the bottom left, click the Disconnect button.

This will delete the partner event source for Atlan in AWS, but not its associated event bus.

To delete the associated event bus:

  1. Navigate to your AWS console.
  2. Open Services, then Amazon EventBridge.
  3. Under Events, click Event buses.
  4. Open the event bus that was associated with Atlan's partner event source.
  5. In the upper-right, click the Delete button, and when prompted for confirmation click Delete again.

Events will no longer flow from Atlan to EventBridge, and you will no longer have any AWS resources allocated for these events.

Related articles

Was this article helpful?
0 out of 0 found this helpful