software.amazon.awscdk.services.pinpointemail

Class CfnConfigurationSetEventDestination

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpointemail.CfnConfigurationSetEventDestination

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.252Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConfigurationSetEventDestination.Builder A fluent builder for CfnConfigurationSetEventDestination.
static interface	CfnConfigurationSetEventDestination.CloudWatchDestinationProperty An object that defines an Amazon CloudWatch destination for email events.
static interface	CfnConfigurationSetEventDestination.DimensionConfigurationProperty An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
static interface	CfnConfigurationSetEventDestination.EventDestinationProperty In Amazon Pinpoint, *events* include message sends, deliveries, opens, clicks, bounces, and complaints.
static interface	CfnConfigurationSetEventDestination.KinesisFirehoseDestinationProperty An object that defines an Amazon Kinesis Data Firehose destination for email events.
static interface	CfnConfigurationSetEventDestination.PinpointDestinationProperty An object that defines a Amazon Pinpoint destination for email events.
static interface	CfnConfigurationSetEventDestination.SnsDestinationProperty An object that defines an Amazon SNS destination for email events.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfigurationSetEventDestination(software.constructs.Construct scope, String id, CfnConfigurationSetEventDestinationProps props) Create a new `AWS::PinpointEmail::ConfigurationSetEventDestination`.
protected	CfnConfigurationSetEventDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationSetEventDestination(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getConfigurationSetName() The name of the configuration set that contains the event destination that you want to modify.
Object	getEventDestination() An object that defines the event destination.
String	getEventDestinationName() The name of the event destination that you want to modify.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfigurationSetName(String value) The name of the configuration set that contains the event destination that you want to modify.
void	setEventDestination(CfnConfigurationSetEventDestination.EventDestinationProperty value) An object that defines the event destination.
void	setEventDestination(IResolvable value) An object that defines the event destination.
void	setEventDestinationName(String value) The name of the event destination that you want to modify.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConfigurationSetEventDestination

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

CfnConfigurationSetEventDestination

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

CfnConfigurationSetEventDestination

@Stability(value=Stable)
public CfnConfigurationSetEventDestination(@NotNull
                                                                    software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfigurationSetName

@Stability(value=Stable)
 @NotNull
public String getConfigurationSetName()

The name of the configuration set that contains the event destination that you want to modify.

setConfigurationSetName

@Stability(value=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(value=Stable)
 @NotNull
public String getEventDestinationName()

The name of the event destination that you want to modify.

setEventDestinationName

@Stability(value=Stable)
public void setEventDestinationName(@NotNull
                                                             String value)

The name of the event destination that you want to modify.

getEventDestination

@Stability(value=Stable)
 @Nullable
public Object getEventDestination()

An object that defines the event destination.

setEventDestination

@Stability(value=Stable)
public void setEventDestination(@Nullable
                                                         CfnConfigurationSetEventDestination.EventDestinationProperty value)

An object that defines the event destination.

setEventDestination

@Stability(value=Stable)
public void setEventDestination(@Nullable
                                                         IResolvable value)

An object that defines the event destination.