本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
LambdaTokenAuthorizer
配置 Lambda 授权方以使用 Lambda 函数控制对 API 的访问。
有关更多信息以及示例,请参阅 控制对 API 网关 APIs 的访问。
语法
在您的 中声明此实体 AWS 无服务器应用程序模型 (AWS SAM) 模板时,请使用以下语法。
YAML
AuthorizationScopes:
List
FunctionArn:String
FunctionInvokeRole:String
FunctionPayloadType:String
Identity:LambdaTokenAuthorizationIdentity
属性
-
AuthorizationScopes
-
此授权方的授权范围列表。
类型:列表
必需: 否
兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。
-
FunctionArn
-
指定为 API 提供授权的 Lambda 函数的 arn 函数。
类型: 字符串
必需: 是
兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。
-
FunctionInvokeRole
-
将授权方凭证添加到 Lambda 授权方的 OpenApi 定义。
类型: 字符串
必需: 否
兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。
-
FunctionPayloadType
-
此属性可用于为 Api 定义 Lambda 授权方的类型。
有效值:
TOKEN
或者REQUEST
类型: 字符串
必需: 否
默认值:
TOKEN
兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。
-
Identity
-
此属性可用于在 授权方的传入请求中指定
IdentitySource
。类型: LambdaTokenAuthorizationIdentity
必需: 否
兼容性AWS CloudFormation: 此属性对于 AWS SAM 是唯一的,没有等效的 AWS CloudFormation。
示例
LambdaTokenAuth
YAML
Authorizers: MyLambdaTokenAuth: FunctionArn: Fn::GetAtt: - MyAuthFunction - Arn Identity: Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization' ValidationExpression: mycustomauthexpression # OPTIONAL ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300
BasicLambdaTokenAuth
YAML
Authorizers: MyLambdaTokenAuth: FunctionArn: Fn::GetAtt: - MyAuthFunction - Arn