feat(AWS SQS): Support functions[].events[].sqs.maximumConcurrency

(PR #11678)
serverless · Jan 18, 2023 · 57f2719 · 57f2719
1 parent 99cd9e6
commit 57f2719
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/docs/providers/aws/events/sqs.md b/docs/providers/aws/events/sqs.md
@@ -88,6 +88,22 @@ functions:
             - a: [1, 2]
 ```
 
+## Setting the Maximum Concurrency
+
+The maximum concurrency setting limits the number of concurrent instances of the function that an Amazon SQS event source can invoke. The minimum limit of concurrent functions that the event source can invoke is `2`, and the maximum is `1000`. To turn off maximum concurrency, leave this field empty.
+
+For more details, see the [AWS SQS max concurrency documentation](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency).
+
+```yml
+functions:
+  onlyOneOrTwo:
+    handler: handler.preprocess
+    events:
+      - sqs:
+          arn: arn:aws:sqs:region:XXXXXX:myQueue
+          maximumConcurrency: 250
+```
+
 ## IAM Permissions
 
 The Serverless Framework will automatically configure the most minimal set of IAM permissions for you. However you can still add additional permissions if you need to. Read the official [AWS documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-lambda-function-trigger.html) for more information about IAM Permissions for SQS events.

diff --git a/lib/plugins/aws/package/compile/events/sqs.js b/lib/plugins/aws/package/compile/events/sqs.js
@@ -24,6 +24,7 @@ class AwsCompileSQSEvents {
             maximumBatchingWindow: { type: 'integer', minimum: 0, maximum: 300 },
             functionResponseType: { enum: ['ReportBatchItemFailures'] },
             filterPatterns: { $ref: '#/definitions/filterPatterns' },
+            maximumConcurrency: { type: 'integer', minimum: 2, maximum: 1000 },
           },
           required: ['arn'],
           additionalProperties: false,
@@ -111,6 +112,12 @@ class AwsCompileSQSEvents {
               };
             }
 
+            if (event.sqs.maximumConcurrency) {
+              sqsTemplate.Properties.ScalingConfig = {
+                MaximumConcurrency: event.sqs.maximumConcurrency,
+              };
+            }
+
             // add event source ARNs to PolicyDocument statements
             sqsStatement.Resource.push(EventSourceArn);
 

diff --git a/test/unit/lib/plugins/aws/package/compile/events/sqs.test.js b/test/unit/lib/plugins/aws/package/compile/events/sqs.test.js
@@ -202,6 +202,7 @@ describe('test/unit/lib/plugins/aws/package/compile/events/sqs.test.js', () => {
                     batchSize: 10,
                     maximumBatchingWindow: 100,
                     filterPatterns: [{ a: [1, 2] }, { b: [3, 4] }],
+                    maximumConcurrency: 250,
                   },
                 },
               ],
@@ -246,6 +247,12 @@ describe('test/unit/lib/plugins/aws/package/compile/events/sqs.test.js', () => {
         ],
       });
     });
+
+    it('should have correct maximum concurrency', () => {
+      expect(eventSourceMappingResource.Properties.ScalingConfig).to.deep.equal({
+        MaximumConcurrency: 250,
+      });
+    });
   });
 
   it('should not depend on default IAM role when custom role defined', async () => {