Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PinpointEmail.Types.EventDestinationDefinition

Description

Synopsis

Documentation

data EventDestinationDefinition Source #

An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.

See: newEventDestinationDefinition smart constructor.

Constructors

EventDestinationDefinition'

Fields

cloudWatchDestination :: Maybe CloudWatchDestination
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 :: Maybe Bool
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 :: Maybe KinesisFirehoseDestination
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.
matchingEventTypes :: Maybe [EventType]
An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.
pinpointDestination :: Maybe PinpointDestination
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 :: Maybe SnsDestination
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

Instances

Instances details

ToJSON EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Methods toJSON :: EventDestinationDefinition -> Value # toEncoding :: EventDestinationDefinition -> Encoding # toJSONList :: [EventDestinationDefinition] -> Value # toEncodingList :: [EventDestinationDefinition] -> Encoding #
Generic EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Associated Types type Rep EventDestinationDefinition :: Type -> Type # Methods from :: EventDestinationDefinition -> Rep EventDestinationDefinition x # to :: Rep EventDestinationDefinition x -> EventDestinationDefinition #
Read EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Methods readsPrec :: Int -> ReadS EventDestinationDefinition # readList :: ReadS [EventDestinationDefinition] # readPrec :: ReadPrec EventDestinationDefinition # readListPrec :: ReadPrec [EventDestinationDefinition] #
Show EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Methods showsPrec :: Int -> EventDestinationDefinition -> ShowS # show :: EventDestinationDefinition -> String # showList :: [EventDestinationDefinition] -> ShowS #
NFData EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Methods rnf :: EventDestinationDefinition -> () #
Eq EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Methods (==) :: EventDestinationDefinition -> EventDestinationDefinition -> Bool # (/=) :: EventDestinationDefinition -> EventDestinationDefinition -> Bool #
Hashable EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition Methods hashWithSalt :: Int -> EventDestinationDefinition -> Int # hash :: EventDestinationDefinition -> Int #
type Rep EventDestinationDefinition Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestinationDefinition type Rep EventDestinationDefinition = D1 ('MetaData "EventDestinationDefinition" "Amazonka.PinpointEmail.Types.EventDestinationDefinition" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "EventDestinationDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cloudWatchDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchDestination)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kinesisFirehoseDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisFirehoseDestination)))) :: (S1 ('MetaSel ('Just "matchingEventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventType])) :: (S1 ('MetaSel ('Just "pinpointDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PinpointDestination)) :*: S1 ('MetaSel ('Just "snsDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnsDestination))))))

newEventDestinationDefinition :: EventDestinationDefinition Source #

Create a value of EventDestinationDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cloudWatchDestination:EventDestinationDefinition', eventDestinationDefinition_cloudWatchDestination - 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.

$sel:enabled:EventDestinationDefinition', eventDestinationDefinition_enabled - 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.

$sel:kinesisFirehoseDestination:EventDestinationDefinition', eventDestinationDefinition_kinesisFirehoseDestination - 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.

$sel:matchingEventTypes:EventDestinationDefinition', eventDestinationDefinition_matchingEventTypes - An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.

$sel:pinpointDestination:EventDestinationDefinition', eventDestinationDefinition_pinpointDestination - 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.

$sel:snsDestination:EventDestinationDefinition', eventDestinationDefinition_snsDestination - An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

eventDestinationDefinition_cloudWatchDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchDestination) Source #

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.

eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool) Source #

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.

eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination) Source #

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.

eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType]) Source #

An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.

eventDestinationDefinition_pinpointDestination :: Lens' EventDestinationDefinition (Maybe PinpointDestination) Source #

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.

eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination) Source #

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.