LambdaRequestAuthorizer

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

有关更多信息以及示例，请参阅 使用您的 AWS SAM 模板控制 API 访问权限。

语法

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

YAML

DisableFunctionDefaultPermissions: Boolean
FunctionArn: String
FunctionInvokeRole: String
FunctionPayloadType: String
Identity: LambdaRequestAuthorizationIdentity

属性

DisableFunctionDefaultPermissions

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

默认值：false

类型：布尔值

必需：否

AWS CloudFormation 兼容性：此属性是独有的 AWS SAM ，没有 AWS CloudFormation 等效属性。

FunctionArn

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

注意

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

类型：字符串

必需：是

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。仅当属性 FunctionPayloadType 为 REQUEST 时，该属性是必需属性。

类型:LambdaRequestAuthorizationIdentity

必需：条件

AWS CloudFormation 兼容性：此属性是独有的 AWS SAM ，没有 AWS CloudFormation 等效属性。

示例

LambdaRequestAuth

YAML

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