CognitoAuthorizer

Définissez un autorisation de groupe d'utilisateurs Amazon Cognito.

Pour plus d’informations et d’exemples, consultez Contrôlez l'accès aux API avec votre AWS SAM modèle.

Syntaxe

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

YAML

  AuthorizationScopes: List
  Identity: CognitoAuthorizationIdentity
  UserPoolArn: String

Propriétés

AuthorizationScopes

Liste des étendues d'autorisation pour cet autorisateur.

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Identity

Cette propriété peut être utilisée pour spécifier une IdentitySource dans une demande d'autorisation entrante.

Type : CognitoAuthorizationIdentity

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

UserPoolArn

Peut se référer à un groupe d'utilisateur/spécifier un arn userpool (groupe d'utilisateurs) auquel vous souhaitez ajouter cet autorisateur cognito

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

CognitoAuth

Exemple d'authentification Cognito

YAML

Auth:
  Authorizers:
    MyCognitoAuth:
      AuthorizationScopes:
        - scope1
        - scope2
      UserPoolArn:
        Fn::GetAtt:
          - MyCognitoUserPool
          - Arn
      Identity:
        Header: MyAuthorizationHeader
        ValidationExpression: myauthvalidationexpression