Package software.amazon.awscdk.services.pinpointemail

Class CfnConfigurationSetEventDestination

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.pinpointemail.CfnConfigurationSetEventDestination
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.895Z") @Stability(Stable) public class CfnConfigurationSetEventDestination extends CfnResource implements IInspectable
A CloudFormation AWS::PinpointEmail::ConfigurationSetEventDestination.

Create an event destination. 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.

A single configuration set can include more than one event destination.

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.*;
 CfnConfigurationSetEventDestination cfnConfigurationSetEventDestination = CfnConfigurationSetEventDestination.Builder.create(this, "MyCfnConfigurationSetEventDestination")
         .configurationSetName("configurationSetName")
         .eventDestinationName("eventDestinationName")
         // the properties below are optional
         .eventDestination(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())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConfigurationSetEventDestination

      protected CfnConfigurationSetEventDestination(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConfigurationSetEventDestination

      protected CfnConfigurationSetEventDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConfigurationSetEventDestination

      @Stability(Stable) public CfnConfigurationSetEventDestination(@NotNull Construct scope, @NotNull String id, @NotNull CfnConfigurationSetEventDestinationProps props)
      Create a new AWS::PinpointEmail::ConfigurationSetEventDestination.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getConfigurationSetName

      @Stability(Stable) @NotNull public String getConfigurationSetName()
      The name of the configuration set that contains the event destination that you want to modify.

    • setConfigurationSetName

      @Stability(Stable) public void setConfigurationSetName(@NotNull String value)
      The name of the configuration set that contains the event destination that you want to modify.

    • getEventDestinationName

      @Stability(Stable) @NotNull public String getEventDestinationName()
      The name of the event destination that you want to modify.

    • setEventDestinationName

      @Stability(Stable) public void setEventDestinationName(@NotNull String value)
      The name of the event destination that you want to modify.

    • getEventDestination

      @Stability(Stable) @Nullable public Object getEventDestination()
      An object that defines the event destination.

    • setEventDestination

      @Stability(Stable) public void setEventDestination(@Nullable IResolvable value)
      An object that defines the event destination.

    • setEventDestination

      @Stability(Stable) public void setEventDestination(@Nullable CfnConfigurationSetEventDestination.EventDestinationProperty value)
      An object that defines the event destination.