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 0204b93ea18fb7f2bfd7e72e5dd85ce95c286d5d Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Thu Feb 28 14:11:37 2019 +0100 CAMEL-13165 - Brings in docs for SB too --- .../src/main/docs/aws-msk-component.adoc | 35 ++++++++++++++++++++++ docs/components/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages}/aws-msk-component.adoc | 35 ++++++++++++++++++++++ 3 files changed, 71 insertions(+) diff --git a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc index e1d5432..77eea2d 100644 --- a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc +++ b/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc @@ -81,6 +81,41 @@ with the following path and query parameters: // endpoint options: END // spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + +When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws-msk-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 12 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.aws-msk.access-key* | Amazon AWS Access Key | | String +| *camel.component.aws-msk.configuration.access-key* | Amazon AWS Access Key | | String +| *camel.component.aws-msk.configuration.msk-client* | To use a existing configured AWS MSK as client | | AWSKafka +| *camel.component.aws-msk.configuration.operation* | The operation to perform | | MSKOperations +| *camel.component.aws-msk.configuration.proxy-host* | To define a proxy host when instantiating the KMS client | | String +| *camel.component.aws-msk.configuration.proxy-port* | To define a proxy port when instantiating the KMS client | | Integer +| *camel.component.aws-msk.configuration.region* | The region in which KMS client needs to work | | String +| *camel.component.aws-msk.configuration.secret-key* | Amazon AWS Secret Key | | String +| *camel.component.aws-msk.enabled* | Whether to enable auto configuration of the aws-msk component. This is enabled by default. | | Boolean +| *camel.component.aws-msk.region* | The region in which KMS client needs to work | | String +| *camel.component.aws-msk.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.aws-msk.secret-key* | Amazon AWS Secret Key | | String +|=== // spring-boot-auto-configure options: END diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index 23893da..a2780c7 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -28,6 +28,7 @@ * xref:aws-kms-component.adoc[AWS KMS Component] * xref:aws-lambda-component.adoc[AWS Lambda Component] * xref:aws-mq-component.adoc[AWS MQ Component] +* xref:aws-msk-component.adoc[AWS MSK Component] * xref:aws-s3-component.adoc[AWS S3 Storage Service Component] * xref:aws-sdb-component.adoc[AWS SimpleDB Component] * xref:aws-cw-component.adoc[AWS CloudWatch Component] diff --git a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc b/docs/components/modules/ROOT/pages/aws-msk-component.adoc similarity index 70% copy from components/camel-aws-msk/src/main/docs/aws-msk-component.adoc copy to docs/components/modules/ROOT/pages/aws-msk-component.adoc index e1d5432..77eea2d 100644 --- a/components/camel-aws-msk/src/main/docs/aws-msk-component.adoc +++ b/docs/components/modules/ROOT/pages/aws-msk-component.adoc @@ -81,6 +81,41 @@ with the following path and query parameters: // endpoint options: END // spring-boot-auto-configure options: START +=== Spring Boot Auto-Configuration + +When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws-msk-starter</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +The component supports 12 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *camel.component.aws-msk.access-key* | Amazon AWS Access Key | | String +| *camel.component.aws-msk.configuration.access-key* | Amazon AWS Access Key | | String +| *camel.component.aws-msk.configuration.msk-client* | To use a existing configured AWS MSK as client | | AWSKafka +| *camel.component.aws-msk.configuration.operation* | The operation to perform | | MSKOperations +| *camel.component.aws-msk.configuration.proxy-host* | To define a proxy host when instantiating the KMS client | | String +| *camel.component.aws-msk.configuration.proxy-port* | To define a proxy port when instantiating the KMS client | | Integer +| *camel.component.aws-msk.configuration.region* | The region in which KMS client needs to work | | String +| *camel.component.aws-msk.configuration.secret-key* | Amazon AWS Secret Key | | String +| *camel.component.aws-msk.enabled* | Whether to enable auto configuration of the aws-msk component. This is enabled by default. | | Boolean +| *camel.component.aws-msk.region* | The region in which KMS client needs to work | | String +| *camel.component.aws-msk.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.aws-msk.secret-key* | Amazon AWS Secret Key | | String +|=== // spring-boot-auto-configure options: END