x-sqs ¶

          x-sqs:
  queue-logical-name:
    Properties: {}
    Lookup: {}
    MacroParameters: {}
    Settings: {}
    Services: {}

         

Define SQS Queues that you want to create / lookup (use existing ones) and link these to services that are going to publish/consume messages.

You can also create DLQ and reference them to each other. See Special Features for more details.

You can also define services autoscaling automatically in the queue section instead of creating a new alarm etc. separately, compose-x will do all of that for you automatically. See Scaling for more details.

Services ¶

For IAM Access, refer to Services

In addition to Access and ReturnValues , x-sqs also supports Scaling which allows you to automatically generate Scaling Step policy to scale your ECS Service based on the Number of messages in the queue.

See Scaling for more details.

IAM Permissions ¶

RO - read only
RWMessages - read/write messages on the queue
RWPermissions - read/write messages and grants access to modify some queue attributes

Tip

IAM policies, are defined in sqs/sqs_perms.json

Hint

You can also use AWS SAM Permissions as defined in AWS Documentation

SAM Policy Example ¶

              services:
  serviceA: {}
x-sqs:
  QueueA:
    Services:
      serviceA:
        Access: SQSPollerPolicy

             

ReturnValues ¶

Refer to AWS SQS Return Values from the AWS CFN documentation.

By default, the value for Ref is automatically set on the service. Use QueueUrl as return value to map to a custom environment variable.

Properties ¶

Mandatory Properties ¶

SQS does not require any properties to be set in order to create the queue. No settings are mandatory. The QueueName will be automatically generated for you.

Special properties ¶

It is possible to define Dead Letter Queues for SQS messages (DLQ). It is possible to easily define this in ECS ComposeX simply by referring to the name of the queue, deployed in this same deployment.

Warning

It won’t be possible to import a queue ARN at this time in ECS ComposeX that exists outside of the stack today.

Lookup ¶

See Lookup for more details about Lookup.

           x-sqs:
  QueueA:
    Lookup:
      Tags:
        - Name: queue-a-123
        - owner: app01

          

Scaling ¶

You can now defined StepScaling on the ECS Service based on the number of messages in the queue!

Scaling Syntax ¶

            Scaling:
  Steps:
    - LowerBound: int
      UpperBound: int
      Count: int
  ScalingInCooldown: int
  ScalingOutCooldown: int

           

Tip

You can define scaling rules on SQS Queues that you are importing via Lookup

Attention

If you already setup other Scaling policies for the service, you might run into race conditions. As a rule of thumb, AWS Application Autoscaling will set the desired count to the highest of value among conflicting policies.

Special Features ¶

Redrive policy ¶

The redrive policy works exactly as you would expect it and is defined in the exact same way as for within the SQS proprties. Only, here, you only need to put the queue name of the DLQ. The generated ARN etc. will be fetched via exports (which also implicitly adds a lock on it).

Example with DLQ:

            x-sqs:
  DLQ:
    Properties: {}
    Settings: {}
    Services: []

AppQueue:
  Properties:
    RedrivePolicy:
      deadLetterTargetArn: DLQ
      maxReceiveCount: 10

           

Settings ¶

Refer to Settings

Note

This service does not support the Subnets setting.

Examples ¶

Simple SQS Queues with DLQ configured ¶

            x-sqs:
  Queue02:
    Services:
      app02:
        Access: RWPermissions
      app03:
        Access: RO
    Properties:
      RedrivePolicy:
        deadLetterTargetArn: Queue01
        maxReceiveCount: 10

  Queue01:
    Services:
      app03:
        Access: RWMessages
    Properties: {}

           

SQS Queue with scaling definition ¶

            x-sqs:
  QueueA:
    Services:
      frontend:
        Access: RWMessages
        scaling:
          ScaleInCooldown: 120
          ScaleOutCooldown: 60
          Steps:
            - LowerBound: 0
              UpperBound: 10
              Count: 1 # Gives you 1 container if there is between 0 and 10 messages in the queue.
            - LowerBound: 10
              UpperBound: 100
              Count: 10 # Gives you 10 containers if you have between 10 and 100 messages in the queue.
            - LowerBound: 100
              Count: 20 # Gives you 20 containers if there is 100+ messages in the queue

           

Note

The last step cannot have defined a upper_bound. If you set one, it will be automatically be removed.

Note

You need to have defined x-configs/scaling/Range to enable step scaling on the ECS Service.

JSON Schema ¶

Model ¶

x-sqs ¶

x-sqs.spec.json
x-sqs specification
type	object
properties
Lookup	x-resources.common.spec.json#/definitions/Lookup
Properties	https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html
	type	object
Settings	x-resources.common.spec.json#/definitions/Settings
Services	x-resources.common.spec.json#/definitions/Services
MacroParameters	type	object
additionalProperties	False

Definition ¶

            {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "x-sqs.spec.json",
  "$id": "x-sqs.spec.json",
  "title": "x-sqs",
  "description": "x-sqs specification",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "Lookup": {
      "$ref": "x-resources.common.spec.json#/definitions/Lookup"
    },
    "Properties": {
      "type": "object",
      "description": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html"
    },
    "Settings": {
      "$ref": "x-resources.common.spec.json#/definitions/Settings"
    },
    "Services": {
      "$ref": "x-resources.common.spec.json#/definitions/Services"
    },
    "MacroParameters": {
      "type": "object"
    }
  }
}

           

Test files ¶

You can find the test files here to use as reference for your use-case.