LambdaAuthorizer - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

LambdaAuthorizer

配置 Lambda 授权方以控制对 Amazon API Gateway HTTP API 的访问,并使用Amazon Lambdafunction.

有关更多信息和示例,请参阅。使用Amazon LambdaHTTP API 的授权方中的API Gateway 开发人员指南.

Syntax

要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。

Properties

AuthorizerPayloadFormatVersion

指定发送到 HTTP API Lambda 授权方的负载的格式。对于 HTTP API Lambda 授权方必须指定。

这将传递至authorizerPayloadFormatVersion的部分x-amazon-apigateway-authorizer中的securitySchemesOpenAPI 定义的部分。

有效值1.02.0

类型:String

必需:是

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

EnableSimpleResponses

指定 Lambda 授权方是否以简单格式返回响应。默认情况下,Lambda 授权方必须返回Amazon Identity and Access Management(IAM) 策略。如果启用,Lambda 授权方可以返回布尔值,而不是 IAM 策略。

这将传递至enableSimpleResponses的部分x-amazon-apigateway-authorizer中的securitySchemesOpenAPI 定义的部分。

类型:Boolean

必需:否

Amazon CloudFormation兼容性:该属性是唯一的Amazon SAM没有Amazon CloudFormation等效函数

FunctionArn

提供 API 授权的 Lambda 函数的 Amazon 资源名称 (ARN)。

这将传递至authorizerUri的部分x-amazon-apigateway-authorizer中的securitySchemesOpenAPI 定义的部分。

类型:String

必需:是

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

FunctionInvokeRole

具有 API Gateway 调用授权方函数所需凭证的 IAM 角色的 ARN。如果函数的基于资源的策略未授予 API Gateway,则指定该参数。lambda:InvokeFunction权限。

这将传递至authorizerCredentials的部分x-amazon-apigateway-authorizer中的securitySchemesOpenAPI 定义的部分。

有关更多信息,请参阅 。创建 Lambda 授权方中的API Gateway 开发人员指南.

类型:String

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

Identity

指定IdentitySource在收到的授权人请求中。

这将传递至identitySource的部分x-amazon-apigateway-authorizer中的securitySchemesOpenAPI 定义的部分。

类型lambda 授权身份

必需:否

Amazon CloudFormation兼容性:对是唯一的。Amazon SAM没有Amazon CloudFormation等效函数

Examples

LambdaAuthorizer

Lambda Authorizer 示例

YAML

Auth: Authorizers: MyLambdaAuthorizer: AuthorizerPayloadFormatVersion: 2.0 FunctionArn: Fn::GetAtt: - MyAuthFunction - Arn FunctionInvokeRole: Fn::GetAtt: - LambdaAuthInvokeRole - Arn Identity: Headers: - Authorization