{"component":{"kind":"component","name":"aws2-kinesis","title":"AWS Kinesis","description":"Consume and produce records from and to AWS Kinesis Streams using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.2.0","label":"cloud,messaging","javaType":"org.apache.camel.component.aws2.kinesis.Kinesis2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-kinesis","version":"3.18.1","scheme":"aws2-kinesis","extendsScheme":"","syntax":"aws2-kinesis:streamName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelAwsKinesisSequenceNumber":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence number of the record, as defined in http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntaxResponse Syntax","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#SEQUENCE_NUMBER"},"CamelAwsKinesisApproximateArrivalTimestamp":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The time AWS assigned as the arrival time of the record.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#APPROX_ARRIVAL_TIME"},"CamelAwsKinesisPartitionKey":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Identifies which shard in the stream the data record is assigned to.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#PARTITION_KEY"},"CamelMessageTimestamp":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The timestamp of the message","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#MESSAGE_TIMESTAMP"},"CamelAwsKinesisShardId":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The shard ID of the shard where the data record was placed.","constantName":"org.apache.camel.component.aws2.kinesis.Kinesis2Constants#SHARD_ID"}},"properties":{"streamName":{"kind":"path","displayName":"Stream Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Name of the stream"},"amazonKinesisClient":{"kind":"parameter","displayName":"Amazon Kinesis Client","group":"common","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kinesis.KinesisClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon Kinesis client to use for all requests for this endpoint"},"cborEnabled":{"kind":"parameter","displayName":"Cbor Enabled","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"This option will set the CBOR_ENABLED property during the execution"},"overrideEndpoint":{"kind":"parameter","displayName":"Override Endpoint","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"proxyHost":{"kind":"parameter","displayName":"Proxy Host","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the Kinesis client"},"proxyPort":{"kind":"parameter","displayName":"Proxy Port","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the Kinesis client"},"proxyProtocol":{"kind":"parameter","displayName":"Proxy Protocol","group":"common","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the Kinesis client"},"region":{"kind":"parameter","displayName":"Region","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"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()"},"trustAllCertificates":{"kind":"parameter","displayName":"Trust All Certificates","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"kind":"parameter","displayName":"Uri Endpoint Override","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"kind":"parameter","displayName":"Use Default Credentials Provider","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"iteratorType":{"kind":"parameter","displayName":"Iterator Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"software.amazon.awssdk.services.kinesis.model.ShardIteratorType","enum":["AT_SEQUENCE_NUMBER","AFTER_SEQUENCE_NUMBER","TRIM_HORIZON","LATEST","AT_TIMESTAMP","null"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRIM_HORIZON","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Defines where in the Kinesis stream to start getting records"},"maxResultsPerRequest":{"kind":"parameter","displayName":"Max Results Per Request","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Maximum number of records that will be fetched in each poll"},"sendEmptyMessageWhenIdle":{"kind":"parameter","displayName":"Send Empty Message When Idle","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."},"sequenceNumber":{"kind":"parameter","displayName":"Sequence Number","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER"},"shardClosed":{"kind":"parameter","displayName":"Shard Closed","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum","enum":["ignore","fail","silent"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"ignore","configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised"},"shardId":{"kind":"parameter","displayName":"Shard Id","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Defines which shardId in the Kinesis stream to get records from"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"kind":"parameter","displayName":"Poll Strategy","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.PollingConsumerPollStrategy","deprecated":false,"autowired":false,"secret":false,"description":"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."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"backoffErrorThreshold":{"kind":"parameter","displayName":"Backoff Error Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."},"backoffIdleThreshold":{"kind":"parameter","displayName":"Backoff Idle Threshold","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."},"backoffMultiplier":{"kind":"parameter","displayName":"Backoff Multiplier","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"description":"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":{"kind":"parameter","displayName":"Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":500,"description":"Milliseconds before the next poll."},"greedy":{"kind":"parameter","displayName":"Greedy","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."},"initialDelay":{"kind":"parameter","displayName":"Initial Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"description":"Milliseconds before the first poll starts."},"repeatCount":{"kind":"parameter","displayName":"Repeat Count","group":"scheduler","label":"consumer,scheduler","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":0,"description":"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":{"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"org.apache.camel.LoggingLevel","enum":["TRACE","DEBUG","INFO","WARN","ERROR","OFF"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"TRACE","description":"The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."},"scheduledExecutorService":{"kind":"parameter","displayName":"Scheduled Executor Service","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.ScheduledExecutorService","deprecated":false,"autowired":false,"secret":false,"description":"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":{"kind":"parameter","displayName":"Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"defaultValue":"none","description":"To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"},"schedulerProperties":{"kind":"parameter","displayName":"Scheduler Properties","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","prefix":"scheduler.","multiValue":true,"deprecated":false,"autowired":false,"secret":false,"description":"To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler."},"startScheduler":{"kind":"parameter","displayName":"Start Scheduler","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether the scheduler should be auto started."},"timeUnit":{"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","javaType":"java.util.concurrent.TimeUnit","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"MILLISECONDS","description":"Time unit for initialDelay and delay options."},"useFixedDelay":{"kind":"parameter","displayName":"Use Fixed Delay","group":"scheduler","label":"consumer,scheduler","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."},"accessKey":{"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.kinesis.Kinesis2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}}