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.
El objeto que describe un origen de eventos con el 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 corresponde) por usted.
Si en la API no existe una definición de OpenAPI para la ruta y el método especificados, SAM creará esta definición automáticamente.
Sintaxis
Para declarar esta entidad en tu plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:
YAML
ApiId: String
Auth: HttpApiFunctionAuth
Method: String
Path: String
PayloadFormatVersion: String
RouteSettings: RouteSettings
TimeoutInMillis: Integer
Propiedades
-
ApiId
-
Identificador de un recurso AWS::Serverless::HttpApi definido en esta plantilla.
Si no está definido, se crea un recurso AWS::Serverless::HttpApi predeterminado llamado
ServerlessHttpApi
mediante un documento OpenAPI 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
Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.
-
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únDefaultAuthorizer
.Tipo: HttpApiFunctionAuth
Obligatorio: no
Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.
-
Method
-
Método HTTP para el que se invoca esta función.
Si no,
Path
yMethod
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
Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.
-
Path
-
Ruta de URI para la que se invoca esta función. Debe empezar con
/
.Si no,
Path
yMethod
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
Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.
-
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 OpenAPI integrada definida en la propiedad
DefinitionBody
.Tipo: cadena
Obligatorio: no
Predeterminado: 2.0.
Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.
-
RouteSettings
-
La configuración de ruta por ruta para esta API HTTP. Para obtener más información sobre la configuración de rutas, consulta AWS::ApiGatewayV2::Stage RouteSettings en la Guía para desarrolladores de API Gateway.
Nota: Si Routesettings se especifica tanto en el recurso HttpAPI como en el origen de eventos, AWS SAM los combina con las propiedades de la fuente de eventos que tienen prioridad.
Type: RouteSettings
Obligatorio: no
Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad
RouteSettings
de un recursoAWS::ApiGatewayV2::Stage
. -
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 OpenAPI integrada definida en la propiedad
DefinitionBody
.Tipo: entero
Obligatorio: no
Predeterminado: 5000
Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.
Ejemplos
Evento HttpApi predeterminado
Evento HttpApi 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
Evento HttpApi que utiliza una ruta y un método específicos.
YAML
Events:
HttpApiEvent:
Type: HttpApi
Properties:
Path: /
Method: GET
Autorización HttpApi
Evento HttpApi que utiliza un autorizador.
YAML
Events:
HttpApiEvent:
Type: HttpApi
Properties:
Path: /authenticated
Method: GET
Auth:
Authorizer: OpenIdAuth
AuthorizationScopes:
- scope1
- scope2