Interface CfnConfigurationSetEventDestination.IEventDestinationProperty
In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints.
Namespace: Amazon.CDK.AWS.PinpointEmail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEventDestinationProperty
Syntax (vb)
Public Interface IEventDestinationProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.PinpointEmail;
var eventDestinationProperty = new EventDestinationProperty {
MatchingEventTypes = new [] { "matchingEventTypes" },
// the properties below are optional
CloudWatchDestination = new CloudWatchDestinationProperty {
DimensionConfigurations = new [] { new DimensionConfigurationProperty {
DefaultDimensionValue = "defaultDimensionValue",
DimensionName = "dimensionName",
DimensionValueSource = "dimensionValueSource"
} }
},
Enabled = false,
KinesisFirehoseDestination = new KinesisFirehoseDestinationProperty {
DeliveryStreamArn = "deliveryStreamArn",
IamRoleArn = "iamRoleArn"
},
PinpointDestination = new PinpointDestinationProperty {
ApplicationArn = "applicationArn"
},
SnsDestination = new SnsDestinationProperty {
TopicArn = "topicArn"
}
};
Synopsis
Properties
CloudWatchDestination | An object that defines an Amazon CloudWatch destination for email events. |
Enabled | If |
KinesisFirehoseDestination | An object that defines an Amazon Kinesis Data Firehose destination for email events. |
MatchingEventTypes | The types of events that Amazon Pinpoint sends to the specified event destinations. |
PinpointDestination | An object that defines a Amazon Pinpoint destination for email events. |
SnsDestination | An object that defines an Amazon SNS destination for email events. |
Properties
CloudWatchDestination
An object that defines an Amazon CloudWatch destination for email events.
virtual object CloudWatchDestination { get; }
Property Value
System.Object
Remarks
You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
Enabled
If true
, the event destination is enabled.
virtual object Enabled { get; }
Property Value
System.Object
Remarks
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
An object that defines an Amazon Kinesis Data Firehose destination for email events.
virtual object KinesisFirehoseDestination { get; }
Property Value
System.Object
Remarks
You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
MatchingEventTypes
The types of events that Amazon Pinpoint sends to the specified event destinations.
string[] MatchingEventTypes { get; }
Property Value
System.String[]
Remarks
Acceptable values: SEND
, REJECT
, BOUNCE
, COMPLAINT
, DELIVERY
, OPEN
, CLICK
, and RENDERING_FAILURE
.
PinpointDestination
An object that defines a Amazon Pinpoint destination for email events.
virtual object PinpointDestination { get; }
Property Value
System.Object
Remarks
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
An object that defines an Amazon SNS destination for email events.
virtual object SnsDestination { get; }
Property Value
System.Object
Remarks
You can use Amazon SNS to send notification when certain email events occur.