AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

EventBus

Define an EventBridge EventBus.

Import

import { EventBus } from 'aws-cdk-lib/aws-events';

Or use the module namespace:

import * as events from 'aws-cdk-lib/aws-events';
// events.EventBus

Properties

Configuration passed to the constructor as EventBusProps.

deadLetterQueueOptional
IQueue

Dead-letter queue for the event bus.

Default: - no dead-letter queue

descriptionOptional
string

The event bus description. The description can be up to 512 characters long.

Default: - no description

eventBusNameOptional
string

The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.

Default: - automatically generated name

eventSourceNameOptional
string

The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.

Default: - no partner event source

kmsKeyOptional
IKey

The customer managed key that encrypt events on this event bus.

Default: - Use an AWS managed key

logConfigOptional
LogConfig

The Logging Configuration of the Èvent Bus.

Default: - no logging

Get the Amazon EventBridge Cheat Sheet

Everything you need to know about Amazon EventBridge on one page. HD quality, print-friendly.

Download Free Infographic