AWS Kinesis

Consume and produce records from and to AWS Kinesis Streams.

Metadata

Property	Value
Scheme	`aws2-kinesis`
Support Level	Stable
Labels	cloud,messaging
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-kinesis</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`streamName`	string	✓		Name of the stream
`cborEnabled`	boolean		`true`	This option will set the CBOR_ENABLED property during the execution
`overrideEndpoint`	boolean		`false`	Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option
`region`	string			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()
`uriEndpointOverride`	string			Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option
`iteratorType`	object		`TRIM_HORIZON`	Defines where in the Kinesis stream to start getting records
`maxResultsPerRequest`	integer		`1`	Maximum number of records that will be fetched in each poll
`messageTimestamp`	string			The message timestamp to start polling from. Required if iteratorType is set to AT_TIMESTAMP
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`sequenceNumber`	string			The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER
`shardClosed`	object		`ignore`	Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a WARN message will be logged once and the consumer will not process new messages until restarted,in case of silent there will be no logging and the consumer will not process new messages until restarted,in case of fail a ReachedClosedStateException will be thrown
`shardId`	string			Defines which shardId in the Kinesis stream to get records from
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`shardMonitorInterval`	integer		`10000`	The interval in milliseconds to wait between shard polling
`lazyStartProducer`	boolean		`false`	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.
`amazonKinesisAsyncClient`	object			Supply a pre-constructed Amazon Kinesis async client to use for the KCL Consumer
`amazonKinesisClient`	object			Amazon Kinesis client to use for all requests for this endpoint
`applicationName`	string			Name of the KCL application. This defaults to the stream name.
`asyncClient`	boolean		`false`	If we want to a KinesisAsyncClient instance set it to true
`cloudWatchAsyncClient`	object			If we want to a KCL Consumer, we can pass an instance of CloudWatchAsyncClient
`dynamoDbAsyncClient`	object			If we want to a KCL Consumer, we can pass an instance of DynamoDbAsyncClient
`kclDisableCloudwatchMetricsExport`	boolean		`false`	If we want to use a KCL Consumer and disable the CloudWatch Metrics Export
`useKclConsumers`	boolean		`false`	If we want to a KCL Consumer set it to true
`proxyHost`	string			To define a proxy host when instantiating the Kinesis client
`proxyPort`	integer			To define a proxy port when instantiating the Kinesis client
`proxyProtocol`	object		`HTTPS`	To define a proxy protocol when instantiating the Kinesis client
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`delay`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`accessKey`	string			Amazon AWS Access Key
`profileCredentialsName`	string			If using a profile credentials provider this parameter will set the profile name.
`secretKey`	string			Amazon AWS Secret Key
`sessionToken`	string			Amazon AWS Session Token used when the user needs to assume a IAM role
`trustAllCertificates`	boolean		`false`	If we want to trust all certificates in case of overriding the endpoint
`useDefaultCredentialsProvider`	boolean		`false`	Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
`useProfileCredentialsProvider`	boolean		`false`	Set whether the Kinesis client should expect to load credentials through a profile credentials provider.
`useSessionCredentials`	boolean		`false`	Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis.