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

HttpApiAuth

Configure la autorización para controlar el acceso a la API HTTP de Amazon API Gateway.

Para obtener más información sobre cómo configurar el acceso a las API HTTP, consulta Controlar y administrar el acceso a una API HTTP en API Gateway en la Guía para desarrolladores de API Gateway.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

Propiedades

Authorizers

El autorizador utilizado para controlar el acceso a la API de API Gateway.

Tipo: OAuth2Authorizer | LambdaAuthorizer

Obligatorio: no

Valor predeterminado: Ninguno

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

Notas adicionales: AWS SAM añade los autorizadores a la definición de OpenAPI.

DefaultAuthorizer

Especifica el autorizador predeterminado que se utilizará para autorizar las llamadas a la API de API Gateway. Puede especificar AWS_IAM como autorizador predeterminado si EnableIamAuthorizer está configurado en true. De lo contrario, especifica un autorizador que haya definido en Authorizers.

Tipo: cadena

Obligatorio: no

Valor predeterminado: Ninguno

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

EnableIamAuthorizer

Especifica si quieres utilizar la autorización de IAM para la ruta de la API.

Tipo: Booleano

Obligatorio: no

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

Ejemplos

Autorizador de OAuth 2.0

Ejemplo de autorizadores de OAuth 2.0

YAML

Auth:
  Authorizers:
    OAuth2Authorizer:
      AuthorizationScopes:
        - scope1
        - scope2
      JwtConfiguration:
        issuer: "https://www.example.com/v1/connect/oauth2"
        audience:
          - MyApi
      IdentitySource: "$request.querystring.param"
  DefaultAuthorizer: OAuth2Authorizer

Autorizador de IAM

Ejemplo de autorizador de IAM

YAML

Auth:
  EnableIamAuthorizer: true
  DefaultAuthorizer: AWS_IAM