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

Api

El objeto que describe un tipo de fuente de evento de Api. Si se define un recurso AWS::Serverless::Api, 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 su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

  Auth: ApiStateMachineAuth
  Method: String
  Path: String
  RestApiId: String
  UnescapeMappingTemplate: Boolean

Propiedades

Auth

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

Usa esta propiedad para anular la configuración DefaultAuthorizer de la API para una ruta individual, si no se especifica DefaultAuthorizer, o para anular la configuración de ApiKeyRequired predeterminada.

Tipo: apiStateMachineAuth

Obligatorio: no

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

Method

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

Tipo: cadena

Obligatorio: sí

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

Path

La ruta URI para la que se invoca esta función. El valor debe empezar por /.

Tipo: cadena

Obligatorio: sí

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

RestApiId

El identificador de un recurso RestApi, que debe contener una operación con la ruta y el método dados. Normalmente, se configura para hacer referencia a un recurso AWS::Serverless::Api definido en esta plantilla.

Si no define esta propiedad, AWS SAM crea un recurso AWS::Serverless::Api predeterminado a partir de un documento OpenApi generado. Ese recurso contiene una unión de todas las rutas y métodos definidos por eventos Api de la misma plantilla que no especifican un RestApiId.

Esta propiedad no puede hacer referencia a un recurso AWS::Serverless::Api definido en otra plantilla.

Tipo: cadena

Obligatorio: no

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

UnescapeMappingTemplate

Evita las comillas simples, sustituyendo \' por ', en la entrada que se pasa a la máquina de estados. Haga esto cuando la entrada contenga comillas simples.

nota

Si se establece en False y la entrada contiene comillas simples, se producirá un error.

Tipo: Booleano

Obligatorio: no

Valor predeterminado: False

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

Ejemplos

ApiEvent

A continuación, se muestra un ejemplo de un evento tipo Api.

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get