interface EventDestinationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.PinpointEmail.CfnConfigurationSetEventDestination.EventDestinationProperty`
Java	`software.amazon.awscdk.services.pinpointemail.CfnConfigurationSetEventDestination.EventDestinationProperty`
Python	`aws_cdk.aws_pinpointemail.CfnConfigurationSetEventDestination.EventDestinationProperty`
TypeScript	`@aws-cdk/aws-pinpointemail` » `CfnConfigurationSetEventDestination` » `EventDestinationProperty`

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 * as pinpointemail from '@aws-cdk/aws-pinpointemail';
const eventDestinationProperty: pinpointemail.CfnConfigurationSetEventDestination.EventDestinationProperty = {
  matchingEventTypes: ['matchingEventTypes'],

  // the properties below are optional
  cloudWatchDestination: {
    dimensionConfigurations: [{
      defaultDimensionValue: 'defaultDimensionValue',
      dimensionName: 'dimensionName',
      dimensionValueSource: 'dimensionValueSource',
    }],
  },
  enabled: false,
  kinesisFirehoseDestination: {
    deliveryStreamArn: 'deliveryStreamArn',
    iamRoleArn: 'iamRoleArn',
  },
  pinpointDestination: {
    applicationArn: 'applicationArn',
  },
  snsDestination: {
    topicArn: 'topicArn',
  },
};

Properties

Name	Type	Description
matchingEventTypes	`string[]`	The types of events that Amazon Pinpoint sends to the specified event destinations.
cloudWatchDestination?	`IResolvable` `\|` `CloudWatchDestinationProperty`	An object that defines an Amazon CloudWatch destination for email events.
enabled?	`boolean \|` `IResolvable`	If `true` , the event destination is enabled.
kinesisFirehoseDestination?	`IResolvable` `\|` `KinesisFirehoseDestinationProperty`	An object that defines an Amazon Kinesis Data Firehose destination for email events.
pinpointDestination?	`IResolvable` `\|` `PinpointDestinationProperty`	An object that defines a Amazon Pinpoint destination for email events.
snsDestination?	`IResolvable` `\|` `SnsDestinationProperty`	An object that defines an Amazon SNS destination for email events.

matchingEventTypes

Type: string[]

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 .

cloudWatchDestination?

Type: IResolvable | CloudWatchDestinationProperty (optional)

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.

enabled?

Type: boolean | IResolvable (optional)

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.

kinesisFirehoseDestination?

Type: IResolvable | KinesisFirehoseDestinationProperty (optional)

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.

pinpointDestination?

Type: IResolvable | PinpointDestinationProperty (optional)

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.

snsDestination?

Type: IResolvable | SnsDestinationProperty (optional)

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

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