Amazonka.Pinpoint.Types.WriteEventStream

Documentation

data WriteEventStream

Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

See: newWriteEventStream smart constructor.

Constructors

WriteEventStream'

Fields

• 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 that you want 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

ToJSON WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

toJSON :: WriteEventStream -> Value

toEncoding :: WriteEventStream -> Encoding

toJSONList :: [WriteEventStream] -> Value

toEncodingList :: [WriteEventStream] -> Encoding

Generic WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Associated Types

type Rep WriteEventStream :: Type -> Type

Methods

from :: WriteEventStream -> Rep WriteEventStream x

to :: Rep WriteEventStream x -> WriteEventStream

Read WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

readsPrec :: Int -> ReadS WriteEventStream

readList :: ReadS [WriteEventStream]

readPrec :: ReadPrec WriteEventStream

readListPrec :: ReadPrec [WriteEventStream]

Show WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

showsPrec :: Int -> WriteEventStream -> ShowS

show :: WriteEventStream -> String

showList :: [WriteEventStream] -> ShowS

NFData WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

rnf :: WriteEventStream -> ()

Eq WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

(==) :: WriteEventStream -> WriteEventStream -> Bool

(/=) :: WriteEventStream -> WriteEventStream -> Bool

Hashable WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

Methods

hashWithSalt :: Int -> WriteEventStream -> Int

hash :: WriteEventStream -> Int

type Rep WriteEventStream

Defined in Amazonka.Pinpoint.Types.WriteEventStream

type Rep WriteEventStream = D1 ('MetaData "WriteEventStream" "Amazonka.Pinpoint.Types.WriteEventStream" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "WriteEventStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationStreamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWriteEventStream

Arguments

:: Text

$sel:roleArn:WriteEventStream'

-> Text

$sel:destinationStreamArn:WriteEventStream'

-> WriteEventStream

Create a value of WriteEventStream 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:roleArn:WriteEventStream', writeEventStream_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:WriteEventStream', writeEventStream_destinationStreamArn - The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want 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

writeEventStream_roleArn :: Lens' WriteEventStream Text

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

writeEventStream_destinationStreamArn :: Lens' WriteEventStream Text

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want 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