aws-cdk-lib.aws_events.EventBusProps

interface EventBusProps

LanguageType name
.NETAmazon.CDK.AWS.Events.EventBusProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#EventBusProps
Javasoftware.amazon.awscdk.services.events.EventBusProps
Pythonaws_cdk.aws_events.EventBusProps
TypeScript (source)aws-cdk-lib » aws_events » EventBusProps

Properties to define an event bus.

Example

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

bus.archive('MyArchive', {
  archiveName: 'MyCustomEventBusArchive',
  description: 'MyCustomerEventBus Archive',
  eventPattern: {
    account: [Stack.of(this).account],
  },
  retention: Duration.days(365),
});

Properties

NameTypeDescription
eventBusName?stringThe name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.
eventSourceName?stringThe partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.

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.