AWS Kinesis Streams (Tealium-Provided Credentials) Connector Setup Guide

Connector Actions

Action Name	AudienceStream	EventStream
Send Event Data to Kinesis Stream	✗	✓
Send Visitor Data to Kinesis Stream	✓	✗
Send Customized Data to Kinesis Stream (Advanced)	✓	✓
Send Batched Event Data to Kinesis Stream	✗	✓
Send Batched Visitor Data to Kinesis Stream	✓	✗
Send Batched Customized Data to Kinesis Stream (Advanced)	✓	✓

Add Tealium role to AWS account

Before you configure the connector, you must create a role for the Tealium account ID and set it as a trusted entity:

1. In the Identity and Access Management (IAM) console, locate the Amazon Resource Name (ARN) for the Kinesis stream in the Details tab.
2. Navigate to Policies > Create Policy. If this is the first policy you have created, click Get Started and Create Policy.
3. Enter the ARN for the Kinesis Stream.
4. Click {} JSON.
5. Enter the following policy, replacing arn:aws:kinesis:us-east-1:123456789:stream/example with the ARN from Step 1.

{
  "Version": "2023-06-01",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "kinesis:PutRecord",
        "kinesis:PutRecords"
                ],
      "Resource": "arn:aws:kinesis:us-east-1:123456789:stream/example"
    }
  ]
}

6. Click Next Step.
7. Under Policy Name, enter TealiumKinesis.
8. Click Create Policy.
9. Navigate to Roles > Create Role.
10. Under Trusted entity type, select AWS Account.
11. Select Another AWS account.
12. Under Account ID, enter 719386139886.
13. Click Next: Permissions.
14. Select the TealiumKinesis policy.
15. Click Next: Review.
16. For the Name, enter TealiumUser.
17. Click Create Role.

Kinesis will generate an ARN for the role similar to the following:

arn:aws:kinesis:us-east-1:123456789:role/example

For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM and Create an IAM Policy and User.

Configure Settings

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

• Region
  Required: Select a region.
• Assume Role: ARN
  Optional: Provide Amazon Resource Name (ARN) of role to assume. For example: arn:aws:iam::222222222222:role/myrole See: Switching to an IAM Role.
• Assume Role: Session Name
  Required: Provide identifier for assumed role session. Length Constraints: Minimum length of 2, Maximum length of 64.
• Assume Role: External ID
  Optional: {rovide external identifier. See: How to Use an External ID.

After you configure the connector, click Test Connection to confirm that the connector can connect to Amazon.

Actions

Enter a name for the action and select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Action Settings - Send Event Data to Kinesis Stream

Parameters

Parameter	Description
Stream Name	Select the stream to send data to. If your IAM policy does not grant kinesis:ListStreams permission, you will need to manually enter a custom value.
Partition Key	(Required) A partition key groups data by shard within a stream.
Sequence Number For Ordering	The data record’s sequence number within the Kinesis data stream’s shard.
Explicit Hash Key	The key used to hash the Partition Key.
Print Attribute Names	If attribute names are updated, the names in the payload will reflect the update.

Action Settings - Send Visitor Data to Kinesis Stream

Parameters

Parameter	Description
Stream Name	Select the stream to send data to. If your IAM policy does not grant kinesis:ListStreams permission, you will need to manually enter a custom value.
Partition Key	(Required) A partition key groups data by shard within a stream.
Sequence Number For Ordering	The data record’s sequence number within the Kinesis data stream’s shard.
Explicit Hash Key	The key used to hash the Partition Key.
Include Current Visit Data	A true/false value that indicates whether to include the current visit data in the payload.
Print Attribute Names	If attribute names are updated, the names in the payload will reflect the update.

Action Settings - Send Customized Data to Kinesis Stream (Advanced)

Parameters

Parameter	Description
Stream Name	Select the stream to send data to. If your IAM policy does not grant kinesis:ListStreams permission, you will need to manually enter a custom value.
Partition Key	(Required) A partition key groups data by shard within a stream.
Sequence Number For Ordering	The data record’s sequence number within the Kinesis data stream’s shard.
Explicit Hash Key	The key used to hash the Partition Key.
Custom Message Definition	A custom message to include in the log file.
Template Variables	Optional. Provide template variables as data input for templates (see: Template Variables Guide. Name nested template variables with the dot notation (For example: items.name). Nested template variables are typically built from data layer list attributes.
Templates	Optional. Provide templates to be referenced in message data (see: Templates Guide. Templates are injected by name with double curly braces into supported fields (For example: {{SomeTemplateName}})

Action Settings - Send Batched Event Data to Kinesis Stream

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: 5 MB

Parameters

Parameter	Description
Stream Name	Select the stream to send data to. If your IAM policy does not grant kinesis:ListStreams permission, you will need to manually enter a custom value.
Partition Key	(Required) A partition key groups data by shard within a stream.
Explicit Hash Key	The key used to hash the Partition Key.
Print Attribute Names	If attribute names are updated, the names in the payload will reflect the update.

Action Settings - Send Batched Visitor Data to Kinesis Stream

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: 5 MB

Parameters

Parameter	Description
Stream Name	Select the stream to send data to. If your IAM policy does not grant kinesis:ListStreams permission, you will need to manually enter a custom value.
Partition Key	(Required) A partition key groups data by shard within a stream.
Explicit Hash Key	The key used to hash the Partition Key.
Include Current Visit Data	A true/false value that indicates whether to include the current visit data in the payload.
Print Attribute Names	If attribute names are updated, the names in the payload will reflect the update.

Action Settings - Send Batched Customized Data to Kinesis Stream (Advanced)

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: 5 MB

Parameters

Parameter	Description
Stream Name	Select the stream to send data to. If your IAM policy does not grant kinesis:ListStreams permission, you will need to manually enter a custom value.
Partition Key	(Required) A partition key groups data by shard within a stream.
Explicit Hash Key	The key used to hash the Partition Key.
Custom Message Definition	A custom message to include in the log file.
Template Variables	Optional. Provide template variables as data input for templates (see: Template Variables Guide. Name nested template variables with the dot notation (For example: items.name). Nested template variables are typically built from data layer list attributes.
Templates	Optional. Provide templates to be referenced in message data (see: Templates Guide. Templates are injected by name with double curly braces into supported fields (For example: {{SomeTemplateName}})