AWS Amazon Pinpoint Event Stream

This page shows how to write Terraform and CloudFormation for Amazon Pinpoint Event Stream and write them securely.

aws_pinpoint_event_stream (Terraform)

The Event Stream in Amazon Pinpoint can be configured in Terraform with the resource name aws_pinpoint_event_stream. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

Explanation in Terraform Registry

Provides a Pinpoint Event Stream resource.

AWS::Pinpoint::EventStream (CloudFormation)

The EventStream in Pinpoint can be configured in CloudFormation with the resource name AWS::Pinpoint::EventStream. The following sections describe 8 examples of how to use the resource and its parameters.

Example Usage from GitHub

product.template-ap-south-1.yaml#L15
    Type: AWS::Pinpoint::EventStream
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
    Properties:
      ApplicationId: !Ref 'ApplicationId'
      DestinationStreamArn: !Ref 'DestinationStreamArn'
      RoleArn: !Ref 'RoleArn'
product.template-us-east-1.yaml#L15
    Type: AWS::Pinpoint::EventStream
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
    Properties:
      ApplicationId: !Ref 'ApplicationId'
      DestinationStreamArn: !Ref 'DestinationStreamArn'
      RoleArn: !Ref 'RoleArn'
product.template-eu-central-1.yaml#L15
    Type: AWS::Pinpoint::EventStream
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
    Properties:
      ApplicationId: !Ref 'ApplicationId'
      DestinationStreamArn: !Ref 'DestinationStreamArn'
      RoleArn: !Ref 'RoleArn'
product.template-us-east-1.yaml#L15
    Type: AWS::Pinpoint::EventStream
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
    Properties:
      ApplicationId: !Ref 'ApplicationId'
      DestinationStreamArn: !Ref 'DestinationStreamArn'
      RoleArn: !Ref 'RoleArn'
product.template-ap-southeast-2.yaml#L15
    Type: AWS::Pinpoint::EventStream
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
    Properties:
      ApplicationId: !Ref 'ApplicationId'
      DestinationStreamArn: !Ref 'DestinationStreamArn'
      RoleArn: !Ref 'RoleArn'
awsResouceIconMatches.json#L576
        "resourceType": "AWS::Pinpoint::EventStream",
        "filePath": null
      },
      {
        "resourceType": "AWS::Pinpoint::EmailTemplate",
        "filePath": null
template.json#L479
    "AWS::Pinpoint::EventStream": {
      "Type": "AWS::Pinpoint::EventStream",
      "Properties": {}
    },
    "AWS::PinpointEmail::ConfigurationSetEventDestination": {
      "Type": "AWS::PinpointEmail::ConfigurationSetEventDestination",
PinpointEventStreamSpecification.json#L3
    "AWS::Pinpoint::EventStream": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html",
      "Properties": {
        "ApplicationId": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-applicationid",

Parameters

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

Explanation in CloudFormation Registry

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

Frequently asked questions

What is AWS Amazon Pinpoint Event Stream?

AWS Amazon Pinpoint Event Stream is a resource for Amazon Pinpoint of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS Amazon Pinpoint Event Stream?

For CloudFormation, the awslabs/aws-service-catalog-products, awslabs/aws-service-catalog-products and awslabs/aws-service-catalog-products source code examples are useful. See the CloudFormation Example section for further details.