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.Pinpoint.Types.EventStream

Description

Synopsis

Documentation

data EventStream Source #

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

See: newEventStream smart constructor.

Constructors

EventStream'

Fields

externalId :: Maybe Text
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
lastModifiedDate :: Maybe Text
The date, in ISO 8601 format, when the event stream was last modified.
lastUpdatedBy :: Maybe Text
The IAM user who last modified the event stream.
applicationId :: Text
The unique identifier for the application to publish event data for.
roleArn :: Text
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
destinationStreamArn :: Text
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

Instances

Instances details

FromJSON EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Methods parseJSON :: Value -> Parser EventStream # parseJSONList :: Value -> Parser [EventStream] #
Generic EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Associated Types type Rep EventStream :: Type -> Type # Methods from :: EventStream -> Rep EventStream x # to :: Rep EventStream x -> EventStream #
Read EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Methods readsPrec :: Int -> ReadS EventStream # readList :: ReadS [EventStream] # readPrec :: ReadPrec EventStream # readListPrec :: ReadPrec [EventStream] #
Show EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Methods showsPrec :: Int -> EventStream -> ShowS # show :: EventStream -> String # showList :: [EventStream] -> ShowS #
NFData EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Methods rnf :: EventStream -> () #
Eq EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Methods (==) :: EventStream -> EventStream -> Bool # (/=) :: EventStream -> EventStream -> Bool #
Hashable EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream Methods hashWithSalt :: Int -> EventStream -> Int # hash :: EventStream -> Int #
type Rep EventStream Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventStream type Rep EventStream = D1 ('MetaData "EventStream" "Amazonka.Pinpoint.Types.EventStream" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "EventStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastUpdatedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationStreamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEventStream Source #

Arguments

:: Text	`$sel:applicationId:EventStream'`
-> Text	`$sel:roleArn:EventStream'`
-> Text	`$sel:destinationStreamArn:EventStream'`
-> EventStream

Create a value of EventStream 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:externalId:EventStream', eventStream_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

$sel:lastModifiedDate:EventStream', eventStream_lastModifiedDate - The date, in ISO 8601 format, when the event stream was last modified.

$sel:lastUpdatedBy:EventStream', eventStream_lastUpdatedBy - The IAM user who last modified the event stream.

$sel:applicationId:EventStream', eventStream_applicationId - The unique identifier for the application to publish event data for.

$sel:roleArn:EventStream', eventStream_roleArn - The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

$sel:destinationStreamArn:EventStream', eventStream_destinationStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

eventStream_externalId :: Lens' EventStream (Maybe Text) Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

eventStream_lastModifiedDate :: Lens' EventStream (Maybe Text) Source #

The date, in ISO 8601 format, when the event stream was last modified.

eventStream_lastUpdatedBy :: Lens' EventStream (Maybe Text) Source #

The IAM user who last modified the event stream.

eventStream_applicationId :: Lens' EventStream Text Source #

The unique identifier for the application to publish event data for.

eventStream_roleArn :: Lens' EventStream Text Source #

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

eventStream_destinationStreamArn :: Lens' EventStream Text Source #

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name