Amazon SQS Operation Binding v0.3.0

The Amazon SQS operation binding is used to define a list of SQS queues that an operation can interact with. This is particularly useful in scenarios where an operation may target multiple queues, such as when using an SNS topic to fan out messages to several SQS queues.

Overview

The core of this binding is the queues property, which is an array of queue objects. Each object in the array defines a queue by its name and can include a redrivePolicy and an access policy.

Operation Properties

Property	Type	Description
queues	[object]	Required. An array of Queue Objects. These queues are either the endpoint for an SNS operation or the dead-letter queue of an SQS operation.
bindingVersion	string	The version of this binding. For v0.3.0, this MUST be 0.3.0.

Queue Object

Defines a queue that the operation can interact with.

Property	Type	Description
name	string	Required. The name of the queue.
fifoQueue	boolean	Specifies if the queue is a FIFO queue.
redrivePolicy	object	Defines the dead-letter queue (DLQ) settings. See Redrive Policy.
policy	object	Defines the access policy for the queue. See Queue Policy.
tags	object	Key-value AWS tags for the queue.

Redrive Policy

Specifies the DLQ for un-processable messages.

Property	Type	Description
deadLetterQueue	object	Required. An object that identifies the DLQ by its arn or name.
maxReceiveCount	integer	Number of receives before a message is moved to the DLQ.

Queue Policy

Defines access permissions for the queue.

Property	Type	Description
statements	[object]	Required. An array of policy statements.

Example

This example defines an operation that interacts with two queues: a primary FIFO queue (my-queue.fifo) and its corresponding dead-letter queue (my-dlq.fifo). It includes a policy to deny a specific user from sending or receiving messages.

operations:
  processUserEvents:
    bindings:
      sqs:
        queues:
          - name: my-queue.fifo
            fifoQueue: true
            redrivePolicy:
              deadLetterQueue:
                name: my-dlq.fifo # Identifies the DLQ
              maxReceiveCount: 5
            policy:
              statements:
                - effect: Deny
                  principal: 'arn:aws:iam::123456789012:user/some-user'
                  action: ['sqs:SendMessage', 'sqs:ReceiveMessage']
          - name: my-dlq.fifo
            fifoQueue: true
        bindingVersion: '0.3.0'

Changelog

Added

queue.policy.statements.resource

The resource(s) that this policy applies to.

{ 
  "resource": { 
      "description": "The resource(s) that this policy applies to.", 
      "oneOf": [ 
        { 
          "type": "string" 
        }, 
        { 
          "type": "array", 
          "items": { 
              "type": "string" 
          } 
        } 
      ] 
    } 
}

queue.policy.statements.condition

Specific circumstances under which the policy grants permission

{
  "condition": { 
    "description": "Specific circumstances under which the policy grants permission", 
    "type": "object", 
    "patternProperties": { 
      ".*": { 
        "type": "object", 
        "patternProperties": { 
          ".*": { 
            "oneOf": [ 
              { 
                "type": "string" 
              }, 
              { 
                "type": "array", 
                "items": { 
                  "type": "string" 
                } 
              } 
            ] 
          } 
        } 
      } 
    } 
  } 
}

Changed

queue.policy.statements.principal

The AWS account(s) or resource ARN(s) that this statement applies to.

{
  "principal": {
    "description": "The AWS account(s) or resource ARN(s) that this statement applies to.",
    "oneOf": [
      {
        "type": "string"
      },
      { 
        "type": "object", 
        "properties": { 
          "AWS": { 
            "oneOf": [ 
              { 
                "type": "string" 
              }, 
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ] 
          } 
        }, 
        "required": [ 
          "AWS" 
        ], 
        "additionalProperties": false 
      }, 
      { 
        "type": "object", 
        "properties": { 
          "Service": { 
            "oneOf": [ 
              { 
                "type": "string" 
              }, 
              { 
                "type": "array", 
                "items": { 
                  "type": "string" 
                } 
              } 
            ] 
          } 
        }, 
        "required": [ 
          "Service" 
        ], 
        "additionalProperties": false 
      }
    ]
  }
}