Package software.amazon.awscdk.services.pinpointemail

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 Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints.

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.pinpointemail.*;
 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())
         .pinpointDestination(PinpointDestinationProperty.builder()
                 .applicationArn("applicationArn")
                 .build())
         .snsDestination(SnsDestinationProperty.builder()
                 .topicArn("topicArn")
                 .build())
         .build();

  • Method Details

    • getMatchingEventTypes

      @Stability(Stable) @NotNull List<String> getMatchingEventTypes()
      The types of events that Amazon Pinpoint sends to the specified event destinations.

      Acceptable values: SEND , REJECT , BOUNCE , COMPLAINT , DELIVERY , OPEN , CLICK , and RENDERING_FAILURE .

    • 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.

    • 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.

    • getKinesisFirehoseDestination

      @Stability(Stable) @Nullable default Object getKinesisFirehoseDestination()
      An object that defines an Amazon Kinesis Data Firehose destination for email events.

      You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

    • getPinpointDestination

      @Stability(Stable) @Nullable default Object getPinpointDestination()
      An object that defines a Amazon Pinpoint destination for email events.

      You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

    • getSnsDestination

      @Stability(Stable) @Nullable default Object getSnsDestination()
      An object that defines an Amazon SNS destination for email events.

      You can use Amazon SNS to send notification when certain email events occur.

    • builder

      @Stability(Stable) static CfnConfigurationSetEventDestination.EventDestinationProperty.Builder builder()
      Returns:
      a CfnConfigurationSetEventDestination.EventDestinationProperty.Builder of CfnConfigurationSetEventDestination.EventDestinationProperty