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/03 18:25:22 UTC
[camel] 02/07: CAMEL-14478 - Create an AWS-KMS component based on
SDK v2, 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 4be04eb7624505d89843a3abc4f6444ab6e2ad7b
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Mon Feb 3 17:47:43 2020 +0100
CAMEL-14478 - Create an AWS-KMS component based on SDK v2, docs
---
.../src/main/docs/aws-kms-component.adoc | 200 ---------------------
1 file changed, 200 deletions(-)
diff --git a/components/camel-aws2-kms/src/main/docs/aws-kms-component.adoc b/components/camel-aws2-kms/src/main/docs/aws-kms-component.adoc
deleted file mode 100644
index 4b57400..0000000
--- a/components/camel-aws2-kms/src/main/docs/aws-kms-component.adoc
+++ /dev/null
@@ -1,200 +0,0 @@
-[[aws-kms-component]]
-= AWS KMS Component
-
-*Since Camel 2.21*
-
-// HEADER START
-*Only producer is supported*
-// HEADER END
-
-The KMS component supports the ability to work with keys stored in
-https://aws.amazon.com/kms/[AWS KMS] instances.
-
-Prerequisites
-
-You must have a valid Amazon Web Services developer account, and be
-signed up to use Amazon KMS. More information is available at
-https://aws.amazon.com/kms/[Amazon KMS].
-
-== URI Format
-
-[source,java]
--------------------------
-aws-kms://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 KMS 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 KMS default configuration | | KMSConfiguration
-| *accessKey* (producer) | Amazon AWS Access Key | | String
-| *secretKey* (producer) | Amazon AWS Secret Key | | String
-| *region* (producer) | The region in which KMS 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 KMS endpoint is configured using URI syntax:
-
-----
-aws-kms: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
-| *kmsClient* (producer) | To use a existing configured AWS KMS as client | | AWSKMS
-| *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 | | KMSOperations
-| *proxyHost* (producer) | To define a proxy host when instantiating the KMS client | | String
-| *proxyPort* (producer) | To define a proxy port when instantiating the KMS client | | Integer
-| *proxyProtocol* (producer) | To define a proxy protocol when instantiating the KMS client | HTTPS | Protocol
-| *region* (producer) | The region in which KMS 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-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.springboot</groupId>
- <artifactId>camel-aws-kms-starter</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-----
-
-
-The component supports 15 options, which are listed below.
-
-
-
-[width="100%",cols="2,5,^1,2",options="header"]
-|===
-| Name | Description | Default | Type
-| *camel.component.aws-kms.access-key* | Amazon AWS Access Key | | String
-| *camel.component.aws-kms.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean
-| *camel.component.aws-kms.bridge-error-handler* | 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
-| *camel.component.aws-kms.configuration.access-key* | Amazon AWS Access Key | | String
-| *camel.component.aws-kms.configuration.kms-client* | To use a existing configured AWS KMS as client | | AWSKMS
-| *camel.component.aws-kms.configuration.operation* | The operation to perform | | KMSOperations
-| *camel.component.aws-kms.configuration.proxy-host* | To define a proxy host when instantiating the KMS client | | String
-| *camel.component.aws-kms.configuration.proxy-port* | To define a proxy port when instantiating the KMS client | | Integer
-| *camel.component.aws-kms.configuration.proxy-protocol* | To define a proxy protocol when instantiating the KMS client | | Protocol
-| *camel.component.aws-kms.configuration.region* | The region in which KMS 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
-| *camel.component.aws-kms.configuration.secret-key* | Amazon AWS Secret Key | | String
-| *camel.component.aws-kms.enabled* | Whether to enable auto configuration of the aws-kms component. This is enabled by default. | | Boolean
-| *camel.component.aws-kms.lazy-start-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 th [...]
-| *camel.component.aws-kms.region* | The region in which KMS client needs to work | | String
-| *camel.component.aws-kms.secret-key* | Amazon AWS Secret Key | | String
-|===
-// spring-boot-auto-configure options: END
-
-
-
-
-Required KMS component options
-
-You have to provide the amazonKmsClient in the
-Registry or your accessKey and secretKey to access
-the https://aws.amazon.com/kms/[Amazon KMS] service.
-
-== Usage
-
-=== Message headers evaluated by the KMS producer
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Header |Type |Description
-
-|`CamelAwsKMSLimit` |`Integer` |The limit number of keys to return while performing a listKeys operation
-
-|`CamelAwsKMSOperation` |`String` |The operation we want to perform
-
-|`CamelAwsKMSDescription` |`String` |A key description to use while performing a createKey operation
-
-|`CamelAwsKMSKeyId` |`String` |The key Id
-|=======================================================================
-
-=== KMS Producer operations
-
-Camel-AWS KMS component provides the following operation on the producer side:
-
-- listKeys
-- createKey
-- disableKey
-- scheduleKeyDeletion
-- describeKey
-- enableKey
-
-== Producer Examples
-
-- listKeys: this operation will list the available keys in KMS
-
-[source,java]
---------------------------------------------------------------------------------
-from("direct:listKeys")
- .to("aws-kms://test?kmsClient=#amazonKmsClient&operation=listKeys")
---------------------------------------------------------------------------------
-
-== Automatic detection of AWSKMS client in registry
-
-The component is capable of detecting the presence of an AWSKMS 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-aws-kms</artifactId>
- <version>${camel-version}</version>
-</dependency>
----------------------------------------
-
-where `$\{camel-version\}` must be replaced by the actual version of Camel.
-