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 619d88d092927341fc8791c6b9c46840bcad3342 Author: Andrea Cosentino <[email protected]> AuthorDate: Fri Jan 31 17:23:37 2020 +0100 CAMEL-14463 - Create an AWS-MQ component based on SDK v2, regen docs --- docs/components/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages/aws2-mq-component.adoc | 175 +++++++++++++++++++++ docs/components/modules/ROOT/pages/index.adoc | 4 +- 3 files changed, 179 insertions(+), 1 deletion(-) diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index 50e6d58..4d0d4ac 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -45,6 +45,7 @@ * xref:aws-xray.adoc[AWS XRay Component] * xref:aws2-ecs-component.adoc[AWS 2 ECS Component] * xref:aws2-eks-component.adoc[AWS 2 EKS Component] +* xref:aws2-mq-component.adoc[AWS 2 MQ Component] * xref:aws2-translate-component.adoc[AWS 2 Translate Component] * xref:azure-blob-component.adoc[Azure Storage Blob Service Component] * xref:azure-queue-component.adoc[Azure Storage Queue Service Component] diff --git a/docs/components/modules/ROOT/pages/aws2-mq-component.adoc b/docs/components/modules/ROOT/pages/aws2-mq-component.adoc new file mode 100644 index 0000000..dc5339d --- /dev/null +++ b/docs/components/modules/ROOT/pages/aws2-mq-component.adoc @@ -0,0 +1,175 @@ +[[aws2-mq-component]] += AWS 2 MQ Component +:page-source: components/camel-aws2-mq/src/main/docs/aws2-mq-component.adoc + +*Since Camel 3.1* + +// HEADER START +*Only producer is supported* +// HEADER END + +The MQ component supports create, run, start, stop and terminate +https://aws.amazon.com/amazon-mq/[AWS MQ] instances. + +Prerequisites + +You must have a valid Amazon Web Services developer account, and be +signed up to use Amazon MQ. More information is available at +https://aws.amazon.com/amazon-mq/[Amazon MQ]. + +== URI Format + +[source,java] +------------------------- +aws2-mq://label[?options] +------------------------- + +You can append query options to the URI in the following format, +?options=value&option2=value&... + +== URI Options + + +// component options: START +The AWS 2 MQ component supports 6 options, which are listed below. + + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *configuration* (advanced) | The AWS MQ default configuration | | MQ2Configuration +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *secretKey* (producer) | Amazon AWS Secret Key | | String +| *region* (producer) | The region in which MQ client needs to work | | String +| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean +| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] +|=== +// component options: END + + + + +// endpoint options: START +The AWS 2 MQ endpoint is configured using URI syntax: + +---- +aws2-mq:label +---- + +with the following path and query parameters: + +=== Path Parameters (1 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *label* | *Required* Logical name | | String +|=== + + +=== Query Parameters (11 parameters): + + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| *accessKey* (producer) | Amazon AWS Access Key | | String +| *amazonMqClient* (producer) | To use a existing configured AmazonMQClient as client | | MqClient +| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] +| *operation* (producer) | *Required* The operation to perform. It can be listBrokers,createBroker,deleteBroker | | MQ2Operations +| *proxyHost* (producer) | To define a proxy host when instantiating the MQ client | | String +| *proxyPort* (producer) | To define a proxy port when instantiating the MQ client | | Integer +| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the MQ client | HTTPS | Protocol +| *region* (producer) | The region in which MQ 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 +| *secretKey* (producer) | Amazon AWS Secret Key | | 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 +|=== +// endpoint options: END + +// spring-boot-auto-configure options: START +// spring-boot-auto-configure options: END + + + + +Required MQ component options + +You have to provide the amazonMqClient in the +Registry or your accessKey and secretKey to access +the https://aws.amazon.com/amazon-mq/[Amazon MQ] service. + +== Usage + +=== Message headers evaluated by the MQ producer + +[width="100%",cols="10%,10%,80%",options="header",] +|======================================================================= +|Header |Type |Description + +|`CamelAwsMQMaxResults` |`String` |The number of results that must be retrieved from listBrokers operation + +|`CamelAwsMQBrokerName` |`String` |The broker name + +|`CamelAwsMQOperation` |`String` |The operation we want to perform + +|`CamelAwsMQBrokerId` |`String` |The broker id + +|`CamelAwsMQBrokerDeploymentMode` |`String` |The deployment mode for the broker in the createBroker operation + +|`CamelAwsMQBrokerInstanceType` |`String` |The instance type for the MQ machine in the createBroker operation + +|`CamelAwsMQBrokerEngine` |`String` |The Broker Engine for MQ. Default is ACTIVEMQ + +|`CamelAwsMQBrokerEngineVersion` |`String` |The Broker Engine Version for MQ. Currently you can choose between 5.15.6 and 5.15.0 of ACTIVEMQ + +|`CamelAwsMQBrokerUsers` |`List<User>` |The list of users for MQ + +|`CamelAwsMQBrokerPubliclyAccessible` |`Boolean` |If the MQ instance must be publicly available or not. Default is false. +|======================================================================= + +=== MQ Producer operations + +Camel-AWS MQ component provides the following operation on the producer side: + +- listBrokers +- createBroker +- deleteBroker +- rebootBroker +- updateBroker +- describeBroker + +== Producer Examples + +- listBrokers: this operation will list the available MQ Brokers in AWS + +[source,java] +-------------------------------------------------------------------------------- +from("direct:listBrokers") + .to("aws2-mq://test?amazonMqClient=#amazonMqClient&operation=listBrokers") +-------------------------------------------------------------------------------- + +== Automatic detection of MqClient client in registry + +The component is capable of detecting the presence of an MqClient bean into the registry. +If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. +This may be really useful for smarter configuration of the endpoint. + +Dependencies + +Maven users will need to add the following dependency to their pom.xml. + +*pom.xml* + +[source,xml] +--------------------------------------- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-aws2-mq</artifactId> + <version>${camel-version}</version> +</dependency> +--------------------------------------- + +where `$\{camel-version\}` must be replaced by the actual version of Camel. \ No newline at end of file diff --git a/docs/components/modules/ROOT/pages/index.adoc b/docs/components/modules/ROOT/pages/index.adoc index efbcf67..c2d4eeb 100644 --- a/docs/components/modules/ROOT/pages/index.adoc +++ b/docs/components/modules/ROOT/pages/index.adoc @@ -6,7 +6,7 @@ The following Apache Camel artifacts are provided: == Components // components: START -Number of Components: 314 in 252 JAR artifacts (1 deprecated) +Number of Components: 315 in 253 JAR artifacts (1 deprecated) [width="100%",cols="4,1,5",options="header"] |=== @@ -50,6 +50,8 @@ Number of Components: 314 in 252 JAR artifacts (1 deprecated) | xref:aws2-eks-component.adoc[AWS 2 EKS] (camel-aws2-eks) | 3.1 | The aws-eks is used for managing Amazon EKS +| xref:aws2-mq-component.adoc[AWS 2 MQ] (camel-aws2-mq) | 3.1 | The aws-mq is used for managing Amazon MQ instances. + | xref:aws2-translate-component.adoc[AWS 2 Translate] (camel-aws2-translate) | 3.1 | The aws2-translate component is used for managing Amazon Translate | xref:aws-cw-component.adoc[AWS CloudWatch] (camel-aws-cw) | 2.11 | The aws-cw component is used for sending metrics to an Amazon CloudWatch.
