aws sqs source AWS SQS Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive data from AWS SQS.

Configuration Options

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

Property Name Description Type Default Example

accessKey *

Access Key

The access key obtained from AWS

string

queueNameOrArn *

Queue Name

The SQS Queue Name or ARN

string

region *

AWS Region

The AWS region to connect to

string

"eu-west-1"

secretKey *

Secret Key

The secret key obtained from AWS

string

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

deleteAfterRead

Auto-delete Messages

Delete messages after consuming them

boolean

true

protocol

Protocol

The underlying protocol used to communicate with SQS

string

"https"

"http or https"
Fields marked with (*) are mandatory.

Usage

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

Knative Source

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

aws-sqs-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-sqs-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-sqs-source
    properties:
      accessKey: "The Access Key"
      queueNameOrArn: "The Queue Name"
      region: "eu-west-1"
      secretKey: "The Secret Key"
  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-sqs-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-sqs-source-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:aws2-sqs

  • 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-sqs-source -p "source.accessKey=The Access Key" -p "source.queueNameOrArn=The Queue Name" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" channel:mychannel

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

Kafka Source

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

aws-sqs-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-sqs-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-sqs-source
    properties:
      accessKey: "The Access Key"
      queueNameOrArn: "The Queue Name"
      region: "eu-west-1"
      secretKey: "The Secret Key"
  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-sqs-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-sqs-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-sqs-source -p "source.accessKey=The Access Key" -p "source.queueNameOrArn=The Queue Name" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" 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.

Kamelet source file

Have a look at the following link:

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

Back to top