AWS SQS Source
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
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 |
---|---|---|---|---|---|
Queue Name | Required The SQS Queue Name or ARN. | string | |||
AWS Region | Required The AWS region to access. Enum values: * ap-south-1 * eu-south-1 * us-gov-east-1 * me-central-1 * ca-central-1 * eu-central-1 * us-iso-west-1 * us-west-1 * us-west-2 * af-south-1 * eu-north-1 * eu-west-3 * eu-west-2 * eu-west-1 * ap-northeast-3 * ap-northeast-2 * ap-northeast-1 * me-south-1 * sa-east-1 * ap-east-1 * cn-north-1 * us-gov-west-1 * ap-southeast-1 * ap-southeast-2 * us-iso-east-1 * ap-southeast-3 * us-east-1 * us-east-2 * cn-northwest-1 * us-isob-east-1 * aws-global * aws-cn-global * aws-us-gov-global * aws-iso-global * aws-iso-b-global | string | |||
Access Key | The access key obtained from AWS. | string | |||
AWS Host | The hostname of the Amazon AWS cloud. | string | amazonaws.com | ||
Autocreate Queue | Setting the autocreation of the SQS queue. | boolean | false | ||
Delay | The number of milliseconds before the next poll of the selected stream. | integer | 500 | ||
Auto-delete Messages | Delete messages after consuming them. | boolean | true | ||
Greedy Scheduler | If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages. | boolean | false | ||
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 | ||
Endpoint Overwrite | Select this option to override the endpoint URI. To use this option, you must also provide a URI for the | boolean | false | ||
Profile Credentials Name | If using a profile credentials provider this parameter will set the profile name. | string | |||
Protocol | The underlying protocol used to communicate with SQS. | string | https | http or https | |
Queue URL | The full SQS Queue URL (required if using KEDA). | string | |||
Secret Key | The secret key obtained from AWS. | string | |||
Session Token | Amazon AWS Session Token used when the user needs to assume a IAM role. | string | |||
Overwrite Endpoint URI | The overriding endpoint URI. To use this option, you must also select the | string | |||
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 | ||
Profile Credentials Provider | Set whether the SQS client should expect to load credentials through a profile credentials provider. | boolean | false | ||
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 | ||
Visibility Timeout | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. | integer | |||
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 |
Dependencies
At runtime, the aws-sqs-source
Kamelet relies upon the presence of the following dependencies:
-
camel:core
-
camel:aws2-sqs
-
camel:kamelet
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel
Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:aws-sqs-source"
parameters:
.
.
.
steps:
- to:
uri: "kamelet:log-sink"
You can now run it directly through the following command
camel run route.yaml
AWS SQS Source Kamelet Description
Authentication methods
In this Kamelet you have the possibility of avoiding the usage of 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
andaws.secretKey
. -
Environment variables -
AWS_ACCESS_KEY_ID
andAWS_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 have also the possibility of using Profile Credentials Provider, by specifying 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 about this you can look at AWS credentials documentation