Synadia Connect

AWS SQS

NAMERUNTIMETYPEVERSIONSTATUS
aws_sqswombatsourcelateststable

Consume messages from an AWS SQS URL.

Configuration

nametypeoptionalsecretdescription
urlstringnonoThe SQS URL to consume from.
delete_messageboolyesnoWhether to delete the consumed message once it is acked. Disabling allows you to handle the deletion using a different mechanism. The value defaults to true.
reset_visibilityboolyesnoWhether to set the visibility timeout of the consumed message to zero once it is nacked. Disabling honors the preset visibility timeout specified for the queue. The value defaults to true.
max_number_of_messagesintyesnoThe maximum number of messages to return on one poll. Valid values: 1 to 10. The value defaults to 10.
max_outstanding_messagesintyesnoThe maximum number of outstanding pending messages to be consumed at a given time. The value defaults to 1000.
wait_time_secondsintyesnoWhether to set the wait time. Enabling this activates long-polling. Valid values: 0 to 20. The value defaults to 0.
message_timeoutstringyesnoThe time to process messages before needing to refresh the receipt handle. Messages will be eligible for refresh when half of the timeout has elapsed. This sets MessageVisibility for each received message. The value defaults to 30s.
regionstringnonoThe AWS region to target.
endpointstringyesnoAllows you to specify a custom endpoint for the AWS API. The value defaults to ``.
credentialscredentialsnonoOptional manual configuration of AWS credentials to use. More information can be found in xref:guides:cloud/aws.adoc[].

Credentials

nametypeoptionalsecretdescription
idstringyesnoThe ID of credentials to use. The value defaults to ``.
secretstringyesnoThe secret for the credentials being used. The value defaults to ``.
tokenstringyesnoThe token for the credentials being used, required when using short term credentials. The value defaults to ``.
Previous
AWS S3