LambdaTokenAuthorizationIdentity

このプロパティを使用して、オーソライザーの受信リクエスト IdentitySource で を指定できます。の詳細については、ApiGateway 「Authorizer extension OpenApi IdentitySource 」を参照してください。

構文

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

YAML

  Header: String
  ReauthorizeEvery: Integer
  ValidationExpression: String

プロパティ

Header

OpenApi 定義で認証のヘッダー名を指定します。

タイプ: 文字列

必須: いいえ

デフォルト: Authorization

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

ReauthorizeEvery

API Gateway がオーソライザーの結果をキャッシュする時間を指定する time-to-live (TTL) 期間を秒単位で指定します。0 より大きい値を指定する場合、API Gateway が認証レスポンスをキャッシュします。デフォルトで、API Gateway はこのプロパティを 300 に設定します。最大値は 3600、つまり 1 時間です。

タイプ: 整数

必須: いいえ

デフォルト: 300

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

ValidationExpression

受信アイデンティティを検証するための検証式を指定します。

タイプ: 文字列

必須: いいえ

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

例

LambdaTokenIdentity

YAML

Identity:
  Header: MyCustomAuthHeader
  ValidationExpression: Bearer.*
  ReauthorizeEvery: 30