AWS CDK Reference

Appearance

v2.273.0

IEventBus Interface ​

Interface which all EventBus based classes MUST implement.

Source
aws-events/lib/event-bus.ts
Type last changed
v2.227.0 · 21 Nov 2025

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

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.

eventBusArnstringevent_bus_arnstreventBusArnStringEventBusArnstringEventBusArn*stringrequired#
The ARN of this event bus resource.
eventBusNamestringevent_bus_namestreventBusNameStringEventBusNamestringEventBusName*stringrequired#
The physical ID of this event bus resource.
eventBusPolicystringevent_bus_policystreventBusPolicyStringEventBusPolicystringEventBusPolicy*stringrequired#
The JSON policy of this event bus resource.
eventBusRefEventBusReferenceevent_bus_refEventBusReferenceeventBusRefEventBusReferenceEventBusRefEventBusReferenceEventBusRefEventBusReferencerequired#
A reference to a EventBus resource.
eventSourceNamestringevent_source_namestreventSourceNameStringEventSourceNamestringEventSourceName*string#
The partner event source to associate with this event bus resource.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.

Methods ​

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

archive(id: string, props: BaseArchiveProps): Archivedef archive(self, id: str, props: BaseArchiveProps) -> Archivepublic Archive archive(String id, BaseArchiveProps props)public Archive Archive(string id, BaseArchiveProps props)func Archive(Id *string, Props BaseArchiveProps) Archive#
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.

1 parameter

Parameters

  • propspropspropspropsProps — Properties of the archive.
grantPutEventsTo(grantee: IGrantable, sid?: string): Grantdef grant_put_events_to(self, grantee: IGrantable, sid: typing.Optional[str] = None) -> Grantpublic Grant grantPutEventsTo(IGrantable grantee, String sid)public Grant GrantPutEventsTo(IGrantable grantee, string? sid = null)func GrantPutEventsTo(Grantee IGrantable, Sid *string) Grant#
Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.
2 parameters

Parameters

  • granteegranteegranteegranteeGrantee — The principal (no-op if undefined).
  • sidsidsidsidSid — The Statement ID used if we need to add a trust policy on the event bus.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining