Event

Amazon Kinesis is a platform for streaming data on AWS, offering powerful services to make it easy to load and analyze streaming data, and also providing the ability for you to build custom streaming data applications for specialized needs.

Supported Features

• Event Forwarding

Prerequisites

In order to take advantage of the Amazon Kinesis integration, you’ll need the Stream Name, Kinesis Service Region, and either the credentials of an Identity and Access Management (IAM) user that has access to Kinesis, or the AWS Account ID of the role mParticle will assume, depending on the setup option taken.

Option 1 is role-based authentication. In this option, you apply a policy to the stream itself, granting mParticle access to write to your stream. AWS Account ID of the role mParticle will assume will have to be provided. Furthermore, a role will have to be created with the specified naming convention.

Option 2 is user-based authentication. In this option, you create a user under your own AWS account, give the user permission to write to your stream, and provide the credentials for that user to mParticle.Credentials of an Identity and Access Management (IAM) user that has access to Kinesis will have to be provided.

Refer to the links below for Amazon setup: Click here for information on Kinesis ARN syntax. Sample ARN syntax for Kinesis is: arn:aws:kinesis:{region}:{account-id}:stream/{stream-name}.

Option 1 - Role-Based Authentication

1. Create a Stream

• The Kinesis Stream Name and Kinesis Service Region are required for mParticle setup

2. Create IAM Role with the following naming convention: arn:aws:iam::{account-id}:role/mparticle-kinesis-role. This naming convention is required for mParticle to be able to assume role correctly.

3. Create a Custom Policy. Use one of the following methods to create the policy:

   1. Manual Policy Creation
   • Select Amazon Kinesis as the AWS Service
   • Include the following actions: PutRecord
   • Enter the ARN
   • Click Add Statement
   2. Create Policy from JSON
   • Attach the template policy below under the “Permissions” tab of the role. Be sure to replace the {region}, {account-id} and {stream-name} with your specific values.

{
   "Version": "2012-10-17",
   "Statement": [
       {
           "Effect": "Allow",
           "Action": [
               "kinesis:PutRecord"
           ],
           "Resource": [
               "arn:aws:kinesis:{region}:{account-id}:stream/{stream-name}"
           ]
       }
   ]
}

4. Create Trust Relationship for the role that allows Assume Role permissions for the below mParticle services. Replace {org-id} with your own mParticle Org ID for the External Id (e.g. orgid:1111).

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "AWS": [
          "arn:aws:iam::338661164609:role/lambda_basic_vpc_execution",
          "arn:aws:iam::338661164609:role/role-ecs-mp-notification-httpservertoserverprocessor"
        ]
      },
      "Action": "sts:AssumeRole",
      "Condition": {
        "StringEquals": {
          "sts:ExternalId": "orgid:{org-id}"
        }
      }
    }
  ]
}

Option 2 - User-Based Authentication

1. Create a Stream

• The Kinesis Stream Name and Kinesis Service Region are required for mParticle setup

2. Create an IAM user

• Be sure to save the credentials file which contains the Access Key Id and Secret Access Key required for mParticle setup.

3. Create a Custom Policy. Use one of the following methods to create the policy:

   1. Manual Policy Creation
   • Select Amazon Kinesis as the AWS Service
   • Include the following actions: PutRecord
   • Enter the ARN
   • Click Add Statement
   2. Create Policy from JSON
   • Paste the template policy below into the “Policy Document” field. Be sure to replace the {region}, {account-id} and {stream-name} with your specific values.

{
   "Version": "2012-10-17",
   "Statement": [
       {
           "Effect": "Allow",
           "Action": [
               "kinesis:PutRecord"
           ],
           "Resource": [
               "arn:aws:kinesis:{region}:{account-id}:stream/{stream-name}"
           ]
       }
   ]
}

4. Assign Customer Policy to User

Event Data Format

The event data will be forwarded as JSON objects. Please refer to the JSON documentation for a detailed description of the data format.

Configuration Settings

Connection Settings