Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Kinesis README #5048

Merged
merged 1 commit into from
Oct 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions data-prepper-plugins/kinesis-source/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Kinesis Source

This source ingests data into Data Prepper from [Amazon Kinesis Data Streams](https://aws.amazon.com/kinesis/data-streams/).

See the [`kinesis` source documentation](https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sources/kinesis/) for details on usage.


## Developer Guide

The integration tests for this plugin do not run as part of the Data Prepper build.

The following command runs the integration tests:

```
./gradlew data-prepper-plugins:kinesis-source:integrationTest -Dtests.kinesis.source.aws.region=<your-aws-region> --tests KinesisSourceIT
```
Loading