| // kafka-connector options: START |
| [[camel-aws-kinesis-firehose-kafka-connector-sink]] |
| = camel-aws-kinesis-firehose-kafka-connector sink configuration |
| |
| When using camel-aws-kinesis-firehose-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-aws-kinesis-firehose-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-aws-kinesis-firehose sink connector supports 17 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.streamName* | Name of the stream | null | HIGH |
| | *camel.sink.endpoint.amazonKinesisFirehoseClient* | Amazon Kinesis Firehose client to use for all requests for this endpoint | null | 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 | MEDIUM |
| | *camel.sink.endpoint.proxyHost* | To define a proxy host when instantiating the Kinesis Firehose client | null | MEDIUM |
| | *camel.sink.endpoint.proxyPort* | To define a proxy port when instantiating the Kinesis Firehose client | null | MEDIUM |
| | *camel.sink.endpoint.proxyProtocol* | To define a proxy protocol when instantiating the Kinesis Firehose client One of: [HTTP] [HTTPS] | "HTTPS" | MEDIUM |
| | *camel.sink.endpoint.region* | The region in which Kinesis 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 | 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 | MEDIUM |
| | *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.sink.endpoint.accessKey* | Amazon AWS Access Key | null | MEDIUM |
| | *camel.sink.endpoint.secretKey* | Amazon AWS Secret Key | null | MEDIUM |
| | *camel.component.aws-kinesis-firehose.accessKey* | Amazon AWS Access Key | null | MEDIUM |
| | *camel.component.aws-kinesis-firehose.lazyStart 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 | MEDIUM |
| | *camel.component.aws-kinesis-firehose.region* | Amazon AWS Region | null | MEDIUM |
| | *camel.component.aws-kinesis-firehose.secretKey* | Amazon AWS Secret Key | null | MEDIUM |
| | *camel.component.aws-kinesis-firehose.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.aws-kinesis-firehose.configuration* | The AWS Kinesis Firehose default configuration | null | MEDIUM |
| |=== |
| // kafka-connector options: END |
