AWS Kinesis Source
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Preview"
Receive data from AWS Kinesis.
Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'.
When using a default Credentials Provider the Kinesis client will load the credentials through this provider and won’t use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet.
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 connect to. |
string |
eu-west-1 |
||
Stream Name |
Required The Kinesis stream that you want to access (needs to be created in advance). |
string |
|||
Access Key |
The access key obtained from AWS. |
string |
|||
Endpoint Overwrite |
Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting. |
boolean |
false |
||
Secret Key |
The secret key obtained from AWS. |
string |
|||
Overwrite Endpoint URI |
Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option. |
string |
|||
Default Credentials Provider |
Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. |
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
Usage
This section describes how you can use the aws-kinesis-source
.
Knative source
You can use the aws-kinesis-source
Kamelet as a Knative source by binding it to a Knative object.
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-kinesis-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-kinesis-source
properties:
region: eu-west-1
stream: The Stream Name
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
Prerequisite
You have Camel K installed on the cluster.
Kafka source
You can use the aws-kinesis-source
Kamelet as a Kafka source by binding it to a Kafka topic.
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-kinesis-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-kinesis-source
properties:
region: eu-west-1
stream: The Stream Name
sink:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
Prerequisites
-
You’ve installed Strimzi.
-
You’ve created a topic named
my-topic
in the current namespace. -
You have Camel K installed on the cluster.
Procedure for using the cluster CLI
-
Save the
aws-kinesis-source-binding.yaml
file to your local drive, and then edit it as needed for your configuration. -
Run the source by using the following command:
kubectl apply -f aws-kinesis-source-binding.yaml
Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind aws-kinesis-source -p "source.region=eu-west-1" -p "source.stream=The Stream Name" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
This command creates the KameletBinding in the current namespace on the cluster.