Official `aws-lite` plugin for API Gateway WebSocket Management API
npm install @aws-lite/apigatewaymanagementapi@aws-lite/apigatewaymanagementapi> Official aws-lite plugin for API Gateway WebSocket Management API
> Maintained by: @architect
``sh`
npm i @aws-lite/apigatewaymanagementapi
Optionally install types:
`sh`
npm i -D @aws-lite/apigatewaymanagementapi-types
Reference documentation with examples at aws-lite.org
Properties:
- ConnectionId (string) [required]
- WebSocket connection ID
- ApiUrl (string)
- Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$defaultApiId
- (string)Stage
- API Gateway ID
- (string)$default
- API Gateway stage; example: Data
- (string, object)
- Data to send to WebSocket client
Properties:
- ConnectionId (string) [required]
- WebSocket connection ID
- ApiUrl (string)
- Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$defaultApiId
- (string)Stage
- API Gateway ID
- (string)$default
- API Gateway stage; example:
Properties:
- ConnectionId (string) [required]
- WebSocket connection ID
- ApiUrl (string)
- Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$defaultApiId
- (string)Stage
- API Gateway ID
- (string)$default
- API Gateway stage; example:
- More information about the aws-lite plugin API
- Learn about contributing to this and other aws-lite` plugins