New serverless pattern - apigw-websocket-api-vpclink #2391
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
parikhudit
reviewed
Sep 1, 2024
Comment on lines
+13
to
+15
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Please remove extra lines here. Review all the files as well.
parikhudit
reviewed
Sep 1, 2024
There was a problem hiding this comment.
Please rename the folder as per the name of the pattern. You may find examples in the repository.
parikhudit
reviewed
Sep 1, 2024
|
|
||
| The SAM template deploys a websocket API Gateway and two Lambda functions required to run the application. This pattern deploys an Amazon API Gateway WebSocket API with a $connect route with a Lambda proxy integration which will invoke another Lambda function asynchronously and pass the Connection Id and the API Gateway stage URL to it. Then the Lambda function which got invoked asynchronously will check the validity of the connection. If the Connection Id is valid it will make an SDK API call to post a greeting to the client. | ||
|
|
||
| Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/s3-lambda |
parikhudit
reviewed
Sep 1, 2024
| 3. From the command line, use AWS SAM to build and deploy the AWS resources for the pattern as specified in the template.yml file: | ||
|
|
||
| ``` | ||
| sam build |
There was a problem hiding this comment.
There's no requirements.txt file. Do you need this command?
parikhudit
reviewed
Sep 1, 2024
Comment on lines
+53
to
+62
| 3. Connect to your WebSocketURL by executing the following command: | ||
| ``` | ||
| $ wscat -c <YOUR WEBSOCKET URL> | ||
| ``` | ||
|
|
||
| 4. To test the custom route and its associated function, send a JSON-formatted request like the following example. The Lambda function sends back the value of the "data" key using the callback URL: | ||
| ``` | ||
| $ wscat -c <YOUR WEBSOCKET URL> | ||
| connected (press CTRL+C to quit) | ||
| ``` |
There was a problem hiding this comment.
Could you kindly explain this with an example for better clarity?
parikhudit
reviewed
Sep 1, 2024
| @@ -0,0 +1,75 @@ | |||
| ## Websocket API Gateway acknowledgement for $connect route. | |||
|
|
|||
| The SAM template deploys a websocket API Gateway and two Lambda functions required to run the application. This pattern deploys an Amazon API Gateway WebSocket API with a $connect route with a Lambda proxy integration which will invoke another Lambda function asynchronously and pass the Connection Id and the API Gateway stage URL to it. Then the Lambda function which got invoked asynchronously will check the validity of the connection. If the Connection Id is valid it will make an SDK API call to post a greeting to the client. | |||
There was a problem hiding this comment.
The explanation in first 2 lines redundant. Could you please rephrase it?
|
Thanks for the contribution @manasvijain99. As this PR contains 2 new patterns, I'd request you to kindly update the PR to have just 1 pattern and have a new PR for another. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
We have created a pattern which deploys a SAM template to create an Amazon API Gateway Websocket API endpoint with a VPC Link integration.