Skip to main content Skip to complementary content

cAWSSQS Standard properties

These properties are used to configure cAWSSQS running in the Standard Job framework.

The Standard cAWSSQS component belongs to the AWS and Connectivity families.

Basic settings

Connection

Select an AWS connection component from the list to reuse the connection details you already defined.

Queue Name

Enter the name of the queue to send message to or receive message from. When the cAWSSQS is used as a producer, the queue will be created if it does not exist. Queue names must be 1-80 characters in length and be composed of alphanumeric characters, hyphens (-), and underscores (_).

The following options are available only when the cAWSSQS is used as a Producer:

  

Delay (in seconds)

Specify the amount of time to delay the first delivery of all messages added to this queue.

Wait Time (0 to 20 seconds)

Specify the maximum amount of time in seconds (0 to 20) that a long polling receive call will wait for a message to become available before returning an empty response.

The following options are available only when the cAWSSQS is used as a Consumer:

  

Delete Message / After Read (processed by route)

Select this check box to delete the message from the queue after it is read and processed by the Route.

Delete Message / If Filtered (matched by filter)

Select this check box to delete the messages from the queue that are filtered in the Route, even if the exchange fails to get through a filter.

Allow Multiple Threads

Select this check box to allow multiple threads to poll the SQS queue to increase throughput. When this option is enabled, you need to specify the maximum number of concurrent consumers and objects that can be retrieved in one poll in the Concurrency Number and Max Messages Per Poll fields respectively.

Extend Message Visibility

Select this check box to enable a scheduled background task to keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. When this option is enabled, you need to set the duration in seconds that the received messages are hidden from subsequent retrieve requests in the Visibility Timeout field. For more information, see the site http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibility.html.

Request Attribute / All

Select this check box to retrieve the standard Amazon SQS attributes along with each message. For more information about the Amazon SQS attributes, see ReceiveMessage > Request Parameters.

Request Attribute / Approximate First Receive Timestamp

Select this check box to retrieve the ApproximateFirstReceiveTimestamp attribute only along with each message. For more information about the Amazon SQS attributes, see ReceiveMessage > Request Parameters.

Request Attribute / Approximate Receive Count

Select this check box to retrieve the ApproximateReceiveCount attribute only along with each message. For more information about the Amazon SQS attributes, see ReceiveMessage > Request Parameters.

Request Attribute / Sender ID

Select this check box to retrieve the SenderId attribute only along with each message. For more information about the Amazon SQS attributes, see ReceiveMessage > Request Parameters.

Request Attribute / Sent Timestamp

Select this check box to retrieve the SentTimestamp attribute only along with each message. For more information about the Amazon SQS attributes, see ReceiveMessage > Request Parameters.

Advanced settings

AWS Account ID (Queue Owner)

Specify the queue owner's AWS account ID when you need to connect the queue with different account owner.
Queue Configuration / Attributes
Set the optional queue attributes in the corresponding table. Click [+] as many times as required to add attributes to the table. Then click the corresponding Value field and enter a value. The following attributes are available:
  • Default Visibility Timeout(in seconds): The default visibility timeout for the queue in seconds.
  • Max Message Size(in bytes): The maximum message size in bytes that an SQS message can contain for the queue.
  • Message Retention Period(in seconds): The period in seconds that a message will be retained by SQS for the queue.
  • Receive Message Wait Time(in seconds): The duration in seconds that the ReceiveMessage action call will wait until a message is in the queue to include in the response.
  • Message GroupId Strategy(for FIFO queue): To send messages to FIFO queue of Amazon SQS, you have to specify the value of this attribute from the following to set the Message Group ID:
    • useConstant: The Message Group ID is the fixed string CamelSingleMessageGroup.
    • useExchangeId: The Message Group ID is the camel exchangeId, for example, ID-xldai-PC-1545104566148-0-1.
    • usePropertyValue: The Message Group ID is specified from the Camel property CamelAwsMessageGroupId.
  • Message DeduplicationId Strategy(for FIFO queue): This attribute is optional for sending messages to FIFO queue of Amazon SQS. Specify the value of this attribute from the following for how messages are deduplicated:
    • useExchangeId: the messages are deduplicated by exchangeId.
    • useContentBasedDeduplication: the messages are deduplicated by message content.

Request Message Attribute

This option is only available when cAWSSQS is used as a Consumer. Select this check box and add the attribute to be retrieved along with each message.

Usage

Usage rule

cAWSSQS can be a start, middle or end component in a Route. It has to be used with the cAWSConnection component, which creates a connection to Amazon SNS service. For more information about cAWSConnection, see cAWSConnection.

Limitation

 n/a

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here