Interface IEventBusProps

Properties to define an event bus.

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEventBusProps

Syntax (vb)

Public Interface IEventBusProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Events;


            var myEventBus = new EventBus(this, "EventBus", new EventBusProps {
                EventBusName = "MyEventBus1"
            });

            new EventBridgePutEvents(this, "Send an event to EventBridge", new EventBridgePutEventsProps {
                Entries = new [] { new EventBridgePutEventsEntry {
                    Detail = TaskInput.FromObject(new Dictionary<string, object> {
                        { "Message", "Hello from Step Functions!" }
                    }),
                    EventBus = myEventBus,
                    DetailType = "MessageFromStepFunctions",
                    Source = "step.functions"
                } }
            });

Synopsis

Properties

DeadLetterQueue	Dead-letter queue for the event bus.
Description	The event bus description.
EventBusName	The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.
EventSourceName	The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.
KmsKey	The customer managed key that encrypt events on this event bus.
LogConfig	The Logging Configuration of the Èvent Bus.

Properties

DeadLetterQueue

Dead-letter queue for the event bus.

IQueue? DeadLetterQueue { get; }

Property Value

IQueue

Remarks

Default: - no dead-letter queue

See: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq

Description

The event bus description.

string? Description { get; }

Property Value

string

Remarks

The description can be up to 512 characters long.

Default: - no description

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-description

EventBusName

The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.

string? EventBusName { get; }

Property Value

string

Remarks

Default: - automatically generated name

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

EventSourceName

The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.

string? EventSourceName { get; }

Property Value

string

Remarks

Default: - no partner event source

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

KmsKey

The customer managed key that encrypt events on this event bus.

IKey? KmsKey { get; }

Property Value

IKey

Remarks

Default: - Use an AWS managed key

LogConfig

The Logging Configuration of the Èvent Bus.

ILogConfig? LogConfig { get; }

Property Value

ILogConfig

Remarks

Default: - no logging