Interface IEventBus

Interface which all EventBus based classes MUST implement.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEventBus : IResource, IConstruct, IDependable

Syntax (vb)

Public Interface IEventBus Inherits IResource, IConstruct, IDependable

Synopsis

Properties

EventBusArn	The ARN of this event bus resource.
EventBusName	The physical ID of this event bus resource.
EventBusPolicy	The JSON policy of this event bus resource.
EventSourceName	The partner event source to associate with this event bus resource.

Methods

Archive(string, IBaseArchiveProps)	Create an EventBridge archive to send events to.
GrantPutEventsTo(IGrantable, string?)	Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.

Properties

EventBusArn

The ARN of this event bus resource.

string EventBusArn { get; }

Property Value

string

Remarks

Attribute: true

Link: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Arn-fn::getatt

EventBusName

The physical ID of this event bus resource.

string EventBusName { get; }

Property Value

string

Remarks

Attribute: true

Link: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-name

EventBusPolicy

The JSON policy of this event bus resource.

string EventBusPolicy { get; }

Property Value

string

Remarks

Attribute: true

Link: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#Policy-fn::getatt

EventSourceName

The partner event source to associate with this event bus resource.

string? EventSourceName { get; }

Property Value

string

Remarks

Link: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-eventsourcename

Methods

Archive(string, IBaseArchiveProps)

Create an EventBridge archive to send events to.

Archive Archive(string id, IBaseArchiveProps props)

Parameters

id string
props IBaseArchiveProps: Properties of the archive.

Returns

Remarks

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.

GrantPutEventsTo(IGrantable, string?)

Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.

Grant GrantPutEventsTo(IGrantable grantee, string? sid = null)

Parameters

grantee IGrantable: The principal (no-op if undefined).
sid string: The Statement ID used if we need to add a trust policy on the event bus.

Returns

Grant