AWS DynamoDB Streams Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive events from AWS DynamoDB Streams.

Access Key/Secret Key are the basic method for authenticating to the AWS DynamoDB Streams Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the AWS DynamoDB Streams 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-ddb-streams-source Kamelet:

Property	Name	Description	Type	Default	Example
region	AWS Region	Required The AWS region to connect to.	string		eu-west-1
table	Table	Required Name of the DynamoDB table to look at.	string
accessKey	Access Key	The access key obtained from AWS.	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
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
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
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 AWS DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	boolean	false

Property

Name

Description

Type

Default

Example

region

AWS Region

Required The AWS region to connect to.

string

eu-west-1

table

Table

Required Name of the DynamoDB table to look at.

string

accessKey

Access Key

The access key obtained from AWS.

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

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

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

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 AWS DynamoDB Streams 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-ddb-streams-source Kamelet relies upon the presence of the following dependencies:

camel:gson
camel:aws2-ddb
camel:kamelet

Usage

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

Knative source

You can use the aws-ddb-streams-source Kamelet as a 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:
      region: eu-west-1
      table: The Table
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the aws-ddb-streams-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-ddb-streams-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

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

Kafka source

You can use the aws-ddb-streams-source Kamelet as a 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:
      region: eu-west-1
      table: The Table
  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-ddb-streams-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-ddb-streams-source-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

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

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/aws-ddb-streams-source.kamelet.yaml