LambdaRequestAuthorizer - Amazon Serverless Application Model
语法属性示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

LambdaRequestAuthorizer

配置 Lambda 授权方以通过 Lambda 函数控制对 API 的访问。

有关更多信息以及示例，请参阅 控制对 API Gateway API 的访问。

语法

要在模板中声明此实体，请使用以下语法。Amazon Serverless Application ModelAmazon SAM

属性

AuthorizationScopes

此授权者的授权范围列表。

类型：清单

必需：否

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

DisableFunctionDefaultPermissions

指定trueAmazon SAM防止自动创建AWS::Lambda::Permissions资源以在您的AWS::Serverless::Api资源和授权方 Lambda 函数之间预置权限。

默认值：false

类型：布尔值

必需：否

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

FunctionArn

指定 Lambda 函数的函数 ARN，该函数为 API 提供授权。

注意

Amazon SAM为指定时FunctionArn将自动创建AWS::Lambda::Permissions资源AWS::Serverless::Api。AWS::Lambda::Permissions资源在您的 API 和授权方 Lambda 函数之间配置权限。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

FunctionInvokeRole

将授权者凭证添加到 Lambda 授权者的 OpenApi 定义中。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

FunctionPayloadType

此属性可用于定义 API 的 Lambda 授权器的类型。

有效值：TOKEN 或 REQUEST

类型：字符串

必需：否

默认值：TOKEN

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

Identity

此属性可用于IdentitySource在向授权者发送的传入请求中指定。只有当该属性设置为时，才需要此FunctionPayloadType属性REQUEST。

类型：LambdaRequestAuthorizationIdentity

必需：条件

Amazon CloudFormation兼容性：此属性是唯一的Amazon SAM，没有Amazon CloudFormation等效属性。

示例

LambdaRequestAuth

YAML

Authorizer:
  MyLambdaRequestAuth:
    FunctionPayloadType: REQUEST
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    FunctionInvokeRole:
      Fn::GetAtt:
        - LambdaAuthInvokeRole
        - Arn
    Identity:
      Headers:
        - Authorization1