AWS 2 MQ :: Apache Camel

URI Format

aws2-mq://label[?options]

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

URI Options

The AWS 2 MQ component supports 12 options, which are listed below.

Name	Description	Default	Type
amazonMqClient (producer)	To use a existing configured AmazonMQClient as client		MqClient
configuration (producer)	Component configuration		MQ2Configuration
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 starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
operation (producer)	Required The operation to perform. It can be listBrokers,createBroker,deleteBroker. The value can be one of: listBrokers, createBroker, deleteBroker, rebootBroker, updateBroker, describeBroker		MQ2Operations
pojoRequest (producer)	If we want to use a POJO request as body or not	false	boolean
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. The value can be one of: HTTP, HTTPS	HTTPS	Protocol
region (producer)	The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()		String
basicPropertyBinding (advanced)	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean
accessKey (security)	Amazon AWS Access Key		String
secretKey (security)	Amazon AWS Secret Key		String

Name

Description

Default

Type

amazonMqClient (producer)

To use a existing configured AmazonMQClient as client

MqClient

configuration (producer)

Component configuration

MQ2Configuration

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 starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

operation (producer)

Required The operation to perform. It can be listBrokers,createBroker,deleteBroker. The value can be one of: listBrokers, createBroker, deleteBroker, rebootBroker, updateBroker, describeBroker

MQ2Operations

pojoRequest (producer)

If we want to use a POJO request as body or not

false

boolean

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. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

String

basicPropertyBinding (advanced)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

accessKey (security)

Amazon AWS Access Key

String

secretKey (security)

Amazon AWS Secret Key

String

The AWS 2 MQ endpoint is configured using URI syntax:

aws2-mq:label

with the following path and query parameters:

Path Parameters (1 parameters):

Name	Description	Default	Type
label	Required Logical name		String

Name

Description

Default

Type

label

Required Logical name

String

Query Parameters (12 parameters):

Name	Description	Default	Type
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 starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
operation (producer)	Required The operation to perform. It can be listBrokers,createBroker,deleteBroker. The value can be one of: listBrokers, createBroker, deleteBroker, rebootBroker, updateBroker, describeBroker		MQ2Operations
pojoRequest (producer)	If we want to use a POJO request as body or not	false	boolean
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. The value can be one of: HTTP, HTTPS	HTTPS	Protocol
region (producer)	The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()		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
accessKey (security)	Amazon AWS Access Key		String
secretKey (security)	Amazon AWS Secret Key		String

Name

Description

Default

Type

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 starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

operation (producer)

Required The operation to perform. It can be listBrokers,createBroker,deleteBroker. The value can be one of: listBrokers, createBroker, deleteBroker, rebootBroker, updateBroker, describeBroker

MQ2Operations

pojoRequest (producer)

If we want to use a POJO request as body or not

false

boolean

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. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

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

accessKey (security)

Amazon AWS Access Key

String

secretKey (security)

Amazon AWS Secret Key

String

Required MQ component options

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

Usage

Message headers evaluated by the MQ producer

Header Type Description

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.

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

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.

Using a POJO as body

Sometimes build an AWS Request can be complex, because of multiple options. We introduce the possibility to use a POJO as body. In AWS MQ there are multiple operations you can submit, as an example for List brokers request, you can do something like:

from("direct:aws2-mq")
     .setBody(ListBrokersRequest.builder().maxResults(10).build())
     .to("aws2-mq://test?amazonMqClient=#amazonMqClient&operation=listBrokers&pojoRequest=true")

In this way you’ll pass the request directly without the need of passing headers and options specifically related to this operation.

Dependencies

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

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

Spring Boot Auto-Configuration

When using aws2-mq with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-aws2-mq-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.

Name	Description	Default	Type
camel.component.aws2-mq.access-key	Amazon AWS Access Key		String
camel.component.aws2-mq.amazon-mq-client	To use a existing configured AmazonMQClient as client. The option is a software.amazon.awssdk.services.mq.MqClient type.		String
camel.component.aws2-mq.auto-discover-client	Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.	true	Boolean
camel.component.aws2-mq.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.aws2-mq.configuration	Component configuration. The option is a org.apache.camel.component.aws2.mq.MQ2Configuration type.		String
camel.component.aws2-mq.enabled	Whether to enable auto configuration of the aws2-mq component. This is enabled by default.		Boolean
camel.component.aws2-mq.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 then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.aws2-mq.operation	The operation to perform. It can be listBrokers,createBroker,deleteBroker		MQ2Operations
camel.component.aws2-mq.pojo-request	If we want to use a POJO request as body or not	false	Boolean
camel.component.aws2-mq.proxy-host	To define a proxy host when instantiating the MQ client		String
camel.component.aws2-mq.proxy-port	To define a proxy port when instantiating the MQ client		Integer
camel.component.aws2-mq.proxy-protocol	To define a proxy protocol when instantiating the MQ client		Protocol
camel.component.aws2-mq.region	The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()		String
camel.component.aws2-mq.secret-key	Amazon AWS Secret Key		String
camel.component.aws2-mq.trust-all-certificates	If we want to trust all certificates in case of overriding the endpoint	false	Boolean

Name

Description

Default

Type

camel.component.aws2-mq.access-key

Amazon AWS Access Key

String

camel.component.aws2-mq.amazon-mq-client

To use a existing configured AmazonMQClient as client. The option is a software.amazon.awssdk.services.mq.MqClient type.

String

camel.component.aws2-mq.auto-discover-client

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

Boolean

camel.component.aws2-mq.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.aws2-mq.configuration

Component configuration. The option is a org.apache.camel.component.aws2.mq.MQ2Configuration type.

String

camel.component.aws2-mq.enabled

Whether to enable auto configuration of the aws2-mq component. This is enabled by default.

Boolean

camel.component.aws2-mq.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 then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.aws2-mq.operation

The operation to perform. It can be listBrokers,createBroker,deleteBroker

MQ2Operations

camel.component.aws2-mq.pojo-request

If we want to use a POJO request as body or not

false

Boolean

camel.component.aws2-mq.proxy-host

To define a proxy host when instantiating the MQ client

String

camel.component.aws2-mq.proxy-port

To define a proxy port when instantiating the MQ client

Integer

camel.component.aws2-mq.proxy-protocol

To define a proxy protocol when instantiating the MQ client

Protocol

camel.component.aws2-mq.region

The region in which MQ client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id()

String

camel.component.aws2-mq.secret-key

Amazon AWS Secret Key

String

camel.component.aws2-mq.trust-all-certificates

If we want to trust all certificates in case of overriding the endpoint

false

Boolean