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.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.043Z") @Stability(Stable) public interface EventBusProps extends software.amazon.jsii.JsiiSerializable
Properties to define an event bus.

Example: 

 EventBus bus = EventBus.Builder.create(this, "bus")
         .eventBusName("MyCustomEventBus")
         .build();
 bus.archive("MyArchive", BaseArchiveProps.builder()
         .archiveName("MyCustomEventBusArchive")
         .description("MyCustomerEventBus Archive")
         .eventPattern(EventPattern.builder()
                 .account(List.of(Stack.of(this).getAccount()))
                 .build())
         .retention(Duration.days(365))
         .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 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.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • 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

    • builder

      @Stability(Stable) static EventBusProps.Builder builder()
      Returns:
      a EventBusProps.Builder of EventBusProps