AWS MSK Component
Available as of Camel version 3.0
The KMS component supports create, run, start, stop and terminate AWS MSK instances.
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon MSK. More information is available at Amazon MSK.
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 6 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
configuration (advanced) |
The AWS MSK default configuration |
MSKConfiguration |
|
accessKey (producer) |
Amazon AWS Access Key |
String |
|
secretKey (producer) |
Amazon AWS Secret Key |
String |
|
region (producer) |
The region in which MSK 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 |
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 |
Query Parameters (9 parameters):
Name | Description | Default | Type |
---|---|---|---|
accessKey (producer) |
Amazon AWS Access Key |
String |
|
mskClient (producer) |
To use a existing configured AWS MSK as client |
AWSKafka |
|
operation (producer) |
Required The operation to perform |
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 |
|
region (producer) |
The region in which MSK client needs to work |
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 |
Spring Boot Auto-Configuration
When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel</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 13 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.access-key |
Amazon AWS Access Key |
String |
|
camel.component.aws-msk.configuration.msk-client |
To use a existing configured AWS MSK as client |
AWSKafka |
|
camel.component.aws-msk.configuration.operation |
The operation to perform |
MSKOperations |
|
camel.component.aws-msk.configuration.proxy-host |
To define a proxy host when instantiating the MSK client |
String |
|
camel.component.aws-msk.configuration.proxy-port |
To define a proxy port when instantiating the MSK client |
Integer |
|
camel.component.aws-msk.configuration.region |
The region in which MSK client needs to work |
String |
|
camel.component.aws-msk.configuration.secret-key |
Amazon AWS Secret Key |
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.region |
The region in which MSK client needs to work |
String |
|
camel.component.aws-msk.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-msk.secret-key |
Amazon AWS Secret Key |
String |
Required MSK component options
You have to provide the amazonKmsClient 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 |
---|---|---|
|
|
The operation to perform |
|
|
The cluster name filter for list operation |
|
|
The cluster name for list and create operation |
|
|
The cluster arn for delete operation |
|
|
The Kafka for the cluster during create operation |
|
|
The number of nodes for the cluster during create operation |
|
|
The Broker nodes group info to provide during the create operation |
KMS Producer operations
Camel-AWS KMS component provides the following operation on the producer side:
-
listClusters
-
createCluster
-
deleteCluster
Automatic detection of AWSKafka client in registry
From Camel 3.0.0-M3 the component will be able to detect 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
(2.16 or higher).
See Also
-
Configuring Camel
-
Component
-
Endpoint
-
Getting Started
-
AWS Component