From 5e8c16a101b164d87e3b7a9319aa446af3564ec7 Mon Sep 17 00:00:00 2001 From: Hamed Hatami Date: Fri, 21 Jul 2023 11:01:16 +0200 Subject: [PATCH] According to the latest changes on AWS2 Kinesis component the doc got updated --- .../src/main/docs/aws2-kinesis-component.adoc | 24 ++++++++++++------- 1 file changed, 16 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 a5063f8153ff5..6e9487bafed73 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,12 @@ *{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 +35,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 +67,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 +80,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.