CognitoAuthorizationIdentity

Esta propiedad se puede usar para especificar un autorizador IdentitySource en una solicitud entrante. Para obtener más información, IdentitySource consulte la extensión ApiGateway Authorizer OpenApi .

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), use la siguiente sintaxis:

YAML

  Header: String
  ReauthorizeEvery: Integer
  ValidationExpression: String

Propiedades

Header

Especifique el nombre del encabezado de la autorización en la OpenApi definición.

Tipo: cadena

Obligatorio: no

Predeterminado: Autorización

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

ReauthorizeEvery

El período time-to-live (TTL), en segundos, que especifica cuánto tiempo API Gateway almacena en caché los resultados del autorizador. Si especifica un valor mayor que 0, API Gateway almacena en caché las respuestas del autorizador. De forma predeterminada, API Gateway establece esta propiedad en 300. El valor máximo es 3600 o 1 hora.

Tipo: entero

Obligatorio: no

Predeterminado: 300

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

ValidationExpression

Especifique una expresión de validación para la identidad de entrada.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

Ejemplos

CognitoAuthIdentity

YAML

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