AWS::Pinpoint::EventStream - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Pinpoint::EventStream

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

Syntax

To declare this entity in your Amazon 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 export data from.

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 Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your Amazon account.

Required: Yes

Type: String

Update requires: No interruption

Return values

Ref

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

For more information about using the Reffunction, see Ref.