Api

L'objet décrivant un type de source d'événement Api. Si une ressource AWS::Serverless::Api est définie, les valeurs de chemin d'accès et de méthode doivent correspondre à une opération dans la définition OpenAPI de l'API.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

Auth

La configuration d'autorisation pour cette API, ce chemin d'accès et cette méthode.

Utilisez cette propriété pour remplacer la propriété DefaultAuthorizer pour un chemin d'accès individuel, lorsqu'aucun DefaultAuthorizer n'est spécifié, ou pour remplacer le réglage ApiKeyRequired par défaut.

Type : ApiStateMachineAuth

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Method

La méthode HTTP pour laquelle cette fonction est appelée.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Path

Le chemin d'accès d'URI pour lequel cette fonction est appelée. La valeur doit commencer par /.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

RestApiId

L'identificateur d'une ressource RestApi, qui doit contenir une opération avec le chemin et la méthode donnés. Cela est généralement défini pour faire référence à une ressource AWS::Serverless::Api qui est définie dans ce modèle.

Si vous ne définissez pas cette propriété, AWS SAM crée une AWS::Serverless::Api ressource par défaut à l'aide d'un OpenApi document généré. Cette ressource contient une union de tous les chemins et méthodes définis par Api dans le même modèle qui ne spécifient pas un RestApiId.

Cette propriété ne peut pas faire référence à une ressource AWS::Serverless::Api qui est définie dans un autre modèle.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

UnescapeMappingTemplate

Élimine les guillemets simples, en remplaçant \' par ', sur l'entrée transmise à la machine d'état. À utiliser lorsque votre entrée contient des guillemets simples.

Note

Si ce paramètre est défini sur False et que votre entrée contient des guillemets simples, une erreur se produira.

Type : valeur booléenne

Obligatoire : non

Par défaut : False

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

ApiEvent

Voici un exemple d'un événement du type Api.

YAML

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