Amazon SQS Connector 5.11 Reference - Mule 4

String

Session token provided by Amazon STS.

String

Use this parameter to test the connection to Amazon SQS Connector. If you do not specify this parameter, the test connection is not performed.

A queue ARN is constructed in the following format: arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}, for example: arn:aws:sqs:us-east-1:123456789101:test-queue.

Large Payload Support

Support large message payloads on Amazon SQS.

Number

How long the connector waits before timing out when establishing a connection to the remote service. A value of 0 means infinity and is not recommended.

50000

Enumeration, one of:

Time unit for the Connection Timeout field.

MILLISECONDS

Number

Sets the maximum number of allowed open HTTP connections.

Number

How long to wait for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Enumeration, one of:

Time unit for the Socket Timeout field.

MILLISECONDS

String

Access key provided by Amazon.

x

String

Secret key provided by Amazon.

x

Boolean

Set this field to true to obtain credentials from the AWS environment. Refer to Using Credentials.

false

String

Sets the topic region endpoint.

US_EAST_1

String

Sets a custom SQS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Optional proxy host.

Number

Optional proxy port.

String

Optional proxy username.

String

Optional proxy password.

String

Optional proxy domain.

String

Optional proxy workstation.

String

Role ARN that uniquely identifies the role to assume to gain cross-account access.

x

String

Use this parameter to test the connection to Amazon SQS Connector. If you do not specify this parameter, the test connection is not performed.

A queue ARN is constructed in the following format: arn:aws:{REGION}:{ACCOUNT_NUMBER}:{QUEUE_NAME}, for example: arn:aws:sqs:us-east-1:123456789101:test-queue.

Large Payload Support

Support large message payloads on Amazon SQS.

Number

How long the connector waits before timing out when establishing a connection to the remote service. A value of 0 means infinity and is not recommended.

50000

Enumeration, one of:

Time unit for the Connection Timeout field.

MILLISECONDS

Number

Sets the maximum number of allowed open HTTP connections.

Number

How long to wait for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Enumeration, one of:

Time unit for the Socket Timeout field.

MILLISECONDS

String

Access key provided by Amazon.

x

String

Secret key provided by Amazon.

x

Boolean

Set this field to true to obtain credentials from the AWS environment. Refer to Using Credentials.

false

String

Sets the topic region endpoint.

US_EAST_1

String

Sets a custom STS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.

String

Sets a custom SQS endpoint. Use this parameter when a non-standard service endpoint is required, such as a Virtual Private Cloud (VPC) endpoint.

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

String

Optional proxy host.

Number

Optional proxy port.

String

Optional proxy username.

String

Optional proxy password.

String

Optional proxy domain.

String

Optional proxy workstation.

String

Name of the configuration to use.

x

Number

Period of time during which other consumers are prevented from receiving and processing the same message in the queue.

30

Enumeration, one of:

Time unit for the Visibility Timeout field.

SECONDS

Boolean

Preserve messages after they are read rather than deleting them immediately from the queue after they are read.

false

Number

Number of messages to retrieve on each call. The maximum is 10.

1

String

URL of the queue in which to receive messages.

Number

Maximum duration of a single poll, in seconds:

Number

Number of threads used to consume the messages in the inbound flow. This value must be an integer greater than 0.

1

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

number

Frequency at which the connector polls for incoming messages, in the time unit specified in the Time unit field. If you set this value to 0, the connector polls as fast as possible.

1000

Number

Amount of time that the connector waits before it starts polling for incoming messages, in the time unit specified in the Time unit field. The default value of 0 means that the connector starts polling immediately.

0

Enumeration, one of:

Time unit for the Frequency and Start delay fields.

MILLISECONDS

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name for this permission.

x

Array of String

IDs of the AWS accounts to share this queue with.

x

Array of String

List to indicate how much to share (Send Message, Receive Message, Change Message Visibility, Delete Message, and Get Queue Attributes).

x

String

URL of the queue in which to add permissions to. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Receipt handle associated with the message whose visibility timeout must change.

Number

New value of the message visibility timeout (up to 4300 seconds or 12 hours).

x

Enumeration, one of:

Time unit for the Visibility Timeout field.

SECONDS

String

URL of the queue to act on. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Array of Change Message Visibility Batch Request Entry

List of receipt handles of the messages for which the visibility timeout must be changed.

#[payload]

String

URL of the queue to act on. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the queue to create.

x

Object

Map of attributes with their corresponding values. Refer to the Queue Attributes table below.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Receipt handle of the message to delete.

x

String

URL of the queue. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Array of Delete Message Batch Request Entry

List of receipt handles for the messages to delete.

x

String

URL of the queue to delete messages as a batch from. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URL of the queue to delete. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URL of the queue.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Array of String

List of attributes to retrieve information for.

String

URL of the queue to take action on. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name of the queue whose URL must be fetched.

x

String

AWS account ID of the owner that created the queue.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URL of a dead-letter queue. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

String to use for filtering the list results. Queues only with names beginning with the specified string are returned.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URL of the queue from which messages are fetched. This parameter is optional and if unspecified, you must specify the Default Global Queue URL at the configuration level.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

URL of the queue.

Number

Maximum number of messages to read.

x

Number

Maximum duration of a single poll, in seconds:

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Name for the permission to remove.

x

String

URL of the queue in which permissions are deleted from.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Message

Message to send.

#[payload]

String

URL of the queue in which to send the message.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Array of Message

List of SendMessageBatchRequestEntry items.

#[payload]

String

URL of the queue in which to send the message.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Object

Map of attributes to set.

#[payload]

String

URL of the queue.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

Array of BatchResultErrorEntry

List of Batch Result Error Entry items.

Array of String

List of String items representing the entry ID.

String

Error code that represents why the action failed on this entry.

String

ID of an entry in a batch request.

String

Message that explains why the action failed on this entry.

Boolean

Whether the error happened due to the sender’s fault.

String

Identifier for this particular receipt handle. This is used to communicate the result. The IDs of a batch request must be unique within the request.

String

Receipt handle for this entry.

Number

New value (in seconds) for the message’s visibility timeout.

String

Path to the CRL file.

String

URL of the OCSP responder.

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

String

Identifier for this particular receipt handle. This is used to communicate the result. The IDs of a batch request must be unique within the request.

String

Receipt handle for this entry.

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

String

Type of keystore.

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

String

Password used to protect the private key.

String

Password used to protect the keystore.

String

Encryption algorithm that the keystore uses.

String

Name of the AWS S3 bucket in which to store large payload messages. The AWS S3 bucket must already be created and configured in AWS S3. Enabling this feature incurs additional charges for using AWS S3.

x

Number

Message size threshold value for storing message payloads in the AWS S3 bucket. The default value for the message size threshold is 256 KB and the maximum threshold size value is 256 KB. The maximum message size is 2 GB.

256

Enumeration, one of:

Data unit for the Message Size Threshold field.

KB

String

Sets a custom S3 endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.

String

Message body to send.

String

Token for deduplicating sent messages. If multiple messages are sent with the same deduplication ID, Amazon SQS accepts the messages successfully, but delivers only the first message during the deduplication interval (5 minutes by default).

For FIFO queues, set ContentBasedDeduplication to true at a queue level to automatically generate the value for the deduplicationId field.

Number

Number of seconds that a specific message is delayed. Valid values are 0 through 900. If no value is specified, the default value for the queue is used.

The delaySeconds field cannot be set per message when FifoQueue is set; delaySeconds can only be set at a queue level.

String

Group this message belongs to in the FIFO queue. This parameter applies only to FIFO queues. When creating a FIFO queue, this parameter is required.

String

Unique identifier for the message.

Object

Map of typed key-value pairs to send as message attributes. You must specify a value, key, and data type for each entry.

String

Receipt handle for this entry.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

Reconnection strategy to use.

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

String

One or more expressions that determine when a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

Configures the object store that stores the redelivery counter for each message.

String

AWS request ID used when a service call isn’t working as expected, and you need to work with AWS support to debug an issue.

String

MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message correctly. The first URL in Amazon SQS decodes the message before creating the MD5 digest. For information about MD5, refer to RFC 1321 - The MD5 Message-Digest Algorithm.

String

MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. The first URL in Amazon SQS decodes the message before creating the MD5 digest. For information about MD5, refer to RFC 1321 - The MD5 Message-Digest Algorithm.

String

Element containing the message ID of the message sent to the queue. For more information, refer to Amazon SQS Queue and Message Identifiers.

Boolean

Which elements to verify in the certificate chain:

Boolean

How to check certificate validity:

Boolean

Whether to use the secondary method to check certificate validity:

Boolean

What to do if the revocation server can’t be reached or is busy:

String

Comma-separated list of protocols enabled for this context.

String

Comma-separated list of cipher suites enabled for this context.

Truststore

Configures the TLS truststore.

Keystore

Configures the TLS keystore.

Configures a revocation checking mechanism.

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

String

Password used to protect the truststore.

String

Type of truststore.

String

Encryption algorithm that the truststore uses.

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.