LambdaAuthorizer - AWS Serverless Application Model

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

LambdaAuthorizer

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

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

構文

でこのエンティティを宣言するには AWS サーバーレスアプリケーションモデル (AWS SAM) テンプレート。次の構文を使用します。

プロパティ

AuthorizerPayloadFormatVersion

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

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

有効な値: 1.0 または 2.0

タイプ: 文字列

必須: はい

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

EnableSimpleResponses

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

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

タイプ: ブール値

必須: いいえ

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

FunctionArn

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

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

タイプ: 文字列

必須: はい

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

FunctionInvokeRole

オーソライザーを呼び出すために必要な認証情報を持つIAMロールの ARN。

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

タイプ: 文字列

必須: いいえ

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

Identity

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

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

タイプ: LambdaAuthorizationIdentity

必須: いいえ

AWS CloudFormation compatibility: このプロパティは に固有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