Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 10. AWS SQS Source

Receive data from AWS SQS.

10.1. Configuration Options
Copy link

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

Expand
PropertyNameDescriptionTypeDefaultExample

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

  

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

 

deleteAfterRead

Auto-delete Messages

Delete messages after consuming them

boolean

true

 
Note

Fields marked with an asterisk (*) are mandatory.

10.2. Dependencies
Copy link

At runtime, the aws-sqs-source Kamelet relies upon the presence of the following dependencies:

  • camel:aws2-sqs
  • camel:core
  • camel:kamelet
  • camel:jackson

10.3. Usage
Copy link

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

10.3.1. Knative Source
Copy link

You can use the aws-sqs-source Kamelet as a 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
Copy to Clipboard Toggle word wrap

10.3.1.1. Prerequisite
Copy link

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

10.3.1.2. Procedure for using the cluster CLI
Copy link

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

    oc apply -f aws-sqs-source-binding.yaml
    Copy to Clipboard Toggle word wrap

10.3.1.3. Procedure for using the Kamel CLI
Copy link

Configure and run the source by using the following 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
Copy to Clipboard Toggle word wrap

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

10.3.2. Kafka Source
Copy link

You can use the aws-sqs-source Kamelet as a 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
Copy to Clipboard Toggle word wrap

10.3.2.1. Prerequisites
Copy link

Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

10.3.2.2. Procedure for using the cluster CLI
Copy link

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

    oc apply -f aws-sqs-source-binding.yaml
    Copy to Clipboard Toggle word wrap

10.3.2.3. Procedure for using the Kamel CLI
Copy link

Configure and run the source by using the following 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
Copy to Clipboard Toggle word wrap

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

10.4. Kamelet source file
Copy link

https://github.com/openshift-integration/kamelet-catalog/aws-sqs-source.kamelet.yaml

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat