AWS Firehose Connector Setup Guide

Requirements

• An AWS account.
• Required: firehose:PutRecord permission.
• Optional: firehose:ListDeliveryStreams permission.
• Delivery stream to send data to.

Supported actions

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:

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: AWS: Controlling access with Amazon Data 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 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.

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

• 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

Action: Send Visitor Data to Delivery Stream

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

Action: Send Customized Data to Delivery Stream (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

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

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

Vendor documentation

• AWS: What is Amazon Data Firehose?
• AWS: Amazon Data Firehose Quota
• AWS: Controlling access with Amazon Data Firehose
• AWS: Switch to an IAM role (AWS API)
• AWS: Access to AWS accounts owned by third parties