Package software.amazon.awscdk.services.events

Interface EventBusProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EventBusProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:36.968Z")
@Stability(Stable)
public interface EventBusProps
extends software.amazon.jsii.JsiiSerializable

Properties to define an event bus.

Example:

 import software.amazon.awscdk.services.events.*;
 EventBus myEventBus = EventBus.Builder.create(this, "EventBus")
         .eventBusName("MyEventBus1")
         .build();
 EventBridgePutEvents.Builder.create(this, "Send an event to EventBridge")
         .entries(List.of(EventBridgePutEventsEntry.builder()
                 .detail(TaskInput.fromObject(Map.of(
                         "Message", "Hello from Step Functions!")))
                 .eventBus(myEventBus)
                 .detailType("MessageFromStepFunctions")
                 .source("step.functions")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EventBusProps.Builder	A builder for EventBusProps
static final class	EventBusProps.Jsii$Proxy	An implementation for EventBusProps

Method Summary

Modifier and Type	Method	Description
static EventBusProps.Builder	builder()
default IQueue	getDeadLetterQueue()	Dead-letter queue for the event bus.
default String	getDescription()	The event bus description.
default String	getEventBusName()	The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.
default String	getEventSourceName()	The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.
default IKey	getKmsKey()	The customer managed key that encrypt events on this event bus.
default LogConfig	getLogConfig()	The Logging Configuration of the Èvent Bus.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeadLetterQueue

@Stability(Stable)
@Nullable
default IQueue getDeadLetterQueue()

Dead-letter queue for the event bus.

Default: - no dead-letter queue

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The event bus description.

The description can be up to 512 characters long.

Default: - no description

See Also:

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

getEventBusName

@Stability(Stable)
@Nullable
default String getEventBusName()

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

Default: - automatically generated name

getEventSourceName

@Stability(Stable)
@Nullable
default String getEventSourceName()

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

getKmsKey

@Stability(Stable)
@Nullable
default IKey getKmsKey()

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

Default: - Use an AWS managed key

getLogConfig

@Stability(Stable)
@Nullable
default LogConfig getLogConfig()

The Logging Configuration of the Èvent Bus.

Default: - no logging

builder

@Stability(Stable)
static EventBusProps.Builder builder()

Returns:

a EventBusProps.Builder of EventBusProps