camel-aws-sqs-source-kafka-connector source configuration
Connector Description: Receive data from AWS SQS. Access Key/Secret Key are the basic method for authenticating to the AWS SQS Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. When using a default Credentials Provider the SQS client will load the credentials through this provider and won’t use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet. Two headers will be duplicated with different names for clarity at sink level, CamelAwsSqsMessageId will be duplicated into aws.sqs.message.id and CamelAwsSqsReceiptHandle will be duplicated in aws.sqs.receipt.handle
When using camel-aws-sqs-source-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-aws-sqs-source-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
To use this source connector in Kafka connect you’ll need to set the following connector.class
connector.class=org.apache.camel.kafkaconnector.awssqssource.CamelAwssqssourceSourceConnector
The camel-aws-sqs-source source connector supports 21 options, which are listed below.
Name | Description | Default | Priority |
---|---|---|---|
Required The SQS Queue Name or ARN. | HIGH | ||
Delete messages after consuming them. | true | MEDIUM | |
The access key obtained from AWS. | MEDIUM | ||
The secret key obtained from AWS. | MEDIUM | ||
Required The AWS region to access. | HIGH | ||
Setting the autocreation of the SQS queue. | false | MEDIUM | |
The hostname of the Amazon AWS cloud. | "amazonaws.com" | MEDIUM | |
The underlying protocol used to communicate with SQS Example: http or https. | "https" | MEDIUM | |
The full SQS Queue URL (required if using KEDA). | MEDIUM | ||
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). | false | MEDIUM | |
Set whether the SQS client should expect to load credentials through a profile credentials provider. | false | MEDIUM | |
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. | false | MEDIUM | |
If using a profile credentials provider this parameter will set the profile name. | MEDIUM | ||
Amazon AWS Session Token used when the user needs to assume a IAM role. | MEDIUM | ||
The overriding endpoint URI. To use this option, you must also select the | MEDIUM | ||
Select this option to override the endpoint URI. To use this option, you must also provide a URI for the | false | MEDIUM | |
The number of milliseconds before the next poll of the selected stream. | 500 | MEDIUM | |
If greedy is enabled, then the polling will happen immediately again, if the previous run polled 1 or more messages. | false | MEDIUM | |
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. | 1 | MEDIUM | |
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. | MEDIUM | ||
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request. | MEDIUM |
The camel-aws-sqs-source source connector has no converters out of the box.
The camel-aws-sqs-source source connector has no transforms out of the box.
The camel-aws-sqs-source source connector has no aggregation strategies out of the box.