AWS MSK - Apache Camel

URI Format

aws-msk://label[?options]

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

URI Options

The AWS MSK component supports 11 options, which are listed below.

Name	Description	Default	Type
accessKey (producer)	Amazon AWS Access Key		String
configuration (producer)	The component configuration		MSKConfiguration
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
mskClient (producer)	To use a existing configured AWS MSK as client		AWSKafka
operation (producer)	Required The operation to perform. The value can be one of: listClusters, createCluster, deleteCluster, describeCluster		MSKOperations
proxyHost (producer)	To define a proxy host when instantiating the MSK client		String
proxyPort (producer)	To define a proxy port when instantiating the MSK client		Integer
proxyProtocol (producer)	To define a proxy protocol when instantiating the MSK client. The value can be one of: HTTP, HTTPS	HTTPS	Protocol
region (producer)	The region in which MSK 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 component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean

Name

Description

Default

Type

accessKey (producer)

Amazon AWS Access Key

String

configuration (producer)

The component configuration

MSKConfiguration

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

mskClient (producer)

To use a existing configured AWS MSK as client

AWSKafka

operation (producer)

Required The operation to perform. The value can be one of: listClusters, createCluster, deleteCluster, describeCluster

MSKOperations

proxyHost (producer)

To define a proxy host when instantiating the MSK client

String

proxyPort (producer)

To define a proxy port when instantiating the MSK client

Integer

proxyProtocol (producer)

To define a proxy protocol when instantiating the MSK client. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

The region in which MSK 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 component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

The AWS MSK endpoint is configured using URI syntax:

aws-msk: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 (11 parameters):

Name	Description	Default	Type
accessKey (producer)	Amazon AWS Access Key		String
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
mskClient (producer)	To use a existing configured AWS MSK as client		AWSKafka
operation (producer)	Required The operation to perform. The value can be one of: listClusters, createCluster, deleteCluster, describeCluster		MSKOperations
proxyHost (producer)	To define a proxy host when instantiating the MSK client		String
proxyPort (producer)	To define a proxy port when instantiating the MSK client		Integer
proxyProtocol (producer)	To define a proxy protocol when instantiating the MSK client. The value can be one of: HTTP, HTTPS	HTTPS	Protocol
region (producer)	The region in which MSK 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

Name

Description

Default

Type

accessKey (producer)

Amazon AWS Access Key

String

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

mskClient (producer)

To use a existing configured AWS MSK as client

AWSKafka

operation (producer)

Required The operation to perform. The value can be one of: listClusters, createCluster, deleteCluster, describeCluster

MSKOperations

proxyHost (producer)

To define a proxy host when instantiating the MSK client

String

proxyPort (producer)

To define a proxy port when instantiating the MSK client

Integer

proxyProtocol (producer)

To define a proxy protocol when instantiating the MSK client. The value can be one of: HTTP, HTTPS

HTTPS

Protocol

region (producer)

The region in which MSK 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

Required MSK component options

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

Usage

Message headers evaluated by the MSK producer

Header Type Description

Header	Type	Description
`CamelAwsMSKOperation`	`String`	The operation to perform
`CamelAwsMSKClusterFilter`	`String`	The cluster name filter for list operation
`CamelAwsMSKClusterName`	`String`	The cluster name for list and create operation
`CamelAwsMSKClusterArn`	`String`	The cluster arn for delete operation
`CamelAwsMSKClusterKafkaVersion`	`String`	The Kafka for the cluster during create operation
`CamelAwsMSKBrokerNodesNumber`	`Integer`	The number of nodes for the cluster during create operation
`CamelAwsMSKBrokerNodesGroupInfo`	`com.amazonaws.services.kafka.model.BrokerNodeGroupInfo`	The Broker nodes group info to provide during the create operation

CamelAwsMSKOperation

String

The operation to perform

CamelAwsMSKClusterFilter

String

The cluster name filter for list operation

CamelAwsMSKClusterName

String

The cluster name for list and create operation

CamelAwsMSKClusterArn

String

The cluster arn for delete operation

CamelAwsMSKClusterKafkaVersion

String

The Kafka for the cluster during create operation

CamelAwsMSKBrokerNodesNumber

Integer

The number of nodes for the cluster during create operation

CamelAwsMSKBrokerNodesGroupInfo

com.amazonaws.services.kafka.model.BrokerNodeGroupInfo

The Broker nodes group info to provide during the create operation

MSK Producer operations

Camel-AWS MSK component provides the following operation on the producer side:

listClusters
createCluster
deleteCluster
describeCluster

Producer Examples

listBrokers: this operation will list the available MSK Brokers in AWS

from("direct:listClusters")
    .to("aws-msk://test?mskClient=#amazonMskClient&operation=listClusters")

Automatic detection of AWSKafka client in registry

The component is capable of detecting the presence of an AWSKafka 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

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws-msk</artifactId>
    <version>${camel-version}</version>
</dependency>

where ${camel-version} must be replaced by the actual version of Camel.

Spring Boot Auto-Configuration

When using aws-msk 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-aws-msk-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.

Name	Description	Default	Type
camel.component.aws-msk.access-key	Amazon AWS Access Key		String
camel.component.aws-msk.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-msk.configuration	The component configuration. The option is a org.apache.camel.component.aws.msk.MSKConfiguration type.		String
camel.component.aws-msk.enabled	Whether to enable auto configuration of the aws-msk component. This is enabled by default.		Boolean
camel.component.aws-msk.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.aws-msk.msk-client	To use a existing configured AWS MSK as client. The option is a com.amazonaws.services.kafka.AWSKafka type.		String
camel.component.aws-msk.operation	The operation to perform		MSKOperations
camel.component.aws-msk.proxy-host	To define a proxy host when instantiating the MSK client		String
camel.component.aws-msk.proxy-port	To define a proxy port when instantiating the MSK client		Integer
camel.component.aws-msk.proxy-protocol	To define a proxy protocol when instantiating the MSK client		Protocol
camel.component.aws-msk.region	The region in which MSK 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-msk.secret-key	Amazon AWS Secret Key		String

Name

Description

Default

Type

camel.component.aws-msk.access-key

Amazon AWS Access Key

String

camel.component.aws-msk.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-msk.configuration

The component configuration. The option is a org.apache.camel.component.aws.msk.MSKConfiguration type.

String

camel.component.aws-msk.enabled

Whether to enable auto configuration of the aws-msk component. This is enabled by default.

Boolean

camel.component.aws-msk.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.aws-msk.msk-client

To use a existing configured AWS MSK as client. The option is a com.amazonaws.services.kafka.AWSKafka type.

String

camel.component.aws-msk.operation

The operation to perform

MSKOperations

camel.component.aws-msk.proxy-host

To define a proxy host when instantiating the MSK client

String

camel.component.aws-msk.proxy-port

To define a proxy port when instantiating the MSK client

Integer

camel.component.aws-msk.proxy-protocol

To define a proxy protocol when instantiating the MSK client

Protocol

camel.component.aws-msk.region

The region in which MSK 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-msk.secret-key

Amazon AWS Secret Key

String