View a markdown version of this page

CognitoAuthorizer - AWS Serverless Application Model

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CognitoAuthorizer

Define un autorizador de grupo de usuarios de Amazon Cognito.

Para obtener más información y ejemplos, consulta 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.

Propiedades

AuthorizationScopes

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

Tipo: lista

Obligatorio: no

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

Identity

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

Tipo: CognitoAuthorizationIdentity

Obligatorio: no

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

UserPoolArn

Los ARN del grupo de usuarios de Amazon Cognito que se utilizarán para la autorización. Especifique un único ARN como cadena o varios ARNs como una lista para usar varios grupos de usuarios.

Tipo: Cadenas | Lista

Obligatorio: sí

CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un 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