You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2024/06/27 12:17:10 UTC
(camel) 01/01: CAMEL-20916 - Camel-AWS-Kinesis: KCL Consumers, add documentation
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch CAMEL-20916
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 18cdc7f1b82374c83f696c7b3f14d88e18fef961
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Jun 27 14:16:15 2024 +0200
CAMEL-20916 - Camel-AWS-Kinesis: KCL Consumers, add documentation
Signed-off-by: Andrea Cosentino <an...@gmail.com>
---
.../src/main/docs/aws2-kinesis-component.adoc | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc b/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
index 2421d44e564..d433d650f92 100644
--- a/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
+++ b/components/camel-aws/camel-aws2-kinesis/src/main/docs/aws2-kinesis-component.adoc
@@ -128,6 +128,22 @@ however, a
different http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/AWSCredentialsProvider.html[AWSCredentialsProvider]
can be specified when calling createClient(...).
+=== AWS Kinesis KCL Consumer
+
+The component supports also the KCL (Kinesis Client Library) for consuming from a Kinesis Data Stream.
+
+To enable this feature you'll need to set two different parameter in your endpoint:
+
+[source,java]
+--------------------------------------------------------------------------------------------------------------------
+from("aws2-kinesis://mykinesisstream?asyncClient=true&useDefaultCredentialsProvider=true&useKclConsumers=true")
+ .to("log:out?showAll=true");
+--------------------------------------------------------------------------------------------------------------------
+
+This feature will make possible to automatically checkpointing the Shard Iterations by combining the usage of KCL, DynamoDB Table and CloudWatch alarms.
+
+Everything will work out of the box, by simply using your AWS Credentials.
+
== Dependencies
Maven users will need to add the following dependency to their pom.xml.