Interface IEventBus

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IEventBus.Jsii$Default
All Known Implementing Classes:
EventBus, IEventBus.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-24T02:42:38.425Z") @Stability(Stable) public interface IEventBus extends software.amazon.jsii.JsiiSerializable, IResource
Interface which all EventBus based classes MUST implement.
  • Method Details

    • getEventBusArn

      @Stability(Stable) @NotNull String getEventBusArn()
      The ARN of this event bus resource.
    • getEventBusName

      @Stability(Stable) @NotNull String getEventBusName()
      The physical ID of this event bus resource.
    • getEventBusPolicy

      @Stability(Stable) @NotNull String getEventBusPolicy()
      The JSON policy of this event bus resource.
    • getEventSourceName

      @Stability(Stable) @Nullable default String getEventSourceName()
      The partner event source to associate with this event bus resource.
    • archive

      @Stability(Stable) @NotNull Archive archive(@NotNull String id, @NotNull BaseArchiveProps props)
      Create an EventBridge archive to send events to.

      When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect.

      Parameters:
      id - This parameter is required.
      props - Properties of the archive. This parameter is required.
    • grantPutEventsTo

      @Stability(Stable) @NotNull Grant grantPutEventsTo(@NotNull IGrantable grantee)
      Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.

      Parameters:
      grantee - The principal (no-op if undefined). This parameter is required.