> For the complete documentation index, see [llms.txt](https://docs.onum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.onum.com/data-sinks/data-sink-integrations/send-data-to-amazon-kinesis.md).

# Send data to Amazon Kinesis

{% hint style="info" %}
See the changelog of the **Amazon Kinesis Data Stream** Data Sink [here](/data-sinks-changelog/amazon-kinesis-data-stream-data-sink.md).
{% endhint %}

## Overview

Onum supports integration with [Amazon Kinesis Data Stream](https://aws.amazon.com//kinesis/data-streams/).

Amazon Kinesis Data Streams is a fully managed, serverless streaming data service that allows you to ingest, store, and process real-time data streams. It's designed for high-throughput, low-latency data ingestion from various sources, enabling real-time analytics and applications.

## Prerequisites 

You will need an IAM User, role or group with the correct permissions to access and manage Kinesis. 

## Amazon Kinesis Data Stream Setup

{% stepper %}
{% step %}

#### **Go to IAM (Identity and Access Management)** to manage users, groups, roles and permissions. 

Under **Permissions Policies**, make sure you have assigned the policy `AmazonKinesisFullAccess` to give full access to Kinesis resources. Alternatively, if you have custom permissions, go to **Policies - Create Policy** and in the **JSON** tab, paste your custom JSON e.g.

```json
  {
    "Version": "2012-10-17",
      "Statement": [
       {
         "Effect": "Allow"
         "Action": [
         "kinesis:CreateStream",
         "kinesis:DescribeStream",
         "kinesis:PutRecord"
         ],
         "Resource": "*"
 		}        
	]
  }      
```

{% endstep %}

{% step %}

#### Test the Configuration

`Run aws kinesis list-streams`

If you IAM permission are correct, you'll see a list of streams.
{% endstep %}
{% endstepper %}

## Onum Setup

{% stepper %}
{% step %}
Log in to your Onum tenant and click **Data Sinks > New Data sink**.
{% endstep %}

{% step %}
Double-click the **Amazon Kinesis Data Stream** Data Sink.
{% endstep %}

{% step %}
Enter a **Name** for the new Data Sink. Optionally, add a **Description** and some **Tags** to identify the Data Sink.
{% endstep %}

{% step %}
Decide whether or not to include this Data Sink info in the metrics and graphs of the [**Home**](/home.md) area.
{% endstep %}

{% step %}
In the **Connection settings** section, click **Select region** and choose the region of your AWS data center. Your region is displayed in the top right-hand corner of your AWS console.
{% endstep %}

{% step %}
In the **Authentication** section, click **Select access key ID** and choose it from your [Secrets](broken://pages/SNC8zGVDtIAIFa5E19n5), or click **New secret** to generate a new one. 

The **Access Key ID** is found in the **IAM Dashboard** of the **AWS Management Console**.

1. In the left panel, click on **Users**.
2. Select your **IAM user**.
3. Under the **Security Credentials** tab, scroll to **Access Keys**, and you will find existing **Access Key IDs** (but not the secret access key).
   {% endstep %}

{% step %}
Click **Select secret key** and choose it from your [Secrets](broken://pages/SNC8zGVDtIAIFa5E19n5), or click **New secret** to generate a new one.

Under **Access keys**, you can see your **Access Key IDs**, but AWS **will not show the Secret Access Key**. You must have it saved somewhere. If you don't have the secret key saved, you need to create a new one.

{% hint style="info" %}
Learn more about secrets in Onum in [this article](/settings/organization-settings/secrets-management.md).
{% endhint %}
{% endstep %}

{% step %}
You can enable the **Assume Role** option, which provides a more secure and scalable alternative to traditional credential-based authentication.

Instead of using static credentials, this method leverages an Amazon Resource Name (ARN) to define and assume an IAM role with the necessary permissions to access your SQS queue. By introducing the ARN into the Listener configuration, Falcon Onum can securely assume the designated role and interact with your AWS resources in a controlled and auditable way. To enable access, we need cross-account access from our AWS infrastructure to yours. This is a one-time setup. 

First, you must create an IAM role in your AWS account (or use an existing one) with the following trust policy:

```json
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::721751517261:role/<CustomersRole>"
      },
      "Action": ["sts:AssumeRole", "sts:TagSession"]
    }
  ]
}
```

{% hint style="warning" %}
This trust policy allows our AWS account to assume the role. You can attach whatever permissions you want to the role — the trust policy only controls who can assume it, not what it can do.
{% endhint %}

Once the IAM role is ready, please [contact us](broken://spaces/cSjT21I4EUhzghjc1rER/pages/nW8oZycpfVthtI5KYdQs) to share your full role ARN (e.g. `arn:aws:iam::012345678901:role/YourRoleName`) so we can complete the configuration on our end. Then, configure the **Assume Role** options as follows:

* **Role ARN** -  **Amazon Resource Name** used to access S3 and SQS resources. This is the unique identifier for the specific IAM Role that you want to assume and use.
* **External ID** - Shared secret used to authenticate the usage of this role.
* **Role Session** - Name of the session, used to audit usage of this role ( `s3-listener` by default)
* **STS Region** - If not set, it will use the bucket or the queue region.
* **STS Session Duration** - How much the Assume Role session will last before reauthentication. Uses Golang duration strings, like `1s`, `1m`, `1h`. If not set, it uses the maximum session duration configured for that role. The maximum and default duration is 1h.
  {% endstep %}

{% step %}
Now enter your **Data Stream configuration**:

* **Stream Name** - Enter your AWS Kinesis stream name. To get it:
  1. Go to: <https://console.aws.amazon.com/kinesis>
  2. Select **Data Streams** under **Amazon Kinesis** in the sidebar.
  3. The **Stream Name** will be in the first column e.g. `my-kinesis-stream-prod`
* **Partition key** - This is a string that you assign to each record you put into a stream. It plays a critical role in determining which shard the data record is routed to within the stream e.g. `user_456` means all login events for this user will be sent to the same shard, preserving the order of events for that user.
  {% endstep %}

{% step %}
In the **Advanced Configuration** section, toggle on the **Bulk configuration** switch to enable bulk configuration. Configure the following settings:&#x20;

* **Event time limit** - Time in milliseconds to wait before sending the batch.

Click **Select condition** and choose one of the following:

* **Number of events** - Maximum number of events to send in a single batch. The minimum value is `1`, and the maximum value is `500`.
* **Batch size** - Maximum number of events to send in a single batch. The minimum value is `1024`, and the maximum value is `5242880`.

Enter the required setting in the **Value** field.
{% endstep %}

{% step %}
If you have non-default URL that directs API requests to a specific Kinesis service endpoint, enter it here in the **Custom endpoint**.
{% endstep %}

{% step %}
Click **Finish** when complete. Your new Data Sink will appear in the **Data sinks** area list.
{% endstep %}
{% endstepper %}

## Pipeline configuration <a href="#pipeline-configuration" id="pipeline-configuration"></a>

When it comes to using this Data Sink in a [Pipeline](/pipelines.md), you must configure the following output parameters. To do it, simply click the Data sink on the canvas and select **Configuration**.

### Output configuration

<table><thead><tr><th width="170.0625">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Event Field</strong></td><td>Select the event field that contains the output message. The data type must be <code>string</code>.</td></tr></tbody></table>

Click **Save** to save your configuration.