Skip to content
v2.276.0

EventDestination Class ​

An event destination.

Example ​

ts
import * as events from 'aws-cdk-lib/aws-events';

declare const myConfigurationSet: ses.ConfigurationSet;

const bus = events.EventBus.fromEventBusName(this, 'EventBus', 'default');

myConfigurationSet.addEventDestination('ToEventBus', {
  destination: ses.EventDestination.eventBus(bus),
})
python
import aws_cdk.aws_events as events

# my_configuration_set: ses.ConfigurationSet


bus = events.EventBus.from_event_bus_name(self, "EventBus", "default")

my_configuration_set.add_event_destination("ToEventBus",
    destination=ses.EventDestination.event_bus(bus)
)
java
import software.amazon.awscdk.services.events.*;

ConfigurationSet myConfigurationSet;


IEventBus bus = EventBus.fromEventBusName(this, "EventBus", "default");

myConfigurationSet.addEventDestination("ToEventBus", ConfigurationSetEventDestinationOptions.builder()
        .destination(EventDestination.eventBus(bus))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Events;

ConfigurationSet myConfigurationSet;


var bus = EventBus.FromEventBusName(this, "EventBus", "default");

myConfigurationSet.AddEventDestination("ToEventBus", new ConfigurationSetEventDestinationOptions {
    Destination = EventDestination.EventBus(bus)
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import events "github.com/aws/aws-cdk-go/awscdk"

var myConfigurationSet ConfigurationSet


bus := events.EventBus_FromEventBusName(this, jsii.String("EventBus"), jsii.String("default"))

myConfigurationSet.AddEventDestination(jsii.String("ToEventBus"), &ConfigurationSetEventDestinationOptions{
	Destination: ses.EventDestination_EventBus(bus),
})

Initializer ​

ts
new EventDestination()
python
EventDestination()
java
new EventDestination()
csharp
new EventDestination()
go
NewEventDestination()

Properties ​

busmay be undefinedIEventBusRefbusmay be undefinedIEventBusRefbusmay be undefinedIEventBusRefBusmay be undefinedIEventBusRefBusmay be undefinedIEventBusRef#
Use Event Bus as event destination.

Default: do not send events to Event bus

dimensionsmay be undefinedCloudWatchDimension[]dimensionsmay be undefinedtyping.List[CloudWatchDimension]dimensionsmay be undefinedList<CloudWatchDimension>Dimensionsmay be undefinedCloudWatchDimension[]Dimensionsmay be undefined*[]CloudWatchDimension#
A list of CloudWatch dimensions upon which to categorize your emails.

Default: do not send events to CloudWatch

streammay be undefinedFirehoseDeliveryStreamDestinationstreammay be undefinedFirehoseDeliveryStreamDestinationstreammay be undefinedFirehoseDeliveryStreamDestinationStreammay be undefinedFirehoseDeliveryStreamDestinationStreammay be undefinedFirehoseDeliveryStreamDestination#
Use Firehose Delivery Stream.

Default: do not send events to Firehose Delivery Stream

topicmay be undefinedITopictopicmay be undefinedITopictopicmay be undefinedITopicTopicmay be undefinedITopicTopicmay be undefinedITopic#
A SNS topic to use as event destination.

Default: do not send events to a SNS topic

Methods ​

cloudWatchDimensions(dimensions: CloudWatchDimension[]): EventDestination // chainable@staticmethod def cloud_watch_dimensions(dimensions: typing.List[CloudWatchDimension]) -> EventDestinationpublic static EventDestination cloudWatchDimensions(List<CloudWatchDimension> dimensions)public static EventDestination CloudWatchDimensions(CloudWatchDimension[] dimensions)func CloudWatchDimensions(Dimensions *[]CloudWatchDimension) EventDestinationstatic#
Use CloudWatch dimensions as event destination.
eventBus(eventBus: IEventBusRef): EventDestination // chainable@staticmethod def event_bus(event_bus: IEventBusRef) -> EventDestinationpublic static EventDestination eventBus(IEventBusRef eventBus)public static EventDestination EventBus(IEventBusRef eventBus)func EventBus(EventBus IEventBusRef) EventDestinationstatic#
Use Event Bus as event destination.
firehoseDeliveryStream(stream: FirehoseDeliveryStreamDestination): EventDestination // chainable@staticmethod def firehose_delivery_stream(stream: FirehoseDeliveryStreamDestination) -> EventDestinationpublic static EventDestination firehoseDeliveryStream(FirehoseDeliveryStreamDestination stream)public static EventDestination FirehoseDeliveryStream(FirehoseDeliveryStreamDestination stream)func FirehoseDeliveryStream(Stream FirehoseDeliveryStreamDestination) EventDestinationstatic#
Use Firehose Delivery Stream as event destination.
snsTopic(topic: ITopic): EventDestination // chainable@staticmethod def sns_topic(topic: ITopic) -> EventDestinationpublic static EventDestination snsTopic(ITopic topic)public static EventDestination SnsTopic(ITopic topic)func SnsTopic(Topic ITopic) EventDestinationstatic#
Use a SNS topic as event destination.