Package software.amazon.awscdk.services.ses

Interface CfnConfigurationSetEventDestination.EventDestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationSetEventDestination.EventDestinationProperty.Jsii$Proxy

Enclosing class:

CfnConfigurationSetEventDestination

@Stability(Stable)
public static interface CfnConfigurationSetEventDestination.EventDestinationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ses.*;
 EventDestinationProperty eventDestinationProperty = EventDestinationProperty.builder()
         .matchingEventTypes(List.of("matchingEventTypes"))
         // the properties below are optional
         .cloudWatchDestination(CloudWatchDestinationProperty.builder()
                 .dimensionConfigurations(List.of(DimensionConfigurationProperty.builder()
                         .defaultDimensionValue("defaultDimensionValue")
                         .dimensionName("dimensionName")
                         .dimensionValueSource("dimensionValueSource")
                         .build()))
                 .build())
         .enabled(false)
         .eventBridgeDestination(EventBridgeDestinationProperty.builder()
                 .eventBusArn("eventBusArn")
                 .build())
         .kinesisFirehoseDestination(KinesisFirehoseDestinationProperty.builder()
                 .deliveryStreamArn("deliveryStreamArn")
                 .iamRoleArn("iamRoleArn")
                 .build())
         .name("name")
         .snsDestination(SnsDestinationProperty.builder()
                 .topicArn("topicArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationSetEventDestination.EventDestinationProperty.Builder	A builder for CfnConfigurationSetEventDestination.EventDestinationProperty
static final class	CfnConfigurationSetEventDestination.EventDestinationProperty.Jsii$Proxy	An implementation for CfnConfigurationSetEventDestination.EventDestinationProperty

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationSetEventDestination.EventDestinationProperty.Builder	builder()
default Object	getCloudWatchDestination()	An object that defines an Amazon CloudWatch destination for email events.
default Object	getEnabled()	If true , the event destination is enabled.
default Object	getEventBridgeDestination()	An object that defines an Amazon EventBridge destination for email events.
default Object	getKinesisFirehoseDestination()	An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
List<String>	getMatchingEventTypes()	The types of events that Amazon SES sends to the specified event destinations.
default String	getName()	The name of the event destination.
default Object	getSnsDestination()	An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMatchingEventTypes

@Stability(Stable)
@NotNull
List<String> getMatchingEventTypes()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes

getCloudWatchDestination

@Stability(Stable)
@Nullable
default Object getCloudWatchDestination()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-enabled

getEventBridgeDestination

@Stability(Stable)
@Nullable
default Object getEventBridgeDestination()

An object that defines an Amazon EventBridge destination for email events.

You can use Amazon EventBridge to send notifications when certain email events occur.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-eventbridgedestination

getKinesisFirehoseDestination

@Stability(Stable)
@Nullable
default Object getKinesisFirehoseDestination()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-kinesisfirehosedestination

getName

@Stability(Stable)
@Nullable
default String getName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-name

getSnsDestination

@Stability(Stable)
@Nullable
default Object getSnsDestination()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-snsdestination

builder

@Stability(Stable)
static CfnConfigurationSetEventDestination.EventDestinationProperty.Builder builder()

Returns:

a CfnConfigurationSetEventDestination.EventDestinationProperty.Builder of CfnConfigurationSetEventDestination.EventDestinationProperty