CognitoAuthorizer

Defina un autorizador de grupo de usuarios de Amazon Cognito.

Para obtener más información y ejemplos, consulte Controla el acceso a la API con tu AWS SAM plantilla.

Sintaxis

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

YAML

  AuthorizationScopes: List
  Identity: CognitoAuthorizationIdentity
  UserPoolArn: String

Propiedades

AuthorizationScopes

Lista de los ámbitos de autorización de este autorizador.

Tipo: lista

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.

Identity

Esta propiedad se puede usar para especificar una solicitud IdentitySource entrante de un autorizador.

Tipo: CognitoAuthorizationIdentity

Obligatorio: no

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

UserPoolArn

Puede hacer referencia a un grupo de usuarios o especificar un nombre de grupo de usuarios al que desee añadir este autorizador de cognito

Tipo: cadena

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.

Ejemplos

CognitoAuth

Ejemplo de autorización de Cognito

YAML

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