aws ddb streams source AWS DynamoDB Streams Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive events from AWS DynamoDB Streams.

Configuration Options

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

Property Name Description Type Default Example

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

table *

Table

Name of the DynamoDB table to look at

string

iteratorType

Iterator Type

Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. There are 4 enums and the value can be one of TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER

string

"LATEST"

sequenceNumberProvider

Sequence Number Provider

Provider for the sequence number when using one of the two ShardIteratorType AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number.

string

"000000000000000000000"

"900000000005745712447"

Fields marked with (*) are mandatory.

Usage

This section summarizes how the aws-ddb-streams-source can be used in various contexts.

Knative Source

The aws-ddb-streams-source Kamelet can be used as Knative source by binding it to a Knative object.

aws-ddb-streams-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-ddb-streams-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-ddb-streams-source
    properties:
      accessKey: "The Access Key"
      region: "eu-west-1"
      secretKey: "The Secret Key"
      table: "The Table"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the aws-ddb-streams-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f aws-ddb-streams-source-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:gson

  • camel:aws2-ddb

  • camel:kamelet

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind aws-ddb-streams-source -p "source.accessKey=The Access Key" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" -p "source.table=The Table" channel:mychannel

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Source

The aws-ddb-streams-source Kamelet can be used as Kafka source by binding it to a Kafka topic.

aws-ddb-streams-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-ddb-streams-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-ddb-streams-source
    properties:
      accessKey: "The Access Key"
      region: "eu-west-1"
      secretKey: "The Secret Key"
      table: "The Table"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the aws-ddb-streams-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f aws-ddb-streams-source-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind aws-ddb-streams-source -p "source.accessKey=The Access Key" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" -p "source.table=The Table" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.