LambdaRequestAuthorizer

Lambda 関数を使用して、API へのアクセスを制御するように Lambda オーソライザーを設定します。

詳細な説明と例については、「API Gateway API へのアクセスの制御」を参照してください。

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

YAML

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

プロパティ

DisableFunctionDefaultPermissions

AWS::Serverless::Api リソースとオーソライザー Lambda 関数の間の許可をプロビジョニングするための AWS::Lambda::Permissions リソースを AWS SAM が自動的に作成しないように true を指定します。

デフォルト値: false

タイプ: ブール

必須: いいえ

AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。

FunctionArn

API に対する認可を提供する Lambda 関数の関数 ARN を指定します。

注記

AWS::Serverless::Api 用に FunctionArn が指定されると、AWS SAM は AWS::Lambda::Permissions リソースを自動的に作成します。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

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