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

HttpApi

Objeto que describe un origen de eventos con tipo HttpAPI.

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

Si no existe ninguna definición de OpenAPI para la ruta y el método especificados en la API, SAM creará esta definición por usted.

Sintaxis

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

Properties

ApiId

Identificador de unAWS::Serverless::HttpApirecurso definido en esta plantilla.

Si no se define, un valor predeterminadoAWS::Serverless::HttpApise crea el recurso llamadoServerlessHttpApiutilizando un documento OpenAPI generado que contiene una unión de todas las rutas y métodos definidos por los eventos Api definidos en esta plantilla que no especifican unApiId.

Esto no puede hacer referencia a unAWS::Serverless::HttpApirecurso definido en otra plantilla.

Type: Cadena

Obligatorio: No

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

Auth

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

Útil para anular las APIDefaultAuthorizero configurar la configuración de autenticación en una ruta individual cuando noDefaultAuthorizerse especifica.

Type: Auth de función de API HTTP

Obligatorio: No

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

Method

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

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

Type: Cadena

Obligatorio: No

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

Path

Ruta Uri para la que se invoca esta función. Debe empezar por/.

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

Type: Cadena

Obligatorio: No

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

PayloadFormatVersion

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

NOTA: PayloadFormatVersion requiere que SAM modifique su definición de OpenAPI, por lo que solo funciona con OpenAPI en línea definida en elDefinitionBodypropiedad.

Type: Cadena

Obligatorio: No

Valor predeterminado: 2.0

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

RouteSettings

La configuración de ruta por ruta de esta API HTTP. Para obtener más información sobre la configuración de ruta, consulteRouteSettings de AWS::ApiGatewayV2::Stageen laGuía para desarrolladores de API Gateway.

Nota: Si se especifican RouteSettings tanto en el recurso HttpAPI como en el origen de eventos,AWS SAMlos fusiona con las propiedades del origen de eventos que tienen prioridad.

Type: RouteSettings

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alRouteSettingspropiedad de unAWS::ApiGatewayV2::Stagerecurso.

TimeoutInMillis

Tiempo de espera personalizado entre 50 y 29 000 milisegundos.

NOTA: TimeOutInMillis requiere que SAM modifique su definición de OpenAPI, por lo que solo funciona con OpenAPI en línea definida en elDefinitionBodypropiedad.

Type: Entero

Obligatorio: No

Valor predeterminado: 5000

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

Ejemplos

Evento HttpAPI predeterminado

Evento HttpAPI que utiliza la ruta predeterminada. Todas las rutas y métodos no asignados de esta API se enrutarán a este extremo.

YAML

Events: HttpApiEvent: Type: HttpApi

HTTP API

Evento HttpAPI que utiliza una ruta y un método específicos.

YAML

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

Autorización de HttpAPI

Evento HttpAPI que utiliza un Authorizer.

YAML

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