diff --git a/docs/providers/aws/events/websocket.md b/docs/providers/aws/events/websocket.md index 2d890601433..798ab837d8b 100644 --- a/docs/providers/aws/events/websocket.md +++ b/docs/providers/aws/events/websocket.md @@ -78,6 +78,7 @@ provider: runtime: nodejs12.x websocketsApiName: custom-websockets-api-name websocketsApiRouteSelectionExpression: $request.body.action # custom routes are selected by the value of the action property in the body + websocketsDescription: Custom Serverless Websockets functions: connectionHandler: diff --git a/docs/providers/aws/guide/serverless.yml.md b/docs/providers/aws/guide/serverless.yml.md index fce4c91ae10..6da45e38595 100644 --- a/docs/providers/aws/guide/serverless.yml.md +++ b/docs/providers/aws/guide/serverless.yml.md @@ -241,6 +241,8 @@ provider: websocketsApiName: custom-websockets-api-name # custom route selection expression websocketsApiRouteSelectionExpression: $request.body.route + # Use a custom description for the websockets API + websocketsDescription: Custom Serverless Websockets # Optional API Gateway REST API global config apiGateway: # Attach to an externally created REST API via its ID: diff --git a/lib/plugins/aws/provider.js b/lib/plugins/aws/provider.js index 0c0de407da4..ef008314113 100644 --- a/lib/plugins/aws/provider.js +++ b/lib/plugins/aws/provider.js @@ -1183,6 +1183,7 @@ class AwsProvider { versionFunctions: { $ref: '#/definitions/awsLambdaVersioning' }, websocketsApiName: { type: 'string' }, websocketsApiRouteSelectionExpression: { type: 'string' }, + websocketsDescription: { type: 'string' }, }, }, function: {