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(value=Stable)
public static interface CfnConfigurationSetEventDestination.EventDestinationProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about an event destination.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide .

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)
         .kinesisFirehoseDestination(KinesisFirehoseDestinationProperty.builder()
                 .deliveryStreamArn("deliveryStreamArn")
                 .iamRoleArn("iamRoleArn")
                 .build())
         .name("name")
         .snsDestination(SnsDestinationProperty.builder()
                 .topicArn("topicArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnConfigurationSetEventDestination.EventDestinationProperty.Builder	builder()
default Object	getCloudWatchDestination() An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
default Object	getEnabled() Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.
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 type of email sending events to publish to the event destination.
default String	getName() The name of the event destination.
default Object	getSnsDestination() `CfnConfigurationSetEventDestination.EventDestinationProperty.SnsDestination`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMatchingEventTypes

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

The type of email sending events to publish to the event destination.

• send - The call was successful and Amazon SES is attempting to deliver the email.
• reject - Amazon SES determined that the email contained a virus and rejected it.
• bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.
• complaint - The recipient marked the email as spam.
• delivery - Amazon SES successfully delivered the email to the recipient's mail server.
• open - The recipient received the email and opened it in their email client.
• click - The recipient clicked one or more links in the email.
• renderingFailure - Amazon SES did not send the email because of a template rendering issue.

getCloudWatchDestination

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

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

getEnabled

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

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set.

Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false .

getKinesisFirehoseDestination

@Stability(value=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.

getName

@Stability(value=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.

getSnsDestination

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

`CfnConfigurationSetEventDestination.EventDestinationProperty.SnsDestination`.

builder

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

Returns:

a CfnConfigurationSetEventDestination.EventDestinationProperty.Builder of CfnConfigurationSetEventDestination.EventDestinationProperty