Chapter 11. AWS Simple Queue Service (SQS) Both producer and consumer are supported The AWS2 SQS component supports sending and receiving messages to Amazon's SQS service . Prerequisites You must have a valid Amazon Web Services developer account, and be signed up to use Amazon SQS. More information is available at Amazon SQS . 11.1. Dependencies When using aws2-sqs with Red Hat build of Camel Spring Boot, add the following Maven dependency to your pom.xml to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-aws2-sqs-starter</artifactId> </dependency> 11.2. URI Format The queue will be created if they don't already exists. You can append query options to the URI in the following format, ?options=value&option2=value&... 11.3. Configuring Options Camel components are configured on two separate levels: component level endpoint level 11.3.1. Configuring Component Options At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level. For example, a component may have security settings, credentials for authentication, urls for network connection and so forth. Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all. You can configure components using: the Component DSL . in a configuration file (application.properties, *.yaml files, etc). directly in the Java code. 11.3.2. Configuring Endpoint Options You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both. Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java. A good practice when configuring options is to use Property Placeholders . Property placeholders provide a few benefits: They help prevent using hardcoded urls, port numbers, sensitive information, and other settings. They allow externalizing the configuration from the code. They help the code to become more flexible and reusable. The following two sections list all the options, firstly for the component followed by the endpoint. 11.4. Component Options The AWS Simple Queue Service (SQS) component supports 43 options, which are listed below. Name Description Default Type amazonAWSHost (common) The hostname of the Amazon AWS cloud. amazonaws.com String amazonSQSClient (common) Autowired To use the AmazonSQS as client. SqsClient autoCreateQueue (common) Setting the autocreation of the queue. false boolean configuration (common) The AWS SQS default configuration. Sqs2Configuration overrideEndpoint (common) Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false boolean protocol (common) The underlying protocol used to communicate with SQS. https String proxyProtocol (common) To define a proxy protocol when instantiating the SQS client. Enum values: HTTP HTTPS HTTPS Protocol queueOwnerAWSAccountId (common) Specify the queue owner aws account id when you need to connect the queue with different account owner. String region (common) The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). String trustAllCertificates (common) If we want to trust all certificates in case of overriding the endpoint. false boolean uriEndpointOverride (common) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String useDefaultCredentialsProvider (common) Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. false boolean attributeNames (consumer) A list of attribute names to receive when consuming. Multiple names can be separated by comma. String bridgeErrorHandler (consumer) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean concurrentConsumers (consumer) Allows you to use multiple threads to poll the sqs queue to increase throughput. 1 int defaultVisibilityTimeout (consumer) The default visibility timeout (in seconds). Integer deleteAfterRead (consumer) Delete message from SQS after it has been read. true boolean deleteIfFiltered (consumer) Whether or not to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true. true boolean extendMessageVisibility (consumer) If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. false boolean kmsDataKeyReusePeriodSeconds (consumer) The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). Integer kmsMasterKeyId (consumer) The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. String messageAttributeNames (consumer) A list of message attribute names to receive when consuming. Multiple names can be separated by comma. String serverSideEncryptionEnabled (consumer) Define if Server Side Encryption is enabled or not on the queue. false boolean visibilityTimeout (consumer) The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. Integer waitTimeSeconds (consumer) Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. Integer batchSeparator (producer) Set the separator when passing a String to send batch message operation. , String delaySeconds (producer) Delay sending messages for a number of seconds. Integer lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean messageDeduplicationIdStrategy (producer) Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. Enum values: useExchangeId useContentBasedDeduplication useExchangeId String messageGroupIdStrategy (producer) Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. Enum values: useConstant useExchangeId usePropertyValue String operation (producer) The operation to do in case the user don't want to send only a message. Enum values: sendBatchMessage deleteMessage listQueues purgeQueue deleteQueue Sqs2Operations autowiredEnabled (advanced) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true boolean delayQueue (advanced) Define if you want to apply delaySeconds option to the queue or on single messages. false boolean queueUrl (advanced) To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. String proxyHost (proxy) To define a proxy host when instantiating the SQS client. String proxyPort (proxy) To define a proxy port when instantiating the SQS client. Integer maximumMessageSize (queue) The maximumMessageSize (in bytes) an SQS message can contain for this queue. Integer messageRetentionPeriod (queue) The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. Integer policy (queue) The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. String receiveMessageWaitTimeSeconds (queue) If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. Integer redrivePolicy (queue) Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. String accessKey (security) Amazon AWS Access Key. String secretKey (security) Amazon AWS Secret Key. String 11.5. Endpoint Options The AWS Simple Queue Service (SQS) endpoint is configured using URI syntax: with the following path and query parameters: 11.5.1. Path Parameters (1 parameters) Name Description Default Type queueNameOrArn (common) Required Queue name or ARN. String 11.5.2. Query Parameters (61 parameters) Name Description Default Type amazonAWSHost (common) The hostname of the Amazon AWS cloud. amazonaws.com String amazonSQSClient (common) Autowired To use the AmazonSQS as client. SqsClient autoCreateQueue (common) Setting the autocreation of the queue. false boolean headerFilterStrategy (common) To use a custom HeaderFilterStrategy to map headers to/from Camel. HeaderFilterStrategy overrideEndpoint (common) Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false boolean protocol (common) The underlying protocol used to communicate with SQS. https String proxyProtocol (common) To define a proxy protocol when instantiating the SQS client. Enum values: HTTP HTTPS HTTPS Protocol queueOwnerAWSAccountId (common) Specify the queue owner aws account id when you need to connect the queue with different account owner. String region (common) The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). String trustAllCertificates (common) If we want to trust all certificates in case of overriding the endpoint. false boolean uriEndpointOverride (common) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String useDefaultCredentialsProvider (common) Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. false boolean attributeNames (consumer) A list of attribute names to receive when consuming. Multiple names can be separated by comma. String bridgeErrorHandler (consumer) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean concurrentConsumers (consumer) Allows you to use multiple threads to poll the sqs queue to increase throughput. 1 int defaultVisibilityTimeout (consumer) The default visibility timeout (in seconds). Integer deleteAfterRead (consumer) Delete message from SQS after it has been read. true boolean deleteIfFiltered (consumer) Whether or not to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true. true boolean extendMessageVisibility (consumer) If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. false boolean kmsDataKeyReusePeriodSeconds (consumer) The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). Integer kmsMasterKeyId (consumer) The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. String maxMessagesPerPoll (consumer) Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. int messageAttributeNames (consumer) A list of message attribute names to receive when consuming. Multiple names can be separated by comma. String sendEmptyMessageWhenIdle (consumer) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. false boolean serverSideEncryptionEnabled (consumer) Define if Server Side Encryption is enabled or not on the queue. false boolean visibilityTimeout (consumer) The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. Integer waitTimeSeconds (consumer) Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. Integer exceptionHandler (consumer (advanced)) To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. ExceptionHandler exchangePattern (consumer (advanced)) Sets the exchange pattern when the consumer creates an exchange. Enum values: InOnly InOut InOptionalOut ExchangePattern pollStrategy (consumer (advanced)) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. PollingConsumerPollStrategy batchSeparator (producer) Set the separator when passing a String to send batch message operation. , String delaySeconds (producer) Delay sending messages for a number of seconds. Integer lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean messageDeduplicationIdStrategy (producer) Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. Enum values: useExchangeId useContentBasedDeduplication useExchangeId String messageGroupIdStrategy (producer) Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. Enum values: useConstant useExchangeId usePropertyValue String operation (producer) The operation to do in case the user don't want to send only a message. Enum values: sendBatchMessage deleteMessage listQueues purgeQueue deleteQueue Sqs2Operations delayQueue (advanced) Define if you want to apply delaySeconds option to the queue or on single messages. false boolean queueUrl (advanced) To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. String proxyHost (proxy) To define a proxy host when instantiating the SQS client. String proxyPort (proxy) To define a proxy port when instantiating the SQS client. Integer maximumMessageSize (queue) The maximumMessageSize (in bytes) an SQS message can contain for this queue. Integer messageRetentionPeriod (queue) The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. Integer policy (queue) The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. String receiveMessageWaitTimeSeconds (queue) If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. Integer redrivePolicy (queue) Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. String backoffErrorThreshold (scheduler) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. int backoffIdleThreshold (scheduler) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. int backoffMultiplier (scheduler) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. int delay (scheduler) Milliseconds before the poll. 500 long greedy (scheduler) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the run polled 1 or more messages. false boolean initialDelay (scheduler) Milliseconds before the first poll starts. 1000 long repeatCount (scheduler) Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. 0 long runLoggingLevel (scheduler) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. Enum values: TRACE DEBUG INFO WARN ERROR OFF TRACE LoggingLevel scheduledExecutorService (scheduler) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. ScheduledExecutorService scheduler (scheduler) To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. none Object schedulerProperties (scheduler) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. Map startScheduler (scheduler) Whether the scheduler should be auto started. true boolean timeUnit (scheduler) Time unit for initialDelay and delay options. Enum values: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS MILLISECONDS TimeUnit useFixedDelay (scheduler) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. true boolean accessKey (security) Amazon AWS Access Key. String secretKey (security) Amazon AWS Secret Key. String Required SQS component options You have to provide the amazonSQSClient in the Registry or your accessKey and secretKey to access the Amazon's SQS . 11.6. Batch Consumer This component implements the Batch Consumer. This allows you for instance to know how many messages exists in this batch and for instance let the Aggregator aggregate this number of messages. 11.7. Usage 11.7.1. Static credentials vs Default Credential Provider You have the possibility of avoiding the usage of explicit static credentials, by specifying the useDefaultCredentialsProvider option and set it to true. 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. For more information about this you can look at AWS credentials documentation 11.7.2. Message headers set by the SQS producer Header Type Description CamelAwsSqsMD5OfBody String The MD5 checksum of the Amazon SQS message. CamelAwsSqsMessageId String The Amazon SQS message ID. CamelAwsSqsDelaySeconds Integer The delay seconds that the Amazon SQS message can be see by others. 11.7.3. Message headers set by the SQS consumer Header Type Description CamelAwsSqsMD5OfBody String The MD5 checksum of the Amazon SQS message. CamelAwsSqsMessageId String The Amazon SQS message ID. CamelAwsSqsReceiptHandle String The Amazon SQS message receipt handle. CamelAwsSqsMessageAttributes Map<String, String> The Amazon SQS message attributes. 11.7.4. Advanced AmazonSQS configuration If your Camel Application is running behind a firewall or if you need to have more control over the SqsClient instance configuration, you can create your own instance: from("aws2-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") .to("mock:result"); 11.7.5. Creating or updating an SQS Queue In the SQS Component, when an endpoint is started, a check is executed to obtain information about the existence of the queue or not. You're able to customize the creation through the QueueAttributeName mapping with the SQSConfiguration option. from("aws2-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") .to("mock:result"); In this example if the MyQueue queue is not already created on AWS (and the autoCreateQueue option is set to true), it will be created with default parameters from the SQS configuration. If it's already up on AWS, the SQS configuration options will be used to override the existent AWS configuration. 11.7.6. DelayQueue VS Delay for Single message When the option delayQueue is set to true, the SQS Queue will be a DelayQueue with the DelaySeconds option as delay. For more information about DelayQueue you can read the AWS SQS documentation . One important information to take into account is the following: For standard queues, the per-queue delay setting is not retroactive-changing the setting doesn't affect the delay of messages already in the queue. For FIFO queues, the per-queue delay setting is retroactive-changing the setting affects the delay of messages already in the queue. as stated in the official documentation. If you want to specify a delay on single messages, you can ignore the delayQueue option, while you can set this option to true, if you need to add a fixed delay to all messages enqueued. 11.7.7. Server Side Encryption There is a set of Server Side Encryption attributes for a queue. The related option are serverSideEncryptionEnabled , keyMasterKeyId and kmsDataKeyReusePeriod . The SSE is disabled by default. You need to explicitly set the option to true and set the related parameters as queue attributes. 11.8. JMS-style Selectors SQS does not allow selectors, but you can effectively achieve this by using the Camel Filter EIP and setting an appropriate visibilityTimeout . When SQS dispatches a message, it will wait up to the visibility timeout before it will try to dispatch the message to a different consumer unless a DeleteMessage is received. By default, Camel will always send the DeleteMessage at the end of the route, unless the route ended in failure. To achieve appropriate filtering and not send the DeleteMessage even on successful completion of the route, use a Filter: from("aws2-sqs://MyQueue?amazonSQSClient=#client&defaultVisibilityTimeout=5000&deleteIfFiltered=false&deleteAfterRead=false") .filter("USD{header.login} == true") .setProperty(Sqs2Constants.SQS_DELETE_FILTERED, constant(true)) .to("mock:filter"); In the above code, if an exchange doesn't have an appropriate header, it will not make it through the filter AND also not be deleted from the SQS queue. After 5000 milliseconds, the message will become visible to other consumers. Note we must set the property Sqs2Constants.SQS_DELETE_FILTERED to true to instruct Camel to send the DeleteMessage , if being filtered. 11.9. Available Producer Operations single message (default) sendBatchMessage deleteMessage listQueues 11.10. Send Message You can set a SendMessageBatchRequest or an Iterable from("direct:start") .setBody(constant("Camel rocks!")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1"); 11.11. Send Batch Message You can set a SendMessageBatchRequest or an Iterable from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("sendBatchMessage")) .process(new Processor() { @Override public void process(Exchange exchange) throws Exception { Collection c = new ArrayList(); c.add("team1"); c.add("team2"); c.add("team3"); c.add("team4"); exchange.getIn().setBody(c); } }) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1"); As result you'll get an exchange containing a SendMessageBatchResponse instance, that you can examinate to check what messages were successfull and what not. The id set on each message of the batch will be a Random UUID. 11.12. Delete single Message Use deleteMessage operation to delete a single message. You'll need to set a receipt handle header for the message you want to delete. from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("deleteMessage")) .setHeader(SqsConstants.RECEIPT_HANDLE, constant("123456")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1"); As result you'll get an exchange containing a DeleteMessageResponse instance, that you can use to check if the message was deleted or not. 11.13. List Queues Use listQueues operation to list queues. from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("listQueues")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1"); As result you'll get an exchange containing a ListQueuesResponse instance, that you can examinate to check the actual queues. 11.14. Purge Queue Use purgeQueue operation to purge queue. from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("purgeQueue")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1"); As result you'll get an exchange containing a PurgeQueueResponse instance. 11.15. Queue Autocreation With the option autoCreateQueue users are able to avoid the autocreation of an SQS Queue in case it doesn't exist. The default for this option is true . If set to false any operation on a not-existent queue in AWS won't be successful and an error will be returned. 11.16. Send Batch Message and Message Deduplication Strategy In case you're using a SendBatchMessage Operation, you can set two different kind of Message Deduplication Strategy: - useExchangeId - useContentBasedDeduplication The first one will use a ExchangeIdMessageDeduplicationIdStrategy , that will use the Exchange ID as parameter The other one will use a NullMessageDeduplicationIdStrategy , that will use the body as deduplication element. In case of send batch message operation, you'll need to use the useContentBasedDeduplication and on the Queue you're pointing you'll need to enable the content based deduplication option. 11.17. Dependencies Maven users will need to add the following dependency to their pom.xml. pom.xml <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-aws2-sqs</artifactId> <version>USD{camel-version}</version> </dependency> where {camel-version} must be replaced by the actual version of Camel. 11.18. Spring Boot Auto-Configuration The component supports 44 options, which are listed below. Name Description Default Type camel.component.aws2-sqs.access-key Amazon AWS Access Key. String camel.component.aws2-sqs.amazon-a-w-s-host The hostname of the Amazon AWS cloud. amazonaws.com String camel.component.aws2-sqs.amazon-s-q-s-client To use the AmazonSQS as client. The option is a software.amazon.awssdk.services.sqs.SqsClient type. SqsClient camel.component.aws2-sqs.attribute-names A list of attribute names to receive when consuming. Multiple names can be separated by comma. String camel.component.aws2-sqs.auto-create-queue Setting the autocreation of the queue. false Boolean camel.component.aws2-sqs.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.aws2-sqs.batch-separator Set the separator when passing a String to send batch message operation. , String camel.component.aws2-sqs.bridge-error-handler Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false Boolean camel.component.aws2-sqs.concurrent-consumers Allows you to use multiple threads to poll the sqs queue to increase throughput. 1 Integer camel.component.aws2-sqs.configuration The AWS SQS default configuration. The option is a org.apache.camel.component.aws2.sqs.Sqs2Configuration type. Sqs2Configuration camel.component.aws2-sqs.default-visibility-timeout The default visibility timeout (in seconds). Integer camel.component.aws2-sqs.delay-queue Define if you want to apply delaySeconds option to the queue or on single messages. false Boolean camel.component.aws2-sqs.delay-seconds Delay sending messages for a number of seconds. Integer camel.component.aws2-sqs.delete-after-read Delete message from SQS after it has been read. true Boolean camel.component.aws2-sqs.delete-if-filtered Whether or not to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true. true Boolean camel.component.aws2-sqs.enabled Whether to enable auto configuration of the aws2-sqs component. This is enabled by default. Boolean camel.component.aws2-sqs.extend-message-visibility If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. false Boolean camel.component.aws2-sqs.kms-data-key-reuse-period-seconds The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). Integer camel.component.aws2-sqs.kms-master-key-id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. String camel.component.aws2-sqs.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean camel.component.aws2-sqs.maximum-message-size The maximumMessageSize (in bytes) an SQS message can contain for this queue. Integer camel.component.aws2-sqs.message-attribute-names A list of message attribute names to receive when consuming. Multiple names can be separated by comma. String camel.component.aws2-sqs.message-deduplication-id-strategy Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. useExchangeId String camel.component.aws2-sqs.message-group-id-strategy Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. String camel.component.aws2-sqs.message-retention-period The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. Integer camel.component.aws2-sqs.operation The operation to do in case the user don't want to send only a message. Sqs2Operations camel.component.aws2-sqs.override-endpoint Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. false Boolean camel.component.aws2-sqs.policy The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. String camel.component.aws2-sqs.protocol The underlying protocol used to communicate with SQS. https String camel.component.aws2-sqs.proxy-host To define a proxy host when instantiating the SQS client. String camel.component.aws2-sqs.proxy-port To define a proxy port when instantiating the SQS client. Integer camel.component.aws2-sqs.proxy-protocol To define a proxy protocol when instantiating the SQS client. Protocol camel.component.aws2-sqs.queue-owner-a-w-s-account-id Specify the queue owner aws account id when you need to connect the queue with different account owner. String camel.component.aws2-sqs.queue-url To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. String camel.component.aws2-sqs.receive-message-wait-time-seconds If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. Integer camel.component.aws2-sqs.redrive-policy Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. String camel.component.aws2-sqs.region The region in which SQS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). String camel.component.aws2-sqs.secret-key Amazon AWS Secret Key. String camel.component.aws2-sqs.server-side-encryption-enabled Define if Server Side Encryption is enabled or not on the queue. false Boolean camel.component.aws2-sqs.trust-all-certificates If we want to trust all certificates in case of overriding the endpoint. false Boolean camel.component.aws2-sqs.uri-endpoint-override Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. String camel.component.aws2-sqs.use-default-credentials-provider Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. false Boolean camel.component.aws2-sqs.visibility-timeout The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. Integer camel.component.aws2-sqs.wait-time-seconds Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. Integer

Commands:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-aws2-sqs-starter</artifactId> </dependency>
aws2-sqs://queueNameOrArn[?options]
aws2-sqs:queueNameOrArn
from("aws2-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") .to("mock:result");
from("aws2-sqs://MyQueue?amazonSQSClient=#client&delay=5000&maxMessagesPerPoll=5") .to("mock:result");
from("aws2-sqs://MyQueue?amazonSQSClient=#client&defaultVisibilityTimeout=5000&deleteIfFiltered=false&deleteAfterRead=false") .filter("USD{header.login} == true") .setProperty(Sqs2Constants.SQS_DELETE_FILTERED, constant(true)) .to("mock:filter");
from("direct:start") .setBody(constant("Camel rocks!")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1");
from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("sendBatchMessage")) .process(new Processor() { @Override public void process(Exchange exchange) throws Exception { Collection c = new ArrayList(); c.add("team1"); c.add("team2"); c.add("team3"); c.add("team4"); exchange.getIn().setBody(c); } }) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1");
from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("deleteMessage")) .setHeader(SqsConstants.RECEIPT_HANDLE, constant("123456")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1");
from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("listQueues")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1");
from("direct:start") .setHeader(SqsConstants.SQS_OPERATION, constant("purgeQueue")) .to("aws2-sqs://camel-1?accessKey=RAW(xxx)&secretKey=RAW(xxx)&region=eu-west-1");
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-aws2-sqs</artifactId> <version>USD{camel-version}</version> </dependency>