AWS Firehose Connector Setup Guide
This article describes how to set up the AWS Firehose connector.
Requirements
- An AWS account.
- Required: firehose:PutRecord permission.
- Optional: firehose:ListDeliveryStreams permission.
- Delivery stream to send data to.
Supported actions
| Action Name | Trigger on Audience | Trigger on Streams |
|---|---|---|
| Send Event Data to Delivery Stream | ✗ | ✓ |
| Send Visitor Data to Delivery Stream | ✓ | ✗ |
| Send Customized Data to Delivery Stream (Advanced) | ✓ | ✓ |
| Send Data for Connector Failures to Delivery Stream | ✗ | ✓ |
| Send Customized Data to Delivery Stream (Batched) | ✓ | ✓ |
| Send Event Data to Delivery Stream (Batched) | ✗ | ✓ |
Configure settings
Go to the Connector Marketplace and add a new AWS Firehose Connector. See the Connector Overview article for general instructions on how to add a connector.
To configure your vendor, follow these steps:
-
In the Configure tab, provide a title for the connector instance.
-
Provide your IAM user access and secret key.
The policy statement attached to your IAM user instance must include the firehose:PutRecord permission. For more details on policies for Firehose, see: AWS: Controlling access with Amazon Data Firehose .
-
Select the region where you want to make the API calls.
-
Assume Role Parameters: Required only if your IAM User is not setup with all necessary permissions. For more information, see: Switching to an IAM Role.
- ARN: Required. Amazon Resource Name assigned to the role to assume.
- Session NameRequired: Required. Unique identifier of the assumed role session.
- External ID: Optional. Unique identifier used by third parties when assuming roles in their customers’ accounts. For more information, see: AWS: Access to AWS accounts owned by third parties.
-
Click Test Connection to verify API connectivity with the provided credentials.
Action Settings: Parameters and Options
Click Next or go to the Actions tab. It’s where you’ll set up actions to trigger.
This section describes how to set up parameters and options for each action.
Action: Send Event Data to Delivery Stream
Parameters
| Parameter | Description |
|---|---|
| Delivery Stream | Required. Select the delivery stream to send data to. To see available streams, the firehose:ListDeliveryStreams permission must be granted. |
| Record Suffix | Select a value to append to the visitor data for the purposes of identifying individual records. |
| Print Attribute Names | Select this option to display names for each event data attribute in the message payload. |
Options: Record Suffix
| Option | Description |
|---|---|
Newline (\\n) |
Adds a return character to the end of the visitor data object. |
| No Delimiter | When selected, nothing is added to the visitor data object. |
Action: Send Visitor Data to Delivery Stream
Parameters
| Parameter | Description |
|---|---|
| Delivery Stream | Required. Select the delivery stream to send data to. To see available streams, the firehose:ListDeliveryStreams permission must be granted. |
| Record Suffix | Select a value to append to the visitor data for the purposes of identifying individual records. |
| Include Current Visit Data | Add the current visit data to the payload. This includes event visit data if Exclude Current Visit Event Data isn’t selected. |
| Exclude Current Visit Event Data | Exclude event data from the current visit data. |
| Print Attribute Names | Select this option to display names for each visitor data Attribute in the message payload. |
Options: Record Suffix
| Option | Description |
|---|---|
Newline (\\n) |
Adds a return character to the end of the visitor data object. |
| No Delimiter | When selected, nothing is added to the visitor data object. |
Action: Send Customized Data to Delivery Stream (Advanced)
Parameters
| Parameter | Description |
|---|---|
| Delivery Stream | Required. Select the delivery stream to send data to. To see available streams, the firehose:ListDeliveryStreams permission must be granted. |
| Record Suffix | Select a value to append to the visitor data for the purposes of identifying individual records. |
| Message Data | Required. Construct a custom message body. Map attributes to names in a simple one-level JSON format, or reference a template name enclosed in double curly braces and select the Custom Message Definition option. |
| Message Template Variables | Map attribute(s) to template variable names. Template variables are available for substitution and rendering of all templates.For more information, see Connector template variables. |
| Message Templates | Provide one or more templates to render. Typically, a single template is used to construct a message data. For more information about syntax and extensions, see About connector templates. |
Options: Record Suffix
| Option | Description |
|---|---|
Newline (\\n) |
Adds a return character to the end of the visitor data object. |
| No Delimiter | When selected, nothing is added to the visitor data object. |
Action: Send Customized Data to Delivery Stream (Batched)
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 500
- Max time since oldest request: 10 minutes
- Max size of requests: 4 MB
Parameters
| Parameter | Description |
|---|---|
| Delivery Stream | Select the delivery stream to send data to. To see available streams, the firehose:ListDeliveryStreams permission must be granted. There are limits on the Amazon Kinesis Data Firehose delivery stream. For more information, see AWS: Amazon Data Firehose Quota. |
| Record Suffix | The suffix added to the end of each record to be used as a delimiter. Default: Newline (\n) |
Custom Message Definition
| Parameter | Description |
|---|---|
| Message Template Variables | Map attributes to template variable names. Template variables are available for substitution and rendering of all templates. For more information, see Connector template variables. |
| Message Templates | Provide one or more templates to render. Typically, a single template is used to construct a message data. For more information, see About connector templates. |
Action: Send Event Data to Delivery Stream (Batched)
Batch Limits
This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 500
- Max time since oldest request: 10 minutes
- Max size of requests: 4 MB
Parameters
| Parameter | Description |
|---|---|
| Delivery Stream | Select the delivery stream to send data to. To see available streams, the firehose:ListDeliveryStreams permission must be granted. There are limits on the Amazon Kinesis Data Firehose delivery stream. For more information, see AWS: Amazon Data Firehose Quota. |
| Record Suffix | The suffix added to the end of each record to be used as a delimiter. Default: Newline (\n) |
| Print Attribute Names | If attribute names get updated, the names in the payload will reflect the update. |
Vendor documentation
This page was last updated: June 11, 2025