From f7dcfe7928d46add86ba4c1922e50ed76ea8279d Mon Sep 17 00:00:00 2001 From: Souvik Bose Date: Thu, 10 Oct 2024 16:39:36 -0700 Subject: [PATCH] Adding Kinesis README Signed-off-by: Souvik Bose --- data-prepper-plugins/kinesis-source/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 data-prepper-plugins/kinesis-source/README.md diff --git a/data-prepper-plugins/kinesis-source/README.md b/data-prepper-plugins/kinesis-source/README.md new file mode 100644 index 0000000000..10d17eebf3 --- /dev/null +++ b/data-prepper-plugins/kinesis-source/README.md @@ -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= --tests KinesisSourceIT +```