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

HttpApiFunctionAuth

Configura la autorización a nivel de evento.

Configurar autenticación para un método API + Path + específico

Sintaxis

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

YAML

AuthorizationScopes: List Authorizer: String

Properties

AuthorizationScopes

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

Los ámbitos enumerados aquí sustituirán los ámbitos aplicados por elDefaultAuthorizersi existe alguno.

Type: List

Obligatorio: No

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

Authorizer

LaAuthorizerpara una función específica. Para utilizar la autorización de IAM, especifiqueAWS_IAMy especifiquetrueparaEnableIamAuthorizeren laGlobalssección de su plantilla.

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.

Ejemplos

Función-Auth

Especificación de autorización a nivel de función

YAML

Auth: Authorizer: OpenIdAuth AuthorizationScopes: - scope1 - scope2

Autorización de IAM

Especifica la autorización de IAM a nivel de evento. Para utilizarAWS_IAMautorización a nivel de evento, también debe especificartrueparaEnableIamAuthorizeren laGlobalssección de su plantilla. Para obtener más información, consulte Sección Globals delAWS SAMplantilla.

YAML

Globals: HttpApi: Auth: EnableIamAuthorizer: true Resources: HttpApiFunctionWithIamAuth: Type: AWS::Serverless::Function Properties: Events: ApiEvent: Type: HttpApi Properties: Path: /iam-auth Method: GET Auth: Authorizer: AWS_IAM Handler: index.handler InlineCode: | def handler(event, context): return {'body': 'HttpApiFunctionWithIamAuth', 'statusCode': 200} Runtime: python3.9