coderecipe-dev / serverless-apigw-sqs-plugin

A Serverless plugin that creates an AWS API Gateway resource to connect to an AWS Simple Queue Service (SQS) without the use of a lambda. Without the use of this plugin, any interactions with the queue through public network will need to go through a proxy lambda.

Serverless-APIGW-SQS-Plugin

A Serverless plugin that creates an AWS API Gateway resource to connect to an AWS Simple Queue Service (SQS) without the use of a lambda. Without the use of this plugin, any interactions with the queue through public network will need to go through a proxy lambda.

NOTE: As of today AWS does not support FIFO queue to trigger Lambda functions, so only standard queues are currently supported in this plugin.

More info please refer to: https://coderecipe.ai/architectures/17547953

Installation

npm install serverless-apigw-sqs-plugin

Usage

Add plugin to your serverless.yml file.

plugins:
 - serverless-apigw-sqs-plugin

Set API endpoint name and SQS Queue name under custom parameters in your serverless.yml file:

custom:
  apiGwSqs:
    apiEndpoint: '<your api endpoint name goes here>'
    queueName: '<queue name goes here. Can only include alphanumeric characters, hyphens, or underscores. 1 to 80 in length>'

API endpoint that is created will be listed under "endpoints" in the output of sls deploy.

serverless-apigw-sqs-plugin's Issues

Running with --noDeploy

How to use this plugin without deployment, for testing purposes?

New Stack?

why should this plugin create a new stack?
can't it add its content to the main stack?

thanks

Use AWS:region instead of fixed 'us-east-1' for SQSAPIMethod

serverless-apigw-sqs-plugin/template.yml

Line 54 in e86e955

Uri: !Sub arn:aws:apigateway:us-east-1:sqs:path/${AWS::AccountId}/${SQSQueue.QueueName}

How to do schema validation and adding api keys along with this

I have used the plugin and created an API gateway with SQS. But, below is my requirement:
I want to create an AWS API Gateway with SQS and when a message added to the queue, the API Gateway should process it. Also, need to add schema validation and API keys for this. Please help me, because I am new for using serverless

Allow custom mapping of $input to the SQS payload

Currently it HAS to be $input.body. There's no way to collect the path, headers, etc

Fails to deploy without error

The deployment process quits at a particular point. I use the plugin in combination with these other plugins:

• serverless-python-requirements
• serverless-prune-plugin
• serverless-package-external
• serverless-add-api-key

If I remove the plugin, deployment continues successfully.

custom:
  apiGwSqs:
    apiEndpoint: XXXX
    queueName: YYYY

logs:

Serverless: Invoke deploy
Serverless: Invoke package
Serverless: Invoke aws:common:validate
Serverless: Invoke aws:common:cleanupTempDir
Serverless: [serverless-package-external] Symlinking ../common
Serverless: [serverless-package-external] is complete
Serverless: Packaging service...
Serverless: Excluding development dependencies...
Serverless: Excluding development dependencies...
Serverless: Excluding development dependencies...
Serverless: Excluding development dependencies...
Serverless: Excluding development dependencies...
Serverless: Excluding development dependencies...
Serverless: Injecting required Python packages to package...
Serverless: [serverless-package-external] cleaning up
Serverless: Invoke aws:package:finalize
Serverless: Invoke aws:common:moveArtifactsToPackage
Serverless: Invoke aws:common:validate

At this point, the deployment process quits without logging anything else.

Domain Name

How to add domain name for the newly created API?

In serverless, I used to use Domain Manager plugin