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

HttpApi

El objeto que describe una fuente de eventos con el tipo HttpApi.

Si existe una OpenApi definición para la ruta y el método especificados en la API, SAM le agregará la sección de integración y seguridad de Lambda (si corresponde).

Si en la API no existe una OpenApi definición para la ruta y el método especificados, SAM creará esta definición automáticamente.

Sintaxis

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

Propiedades

ApiId

Identificador de un recurso AWS::Serverless::HttpApi definido en esta plantilla.

Si no está definido, se crea un AWS::Serverless::HttpApi recurso predeterminado llamado ServerlessHttpApi mediante un OpenApi documento generado que contiene una unión de todas las rutas y métodos definidos por los eventos de Api definidos en esta plantilla que no especifican unApiId.

Esto no puede hacer referencia a un recurso AWS::Serverless::HttpApi definido en otra plantilla.

Tipo: cadena

Obligatorio: no

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

Auth

Configuración de autenticación para esta API, ruta y método específicos.

Útil para anular las API DefaultAuthorizer o establecer la configuración de autenticación en una ruta individual cuando no se especifica ningún DefaultAuthorizer.

Tipo: HttpApiFunctionAuth

Obligatorio: no

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

Method

Método HTTP para el que se invoca esta función.

Si no, Path y Method se especifican, SAM creará una ruta de API predeterminada que enruta cualquier solicitud que no se asigne a un punto de conexión diferente a esta función de Lambda. Solo puede existir una de estas rutas predeterminadas por API.

Tipo: cadena

Obligatorio: no

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

Path

Ruta de URI para la que se invoca esta función. Debe empezar con /.

Si no, Path y Method se especifican, SAM creará una ruta de API predeterminada que enruta cualquier solicitud que no se asigne a un punto de conexión diferente a esta función de Lambda. Solo puede existir una de estas rutas predeterminadas por API.

Tipo: cadena

Obligatorio: no

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

PayloadFormatVersion

Especifica el formato de la carga enviada a una integración.

NOTA: PayloadFormatVersion requiere que SAM modifique la definición de OpenAPI, por lo que solo funciona con los elementos en línea OpenApi definidos en la propiedad. DefinitionBody

Tipo: cadena

Obligatorio: no

Predeterminado: 2.0.

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

RouteSettings

La configuración de ruta por ruta para esta API HTTP. Para obtener más información sobre la configuración de rutas, consulte AWS::ApiGatewayV2::Stage RouteSettingsla Guía para desarrolladores de API Gateway.

Nota: Si RouteSettings se especifican tanto en la fuente de HttpApi recursos como en la fuente de eventos, las AWS SAM fusiona teniendo prioridad con las propiedades de la fuente de eventos.

Tipo: RouteSettings

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la RouteSettings propiedad de un AWS::ApiGatewayV2::Stage recurso.

TimeoutInMillis

Tiempo de espera personalizado entre 50 y 29 000 milisegundos.

NOTA: TimeoutInMillis requiere que SAM modifique la definición de OpenAPI, por lo que solo funciona con los elementos en línea OpenApi definidos en la propiedad. DefinitionBody

Tipo: entero

Obligatorio: no

Predeterminado: 5000

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

Ejemplos

HttpApi Evento predeterminado

HttpApi Evento que usa la ruta predeterminada. Todas las rutas y métodos no mapeados de esta API se dirigirán a este punto de conexión.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi

HttpApi

HttpApi Evento que usa una ruta y un método específicos.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET

HttpApi Autorización

HttpApi Evento que utiliza un autorizador.

YAML

Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2