Bots From Extension: aws-kinesis
AWS Kinesis - Read and Write data on AWS Kinesis streams
This extension provides 3 bots.
Bot @kinesis:describe-stream
Bot Position In Pipeline: Source
Describe all shards of a stream in AWS Kinesis
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| stream_name* | Text | Stream Name in Kinesis |
Bot @kinesis:read-stream
Bot Position In Pipeline: Source
Read Data from a stream in AWS Kinesis
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| stream_name* | Text | Stream to read the data from | |
| shard_id | Text | comma separated Shard IDs to read from | |
| max_wait_time | Text | 0 | Max wait time in seconds to read the data for. (Default will run infinitely) |
| timestamp | DateTime | Timestamp to collect data from. |
Bot @kinesis:write-stream
Bot Position In Pipeline: Sink
Write Data to a stream in AWS Kinesis
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| stream_name* | Text | Stream name to ingest the data | |
| partition_key | Text | Must be provided if all records should go into the same shard |