Class EventBus

Define an EventBridge EventBus.

Inheritance
System.Object
Construct
Resource
EventBus
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class EventBus : Resource, IEventBus, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class EventBus
    Inherits Resource
    Implements IEventBus, IResource, IConstruct, IConstruct, IDependable
Remarks

Resource: AWS::Events::EventBus

Synopsis

Constructors

EventBus(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
EventBus(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
EventBus(Construct, String, IEventBusProps)

Properties

EventBusArn

The ARN of the event bus, such as: arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1.
EventBusName

The physical ID of this event bus resource.
EventBusPolicy

The policy for the event bus in JSON form.
EventSourceName

The name of the partner event source.

Methods

Archive(String, IBaseArchiveProps)

Create an EventBridge archive to send events to.
FromEventBusArn(Construct, String, String)

Import an existing event bus resource.
FromEventBusAttributes(Construct, String, IEventBusAttributes)

Import an existing event bus resource.
FromEventBusName(Construct, String, String)

Import an existing event bus resource.
GrantAllPutEvents(IGrantable)

Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.
GrantPutEvents(IGrantable)

(deprecated) Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.
GrantPutEventsTo(IGrantable)

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

Constructors

EventBus(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected EventBus(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

EventBus(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected EventBus(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

EventBus(Construct, String, IEventBusProps)

public EventBus(Construct scope, string id, IEventBusProps props = null)
Parameters
scope Constructs.Construct
id System.String
props IEventBusProps

Properties

EventBusArn

The ARN of the event bus, such as: arn:aws:events:us-east-2:123456789012:event-bus/aws.partner/PartnerName/acct1/repo1.

public virtual string EventBusArn { get; }
Property Value

System.String

EventBusName

The physical ID of this event bus resource.

public virtual string EventBusName { get; }
Property Value

System.String

EventBusPolicy

The policy for the event bus in JSON form.

public virtual string EventBusPolicy { get; }
Property Value

System.String

EventSourceName

The name of the partner event source.

public virtual string EventSourceName { get; }
Property Value

System.String

Methods

Archive(String, IBaseArchiveProps)

Create an EventBridge archive to send events to.

public virtual Archive Archive(string id, IBaseArchiveProps props)
Parameters
id System.String
props IBaseArchiveProps
Returns

Archive

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.

FromEventBusArn(Construct, String, String)

Import an existing event bus resource.

public static IEventBus FromEventBusArn(Construct scope, string id, string eventBusArn)
Parameters
scope Constructs.Construct

Parent construct.

id System.String

Construct ID.

eventBusArn System.String

ARN of imported event bus.

Returns

IEventBus

FromEventBusAttributes(Construct, String, IEventBusAttributes)

Import an existing event bus resource.

public static IEventBus FromEventBusAttributes(Construct scope, string id, IEventBusAttributes attrs)
Parameters
scope Constructs.Construct

Parent construct.

id System.String

Construct ID.

attrs IEventBusAttributes

Imported event bus properties.

Returns

IEventBus

FromEventBusName(Construct, String, String)

Import an existing event bus resource.

public static IEventBus FromEventBusName(Construct scope, string id, string eventBusName)
Parameters
scope Constructs.Construct

Parent construct.

id System.String

Construct ID.

eventBusName System.String

Name of imported event bus.

Returns

IEventBus

GrantAllPutEvents(IGrantable)

Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.

public static Grant GrantAllPutEvents(IGrantable grantee)
Parameters
grantee IGrantable

The principal (no-op if undefined).

Returns

Grant

GrantPutEvents(IGrantable)

(deprecated) Permits an IAM Principal to send custom events to EventBridge so that they can be matched to rules.

public static Grant GrantPutEvents(IGrantable grantee)
Parameters
grantee IGrantable

The principal (no-op if undefined).

Returns

Grant

Remarks

Stability: Deprecated

GrantPutEventsTo(IGrantable)

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

public virtual Grant GrantPutEventsTo(IGrantable grantee)
Parameters
grantee IGrantable
Returns

Grant

Implements

Constructs.IConstruct