Skip to content

/AWS1/CL_PPTEVENTSTREAM

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

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

iv_destinationstreamarn TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

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

iv_rolearn TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

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

Optional arguments:

iv_externalid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

(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.

iv_lastmodifieddate TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

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

iv_lastupdatedby TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The IAM user who last modified the event stream.


Queryable Attributes

ApplicationId

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

Accessible with the following methods

Method Description
GET_APPLICATIONID() Getter for APPLICATIONID, with configurable default
ASK_APPLICATIONID() Getter for APPLICATIONID w/ exceptions if field has no value
HAS_APPLICATIONID() Determine if APPLICATIONID has a value

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

Accessible with the following methods

Method Description
GET_DESTINATIONSTREAMARN() Getter for DESTINATIONSTREAMARN, with configurable default
ASK_DESTINATIONSTREAMARN() Getter for DESTINATIONSTREAMARN w/ exceptions if field has n
HAS_DESTINATIONSTREAMARN() Determine if DESTINATIONSTREAMARN has a value

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.

Accessible with the following methods

Method Description
GET_EXTERNALID() Getter for EXTERNALID, with configurable default
ASK_EXTERNALID() Getter for EXTERNALID w/ exceptions if field has no value
HAS_EXTERNALID() Determine if EXTERNALID has a value

LastModifiedDate

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

Accessible with the following methods

Method Description
GET_LASTMODIFIEDDATE() Getter for LASTMODIFIEDDATE, with configurable default
ASK_LASTMODIFIEDDATE() Getter for LASTMODIFIEDDATE w/ exceptions if field has no va
HAS_LASTMODIFIEDDATE() Determine if LASTMODIFIEDDATE has a value

LastUpdatedBy

The IAM user who last modified the event stream.

Accessible with the following methods

Method Description
GET_LASTUPDATEDBY() Getter for LASTUPDATEDBY, with configurable default
ASK_LASTUPDATEDBY() Getter for LASTUPDATEDBY w/ exceptions if field has no value
HAS_LASTUPDATEDBY() Determine if LASTUPDATEDBY has a value

RoleArn

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

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value