From d4e276d149a89eef184ee48428f2a0d89154416f Mon Sep 17 00:00:00 2001 From: Philipp Muens Date: Thu, 29 Dec 2016 08:27:55 +0100 Subject: [PATCH] Update API keys docs --- docs/providers/aws/events/apigateway.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/providers/aws/events/apigateway.md b/docs/providers/aws/events/apigateway.md index 0de2eef39..99cfc2a95 100644 --- a/docs/providers/aws/events/apigateway.md +++ b/docs/providers/aws/events/apigateway.md @@ -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