https://github.com/oieduardorabelo/cdk-api-gateway-websocket

WebSocket API in Amazon API Gateway using AWS CDK
https://github.com/oieduardorabelo/cdk-api-gateway-websocket

amazon-api-gateway api-gateway aws aws-cdk aws-cdk-typescript aws-lambda aws-lambda-node cdk-example serverless typescript websocket

Last synced: 26 days ago
JSON representation

WebSocket API in Amazon API Gateway using AWS CDK

• Host: GitHub
• URL: https://github.com/oieduardorabelo/cdk-api-gateway-websocket
• Owner: oieduardorabelo
• Created: 2023-02-04T00:19:21.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-04T00:22:04.000Z (about 2 years ago)
• Last Synced: 2024-12-29T03:51:03.255Z (about 1 month ago)
• Topics: amazon-api-gateway, api-gateway, aws, aws-cdk, aws-cdk-typescript, aws-lambda, aws-lambda-node, cdk-example, serverless, typescript, websocket
• Language: TypeScript
• Homepage:
• Size: 116 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WebSocket API in Amazon API Gateway

CDK example of:

- WebSocket API using [Amazon API Gateway WebSocketApi Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-apigatewayv2-alpha.WebSocketApi.html)

- Using `$connect` and `$disconnect` routes to manage connected users

- Using `AWS.ApiGatewayManagementApi` to send message from backend to connected clients

Final architecture:

![](./docs/cdk-api-gateway-websocket.png)

Extra resources:

- [About WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.html)

- [Managing connected users and client apps: $connect and $disconnect routes](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-keys-connect-disconnect.html)

- [Documentation of class: AWS.ApiGatewayManagementApi](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ApiGatewayManagementApi.html)

- [Setup API Gateway WebSocket API with CDK](https://aws.plainenglish.io/setup-api-gateway-websocket-api-with-cdk-c1e58cf3d2be)

- [Process DynamoDB streams with Lambda](https://aws.plainenglish.io/process-dynamodb-streams-with-lambda-5d870455f524)