In the following example, we specify that the
compute function should be triggered whenever there are messages in the given SQS Queue.
The ARN for the queue can be specified as a string, the reference to the ARN of a resource by logical ID, or the import of an ARN that was exported by a different service or CloudFormation stack.
sqs event will hook up your existing SQS Queue to a Lambda function. Serverless won't create a new queue for you.
functions: compute: handler: handler.compute events: # These are all possible formats - sqs: arn:aws:sqs:region:XXXXXX:MyFirstQueue - sqs: arn: Fn::GetAtt: - MySecondQueue - Arn - sqs: arn: Fn::ImportValue: MyExportedQueueArnId - sqs: arn: Fn::Join: - ':' - - arn - aws - sqs - Ref: AWS::Region - Ref: AWS::AccountId - MyOtherQueue
For the SQS event integration, you can set the
batchSize, which effects how many SQS messages can be included in a single Lambda invocation. The default
10. The max
10000 for a standard queue,
10 for a FIFO queue.
You can also set
maximumBatchingWindow to standard queues to specify the maximum amount of time in seconds to gather records before invoking the function. The max
300 seconds. Check AWS documentation for more details.
functions: compute: handler: handler.compute events: - sqs: arn: arn:aws:sqs:region:XXXXXX:myQueue batchSize: 10 maximumBatchingWindow: 60
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 for more information about IAM Permissions for SQS events.