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.

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.

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

table

Table

Required Name of the DynamoDB table to look at.

string

accessKey

Access Key

The access key obtained from AWS.

string

delay

Delay

Milliseconds before the next poll from database.

integer

500

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

streamIteratorType

Stream Iterator Type

Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. There are 2 enums and the value can be one of FROM_LATEST and FROM_START.

string

FROM_LATEST

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

  1. Save the aws-ddb-streams-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:

    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

  1. Save the aws-ddb-streams-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:

    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.