This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Pinpoint::EventStream
<a name="aws-resource-pinpoint-eventstream"></a>

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

## Syntax
<a name="aws-resource-pinpoint-eventstream-syntax"></a>

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

### JSON
<a name="aws-resource-pinpoint-eventstream-syntax.json"></a>

```
{
  "Type" : "AWS::Pinpoint::EventStream",
  "Properties" : {
      "[ApplicationId](#cfn-pinpoint-eventstream-applicationid)" : String,
      "[DestinationStreamArn](#cfn-pinpoint-eventstream-destinationstreamarn)" : String,
      "[RoleArn](#cfn-pinpoint-eventstream-rolearn)" : String
    }
}
```

### YAML
<a name="aws-resource-pinpoint-eventstream-syntax.yaml"></a>

```
Type: AWS::Pinpoint::EventStream
Properties:
  [ApplicationId](#cfn-pinpoint-eventstream-applicationid): String
  [DestinationStreamArn](#cfn-pinpoint-eventstream-destinationstreamarn): String
  [RoleArn](#cfn-pinpoint-eventstream-rolearn): String
```

## Properties
<a name="aws-resource-pinpoint-eventstream-properties"></a>

`ApplicationId`  <a name="cfn-pinpoint-eventstream-applicationid"></a>
The unique identifier for the Amazon Pinpoint application that you want to export data from.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DestinationStreamArn`  <a name="cfn-pinpoint-eventstream-destinationstreamarn"></a>
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon 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 Firehose delivery stream, the ARN format is: `arn:aws:firehose:region:account-id:deliverystream/stream_name`  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-pinpoint-eventstream-rolearn"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-pinpoint-eventstream-return-values"></a>

### Ref
<a name="aws-resource-pinpoint-eventstream-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-pinpoint-eventstream-return-values-fn--getatt"></a>