LambdaAuthorizer

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

詳細と例については、「API Gateway デベロッパーガイド」の APIs 「HTTP API の AWS Lambda オーソライザーの使用」を参照してください。

構文

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

YAML

  AuthorizerPayloadFormatVersion: String
  EnableFunctionDefaultPermissions: Boolean
  EnableSimpleResponses: Boolean
  FunctionArn: String
  FunctionInvokeRole: String
  Identity: LambdaAuthorizationIdentity

プロパティ

AuthorizerPayloadFormatVersion

HTTP API Lambda オーソライザーに送信されるペイロードの形式を指定します。HTTP API Lambda オーソライザーに必要です。

これは、OpenAPI 定義の securitySchemes セクションにある x-amazon-apigateway-authorizer の authorizerPayloadFormatVersion セクションに渡されます。

有効な値: 1.0 または 2.0

タイプ: 文字列

必須: はい

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

EnableFunctionDefaultPermissions

デフォルトでは、HTTP API リソースには Lambda オーソライザーを呼び出すための許可が付与されていません。HTTP API リソースと Lambda オーソライザーの間の許可を自動的に作成するには、このプロパティを true として指定します。

タイプ: ブール

必須: いいえ

デフォルト値: false

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

EnableSimpleResponses

Lambda オーソライザーがシンプルな形式でレスポンスを返すかどうかを指定します。デフォルトでは、Lambda オーソライザーは AWS Identity and Access Management (IAM) ポリシーを返す必要があります。有効にした場合、Lambda オーソライザーは IAM ポリシーの代わりにブール値を返すことができます。

これは、OpenAPI 定義の securitySchemes セクションにある x-amazon-apigateway-authorizer の enableSimpleResponses セクションに渡されます。

タイプ: ブール

必須: いいえ

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

FunctionArn

API の認証を提供する Lambda 関数の Amazon リソースネーム (ARN) です。

これは、OpenAPI 定義の securitySchemes セクションにある x-amazon-apigateway-authorizer の authorizerUri セクションに渡されます。

タイプ: 文字列

必須: はい

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

FunctionInvokeRole

API Gateway がオーソライザー関数を呼び出すために必要な認証情報を持つ IAM ロールの ARN です。このパラメータは、関数のリソースベースのポリシーが API Gateway に lambda:InvokeFunction 許可を付与しない場合に指定します。

これは、OpenAPI 定義の securitySchemes セクションにある x-amazon-apigateway-authorizer の authorizerCredentials セクションに渡されます。

詳細については、API Gateway デベロッパーガイドの「Lambda オーソライザーの作成」を参照してください。

タイプ: 文字列

必須: いいえ

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

Identity

オーソライザーの受信リクエストに IdentitySource を指定します。

これは、OpenAPI 定義の securitySchemes セクションにある x-amazon-apigateway-authorizer の identitySource セクションに渡されます。

タイプ： LambdaAuthorizationIdentity

必須: いいえ

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

例

LambdaAuthorizer

LambdaAuthorizer 例

YAML

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