camel-aws2-kinesis-kafka-connector sink configuration

When using camel-aws2-kinesis-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-aws2-kinesis-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.aws2kinesis.CamelAws2kinesisSinkConnector

The camel-aws2-kinesis sink connector supports 27 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.streamName

Name of the stream

null

true

HIGH

camel.sink.endpoint.amazonKinesisClient

Amazon Kinesis client to use for all requests for this endpoint

null

false

MEDIUM

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

This option will set the CBOR_ENABLED property during the execution

true

false

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the Kinesis client

null

false

MEDIUM

camel.sink.endpoint.proxyPort

To define a proxy port when instantiating the Kinesis client

null

false

MEDIUM

camel.sink.endpoint.proxyProtocol

To define a proxy protocol when instantiating the Kinesis client One of: [HTTP] [HTTPS]

"HTTPS"

false

MEDIUM

camel.sink.endpoint.region

The region in which Kinesis Firehose 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()

null

false

MEDIUM

camel.sink.endpoint.trustAllCertificates

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

false

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.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.sink.endpoint.accessKey

Amazon AWS Access Key

null

false

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key

null

false

MEDIUM

camel.component.aws2-kinesis.amazonKinesisClient

Amazon Kinesis client to use for all requests for this endpoint

null

false

MEDIUM

camel.component.aws2-kinesis.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.aws2-kinesis.cborEnabled

This option will set the CBOR_ENABLED property during the execution

true

false

MEDIUM

camel.component.aws2-kinesis.configuration

Component configuration

null

false

MEDIUM

camel.component.aws2-kinesis.proxyHost

To define a proxy host when instantiating the Kinesis client

null

false

MEDIUM

camel.component.aws2-kinesis.proxyPort

To define a proxy port when instantiating the Kinesis client

null

false

MEDIUM

camel.component.aws2-kinesis.proxyProtocol

To define a proxy protocol when instantiating the Kinesis client One of: [HTTP] [HTTPS]

"HTTPS"

false

MEDIUM

camel.component.aws2-kinesis.region

The region in which Kinesis Firehose 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()

null

false

MEDIUM

camel.component.aws2-kinesis.trustAllCertificates

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

false

false

MEDIUM

camel.component.aws2-kinesis.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.aws2-kinesis.basicPropertyBinding

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

false

false

LOW

camel.component.aws2-kinesis.accessKey

Amazon AWS Access Key

null

false

MEDIUM

camel.component.aws2-kinesis.secretKey

Amazon AWS Secret Key

null

false

MEDIUM

The camel-aws2-kinesis sink connector has no converters out of the box.

The camel-aws2-kinesis sink connector has no transforms out of the box.

The camel-aws2-kinesis sink connector has no aggregation strategies out of the box.

Back to top