AWS::SES::ConfigurationSetEventDestination EventDestination

In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CloudWatchDestination" : CloudWatchDestination,
  "Enabled" : Boolean,
  "EventBridgeDestination" : EventBridgeDestination,
  "KinesisFirehoseDestination" : KinesisFirehoseDestination,
  "MatchingEventTypes" : [ String, ... ],
  "Name" : String,
  "SnsDestination" : SnsDestination
}

YAML

  CloudWatchDestination: 
    CloudWatchDestination
  Enabled: Boolean
  EventBridgeDestination: 
    EventBridgeDestination
  KinesisFirehoseDestination: 
    KinesisFirehoseDestination
  MatchingEventTypes: 
    - String
  Name: String
  SnsDestination: 
    SnsDestination

Properties

CloudWatchDestination

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

Required: No

Type: CloudWatchDestination

Update requires: No interruption

Enabled

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

Required: No

Type: Boolean

Update requires: No interruption

EventBridgeDestination

An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.

Required: No

Type: EventBridgeDestination

Update requires: No interruption

KinesisFirehoseDestination

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Required: No

Type: KinesisFirehoseDestination

Update requires: No interruption

MatchingEventTypes

The types of events that Amazon SES sends to the specified event destinations.

• SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

• REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

• BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

• COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

• DELIVERY - SES successfully delivered the email to the recipient's mail server.

• OPEN - The recipient received the message and opened it in their email client.

• CLICK - The recipient clicked one or more links in the email.

• RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

• DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

• SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

Required: Yes

Type: Array of String

Update requires: No interruption

Name

The name of the event destination. The name must meet the following requirements:

• Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

• Contain 64 characters or fewer.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]{0,64}$

Update requires: No interruption

SnsDestination

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Required: No

Type: SnsDestination

Update requires: No interruption