generated from camel.apache.org/kamelet
2
Home
gitea_admin edited this page 2026-03-11 14:34:45 +00:00
Table of Contents
AWS SQS Source
Receive data from AWS SQS.
Metadata
| Property | Value |
|---|---|
| Type | source |
| Group | AWS SQS |
| Namespace | AWS |
| Support Level | Stable |
| Provider | Apache Software Foundation |
Properties
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
queueNameOrArn |
string | ✓ | The SQS Queue Name or ARN | |
deleteAfterRead |
boolean | true |
Delete messages after consuming them | |
accessKey |
string | The access key obtained from AWS. | ||
secretKey |
string | The secret key obtained from AWS. | ||
region |
string | ✓ | The AWS region to access. | |
autoCreateQueue |
boolean | false |
Setting the autocreation of the SQS queue. | |
amazonAWSHost |
string | amazonaws.com |
The hostname of the Amazon AWS cloud. | |
protocol |
string | https |
The underlying protocol used to communicate with SQS | |
queueURL |
string | The full SQS Queue URL (required if using KEDA) | ||
useDefaultCredentialsProvider |
boolean | false |
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). | |
useProfileCredentialsProvider |
boolean | false |
Set whether the SQS client should expect to load credentials through a profile credentials provider. | |
useSessionCredentials |
boolean | false |
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. | |
profileCredentialsName |
string | If using a profile credentials provider this parameter will set the profile name. | ||
sessionToken |
string | Amazon AWS Session Token used when the user needs to assume a IAM role. | ||
uriEndpointOverride |
string | The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option. |
||
overrideEndpoint |
boolean | false |
Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option. |
|
delay |
integer | 500 |
The number of milliseconds before the next poll of the selected stream | |
greedy |
boolean | false |
If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages. | |
maxMessagesPerPoll |
integer | 1 |
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. | |
waitTimeSeconds |
integer | 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. | ||
visibilityTimeout |
integer | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. |
Dependencies
camel:corecamel:aws2-sqscamel:kamelet