翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
LambdaTokenAuthorizer
Lambda 関数を使用して、API へのアクセスを制御するように Lambda オーソライザーを設定します。
詳細な説明と例については、「API Gateway API へのアクセスの制御」を参照してください。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
DisableFunctionDefaultPermissions:
Boolean
FunctionArn:String
FunctionInvokeRole:String
FunctionPayloadType:String
Identity:LambdaTokenAuthorizationIdentity
プロパティ
-
AWS::Serverless::Api
リソースとオーソライザー Lambda 関数の間の許可をプロビジョニングするためのAWS::Lambda::Permissions
リソースを AWS SAM が自動的に作成しないようにtrue
を指定します。デフォルト値:
false
タイプ: ブール
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
API に対する認可を提供する Lambda 関数の関数 ARN を指定します。
注記
AWS::Serverless::Api
用にFunctionArn
が指定されると、AWS SAM はAWS::Lambda::Permissions
リソースを自動的に作成します。AWS::Lambda::Permissions
リソースは、API とオーソライザー Lambda 関数の間の許可をプロビジョニングします。タイプ: 文字列
必須: はい
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
Lambda オーソライザー OpenApi の定義にオーソライザー認証情報を追加します。
タイプ: 文字列
必須: いいえ
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
このプロパティは、API の Lambda オーソライザーのタイプを定義するために使用できます。
有効な値:
TOKEN
またはREQUEST
タイプ:文字列
必須: いいえ
デフォルト:
TOKEN
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS CloudFormation に同等のものはありません。
-
このプロパティは、オーソライザーの受信リクエストに
IdentitySource
を指定するために使用できます。このプロパティが必要になるのは、FunctionPayloadType
プロパティがREQUEST
に設定されている場合のみです。と入力します。 LambdaTokenAuthorizationIdentity
必須: 条件に応じて異なります
AWS CloudFormation との互換性: このプロパティは AWS SAM に固有であり、AWS 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