--- apiVersion: v1 kind: List items: - apiVersion: v1 kind: ConfigMap metadata: labels: funktion.fabric8.io/kind: Connector provider: fabric8 project: connector-aws-kinesis version: 1.1.23 group: io.fabric8.funktion.connector name: aws-kinesis data: deployment.yml: | --- apiVersion: extensions/v1beta1 kind: Deployment metadata: labels: funktion.fabric8.io/kind: Subscription connector: aws-kinesis spec: replicas: 1 template: metadata: labels: funktion.fabric8.io/kind: Subscription connector: aws-kinesis spec: containers: - image: fabric8/connector-aws-kinesis:1.1.23 name: connector schema.yml: | --- component: kind: component scheme: aws-kinesis syntax: aws-kinesis:streamName title: AWS Kinesis description: The aws-kinesis component is for consuming records from Amazon Kinesis Streams. label: cloud,messaging deprecated: false async: false javaType: org.apache.camel.component.aws.kinesis.KinesisComponent groupId: org.apache.camel artifactId: camel-aws version: 2.18.1 componentProperties: {} properties: streamName: kind: path group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: Name of the stream amazonKinesisClient: kind: parameter group: common required: true type: object javaType: com.amazonaws.services.kinesis.AmazonKinesis deprecated: false secret: false description: Amazon Kinesis client to use for all requests for this endpoint bridgeErrorHandler: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: 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/ERROR level and ignored. iteratorType: kind: parameter group: consumer label: consumer type: string javaType: com.amazonaws.services.kinesis.model.ShardIteratorType enum: - AT_SEQUENCE_NUMBER - AFTER_SEQUENCE_NUMBER - TRIM_HORIZON - LATEST - AT_TIMESTAMP deprecated: false secret: false description: Defines where in the Kinesis stream to start getting records maxResultsPerRequest: kind: parameter group: consumer label: consumer type: integer javaType: int deprecated: false secret: false defaultValue: "1" description: Maximum number of records that will be fetched in each poll sendEmptyMessageWhenIdle: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: 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 group: consumer label: consumer type: string javaType: java.lang.String deprecated: false secret: false description: The sequence number to start polling from shardId: kind: parameter group: consumer label: consumer type: string javaType: java.lang.String deprecated: false secret: false description: Defines which shardId in the Kinesis stream to get records from exceptionHandler: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.ExceptionHandler optionalPrefix: consumer. deprecated: false secret: false description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. exchangePattern: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.ExchangePattern enum: - InOnly - RobustInOnly - InOut - InOptionalOut - OutOnly - RobustOutOnly - OutIn - OutOptionalIn deprecated: false secret: false description: Sets the exchange pattern when the consumer creates an exchange. pollStrategy: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.PollingConsumerPollStrategy optionalPrefix: consumer. deprecated: 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. synchronous: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). backoffErrorThreshold: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: 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 group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. backoffMultiplier: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: 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 group: scheduler label: consumer,scheduler type: integer javaType: long optionalPrefix: consumer. deprecated: false secret: false defaultValue: "500" description: Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). greedy: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: 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 group: scheduler label: consumer,scheduler type: integer javaType: long optionalPrefix: consumer. deprecated: false secret: false defaultValue: "1000" description: Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). runLoggingLevel: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: org.apache.camel.LoggingLevel enum: - TRACE - DEBUG - INFO - WARN - ERROR - OFF optionalPrefix: consumer. deprecated: 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 group: scheduler label: consumer,scheduler type: object javaType: java.util.concurrent.ScheduledExecutorService optionalPrefix: consumer. deprecated: 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 group: scheduler label: consumer,scheduler type: string javaType: org.apache.camel.spi.ScheduledPollConsumerScheduler enum: - none - spring - quartz2 optionalPrefix: consumer. deprecated: false secret: false defaultValue: none description: To use a cron scheduler from either camel-spring or camel-quartz2 component schedulerProperties: kind: parameter group: scheduler label: consumer,scheduler type: object javaType: java.util.Map prefix: scheduler. multiValue: true deprecated: false secret: false description: To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. startScheduler: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: true description: Whether the scheduler should be auto started. timeUnit: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: java.util.concurrent.TimeUnit enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS optionalPrefix: consumer. deprecated: false secret: false defaultValue: MILLISECONDS description: Time unit for initialDelay and delay options. useFixedDelay: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: true description: Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. documentation.adoc: |+ [[AWS-KINESIS-KinesisComponent]] Kinesis Component ~~~~~~~~~~~~~~~~~ *Available as of Camel 2.17* The Kinesis component supports receiving messages from Amazon Kinesis service. Prerequisites You must have a valid Amazon Web Services developer account, and be signed up to use Amazon Kinesis. More information are available at??http://aws.amazon.com/kinesis/[AWS Kinesis] [[AWS-KINESIS-URIFormat]] URI Format ^^^^^^^^^^ [source,java] ----------------------------------- aws-kinesis://stream-name[?options] ----------------------------------- The stream needs to be created prior to it being used. + You can append query options to the URI in the following format, ?options=value&option2=value&... [[AWS-KINESIS-URIOptions]] URI Options ^^^^^^^^^^^ // component options: START The AWS Kinesis component has no options. // component options: END // endpoint options: START The AWS Kinesis component supports 25 endpoint options which are listed below: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description | streamName | common | | String | *Required* Name of the stream | amazonKinesisClient | common | | AmazonKinesis | *Required* Amazon Kinesis client to use for all requests for this endpoint | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | iteratorType | consumer | | ShardIteratorType | Defines where in the Kinesis stream to start getting records | maxResultsPerRequest | consumer | 1 | int | Maximum number of records that will be fetched in each poll | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | sequenceNumber | consumer | | String | The sequence number to start polling from | shardId | consumer | | String | Defines which shardId in the Kinesis stream to get records from | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. | pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | 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. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | backoffMultiplier | scheduler | | int | 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 | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | scheduledExecutorService | scheduler | | ScheduledExecutorService | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component | schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= {% endraw %} // endpoint options: END Required Kinesis component options You have to provide the??amazonKinesisClient in the link:registry.html[Registry] with proxies and relevant credentials configured. [[AWS-KINESIS-BatchConsumer]] Batch Consumer ^^^^^^^^^^^^^^ This component implements the link:batch-consumer.html[Batch Consumer]. This allows you for instance to know how many messages exists in this batch and for instance let the link:aggregator.html[Aggregator] aggregate this number of messages. [[AWS-KINESIS-Usage]] Usage ^^^^^ [[AWS-KINESIS-MessageheaderssetbytheKinesisconsumer]] Message headers set by the Kinesis consumer +++++++++++++++++++++++++++++++++++++++++++ [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Header |Type |Description |`CamelAwsKinesisSequenceNumber` |`String` |The sequence number of the record. This is represented as a String as it size is not defined by the API. If it is to be used as a numerical type then use |`CamelAwsKinesisApproximateArrivalTimestamp` |`String` |The time AWS assigned as the arrival time of the record. |`CamelAwsKinesisPartitionKey` |`String` |Identifies which shard in the stream the data record is assigned to. |======================================================================= [[AWS-KINESIS-AmazonKinesisconfiguration]] AmazonKinesis configuration +++++++++++++++++++++++++++ You will need to create an instance of AmazonDynamoDBStreamsClient and bind it to the registry [source,java] -------------------------------------------------------------------------------------------------------------------- ClientConfiguration clientConfiguration = new ClientConfiguration(); clientConfiguration.setProxyHost("http://myProxyHost"); clientConfiguration.setProxyPort(8080); Region region = Region.getRegion(Regions.fromName(region)); region.createClient(AmazonDynamoDBStreamsClient.class, null, clientConfiguration); // the 'null' here is the AWSCredentialsProvider which defaults to an instance of DefaultAWSCredentialsProviderChain registry.bind("kinesisClient", client); -------------------------------------------------------------------------------------------------------------------- [[AWS-KINESIS-ProvidingAWSCredentials]] Providing AWS Credentials +++++++++++++++++++++++++ It is recommended that the credentials are obtained by using the http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html[DefaultAWSCredentialsProviderChain] that is the default when creating a new ClientConfiguration instance, however, a different??http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/AWSCredentialsProvider.html[AWSCredentialsProvider] can be specified when calling createClient(...). [[AWS-Kinesis-MessageheaderssetbytheKinesisproducer]] Message headers used by the Kinesis producer to write to Kinesis. The producer expects that the message body is a `ByteBuffer`. +++++++++++++++++++++++++++++++++++++++ [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Header |Type |Description |`CamelAwsKinesisPartitionKey` |`String` |The PartitionKey to pass to Kinesis to store this record. |`CamelAwsKinesisSequenceNumber` |`String` |Optional paramter to indicate the sequence number of this record. |======================================================================= Message headers set by the Kinesis producer on successful storage of a Record +++++++++++++++++++++++++++++++++++++++ [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Header |Type |Description |`CamelAwsKinesisSequenceNumber` |`String` |The sequence number of the record, as defined in http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html#API_PutRecord_ResponseSyntax[Response Syntax] |`CamelAwsKinesisShardId` |`String` |The shard ID of where the Record was stored |======================================================================= [[AWS-KINESIS-Dependencies]] Dependencies ^^^^^^^^^^^^ Maven users will need to add the following dependency to their pom.xml. *pom.xml* [source,xml] --------------------------------------- org.apache.camel camel-aws ${camel-version} --------------------------------------- where `${camel-version`} must be replaced by the actual version of Camel (2.17 or higher). [[AWS-KINESIS-SeeAlso]] See Also ^^^^^^^^ * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] * link:aws.html[AWS Component]