> For the complete documentation index, see [llms.txt](https://upsolver.gitbook.io/content/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://upsolver.gitbook.io/content/reference-1/sql-commands/connections/create-connection/amazon-kinesis.md).

# Amazon Kinesis

To ingest data from your Amazon Kinesis stream, you must first create a connection that provides the appropriate credentials to access your topic.

## Syntax

```sql
CREATE KINESIS CONNECTION <connection_identifier> 
    [ { AWS_ROLE = '<role_arn>' 
       EXTERNAL_ID = '<external_id>'
     | AWS_ACCESS_KEY_ID = '<key_id>' 
       AWS_SECRET_ACCESS_KEY = '<key>' } ]
    REGION = '<region>'
    [ READ_ONLY = { TRUE | FALSE } ]
    [ MAX_WRITERS = <integer> ]
    [ STREAM_DISPLAY_FILTER[S] = { '<stream_name>' | ('<stream_name>' [, ...]) } ]
    [ COMMENT = '<comment>' ]
```

#### Jump to

* [`AWS_ROLE`](#aws_role-editable)
* [`EXTERNAL_ID`](#external_id-editable)
* [`AWS_ACCESS_KEY_ID`](#aws_access_key_id-editable)
* [`AWS_SECRET_ACCESS_KEY`](#aws_secret_access_key-editable)
* [`REGION`](#region)
* [`READ_ONLY`](#read_only)
* [`MAX_WRITERS`](#max_writers-editable)
* [`STREAM_DISPLAY_FILTER[S]`](#stream_display_filter-s-editable)
* [`COMMENT`](#comment-editable)

## Connection options

#### `AWS_ROLE` — editable

Type: `text`

(Optional) The AWS IAM role ARN. Used in conjunction with [`EXTERNAL_ID`](#external_id-editable).

If omitted, the role created when integrating Upsolver with the AWS account is used.

#### `EXTERNAL_ID` — editable

Type: `text`

(Optional) The external ID of the role to assume. Used in conjunction with [`AWS_ROLE`](#aws_role-editable).

If omitted, the role created when integrating Upsolver with the AWS account is used.

#### `AWS_ACCESS_KEY_ID` — editable

Type: `text`

(Optional) The AWS access key ID. Used in conjunction with [`AWS_SECRET_ACCESS_KEY`](#aws_secret_access_key).

If omitted, the role created when integrating Upsolver with the AWS account is used.

#### `AWS_SECRET_ACCESS_KEY` — editable

Type: `text`

(Optional) The AWS secret key corresponding to the provided [`AWS_ACCESS_KEY_ID`](#aws_access_key_id).

If omitted, the role created when integrating Upsolver with the AWS account is used.

#### `REGION`

Type: `text`

The AWS region to use.

#### `READ_ONLY`

Type: `Boolean`

Default: `false`

(Optional) When `true`, the connection can only be used to read data from Kinesis and not for writing data to Kinesis.

#### `MAX_WRITERS` — editable

Type: `integer`

Default: `20`

(Optional) The number of maximum parallel writers to Kinesis.&#x20;

#### `STREAM_DISPLAY_FILTER[S]` — editable

Type: `text | list`

(Optional) A single stream or the list of streams to show. If left empty, all streams are visible.

#### `COMMENT` — editable

Type: `text`

(Optional) A description or comment regarding this connection.

## Minimum example

```sql
CREATE KINESIS CONNECTION my_kinesis_connection
    REGION = 'us-east-1';
```

Note: This example uses the default credentials from Upsolver's integration with AWS. For more information, see the how-to guide to [Deploy Upsolver on AWS](/content/how-to-guides-1/setup/deploy-upsolver-on-aws.md).

## Full example

```sql
CREATE KINESIS CONNECTION my_kinesis_connection
    AWS_ROLE = 'arn:aws:iam::123456789012:role/upsolver-sqlake-role'
    REGION = 'us-east-1'
    READ_ONLY = true
    MAX_WRITERS = 22
    STREAM_DISPLAY_FILTERS = ('stream1', 'stream2')
    COMMENT = 'kinesis connection example';
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://upsolver.gitbook.io/content/reference-1/sql-commands/connections/create-connection/amazon-kinesis.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.