[camel] branch main updated: Kinesis doc update (#10769)

[ac...@apache.org]

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.git


The following commit(s) were added to refs/heads/main by this push:
     new cbc3e82ab1f Kinesis doc update (#10769)
cbc3e82ab1f is described below

commit cbc3e82ab1ffe627a5b400c7111d83f33b9c5eea
Author: Hamed Hatami <ja...@gmail.com>
AuthorDate: Fri Jul 21 11:37:42 2023 +0200

    Kinesis doc update (#10769)
    
    * According to the latest changes on AWS2 Kinesis component the doc got updated
    
    * According to the latest changes on AWS2 Kinesis component the doc got updated
    
    ---------
    
    Co-authored-by: Hamed Hatami <ha...@postnord.com>
---
 .../src/main/docs/aws2-kinesis-component.adoc      | 25 +++++++++++++++-------
 1 file changed, 17 insertions(+), 8 deletions(-)

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 a5063f8153f..8df1433b59c 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
@@ -15,9 +15,13 @@
 
 *{component-header}*
 
-The AWS2 Kinesis component supports receiving messages from and sending messages to Amazon Kinesis (no Batch supported)
+The AWS2 Kinesis component supports consuming messages from and producing messages to Amazon Kinesis (no Batch supported)
 service.
 
+AWS2 Kinesis component also supports Synchronous and Asynchronous Client which means you choose what fits best your requirements,
+so if you need the connection (client) to be async there's a property of 'asyncClient' (in DSL also can be found) needs to be turned true.
+
+
 Prerequisites
 
 You must have a valid Amazon Web Services developer account, and be
@@ -32,7 +36,7 @@ aws2-kinesis://stream-name[?options]
 -----------------------------------
 
 The stream needs to be created prior to it being used. +
- You can append query options to the URI in the following format,
+You can append query options to the URI in the following format,
 ?options=value&option2=value&...
 
 
@@ -64,6 +68,11 @@ This allows you for instance to know how many messages exists in this
 batch and for instance let the Aggregator
 aggregate this number of messages.
 
+The consumer is able to consume either from a single specific shard or
+all available shards (multiple shards consumption) of Amazon Kinesis therefore if you leave the 'shardId'
+property in the DSL configuration empty then it'll consume all available shards
+otherwise only the specified shard corresponding to the shardId will be consumed.
+
 == Usage
 
 === Static credentials, Default Credential Provider and Profile Credentials Provider
@@ -72,12 +81,12 @@ You have the possibility of avoiding the usage of explicit static credentials, b
 
 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. 
+- 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.