CognitoAuthorizationIdentity - AWS Serverless Application Model
语法属性示例

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

CognitoAuthorizationIdentity

此属性可用于在授权方的传入请求中指定身份源。有关身份源的更多信息，请参阅 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

生存时间 (TTL) 期间（以秒为单位），用于指定 API Gateway 缓存授权方结果的时长。如果您指定一个大于 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