camel-aws-msk-kafka-connector sink configuration
When using camel-aws-msk-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-aws-msk-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
To use this Sink connector in Kafka connect you’ll need to set the following connector.class
connector.class=org.apache.camel.kafkaconnector.awsmsk.CamelAwsmskSinkConnector
The camel-aws-msk sink connector supports 25 options, which are listed below.
Name | Description | Default | Required | Priority |
---|---|---|---|---|
camel.sink.path.label |
Logical name |
null |
true |
HIGH |
camel.sink.endpoint.autoDiscoverClient |
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 |
false |
MEDIUM |
camel.sink.endpoint.accessKey |
Amazon AWS Access Key |
null |
false |
MEDIUM |
camel.sink.endpoint.lazyStartProducer |
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 |
false |
MEDIUM |
camel.sink.endpoint.mskClient |
To use a existing configured AWS MSK as client |
null |
false |
MEDIUM |
camel.sink.endpoint.operation |
The operation to perform One of: [listClusters] [createCluster] [deleteCluster] [describeCluster] |
null |
true |
HIGH |
camel.sink.endpoint.proxyHost |
To define a proxy host when instantiating the MSK client |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyPort |
To define a proxy port when instantiating the MSK client |
null |
false |
MEDIUM |
camel.sink.endpoint.proxyProtocol |
To define a proxy protocol when instantiating the MSK client One of: [HTTP] [HTTPS] |
"HTTPS" |
false |
MEDIUM |
camel.sink.endpoint.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() |
null |
false |
MEDIUM |
camel.sink.endpoint.secretKey |
Amazon AWS Secret Key |
null |
false |
MEDIUM |
camel.sink.endpoint.basicPropertyBinding |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
false |
MEDIUM |
camel.sink.endpoint.synchronous |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
false |
MEDIUM |
camel.component.aws-msk.autoDiscoverClient |
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 |
false |
MEDIUM |
camel.component.aws-msk.accessKey |
Amazon AWS Access Key |
null |
false |
MEDIUM |
camel.component.aws-msk.configuration |
The component configuration |
null |
false |
MEDIUM |
camel.component.aws-msk.lazyStartProducer |
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 |
false |
MEDIUM |
camel.component.aws-msk.mskClient |
To use a existing configured AWS MSK as client |
null |
false |
MEDIUM |
camel.component.aws-msk.operation |
The operation to perform One of: [listClusters] [createCluster] [deleteCluster] [describeCluster] |
null |
true |
HIGH |
camel.component.aws-msk.proxyHost |
To define a proxy host when instantiating the MSK client |
null |
false |
MEDIUM |
camel.component.aws-msk.proxyPort |
To define a proxy port when instantiating the MSK client |
null |
false |
MEDIUM |
camel.component.aws-msk.proxyProtocol |
To define a proxy protocol when instantiating the MSK client One of: [HTTP] [HTTPS] |
"HTTPS" |
false |
MEDIUM |
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() |
null |
false |
MEDIUM |
camel.component.aws-msk.secretKey |
Amazon AWS Secret Key |
null |
false |
MEDIUM |
camel.component.aws-msk.basicPropertyBinding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
false |
LOW |
The camel-aws-msk sink connector has no converters out of the box.
The camel-aws-msk sink connector has no transforms out of the box.
The camel-aws-msk sink connector has no aggregation strategies out of the box.