From c6a15e28b01194a1476fafa6040b81edba562d28 Mon Sep 17 00:00:00 2001 From: Gadam8 <44494964+Gadam8@users.noreply.github.com> Date: Wed, 1 Nov 2023 12:33:49 +0000 Subject: [PATCH] docs: add high throughput properties for fifo (#216) * docs: Add high throughput properties for fifo * Use enums * Add another example * Bump version --------- Co-authored-by: adam.gloyne --- sqs/README.md | 4 +++- sqs/json_schemas/channel.json | 20 +++++++++++++++++++- sqs/json_schemas/operation.json | 21 ++++++++++++++++++++- 3 files changed, 42 insertions(+), 3 deletions(-) diff --git a/sqs/README.md b/sqs/README.md index f632b66d..5f8281ed 100644 --- a/sqs/README.md +++ b/sqs/README.md @@ -12,7 +12,7 @@ For publish-subscribe scenarios, use as a **publish** Operation Binding Object, ## Version -Current version is `0.1.0`. +Current version is `0.2.0`. @@ -48,6 +48,8 @@ An SQS queue can set up a Dead Letter Queue as part of a Redelivery Policy. To s |---|:---:|---| | `name` | string | **Required.** The name of the queue. When an [SNS Operation Binding Object]() references an SQS queue by name, the identifier should be the one in this field.| | `fifoQueue` | boolean | **Required.** Is this a FIFO queue? | +| `deduplicationScope` | string | **Optional.** Specifies whether message deduplication occurs at the message group or queue level. Valid values are `messageGroup` and `queue`. **This property applies only to high throughput for FIFO queues.** | +| `fifoThroughputLimit` | string | **Optional.** Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are `perQueue` and `perMessageGroupId`. **The `perMessageGroupId` value is allowed only when the value for DeduplicationScope is `messageGroup`. Setting both these values as such will enable high throughput on a FIFO queue. As above, this property applies only to high throughput for FIFO queues.** | | `deliveryDelay` | integer | **Optional.** The number of seconds to delay before a message sent to the queue can be received. Used to create a *delay queue*. Range is 0 to 15 minutes. Defaults to 0. | | `visibilityTimeout` |integer| **Optional.** The length of time, in seconds, that a consumer locks a message - hiding it from reads - before it is unlocked and can be read again. Range from 0 to 12 hours (43200 seconds). Defaults to 30 seconds. | | `receiveMessageWaitTime` |integer| **Optional.** Determines if the queue uses [short polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) or [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html). Set to zero (the default) the queue reads available messages and returns immediately. Set to a non-zero integer, long polling waits the specified number of seconds for messages to arrive before returning. | diff --git a/sqs/json_schemas/channel.json b/sqs/json_schemas/channel.json index 3930780a..6e5279d7 100644 --- a/sqs/json_schemas/channel.json +++ b/sqs/json_schemas/channel.json @@ -21,7 +21,11 @@ }, "bindingVersion": { "type": "string", - "description": "The version of this binding.", + "enum": [ + "0.1.0", + "0.2.0" + ], + "description": "The version of this binding. If omitted, 'latest' MUST be assumed.", "default": "latest" } }, @@ -47,6 +51,18 @@ "description": "Is this a FIFO queue?", "default": false }, + "deduplicationScope": { + "type": "string", + "enum": ["queue", "messageGroup"], + "description": "Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue (default).", + "default": "queue" + }, + "fifoThroughputLimit": { + "type": "string", + "enum": ["perQueue", "perMessageGroupId"], + "description": "Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue (default) and perMessageGroupId.", + "default": "perQueue" + }, "deliveryDelay": { "type": "integer", "description": "The number of seconds to delay before a message sent to the queue can be received. used to create a delay queue.", @@ -207,6 +223,8 @@ "queue": { "name": "myQueue", "fifoQueue": true, + "deduplicationScope": "messageGroup", + "fifoThroughputLimit": "perMessageGroupId", "deliveryDelay": 15, "visibilityTimeout": 60, "receiveMessageWaitTime": 0, diff --git a/sqs/json_schemas/operation.json b/sqs/json_schemas/operation.json index 9f26e977..9bd1e5bf 100644 --- a/sqs/json_schemas/operation.json +++ b/sqs/json_schemas/operation.json @@ -20,7 +20,11 @@ }, "bindingVersion": { "type": "string", - "description": "The version of this binding.", + "enum": [ + "0.1.0", + "0.2.0" + ], + "description": "The version of this binding. If omitted, 'latest' MUST be assumed.", "default": "latest" } }, @@ -50,6 +54,18 @@ "description": "Is this a FIFO queue?", "default": false }, + "deduplicationScope": { + "type": "string", + "enum": ["queue", "messageGroup"], + "description": "Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue (default).", + "default": "queue" + }, + "fifoThroughputLimit": { + "type": "string", + "enum": ["perQueue", "perMessageGroupId"], + "description": "Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue (default) and perMessageGroupId.", + "default": "perQueue" + }, "deliveryDelay": { "type": "integer", "description": "The number of seconds to delay before a message sent to the queue can be received. Used to create a delay queue.", @@ -209,6 +225,9 @@ "queues": [ { "name": "myQueue", + "fifoQueue": true, + "deduplicationScope": "messageGroup", + "fifoThroughputLimit": "perMessageGroupId", "deliveryDelay": 10, "redrivePolicy": { "deadLetterQueue": {