Amazon Firehose Connector Setup Guide

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 Amazon Firehose Connector. See the Connector Overview article for general instructions on how to add a connector.

To configure your vendor, follow these steps:

1. In the Configure tab, provide a title for the connector instance.

2. 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: Access Control for Amazon Firehose.

3. Select the region where you want to make the API calls.

4. 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 Name (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: How to Use an External ID.

1. 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 Steam

Parameters

• Delivery Stream (Required): Select 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: Checking this box will 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 Steam

Parameters

• Delivery Stream (Required): Select 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: Checking this box will include current visit data in the message payload.
• Print Attribute Names: Checking this box will 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 Steam (Advanced)

Parameters

• Delivery Stream (Required): Select 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 attribute(s) to names for simple one level JSON format, or reference a template name (surrounded 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. Refer to our Template Variables Guide for details.
• Message Templates: Provide one or more templates to render. Typically, a single template is used to construct a message data. Refer to our Templates Guide for common syntax and extensions.

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 Amazon Kinesis Data Firehose Limits.
Record Suffix	The suffix added to the end of each record to be used as a delimiter. Default: Newline (\n)

Custom Message Definition

• 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 Template Variables Guide.
• 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 Templates Guide.

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 Amazon Kinesis Data Firehose Limits.
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

• What Is Amazon Kinesis Data Firehose?
• Amazon Kinesis Data Firehose Limits
• Access Control for Amazon Kinesis Firehose
• Switching to an IAM Role
• How to Use an External ID