Chapter 26. AWS KMS Component

Available as of Camel version 2.21

The KMS component supports create, run, start, stop and terminate 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 Amazon KMS.

26.1. URI Format

aws-kms://label[?options]

You can append query options to the URI in the following format, ?options=value&option2=value&…​

26.2. URI Options

The AWS KMS component supports 5 options which are listed below.

NameDescriptionDefaultType

configuration (advanced)

The AWS MQ default configuration

 

KMSConfiguration

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

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

The AWS KMS endpoint is configured using URI syntax:

aws-kms:label

with the following path and query parameters:

26.2.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

label

Required Logical name

 

String

26.2.2. Query Parameters (8 parameters):

NameDescriptionDefaultType

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

Required KMS component options

You have to provide the amazonKmsClient in the Registry or your accessKey and secretKey to access the Amazon KMS service.

26.3. Usage

26.3.1. Message headers evaluated by the MQ producer

HeaderTypeDescription

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

Dependencies

Maven users will need to add the following dependency to their pom.xml.

pom.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).

26.4. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • AWS Component