Amazon SQS Connector Guide

Amazon SQS Connector Guide

Amazon SQS Event Source Properties

Amazon SQS Event Source Properties

You create an Amazon SQS event source to dequeue messages or subscribe to a service. Each event source is available for use in a process that handles SQS messages. You can publish and unpublish the connection to determine when each event source is available for use.
The following table describes the basic properties that you can configure for each event source:
Property
Description
Queue Name
Required. Name of the Amazon SQS queue. If the named queue does not exist, the connection automatically creates the queue.
The question mark (?) character is prohibited in this field. It is not supported by Apache Camel and you cannot publish a connection that contains this value.
Query Parameters
Optional. You can specify other parameters that define how to connect to servers, if required by the SQS client. For example, you can use the standard URI query syntax to provide additional information for the client to successfully connect.
Queue Owner AWS Account ID
Optional. The AWS account ID of the account owner that created the queue if the queue already exists.
Region
Optional. The AWS region for the SQS queue. For example:
us-west-1
Content Format
Required. Identifies the format of the content to be processed.
Select one of the following values:
  • TEXT
    . The content is a string and handled like plain text.
  • XML
    . The content is parsed and converted to an object or a list of process objects.
  • JSON
    . The content is parsed and converted to an object or a list of process objects.
Objectlist Field Name
Optional. If the payload format is JSON and the queue receives an array of objects as a JSON message, this value determines the field name of the object list in the message body.
The following table describes the advanced properties for an event source:
Property
Description
Visibility Timeout
Optional. Duration in seconds for which a message is hidden from subsequent retrieve requests after the message is retrieved by a RetrieveMessage request.
Immediately after the component receives the message, the message is still in the queue. Amazon SQS does not automatically delete a message after it is processed because of the probability that the message might not have been received. This field determines the duration of the timeout during which SQS prevents other components from receiving and processing the same message.
If the
Extend Message Visibility
option is enabled, a scheduled background task extends the message visibility in the queue. You can extend the timeout up to a maximum of 12 hours. Enter a value from 0 to 43200.
Policy
Optional. The JSON-based access policy language required by Amazon to be applied to any new queues created by the process.
Maximum Message Size
Optional. The maximum message size in bytes permitted in this queue. Enter a value between 1000 and 256000.
Message Retention Period
Optional. The retention period, in seconds, for messages in this queue.
Range: 60 seconds to 14 days.
Max Messages Per Poll
Optional. The maximum number of messages that the event source can receive in one poll.
Extend Message Visibility
Optional. Use this option to extend the message visibility timeout. Enabling this option extends the visibility timeout in the queue for a particular message when the visibility timeout is insufficient to fully process and delete the message.
Default is
No
.
Dead queue
Optional. The name of the queue where you want to route messages that cannot be processed.
The question mark (?) character is prohibited in this field. It is not supported by Apache Camel and you cannot publish a connection that contains this value.
Wait Time
Duration in seconds for which the ReceiveMessage action waits until a message is in the queue to include in the response. Enter a value between 0 and 20.