[[aws-kms-component]]
= AWS KMS Component
:page-source: components/camel-aws/src/main/docs/aws-kms-component.adoc

*Available as of Camel version 2.21*


The KMS component supports create, run, start, stop and terminate
https://aws.amazon.com/it/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 are available at
https://aws.amazon.com/it/mq/[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 5 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
| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|===
// 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 (8 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
| *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
| *region* (producer) | The region in which KMS client needs to work |  | String
| *secretKey* (producer) | Amazon AWS Secret Key |  | String
| *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</groupId>
  <artifactId>camel-aws-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-kms.access-key* | Amazon AWS Access Key |  | String
| *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.region* | The region in which KMS client needs to work |  | 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.region* | The region in which KMS client needs to work |  | String
| *camel.component.aws-kms.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-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/it/kms/[Amazon KMS] service.

== Usage

=== Message headers evaluated by the MQ 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

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</artifactId>
    <version>${camel-version}</version>
</dependency>
---------------------------------------

where `$\{camel-version\}` must be replaced by the actual version of Camel
(2.16 or higher).