archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-18 14:58:43 +00:00
Code Issues Projects Releases Wiki Activity

Update API keys docs

Browse Source
This commit is contained in:
Philipp Muens 2016-12-29 08:27:55 +01:00
parent a20cfbed15
commit d4e276d149
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/providers/aws/events/apigateway.md
View File

@ -196,6 +196,9 @@ functions:
In case an exception is thrown in your lambda function AWS will send an error message with `Process exited before completing request`. This will be caught by the regular expression for the 500 HTTP status and the 500 status will be returned.
### Setting API keys for your Rest API
**Note:** Due to a CloudFormation restriction you need to wire up API Keys and usage plans manually in the AWS console.
You can specify a list of API keys to be used by your service Rest API by adding an `apiKeys` array property to the
`provider` object in `serverless.yml`. You'll also need to explicitly specify which endpoints are `private` and require
one of the api keys to be included in the request by adding a `private` boolean property to the `http` event object you