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

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

• EXTERNAL_ID

• AWS_ACCESS_KEY_ID

• AWS_SECRET_ACCESS_KEY

• REGION

• READ_ONLY

• MAX_WRITERS

• STREAM_DISPLAY_FILTER[S]

• COMMENT

Connection options

AWS_ROLE — editable

Type: text

(Optional) The AWS IAM role ARN. Used in conjunction with EXTERNAL_ID.

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.

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.

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.

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.

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

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.

Full example

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';