Api

L'oggetto che descrive un tipo di origine Api dell'evento. Se viene definita una AWS::Serverless::Api risorsa, i valori del percorso e del metodo devono corrispondere a un'operazione nella definizione OpenAPI dell'API.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

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

Proprietà

Auth

La configurazione di autorizzazione per questa API, percorso e metodo.

Utilizzate questa proprietà per sovrascrivere l'DefaultAuthorizerimpostazione dell'API per un singolo percorso, quando non DefaultAuthorizer è specificato nessuno, o per sovrascrivere l'impostazione predefinitaApiKeyRequired.

Tipo: ApiStateMachineAuth

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Method

Il metodo HTTP per cui viene richiamata questa funzione.

▬Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Path

Il percorso URI per il quale viene richiamata questa funzione. Il valore deve iniziare con/.

▬Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

RestApiId

L'identificatore di una RestApi risorsa, che deve contenere un'operazione con il percorso e il metodo indicati. In genere, è impostato per fare riferimento a una AWS::Serverless::Api risorsa definita in questo modello.

Se non definisci questa proprietà, AWS SAM crea una AWS::Serverless::Api risorsa predefinita utilizzando un OpenApi documento generato. Tale risorsa contiene un'unione di tutti i percorsi e i metodi definiti dagli Api eventi nello stesso modello che non specificano aRestApiId.

Questa proprietà non può fare riferimento a una AWS::Serverless::Api risorsa definita in un altro modello.

▬Tipo: stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

UnescapeMappingTemplate

Rimuove le virgolette singole, sostituendole \' con', sull'input passato alla macchina a stati. Da utilizzare quando l'input contiene virgolette singole.

Nota

Se è impostato su False e l'input contiene virgolette singole, si verificherà un errore.

Tipo: Booleano

Required: No

Impostazione predefinita: False

AWS CloudFormation compatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

Esempi

ApiEvent

Di seguito è riportato un esempio di evento del Api tipo.

YAML

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