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 2020/02/27 17:27:51 UTC

[camel] 12/13: CAMEL-14520 - Create an AWS-Kinesis component based on SDK v2, regen docs

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 04bd2b27e463e7a3fdf17023b40ef948ea839a62
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Feb 27 18:13:53 2020 +0100

    CAMEL-14520 - Create an AWS-Kinesis component based on SDK v2, regen docs
---
 docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc   | 9 +++++++--
 .../modules/ROOT/pages/aws2-kinesis-firehose-component.adoc      | 9 +++++++--
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc b/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc
index cdcad4b..d400f12 100644
--- a/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc
+++ b/docs/components/modules/ROOT/pages/aws2-kinesis-component.adoc
@@ -17,6 +17,11 @@ You must have a valid Amazon Web Services developer account, and be
 signed up to use Amazon Kinesis. More information are available
 at https://aws.amazon.com/kinesis/[AWS Kinesis]
 
+[NOTE]
+====
+The AWS2 Kinesis component is not supported in OSGI
+====
+
 == URI Format
 
 [source,java]
@@ -84,7 +89,7 @@ with the following path and query parameters:
 | *proxyHost* (common) | To define a proxy host when instantiating the Kinesis client |  | String
 | *proxyPort* (common) | To define a proxy port when instantiating the Kinesis client |  | Integer
 | *proxyProtocol* (common) | To define a proxy protocol when instantiating the Kinesis client. The value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (common) | The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You'll need to use the name Regions.EU_WEST_1.name() |  | String
+| *region* (common) | The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() |  | String
 | *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
 | *iteratorType* (consumer) | Defines where in the Kinesis stream to start getting records. The value can be one of: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP, null | TRIM_HORIZON | ShardIteratorType
 | *maxResultsPerRequest* (consumer) | Maximum number of records that will be fetched in each poll | 1 | int
@@ -222,4 +227,4 @@ Maven users will need to add the following dependency to their pom.xml.
 where `$\{camel-version\}` must be replaced by the actual version of Camel.
 
 
-include::camel-spring-boot::page$aws-kinesis-starter.adoc[]
\ No newline at end of file
+include::camel-spring-boot::page$aws-kinesis-starter.adoc[]
diff --git a/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc b/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc
index 0075f61..d68c0f8 100644
--- a/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc
+++ b/docs/components/modules/ROOT/pages/aws2-kinesis-firehose-component.adoc
@@ -16,6 +16,11 @@ You must have a valid Amazon Web Services developer account, and be
 signed up to use Amazon Kinesis Firehose. More information are available
 at https://aws.amazon.com/kinesis/firehose/[AWS Kinesis Firehose]
 
+[NOTE]
+====
+The AWS2 Kinesis Firehose component is not supported in OSGI
+====
+
 == URI Format
 
 [source,java]
@@ -83,7 +88,7 @@ with the following path and query parameters:
 | *proxyHost* (producer) | To define a proxy host when instantiating the Kinesis Firehose client |  | String
 | *proxyPort* (producer) | To define a proxy port when instantiating the Kinesis Firehose client |  | Integer
 | *proxyProtocol* (producer) | To define a proxy protocol when instantiating the Kinesis Firehose client. The value can be one of: HTTP, HTTPS | HTTPS | Protocol
-| *region* (producer) | The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You'll need to use the name Regions.EU_WEST_1.name() |  | String
+| *region* (producer) | The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id() |  | String
 | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
 | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
 | *accessKey* (security) | Amazon AWS Access Key |  | String
@@ -162,4 +167,4 @@ Maven users will need to add the following dependency to their pom.xml.
 where `$\{camel-version\}` must be replaced by the actual version of Camel.
 
 
-include::camel-spring-boot::page$aws-kinesis-starter.adoc[]
\ No newline at end of file
+include::camel-spring-boot::page$aws-kinesis-starter.adoc[]