HttpApiFunctionAuth - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

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.

Configura la autenticación para una API + Ruta + Método específica

Sintaxis

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

YAML

  AuthorizationScopes: List
  Authorizer: String

Propiedades

AuthorizationScopes

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

Los ámbitos que se muestran aquí anularán los ámbitos aplicados por el DefaultAuthorizer, si existe alguno.

Tipo: lista

Obligatorio: no

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

Authorizer

Authorizer para una función específica. Para utilizar la autorización de IAM, especifique AWS_IAM y especifique true para EnableIamAuthorizer en la sección Globals de tu plantilla.

Si ha especificado un autorizador global en la API y quiere hacer pública una función específica, anule configurando Authorizer en NONE.

Tipo: cadena

Obligatorio: no

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

Ejemplos

Autenticación de funciones

Especificar la 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 utilizar la autorización AWS_IAM a nivel de evento, también debe especificar true para EnableIamAuthorizer en la sección Globals de tu plantilla. Para obtener más información, consulta Sección Globals de la plantilla de AWS SAM.

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