This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
The following commit(s) were added to refs/heads/main by this push:
new 21f555c4 Added AWS Kinesis Source additional documentation (#2124)
21f555c4 is described below
commit 21f555c424f65cc479aece7259dca7c6fc0c36ee
Author: Andrea Cosentino <[email protected]>
AuthorDate: Fri Jul 26 12:25:00 2024 +0200
Added AWS Kinesis Source additional documentation (#2124)
Signed-off-by: Andrea Cosentino <[email protected]>
---
.../partials/aws-kinesis-source-description.adoc | 66 ++++++++++++++++++++++
1 file changed, 66 insertions(+)
diff --git a/docs/modules/ROOT/partials/aws-kinesis-source-description.adoc
b/docs/modules/ROOT/partials/aws-kinesis-source-description.adoc
new file mode 100644
index 00000000..ac729642
--- /dev/null
+++ b/docs/modules/ROOT/partials/aws-kinesis-source-description.adoc
@@ -0,0 +1,66 @@
+== AWS Kinesis Source Kamelet Description
+
+=== Authentication methods
+
+In this Kamelet you have the possibility of avoiding the usage of explicit
static credentials by specifying the useDefaultCredentialsProvider option and
set it to true.
+
+The order of evaluation for Default Credentials Provider is the following:
+
+ - Java system properties - `aws.accessKeyId` and `aws.secretKey`.
+ - Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
+ - Web Identity Token from AWS STS.
+ - The shared credentials and config files.
+ - Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
+ - Amazon EC2 Instance profile credentials.
+
+You have also the possibility of using Profile Credentials Provider, by
specifying the useProfileCredentialsProvider option to true and
profileCredentialsName to the profile name.
+
+Only one of access key/secret key or default credentials provider could be used
+
+For more information about this you can look at
https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS
credentials documentation]
+
+=== Usage example with plain consumer
+
+You could consume the stream content directly
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:aws-kinesis-source"
+ parameters:
+ useDefaultCredentialsProvider: true
+ region: "eu-west-1"
+ stream: "kamelets"
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
+----
+
+=== Usage example with KCL Consumer
+
+You could consume the stream content with the KCL support
+
+[source,yaml,subs='+attributes,macros']
+----
+- route:
+ from:
+ uri: "kamelet:aws-kinesis-source"
+ parameters:
+ stream: "kamelets"
+ useDefaultCredentialsProvider: true
+ region: "eu-west-1"
+ asyncClient: true
+ useKclConsumers: true
+ steps:
+ - to:
+ uri: "kamelet:log-sink"
+ parameters:
+ showHeaders: true
+----
+
+With the `useKclConsumers` enabled you won't have to deal with shard iteration
directly, everything will be managed by the AWS Kinesis client library and the
KCL layer.
+
+As a side note you need to remember that the KCL consumer will need access to
DynamoDB and Cloudwatch services from AWS, so it will create clients to these
services under the hood and it will use them.
+
+
