Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
Signed-off-by: Souvik Bose <[email protected]>
  • Loading branch information
sbose2k21 committed Oct 1, 2024
1 parent 92ef2d6 commit 33bba57
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions _data-prepper/pipelines/configuration/sources/kinesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav_order: 3

# kinesis

You can use `kinesis` source in Data Prepper to ingest records from one or more [Amazon Kinesis](https://aws.amazon.com/kinesis/) Data Streams.
You can use `kinesis` source in Data Prepper to ingest records from one or more [Amazon Kinesis Data Streams](https://aws.amazon.com/kinesis/data-streams/).

## Usage

Expand Down Expand Up @@ -42,7 +42,7 @@ Option | Required | Type | Description
`buffer_timeout` | No | Duration | The amount of time allowed for writing events to the Data Prepper buffer before timeout occurs. Any events that the source cannot write to the buffer during the specified amount of time are discarded. Default is `1s`.
`records_to_accumulate` | No | Integer | The number of messages that accumulate before being written to the buffer. Default is `100`.
`consumer_strategy` | No | String | Consumer strategy to use for ingesting Kinesis data streams. Default is `fan-out`. However, `polling` can also be used. if `polling` is enabled, additional configuration for `polling` will need to be added.
`polling` | No | String | if `consumer_strategy` is set to `polling`, this config will need to be added. Refer to [polling](#polling).
`polling` | No | polling | Refer to [polling](#polling).


### Streams
Expand Down Expand Up @@ -74,7 +74,7 @@ Option | Required | Type | Description
Option | Required | Type | Description
:--- | :--- |:--------| :---
`max_polling_records` | No | Integer | The number of records to fetch from Kinesis during a single call to get Kinesis stream records.
`idle_time_between_reads` | No | Integer | The time duration to sleep in between calls to get Kinesis stream records.
`idle_time_between_reads` | No | Duration | The time duration to sleep in between calls to get Kinesis stream records.

### aws

Expand Down Expand Up @@ -140,7 +140,7 @@ The following are the minimum required permissions for running `kinesis` as a so
}
```

DynamoDb permissions are needed as `kinesis` source in Data Prepper uses DynamoDb table for ingestion coordination among multiple workers.
DynamoDb permissions are required as `kinesis` source in Data Prepper uses DynamoDb table for ingestion coordination among multiple workers.

## Metrics

Expand Down

0 comments on commit 33bba57

Please sign in to comment.