Skip to main content

Installation

The EventBridge plugin is a generator that can be used to generate your EventCatalog from an EventBridge registry.

You can map your schemas to services, domains and messages. You can also map all events from your registry into your catalog.

Installation

Run the following command to install the plugin.

"Don't have an EventCatalog project yet?"

If you don't have an EventCatalog project yet, you can follow the instructions in the Getting Started guide.

npm i @eventcatalog/generator-eventbridge

Configuration

Configure the plugin in your eventcatalog.config.js file.

Add the plugin to the generators array.


In this example we import all schemas from an EventBridge registry.

We don't map them to any services or domains.

eventcatalog.config.js
// ...
generators: [
// Import all schemas into your catalog
[
'@eventcatalog/generator-eventbridge',
{
// The region of your EventBridge registry
region: 'us-east-1',
// The name of your EventBridge registry
registryName: 'discovered-schemas'
},
],
],
// ...

Configure license key

The EventBridge plugin requires a license key to work with EventCatalog.

You can get a 14 day trial license key to try the plugin out by going to EventCatalog Cloud.

You have a few options for setting the license key:

  1. Setting license key in .env file (recommended)
  2. Setting license key in eventcatalog.config.js

Create a .env file in the root of your project and add the following:

.env
EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE=your-license-key
Using an older version of EventCatalog?

If you are using an older version of EventCatalog that does not support the .env file, you can just export the license key as an environment variable.

Setting license key in environment variables
export EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE=your-license-key

2. Setting license key in eventcatalog.config.js

If you prefer, you can set the license key in the eventcatalog.config.js file using the licenseKey property in the EventCatalog EventBridge plugin.

eventcatalog.config.js
export default {
generators: [
[
'@eventcatalog/generator-eventbridge',
{
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE
region: 'us-east-1',
registryName: 'discovered-schemas'
},
],
],
};

White listing EventCatalog domains

If you are behind a firewall you will need to white list the domain https://api.eventcatalog.cloud in your firewall. This is because the plugin needs to verify your license key.

Run the plugin

This command will run the generators in your eventcatalog.config.js file.

npm run generate

View your catalog

Run your catalog locally to see the changes

npm run dev

AWS Configuration

Policy for AWS

This plugin will require some read access to your Schema Registry and Versions.

It's recommended you create a new IAM user with the following policy.

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "EventCatalog",
"Effect": "Allow",
"Action": [
"schemas:ExportSchema",
"schemas:SearchSchemas",
"schemas:ListSchemas",
"schemas:ListSchemaVersions",
"schemas:DescribeSchema",
"schemas:GetDiscoveredSchema"
],
"Resource": "*"
}
]
}

Commercial and License

This plugin requires a license key to be used.

You can get a 14 day trial license key to try the plugin out by going to EventCatalog Cloud.

After the trial you can purchase a license to continue using this plugin, we have different plans to suit your organization.

See pricing for more information.

Have any questions? You can email us at hello@eventcatalog.dev.

License FAQ

What is the license key for?

The license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.

How do I get a license key?

You can obtain a license key by visiting EventCatalog Cloud. New users can start with a 14-day free trial.

Terms

  • Trial Period: 14 days free trial no credit card required
  • Support: Discord community support (extra for priority support)

After your trial period ends, you can purchase a full license through EventCatalog Cloud to continue using the plugin.

Issues

If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators