Chapter 5. AWS Kinesis Source

Receive data from AWS Kinesis.

5.1. Configuration Options

The following table summarizes the configuration options available for the aws-kinesis-source Kamelet:

PropertyNameDescriptionTypeDefaultExample

accessKey *

Access Key

The access key obtained from AWS

string

  

region *

AWS Region

The AWS region to connect to

string

 

"eu-west-1"

secretKey *

Secret Key

The secret key obtained from AWS

string

  

stream *

Stream Name

The Kinesis stream that you want to access (needs to be created in advance)

string

  
Note

Fields marked with an asterisk (*) are mandatory.

5.2. Dependencies

At runtime, the aws-kinesis-source Kamelet relies upon the presence of the following dependencies:

  • camel:gson
  • camel:kamelet
  • camel:aws2-kinesis

5.3. Usage

This section describes how you can use the aws-kinesis-source.

5.3.1. Knative Source

You can use the aws-kinesis-source Kamelet as a Knative source by binding it to a Knative object.

aws-kinesis-source-binding.yaml

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:
      accessKey: "The Access Key"
      region: "eu-west-1"
      secretKey: "The Secret Key"
      stream: "The Stream Name"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

5.3.1.1. Prerequisite

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

5.3.1.2. Procedure for using the cluster CLI

  1. Save the aws-kinesis-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command: 

    oc apply -f aws-kinesis-source-binding.yaml

5.3.1.3. Procedure for using the Kamel CLI

Configure and run the source by using the following command: 

kamel bind aws-kinesis-source -p "source.accessKey=The Access Key" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" -p "source.stream=The Stream Name" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

5.3.2. Kafka Source

You can use the aws-kinesis-source Kamelet as a Kafka source by binding it to a Kafka topic.

aws-kinesis-source-binding.yaml

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:
      accessKey: "The Access Key"
      region: "eu-west-1"
      secretKey: "The Secret Key"
      stream: "The Stream Name"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

5.3.2.1. Prerequisites

Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

5.3.2.2. Procedure for using the cluster CLI

  1. Save the aws-kinesis-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command: 

    oc apply -f aws-kinesis-source-binding.yaml

5.3.2.3. Procedure for using the Kamel CLI

Configure and run the source by using the following command: 

kamel bind aws-kinesis-source -p "source.accessKey=The Access Key" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" -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.

5.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/tree/kamelet-catalog-1.8//aws-kinesis-source.kamelet.yaml