CognitoAuthorizationIdentity - AWS Serverless Application Model
構文プロパティ例

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

CognitoAuthorizationIdentity

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

構文

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

タイプ: 整数

必須: いいえ

デフォルト: 300

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

ValidationExpression

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

型: 文字列

必須: いいえ

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

例

CognitoAuthIdentity

YAML

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