interface EventBusProps

Language	Type name
.NET	Amazon.CDK.AWS.Events.EventBusProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsevents#EventBusProps
Java	software.amazon.awscdk.services.events.EventBusProps
Python	aws_cdk.aws_events.EventBusProps
TypeScript (source)	aws-cdk-lib » aws_events » EventBusProps

Properties to define an event bus.

Example

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

Name	Type	Description
deadLetterQueue?	IQueue	Dead-letter queue for the event bus.
description?	string	The event bus description.
eventBusName?	string	The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.
eventSourceName?	string	The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.
kmsKey?	IKey	The customer managed key that encrypt events on this event bus.

---

deadLetterQueue?

Type: IQueue (optional, default: no dead-letter queue)

Dead-letter queue for the event bus.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq

---

description?

Type: string (optional, default: no description)

The event bus description.

The description can be up to 512 characters long.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-description

---

eventBusName?

Type: string (optional, default: automatically generated name)

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

---

eventSourceName?

Type: string (optional, default: no partner event source)

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

---

kmsKey?

Type: IKey (optional, default: Use an AWS managed key)

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