CognitoAuthorizer

Defina un autorizador del grupo de usuarios de Amazon Cognito.

Para obtener más información y ejemplos, consulte Controlar el acceso a las API de API Gateway.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

  AuthorizationScopes: List
  Identity: CognitoAuthorizationIdentity
  UserPoolArn: String

Properties

AuthorizationScopes

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

Type: Lista

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Identity

Esta propiedad se puede utilizar para especificar unIdentitySourceen una solicitud entrante de un autorizador.

Type: Identidad de autorización de Cognito

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

UserPoolArn

Puede hacer referencia a un grupo de usuarios/especificar un arn de grupo de usuarios al que desea agregar este autorizador de cognito

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

Ejemplos

CognitoAuth

Ejemplo de autenticación de Cognito Auth

YAML

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