Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 13. AWS SQS Source

Receive data from AWS SQS.

13.1. Authentication methods
Copy link

In this Kamelet you can avoid using explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

  • Java system properties - aws.accessKeyId and aws.secretKey.
  • Environment variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
  • Web Identity Token from AWS STS.
  • The shared credentials and config files.
  • Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set.
  • Amazon EC2 Instance profile credentials.

You can also use the Profile Credentials Provider, by setting the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of access key/secret key or default credentials provider could be used

For more information, see the AWS credentials documentation

13.2. Configuration Options
Copy link

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

Expand
PropertyNameDescriptionTypeDefaultExample

queueNameOrArn *

Queue Name

The SQS Queue Name or ARN.

string

  

region *

AWS Region

The AWS region to access.

string

  

accessKey

Access Key

The access key obtained from AWS.

string

  

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

amazonaws.com

 

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

False

 

delay

Delay

The number of milliseconds before the next poll of the selected stream.

integer

500

 

deleteAfterRead

Auto-delete Messages

Delete messages after consuming them.

boolean

True

 

greedy

Greedy Scheduler

If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages.

boolean

False

 

maxMessagesPerPoll

Max Messages Per Poll

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values 1 to 10. Default 1.

integer

1

 

overrideEndpoint

Endpoint Overwrite

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

boolean

False

 

profileCredentialsName

Profile Credentials Name

If using a profile credentials provider this parameter sets the profile name.

string

  

protocol

Protocol

The underlying protocol used to communicate with SQS.

string

https

http or https

queueURL

Queue URL

The full SQS Queue URL (required if using KEDA).

string

  

secretKey

Secret Key

The secret key obtained from AWS.

string

  

sessionToken

Session Token

Amazon AWS Session Token used when the user needs to assume a IAM role.

string

  

uriEndpointOverride

Overwrite Endpoint URI

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

string

  

useDefaultCredentialsProvider

Default Credentials Provider

If true, the SQS client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

boolean

False

 

useProfileCredentialsProvider

Profile Credentials Provider

Set whether the SQS client should expect to load credentials through a profile credentials provider.

boolean

False

 

useSessionCredentials

Session Credentials

Set whether the SQS client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in SQS.

boolean

False

 

visibilityTimeout

Visibility Timeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

integer

  

waitTimeSeconds

Wait Time Seconds

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call does not return a message list.

integer

  

* = Fields marked with an asterisk are mandatory.

13.3. Dependencies
Copy link

13.3.1. Quarkus dependencies
Copy link

<dependencies>
  <dependency>
    <groupId>org.apache.camel.kamelets</groupId>
    <artifactId>camel-kamelets-utils</artifactId>
    <version>4.8.5</version>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws-sqs-source</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-aws2-sqs</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kamelet</artifactId>
  </dependency>
</dependencies>

13.4. Usage
Copy link

13.4.1. Camel JBang usage
Copy link

13.4.1.1. Prerequisites for JBang
Copy link

  • Install JBang.

  • You have executed the following command: 

    jbang app install camel@apache/camel

13.4.1.2. Running a route with JBang
Copy link

Suppose you have a file named route.yaml with this content: 

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command. 

camel run route.yaml

13.4.2. 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/v1
kind: Pipe
metadata:
  name: aws-sqs-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      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

13.4.3. 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/v1
kind: Pipe
metadata:
  name: aws-sqs-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      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

13.5. Kamelets source file
Copy link

https://github.com/jboss-fuse/camel-kamelets/blob/camel-kamelets-4.10.3-branch/kamelets/aws-sqs-source.kamelet.yaml

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

© 2026 Red HatBack to top