ApiFunctionAuth - 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.

ApiFunctionAuth

Configura la autorización a nivel de evento, para una API, una ruta y un método específicos.

Sintaxis

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

Properties

ApiKeyRequired

Requiere una clave de API para esta API, ruta y método.

Type: Booleano

Obligatorio: No

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

AuthorizationScopes

Los ámbitos de autorización que se aplicarán a esta API, ruta y método.

Los ámbitos que especifique invalidarán los ámbitos aplicados por elDefaultAuthorizerpropiedad si la ha especificado.

Type: Lista

Obligatorio: No

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

Authorizer

LaAuthorizerpara una función específica

Si ha especificado un autorizador global en la API y desea hacer pública una función específica, anula configurandoAuthorizeraNONE.

Type: Cadena

Obligatorio: No

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

InvokeRole

Especifica elInvokeRoleutilizar paraAWS_IAMautorización.

Type: Cadena

Obligatorio: No

Valor predeterminado: CALLER_CREDENTIALS

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

Notas adicionales:CALLER_CREDENTIALSmapas aarn:aws:iam::*:user/*, que utiliza las credenciales de la persona que llama para invocar el punto final.

ResourcePolicy

Configure la directiva de recursos para esta ruta de acceso en una API.

Type: Declaración de política de recursos

Obligatorio: No

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

Ejemplos

Función-Auth

En el ejemplo siguiente se especifica la autorización a nivel de función.

YAML

Auth: ApiKeyRequired: true Authorizer: NONE