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

Api

El objeto que describe unApitipo de origen de evento. Si unAWS::Serverless::Apise define, los valores de ruta y método deben corresponder a una operación de la definición de OpenAPI de la API.

Sintaxis

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

YAML

Auth: ApiStateMachineAuth Method: String Path: String RestApiId: String

Properties

Auth

Configuración de autorización de esta API, ruta y método.

Utilice esta propiedad para anular losDefaultAuthorizerconfiguración de una ruta individual, cuando noDefaultAuthorizerespecificada o anular los valores predeterminadosApiKeyRequiredconfiguración de.

Type: Auth de máquina APIsta

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.

Type: Cadena

Obligatorio: Sí

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

Path

Ruta de URI para la que se invoca esta función. El valor debe comenzar por/.

Type: Cadena

Obligatorio: Sí

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

RestApiId

El identificador de unRestApirecurso, que debe contener una operación con la ruta y el método dados. Normalmente, esto se establece para hacer referencia aAWS::Serverless::Apirecurso que se define en esta plantilla.

Si no define esta propiedad,AWS SAMcrea un valor predeterminadoAWS::Serverless::Apirecurso mediante un generadoOpenApino válido. Ese recurso contiene una unión de todas las rutas y métodos definidos porApieventos de la misma plantilla que no especifican unRestApiId.

Esta propiedad no puede hacer referencia aAWS::Serverless::Apirecurso que se define en otra plantilla.

Type: Cadena

Obligatorio: No

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

Ejemplos

Evento API

A continuación se muestra un ejemplo de un evento deApi.

YAML

Events: ApiEvent: Type: Api Properties: Path: /path Method: get RequestParameters: - method.request.header.Authorization