Package software.amazon.awscdk.services.events

Interface IEventBus

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IEventBusRef, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IEventBus.Jsii$Default
All Known Implementing Classes:
EventBus, IEventBus.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:10.674Z") @Stability(Stable) public interface IEventBus extends software.amazon.jsii.JsiiSerializable, IResource, IEventBusRef
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, @Nullable String sid)
      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.
      sid - The Statement ID used if we need to add a trust policy on the event bus.

    • 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.

    • getNode

      @Stability(Stable) @NotNull software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct

    • getEnv

      @Stability(Stable) @NotNull ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware