AWS Kinesis Streams Connector Setup Guide | Server-Side Connectors

Requirements

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

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)	✓	✓

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:

Access Key
Required: Provide your IAM User’s access key. The associated IAM policy (for either IAM User or Assumed Role) must grant kinesis:PutRecord permission along with streams you want to send data to. See: Kinesis Streams Resources Access.
Secret Key
Required: Provide your IAM User’s secret key.
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
Optional: Provide identifier for assumed role session.
Assume Role: External ID
Optional: Provide external identifier. See: How to Use an External ID.

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

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

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}}`)