LambdaTokenAuthorizer - AWS Serverless Application Model
構文プロパティ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

LambdaTokenAuthorizer

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

詳細な説明と例についてはAWS SAM テンプレートを使用して API アクセスを制御するを参照してください。

構文

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

プロパティ

DisableFunctionDefaultPermissions

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

デフォルト値: false

タイプ: ブール

必須: いいえ

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

FunctionArn

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

注記

AWS::Serverless::Api 用に FunctionArn が指定されると、AWS SAM は AWS::Lambda::Permissions リソースを自動的に作成します。AWS::Lambda::Permissions リソースは、API とオーソライザー Lambda 関数の間の許可をプロビジョニングします。

タイプ: 文字列

必須: はい

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

FunctionInvokeRole

オーソライザーの認証情報を Lambda オーソライザーの OpenApi 定義に追加します。

タイプ: 文字列

必須: いいえ

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

FunctionPayloadType

このプロパティは、API の Lambda オーソライザーのタイプを定義するために使用できます。

有効な値: TOKEN または REQUEST

型: 文字列

必須: いいえ

[Default] (デフォルト): TOKEN

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

Identity

このプロパティは、オーソライザーの受信リクエストに IdentitySource を指定するために使用できます。このプロパティが必要になるのは、FunctionPayloadType プロパティが REQUEST に設定されている場合のみです。

タイプ: LambdaTokenAuthorizationIdentity

必須: 条件に応じて異なります

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、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