Skip to content

Commit

Permalink
Update _data-prepper/pipelines/configuration/sources/kinesis.md
Browse files Browse the repository at this point in the history 
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Souvik Bose <[email protected]>
  • Loading branch information
@sb2k16 @natebower
sb2k16 and natebower authored Oct 22, 2024
1 parent 7ca6fc7 commit c749f2f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion _data-prepper/pipelines/configuration/sources/kinesis.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Option | Required | Type | Description
:--- |:---------|:---------| :---
`aws` | Yes | AWS | Specifies the AWS configuration. See [`aws`](#aws).

Check failure on line 38 in _data-prepper/pipelines/configuration/sources/kinesis.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.HeadingCapitalization] 'aws' is a heading and should be in sentence case.

Raw Output:
{"message": "[OpenSearch.HeadingCapitalization] 'aws' is a heading and should be in sentence case.", "location": {"path": "_data-prepper/pipelines/configuration/sources/kinesis.md", "range": {"start": {"line": 38, "column": 70}}}, "severity": "ERROR"}

Check failure on line 38 in _data-prepper/pipelines/configuration/sources/kinesis.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: aws. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: aws. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_data-prepper/pipelines/configuration/sources/kinesis.md", "range": {"start": {"line": 38, "column": 70}}}, "severity": "ERROR"}
`acknowledgments` | No | Boolean | When set to `true`, enables the `kinesis` source to receive [end-to-end acknowledgments]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/pipelines#end-to-end-acknowledgments) when events are received by OpenSearch sinks.
`streams` | Yes | List | Configures a list of multiple Kinesis data streams that the Data Prepper `kinesis` source uses to read records. You can configure up to four streams. See [Streams](#streams).
`streams` | Yes | List | Configures a list of multiple Kinesis data streams that the `kinesis` source uses to read records. You can configure up to four streams. See [Streams](#streams).

Check failure on line 40 in _data-prepper/pipelines/configuration/sources/kinesis.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Kinesis. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Kinesis. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_data-prepper/pipelines/configuration/sources/kinesis.md", "range": {"start": {"line": 40, "column": 65}}}, "severity": "ERROR"}
`codec` | Yes | Codec | Specifies the [codec](#codec) to apply.
`buffer_timeout` | No | Duration | Sets 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 | Determines the number of messages that accumulate before being written to the buffer. Default is `100`.
Expand Down

0 comments on commit c749f2f

Please sign in to comment.