Area: Deployment Issues
Sub-Area: AWS EventBridge Integration / Event Delivery Setup
Issue
Organizations building event-driven workflows with DataHub Cloud need to configure AWS EventBridge to receive entity change events from their DataHub Cloud environments (e.g., staging and production). This requires both customer-side AWS resource preparation and a configuration step performed by the DataHub Cloud team. Users who have created their EventBridge event buses but are unsure how to complete the integration — or need DataHub Cloud to begin publishing events to those buses — should follow this end-to-end guide.
You Might Be Asking
- How do I set up AWS EventBridge to receive events from DataHub Cloud?
- What AWS permissions does DataHub Cloud need to publish to my EventBridge bus?
- What events and payloads will I receive from DataHub Cloud via EventBridge?
- Do I need to configure multiple event buses for staging and production environments?
- What do I do after creating my EventBridge event buses to activate the integration?
Solution
Step 1: Create Your AWS EventBridge Event Bus (Customer)
Create one or more EventBridge custom event buses in your AWS account — typically one per DataHub Cloud environment (e.g., staging, production). Note the ARN and AWS region for each bus, as you will need to provide these to DataHub Support.
# Example event bus ARNs (replace with your own values)
arn:aws:events:<your-region>:<your-aws-account-id>:event-bus/datahub-events-prod
arn:aws:events:<your-region>:<your-aws-account-id>:event-bus/datahub-events-staging
Step 2: Attach a Resource-Based Policy to Each Event Bus (Customer)
Each event bus must have a resource-based policy that grants the DataHub Cloud AWS account permission to publish events via events:PutEvents. Apply the following policy to each event bus, substituting your own event bus ARN:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "AllowDataHubCloudPutEvents",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::795586375822:root"
},
"Action": "events:PutEvents",
"Resource": "arn:aws:events:<your-region>:<your-aws-account-id>:event-bus/<your-event-bus-name>"
}
]
}
The AWS account ID 795586375822 is the DataHub Cloud event publishing account. This policy must be applied to every event bus you want DataHub Cloud to publish to.
Step 3: Provide Event Bus Details to DataHub Support (Customer)
Once your event buses are created and the resource policies are in place, contact DataHub Support and provide:
- The full ARN for each event bus
- The AWS region for each event bus
- Which DataHub Cloud environment (staging, production, etc.) should publish to each bus
Step 4: DataHub Cloud Team Configures Event Publishing (DataHub Support)
The DataHub Cloud team will configure your DataHub Cloud environment(s) to forward entity change events to the specified EventBridge buses. The relevant internal configuration parameters include:
# Internal DataHub Cloud environment configuration (managed by DataHub Support)
AWS_EVENT_BRIDGE_EVENT_SYNC_ENABLED=true
AWS_EVENT_BRIDGE_BUS_ARN=arn:aws:events:<your-region>:<your-aws-account-id>:event-bus/<your-event-bus-name>
AWS_EVENT_BRIDGE_BUS_REGION=<your-region>
No customer-side backend changes are required beyond the resource policy. DataHub Cloud manages all event publishing infrastructure, networking, and security.
Step 5: Verify Event Delivery and Create EventBridge Rules (Customer)
Once DataHub Support confirms configuration is complete, verify that events are arriving on your event bus. You can then create EventBridge rules to route DataHub events to downstream targets such as AWS Lambda, SQS, or CloudWatch.
DataHub Cloud events arrive with the following attributes, which you can use to write EventBridge rules:
{
"source": "acryl.events",
"detail-type": "EntityChangeEvent_v1",
"detail": {
"entityUrn": "<urn of the affected entity>",
"entityType": "<entity type, e.g. dataset, dashboard>",
"category": "<event category>",
"operation": "<operation type>",
"modifier": "<optional modifier>",
"parameters": {},
"auditStamp": {
"actor": "<urn of the user who made the change>",
"time": "<epoch timestamp in milliseconds>"
}
}
}
Event Categories
The following event categories are delivered via EventBridge:
- Tags
- Glossary Terms
- Domains
- Ownership changes
- Schema field changes
- Deprecation
- Entity lifecycle events (create / delete)
- Assertions
- Incidents
- Proposals
Additional Notes
This integration is supported in DataHub Cloud and has been stable since DataHub Cloud v0.3.12. It is a fully managed, production-ready feature — not a workaround. If you need to update or replace an event bus in the future (e.g., due to a migration or ARN change), provide the new ARN and region to DataHub Support and they will update the configuration accordingly. Separate event buses per environment (staging, production) are recommended to keep event streams isolated. This integration uses the AwsEventBridgeChangeEventSink component internally and does not require any changes to your DataHub Cloud application configuration directly.
Related Documentation
Tags: eventbridge, aws, event-driven, entity-events, datahub-cloud, integration, event-bus, resource-policy, managed-datahub, deployment