From e8463126af18d52bc8d7e3423abe00373f55668e Mon Sep 17 00:00:00 2001 From: Allan Chua Date: Fri, 3 Jan 2020 17:13:12 +0800 Subject: [PATCH] -Fixed code documentation of API Auth Key format --- versions/2016-10-31.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/versions/2016-10-31.md b/versions/2016-10-31.md index d3a3d27ec3..0688598087 100644 --- a/versions/2016-10-31.md +++ b/versions/2016-10-31.md @@ -954,6 +954,8 @@ Auth: # For AWS_IAM: # DefaultAuthorizer: AWS_IAM # InvokeRole: NONE # CALLER_CREDENTIALS by default unless overridden + + ```yaml Authorizers: MyCognitoAuth: UserPoolArn: !GetAtt MyCognitoUserPool.Arn # Can also accept an array @@ -987,8 +989,7 @@ Auth: ReauthorizeEvery: 0 # OPTIONAL; Service Default: 300 ``` -**ApiKey:** -Configure ApiKey restriction for all methods and paths on an API. This setting can be overriden on individual `AWS::Serverless::Function` using the [Function Auth Object](#function-auth-object). Typically this would be used to require ApiKey on all methods and then override it on select methods that you want to be public. +**ApiKey:** Configure ApiKey restriction for all methods and paths on an API. This setting can be overriden on individual `AWS::Serverless::Function` using the [Function Auth Object](#function-auth-object). Typically this would be used to require ApiKey on all methods and then override it on select methods that you want to be public. ```yaml Auth: