Skip to main content

ISESV2EventDestinationDefinition

Interface in AWS.SESV2

Interface for EventDestinationDefinition configuration.

Properties​

CloudWatchDestination​

property CloudWatchDestination: ISESV2CloudWatchDestination

Type: ISESV2CloudWatchDestination

Configuration for sending email events to Amazon CloudWatch.

When configured, email events are published as CloudWatch metrics, allowing you to monitor and gain insights on your email sending performance. You can create CloudWatch alarms and dashboards to track key metrics like bounce and complaint rates. This destination requires dimension configurations that define how the metrics are organized and tagged within CloudWatch.

Enabled​

property Enabled: TOptional<Boolean>

Controls whether the event destination is enabled for processing email events.

When set to True, the specified event types are sent to the configured destinations in this event destination definition. When set to False, the event destination is disabled and events are not sent to any destinations. This setting provides a way to temporarily disable event publishing without removing the event destination configuration entirely.

EventBridgeDestination​

property EventBridgeDestination: ISESV2EventBridgeDestination

Type: ISESV2EventBridgeDestination

Configuration for sending email events to Amazon EventBridge.

When configured, email events are sent to the specified EventBridge event bus, enabling you to build event-driven architectures that respond to email events. You can create EventBridge rules to route events to various AWS services or custom applications. EventBridge provides advanced filtering and routing capabilities, making it ideal for complex event processing workflows.

KinesisFirehoseDestination​

property KinesisFirehoseDestination: ISESV2KinesisFirehoseDestination

Type: ISESV2KinesisFirehoseDestination

Configuration for streaming email events to Amazon Kinesis Data Firehose.

When configured, email events are streamed to the specified Kinesis Data Firehose delivery stream, which can then deliver the data to destinations such as Amazon S3, Amazon Redshift, or Amazon OpenSearch Service for long-term storage and analysis. This destination requires an IAM role that grants Amazon SES permission to write to the specified Firehose delivery stream.

MatchingEventTypes​

property MatchingEventTypes: TList<string>

Specifies which email events should be sent to the configured destinations.

Supported event types include:

  • SEND – The send request was successful and SES will attempt to deliver the message.
  • REJECT – SES accepted the email but determined that it contains a virus and rejected it.
  • BOUNCE – The recipient's mail server permanently rejected the email.
  • COMPLAINT – The email was successfully delivered but the recipient marked it as spam.
  • DELIVERY – SES successfully delivered the email to the recipient's mail server.
  • OPEN – The recipient received and opened the email.
  • CLICK – The recipient clicked one or more links contained in the email.
  • RENDERING_FAILURE – The email was not sent because of a template rendering failure.
  • DELIVERY_DELAY – The email couldn't be delivered because of a temporary issue.
  • SUBSCRIPTION – The email was successfully delivered, but the recipient updated their subscription preferences. You can specify any combination of these event types to customize which events are published to your destinations.

PinpointDestination​

property PinpointDestination: ISESV2PinpointDestination

Type: ISESV2PinpointDestination

Configuration for sending email events to Amazon Pinpoint.

When configured, email events are sent to the specified Amazon Pinpoint application, where you can view metrics using the Transactional Messaging dashboards built into Amazon Pinpoint. This provides integrated analytics and visualization capabilities. This destination is particularly useful when you're already using Amazon Pinpoint for customer engagement and want to centralize your email analytics.

SnsDestination​

property SnsDestination: ISESV2SnsDestination

Type: ISESV2SnsDestination

Configuration for sending email events to Amazon Simple Notification Service (SNS).

When configured, email events are published to the specified SNS topic, allowing you to receive immediate notifications when certain email events occur. This is useful for real-time alerting on bounces, complaints, or other critical events. Subscribers to the SNS topic will receive detailed JSON payloads containing information about each email event.

Methods​

AddMatchingEventType​

function AddMatchingEventType(const AEventType: string): NativeInt;

Add an event type to MatchingEventTypes.

Parameters

NameDescription
AEventTypeSpecify the event type to add to MatchingEventTypes.

Returns

Returns the index of the event type added to MatchingEventTypes.