AWS Kinesis Source
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Receive data from AWS Kinesis.
The basic authentication method for the Kinesis service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider.
If you use the default credentials provider, the Kinesis client loads the credentials through this provider and doesn’t use the basic authentication method.
Two headers will be duplicated with different names for clarity at sink level, CamelAwsKinesisPartitionKey will be duplicated into aws.kinesis.partition.key and CamelAwsKinesisSequenceNumber will be duplicated in aws.kinesis.sequence.number
Configuration Options
The following table summarizes the configuration options available for the aws-kinesis-source
Kamelet:
Property | Name | Description | Type | Default | Example |
---|---|---|---|---|---|
AWS Region | Required The AWS region to access. Enum values: * ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global | string | |||
Stream Name | Required The Kinesis stream that you want to access. The Kinesis stream that you specify must already exist. | string | |||
Access Key | The access key obtained from AWS. | string | |||
Async Client | If we want to a KinesisAsyncClient instance set it to true. | boolean | false | ||
Delay | The number of milliseconds before the next poll of the selected stream. | integer | 500 | ||
Endpoint Overwrite | Select this option to override the endpoint URI. To use this option, you must also provide a URI for the | boolean | false | ||
Secret Key | The secret key obtained from AWS. | string | |||
Overwrite Endpoint URI | The overriding endpoint URI. To use this option, you must also select the | string | |||
Default Credentials Provider | If true, the Kinesis client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key). | boolean | false | ||
KCL Consumer | If we want to a KCL Consumer set it to true. | boolean | false |
Dependencies
At runtime, the aws-kinesis-source
Kamelet relies upon the presence of the following dependencies:
-
camel:aws2-kinesis
-
camel:kamelet
-
camel:core
-
mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.7.0-SNAPSHOT
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel
Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:aws-kinesis-source"
parameters:
.
.
.
steps:
- to:
uri: "kamelet:log-sink"
You can now run it directly through the following command
camel run route.yaml