Skip to content
v2.274.0

EventBusProps Struct ​

Properties to define an event bus.

Example ​

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

const myEventBus = new events.EventBus(this, 'EventBus', {
  eventBusName: 'MyEventBus1',
});

new tasks.EventBridgePutEvents(this, 'Send an event to EventBridge', {
  entries: [{
    detail: sfn.TaskInput.fromObject({
      Message: 'Hello from Step Functions!',
    }),
    eventBus: myEventBus,
    detailType: 'MessageFromStepFunctions',
    source: 'step.functions',
  }],
});

Properties ​

deadLetterQueueoptionalIQueuedead_letter_queueoptionalIQueuedeadLetterQueueoptionalIQueueDeadLetterQueueoptionalIQueueDeadLetterQueueoptionalIQueue#
Dead-letter queue for the event bus.

Default: no dead-letter queue

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The event bus description.

Default: no description

The description can be up to 512 characters long.

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

Default: automatically generated name

eventSourceNameoptionalstringevent_source_nameoptionalstreventSourceNameoptionalStringEventSourceNameoptionalstringEventSourceNameoptional*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

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

Default: Use an AWS managed key

logConfigoptionalLogConfiglog_configoptionalLogConfiglogConfigoptionalLogConfigLogConfigoptionalLogConfigLogConfigoptionalLogConfig#
The Logging Configuration of the Èvent Bus.

Default: no logging