aws kinesis sink AWS Kinesis Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Send data to 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.

The Kamelet expects the following header:

  • partition / ce-partition: to set the Kinesis partition key

If the header won’t be set the exchange ID will be used.

The Kamelet is also able to recognize the following header:

  • sequence-number / ce-sequencenumber: to set the Sequence number

This header is optional.

Configuration Options

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

Property Name Description Type Default Example

region

AWS Region

Required The AWS region to connect to.

Enum values:

* af-south-1 * ap-east-1 * ap-northeast-1 * ap-northeast-2 * ap-northeast-3 * ap-south-1 * ap-southeast-1 * ap-southeast-2 * ap-southeast-3 * ca-central-1 * eu-central-1 * eu-north-1 * eu-south-1 * eu-west-1 * eu-west-2 * eu-west-3 * fips-us-east-1 * fips-us-east-2 * fips-us-west-1 * fips-us-west-2 * me-south-1 * sa-east-1 * us-east-1 * us-east-2 * us-west-1 * us-west-2 * cn-north-1 * cn-northwest-1 * us-gov-east-1 * us-gov-west-1 * us-iso-east-1 * us-iso-west-1 * us-isob-east-1

string

eu-west-1

stream

Stream Name

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

string

accessKey

Access Key

The access key obtained from AWS.

string

overrideEndpoint

Endpoint Overwrite

Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting.

boolean

false

secretKey

Secret Key

The secret key obtained from AWS.

string

uriEndpointOverride

Overwrite Endpoint URI

Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option.

string

useDefaultCredentialsProvider

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-sink Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:aws2-kinesis

  • camel:kamelet

Usage

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

Knative sink

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

aws-kinesis-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-kinesis-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-kinesis-sink
    properties:
      region: eu-west-1
      stream: The Stream Name

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

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

  2. Run the sink by using the following command:

    kubectl apply -f aws-kinesis-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind aws-kinesis-sink -p "sink.region=eu-west-1" -p "sink.stream=The Stream Name" channel:mychannel

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

Kafka sink

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

aws-kinesis-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-kinesis-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-kinesis-sink
    properties:
      region: eu-west-1
      stream: The Stream Name

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

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

  2. Run the sink by using the following command:

    kubectl apply -f aws-kinesis-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind aws-kinesis-sink -p "sink.region=eu-west-1" -p "sink.stream=The Stream Name" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

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