Class EventBusProps

Properties to define an event bus.

Inheritance

object

EventBusProps

Implements

IEventBusProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EventBusProps : IEventBusProps

Syntax (vb)

Public Class EventBusProps Implements 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

Constructors

EventBusProps()

Properties to define an event bus.

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.

Constructors

EventBusProps()

Properties to define an event bus.

public EventBusProps()

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"
                } }
            });

Properties

DeadLetterQueue

Dead-letter queue for the event bus.

public IQueue? DeadLetterQueue { get; set; }

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.

public string? Description { get; set; }

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.

public string? EventBusName { get; set; }

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.

public string? EventSourceName { get; set; }

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.

public IKey? KmsKey { get; set; }

Property Value

IKey

Remarks

Default: - Use an AWS managed key

LogConfig

The Logging Configuration of the Èvent Bus.

public ILogConfig? LogConfig { get; set; }

Property Value

ILogConfig

Remarks

Default: - no logging

Implements

IEventBusProps