AWS::Pinpoint::EventStream - AWS CloudFormation

AWS::Pinpoint::EventStream

You can configure Amazon Pinpoint to stream events to Amazon Kinesis Data Firehose or Amazon Kinesis Data Streams. By streaming events, you enable more flexible options for analysis and storage. The AWS::Pinpoint::EventStream resource defines the settings of an event stream for an Amazon Pinpoint application.

You can configure only one event stream for each Amazon Pinpoint application. To combine data from multiple applications, configure each application to use the same stream.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Pinpoint::EventStream", "Properties" : { "ApplicationId" : String, "DestinationStreamArn" : String, "RoleArn" : String } }

YAML

Type: AWS::Pinpoint::EventStream Properties: ApplicationId: String DestinationStreamArn: String RoleArn: String

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application that you want to publish event data for.

Required: Yes

Type: String

Update requires: Replacement

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

Required: Yes

Type: String

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier (ApplicationId) for the Amazon Pinpoint application that the event stream is associated with.

For more information about using the Ref function, see Ref.