@@ -132,10 +132,6 @@ jobs:
132
132
# Default: 10
133
133
prefetch: 10
134
134
135
- # Consume any payload type (not only Jobs structured)
136
- # Default: false
137
- consume_all: false
138
-
139
135
# Get queue URL only
140
136
# Default: false
141
137
skip_queue_declaration: false
@@ -203,8 +199,8 @@ Default: `0`
203
199
204
200
` retain_failed_jobs` - If enabled, jobs will not be deleted and requeued if they fail. Instead, RoadRunner will
205
201
simply let them be processed again after `visibility_timeout` has passed. If you set `error_visibility_timeout` and
206
- enable this feature, RoadRunner will change the timeout to the value of `error_visibility_timeout`. This lets you
207
- customize the timeout for errors specifically. If you enable this feature, you can configure SQS to automatically
202
+ enable this feature, RoadRunner will change the timeout of the job to the value of `error_visibility_timeout`. This lets
203
+ you customize the timeout for errors specifically. If you enable this feature, you can configure SQS to automatically
208
204
move jobs that fail multiple times to a
209
205
[dead-letter queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html).
210
206
@@ -214,20 +210,35 @@ Default: `false`
214
210
215
211
` wait_time_seconds` - The duration (in seconds) for which the call waits for a message to arrive in the queue before
216
212
returning. If a message is available, the call returns sooner than `wait_time_seconds`. If no messages are available and
217
- the wait time expires, the call returns successfully with an empty list of messages. If you do not provide a value for
218
- this parameter or set it to 0, the `ReceiveMessageWaitTimeSeconds` attribute of the queue is used, which defaults to 0,
219
- in which case you will be using short polling. See the documentation on the differences between
220
- [short and long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html).
213
+ the wait time expires, the call returns successfully with an empty list of messages. Please note that this parameter
214
+ cannot be explicitly configured to use zero, as zero will apply the queue defaults.
221
215
222
216
Default : ` 0`
223
217
218
+ {% hint style="warning" %}
219
+ # ## Shor vs. Long Polling
220
+
221
+ By default, SQS and RoadRunner is configured to use **short polling**. Please review the documentation on the
222
+ differences between
223
+ [short and long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html)
224
+ and make sure that your queue and RoadRunner is configured correctly. Long polling will *usually* be a cost-saving
225
+ feature with no practical impact on performance or functionality. Remember that not providing a value (or zero) for
226
+ ` wait_time_seconds` will cause your queue polling to be based on the `ReceiveMessageWaitTimeSeconds` attribute
227
+ configured on the queue.
228
+ {% endhint %}
229
+
224
230
# ## Queue
225
231
226
232
` queue` - The name of the queue. May only contain alphanumeric characters, hyphens (`-`), and underscores (`_`). On AWS,
227
233
this will form the last part of the queue URL, i.e. `https://sqs.<region>.amazonaws.com/<account id>/<queue>`.
228
234
229
235
Default : ` default`
230
236
237
+ {% hint style="info" %}
238
+ Please note that [FIFO](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html)
239
+ queue names **must** end with `.fifo`.
240
+ {% endhint %}
241
+
231
242
# ## Message Group ID
232
243
233
244
` message_group_id` - Message group ID is required for FIFO queues. Messages that belong to the same message group are
@@ -236,7 +247,7 @@ More info:
236
247
[link](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html#SQS-SendMessage-request-MessageGroupId)
237
248
238
249
# ## Skip Queue Declaration
239
-
250
+ " https://sqs.eu-central-1.amazonaws.com "
240
251
` skip_queue_declaration` - By default, RR tries to create the queue (using the `queue` name) if it does not exist. Set
241
252
this option to `true` if the queue already exists.
242
253
@@ -248,18 +259,11 @@ For queue creation to work, the credentials or the IAM role used must have the
248
259
such as `sqs:CreateQueue` and `sqs:SetQueueAttributes`.
249
260
{% endhint %}
250
261
251
- # ## Consume All
252
-
253
- ` consume_all` - By default, RR consumes only messages in the queue with the `Jobs` structure. Set this option to `true`
254
- if you want to consume all messages in the queue.
255
-
256
- Default : ` false`
257
-
258
262
# ## Attributes
259
263
260
264
` attributes` - A list of
261
265
[AWS SQS attributes](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SetQueueAttributes.html)
262
- to configure for the queue. Attributes are only set if RR creates the queue. Existing queues are not modified.
266
+ to configure for the queue.
263
267
264
268
{% code title=".rr.yaml" %}
265
269
@@ -274,6 +278,10 @@ attributes:
274
278
275
279
{% endcode %}
276
280
281
+ {% hint style="info" %}
282
+ Attributes are only set if RoadRunner creates the queue. Attributes of existing queues are **not modified**.
283
+ {% endhint %}
284
+
277
285
# ## Tags
278
286
279
287
` tags` - Tags don't have any semantic meaning. Amazon SQS interprets tags as character. Tags are only set if RR creates
0 commit comments