Interface IEventBus
Interface which all EventBus based classes MUST implement.
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEventBus : IResource
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) | 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
System.String
Remarks
EventBusName
The physical ID of this event bus resource.
string EventBusName { get; }
Property Value
System.String
Remarks
EventBusPolicy
The JSON policy of this event bus resource.
string EventBusPolicy { get; }
Property Value
System.String
Remarks
EventSourceName
The partner event source to associate with this event bus resource.
virtual string EventSourceName { get; }
Property Value
System.String
Remarks
Methods
Archive(String, IBaseArchiveProps)
Create an EventBridge archive to send events to.
Archive Archive(string id, IBaseArchiveProps props)
Parameters
- id System.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)
Grants an IAM Principal to send custom events to the eventBus so that they can be matched to rules.
Grant GrantPutEventsTo(IGrantable grantee)
Parameters
- grantee IGrantable
The principal (no-op if undefined).
Returns