LambdaAuthorizer - AWS Serverless Application Model

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

LambdaAuthorizer

Lambda オーソライザーを設定し、Amazon API Gateway HTTP API へのアクセスを制御するには、AWS Lambdafunction.

詳細な説明と例については、「」を参照してください。の使用AWS LambdaHTTP API のオーソライザ()API Gateway 開発者ガイド

Syntax

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

Properties

AuthorizerPayloadFormatVersion

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

これは、authorizerPayloadFormatVersionのセクションx-amazon-apigateway-authorizer()securitySchemesOpenAPI 定義のセクション。

有効な値: 1.0 または 2.0

Type: 文字列

必須: はい

AWS CloudFormationの互換性: このプロパティは固有のです。AWS SAMまた、にはAWS CloudFormation同等のもの。

EnableSimpleResponses

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

これは、enableSimpleResponsesのセクションx-amazon-apigateway-authorizer()securitySchemesOpenAPI 定義のセクション。

Type: ブール値

必須: いいえ

AWS CloudFormationの互換性: このプロパティは固有のです。AWS SAMまた、にはAWS CloudFormation同等のもの。

FunctionArn

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

これは、authorizerUriのセクションx-amazon-apigateway-authorizer()securitySchemesOpenAPI 定義のセクション。

Type: 文字列

必須: はい

AWS CloudFormationの互換性: このプロパティは固有のです。AWS SAMまた、にはAWS CloudFormation同等のもの。

FunctionInvokeRole

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

これは、authorizerCredentialsのセクションx-amazon-apigateway-authorizer()securitySchemesOpenAPI 定義のセクション。

詳細については、「」を参照してください。Lambda オーソライザーの作成()API Gateway 開発者ガイド

Type: 文字列

必須: いいえ

AWS CloudFormationの互換性: このプロパティは固有のです。AWS SAMまた、にはAWS CloudFormation同等のもの。

Identity

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

これは、identitySourceのセクションx-amazon-apigateway-authorizer()securitySchemesOpenAPI 定義のセクション。

Type: ラムダ認証アイデンティティ

必須: いいえ

AWS CloudFormationの互換性: このプロパティは固有のです。AWS SAMまた、にはAWS CloudFormation同等のもの。

Examples

LambdaAuthorizer

Lambda オーソライザーの例

YAML

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