EventBusConfig

Defined in: packages/core/src/config/types.ts:715

Config shape for a custom EventBridge event bus. Physical name = ${baseName}-${stageName}; eventBusName is Axis-controlled.

Extends

• Omit<events.EventBusProps, "eventBusName">

Properties

baseName

baseName: string

Defined in: packages/core/src/config/types.ts:719

Logical base name; physical name becomes ${baseName}-${stageName}.

---

constructId

constructId: string

Defined in: packages/core/src/config/types.ts:717

CFN logical ID — NEVER change once deployed.

---

deadLetterQueue?

readonly optional deadLetterQueue?: IQueue

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-events/lib/event-bus.d.ts:139

Dead-letter queue for the event bus

See

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

Default

- no dead-letter queue

Inherited from

Omit.deadLetterQueue

---

description?

readonly optional description?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-events/lib/event-bus.d.ts:149

The event bus description.

The description can be up to 512 characters long.

See

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

Default

- no description

Inherited from

Omit.description

---

eventSourceName?

readonly optional eventSourceName?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-events/lib/event-bus.d.ts:131

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

Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename

Default

- no partner event source

Inherited from

Omit.eventSourceName

---

kmsKey?

readonly optional kmsKey?: IKey

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-events/lib/event-bus.d.ts:155

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

Default

- Use an AWS managed key

Inherited from

Omit.kmsKey

---

logConfig?

readonly optional logConfig?: LogConfig

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-events/lib/event-bus.d.ts:160

The Logging Configuration of the Èvent Bus.

Default

- no logging

Inherited from

Omit.logConfig