Back

The Amazon Kinesis Streams Connector enables you to build custom real-time applications that process or analyze streaming data for specialized needs. This article walks you through the process of setting up the Connector in the Universal Data Hub.

Table of Contents Placeholder

Requirements

  • Amazon Web Services Account
  • Identity and Access Management (IAM) User Credentials
  • Kinesis Streams

Supported Actions

Action Name Trigger on Audience Trigger on Streams
Send Event Data to Kinesis Stream
Send Visitor Data to Kinesis Stream
Send Customized Data to Kinesis Stream (Advanced)

Configure Settings

Go to the Connector Marketplace and add a new Amazon Kinesis Streams Connector. Read 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 kinesisSmiley TongueutRecord permission. For more details on policies for Kinesis Streams, see Kinesis Streams Resources Access).

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

  2. Assume Role Parameters: Required only if your IAM User is not setup with all necessary permissions (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 (see: How to Use an External ID).
  3. 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 Kinesis Stream

Parameters

  1. Stream Name (REQUIRED): Select the stream to send data to. These options are available only if your configured policy is granted the kinesis:ListStreams permission. If the permission is not granted, you must manually enter the stream name as a Custom Value.
  2. Message Options (REQUIRED): Map Attribute(s) to a message option in the To dropdown. See available options below.
  3. Print Attribute Names: Checking this box will display names for each event data Attribute in the message payload. And if the Attribute names change in UDH, they are automatically reflected in the payload.

Options - Message Options

Option Description
Partition Key REQUIRED: Determines which shard in the stream the message is sent to
Explicit Hash Key A specific hash value that helps determine the shard in the stream the message is sent to. Overrides hashing the partition key.
Sequence Number for Ordering Guarantees strictly increasing sequence numbers for messages from the same client and to the same partition key

For more information, see: Put Record Request Parameters

Action - Send Visitor Data to Kinesis Stream

Parameters

  1. Stream Name (REQUIRED): Select the stream to send data to. These options are available only if your configured policy is granted the kinesis:ListStreams permission. If the permission is not granted, you must manually enter the stream name as a Custom Value.
  2. Message Options (REQUIRED): Map Attribute(s) to a message option in the To dropdown.
  3. Include Current Visit Data: Checking this box will include current visit data in the message payload.
  4. Print Attribute Names: Checking this box will display names for each visitor data Attribute in the message payload. And if the Attribute names change in UDH, they are automatically reflected in the payload.

Action - Send Customized Data to Kinesis Streams (Advanced)

Parameters

  1. Stream Name (REQUIRED): Select the stream to send data to. These options are available only if your configured policy is granted the kinesis:ListStreams permission. If the permission is not granted, you must manually enter the stream name as a Custom Value.
  2. Message Options (REQUIRED): Map Attribute(s) to a message option in the To dropdown.
  3. Message Data (REQUIRED): Construct a custom message body. Map Attribute(s) to names for a simple, one-level JSON format, or reference a template name (surrounded in double curly braces) and select the Custom Message Definition option.
  4. 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.
  5. 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.

Vendor Documentation