CognitoAuthorizationIdentity - AWS Serverless Application Model

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CognitoAuthorizationIdentity

Cette propriété peut être utilisée pour spécifier un IdentitySource dans une demande entrante pour un autorisateur. Pour plus d'informations, IdentitySource consultez l' OpenApi extension ApiGateway Authorizer.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante :

YAML

Header: String ReauthorizeEvery: Integer ValidationExpression: String

Propriétés

Header

Spécifiez le nom de l'en-tête pour Authorization dans la OpenApi définition.

Type : chaîne

Obligatoire : non

Par défaut : autorisation

Compatibilité AWS CloudFormation : cette propriété est unique pour AWS SAM et ne dispose pas d'équivalent AWS CloudFormation.

ReauthorizeEvery

Période time-to-live (TTL), en secondes, qui indique la durée pendant laquelle API Gateway met en cache les résultats de l'autorisateur. Si vous définissez une valeur supérieure à 0, API Gateway met en cache les réponses du mécanisme d'autorisation. Par défaut, API Gateway définit cette propriété sur 300. La valeur maximale est 3 600 ou 1 heure.

Type : entier

Obligatoire : non

Par défaut : 300

Compatibilité AWS CloudFormation : cette propriété est unique pour AWS SAM et ne dispose pas d'équivalent AWS CloudFormation.

ValidationExpression

Spécifiez une expression de validation pour valider l'identité entrante.

Type : chaîne

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est unique pour AWS SAM et ne dispose pas d'équivalent AWS CloudFormation.

Exemples

CognitoAuthIdentity

YAML

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