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.

Si aucune AWS::Serverless::Api n'est définie, l'entrée et la sortie de la fonction sont une représentation de la demande HTTP et de la réponse HTTP.

Par exemple, à l'aide de l' JavaScript API, le code d'état et le corps de la réponse peuvent être contrôlés en renvoyant un objet avec les clés statusCode et body.

Syntaxe

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

YAML

  Auth: ApiFunctionAuth
  Method: String
  Path: String
  RequestModel: RequestModel
  RequestParameters: List of [ String | RequestParameter ]
  RestApiId: String
  TimeoutInMillis: Integer

Propriétés

Auth

Configuration d'authentification pour cette méthode Api+Chemin+Méthode spécifique.

Utile pour remplacer la configuration d'autorisation du paramètre de DefaultAuthorizer de l'API sur un chemin d'accès individuel, lorsqu'aucun DefaultAuthorizer n'est spécifié, ou pour remplacer le paramètre ApiKeyRequired par défaut.

Type : ApiFunctionAuth

Obligatoire : non

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

Method

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

Chemin d'accès d'URI pour lequel cette fonction est appelée. 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.

RequestModel

Demander un modèle à utiliser pour cette formule Api+Chemin+Méthode spécifique. Cela devrait faire référence au nom d'un modèle spécifié dans la section Models d'une ressource AWS::Serverless::Api.

Type : RequestModel

Obligatoire : non

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

RequestParameters

Configuration des paramètres de demande pour cette formule Api+Chemin+Méthode spécifique. Tous les noms de paramètres doivent commencer par method.request et doivent être limités à method.request.header, method.request.querystring, ou method.request.path.

Une liste peut contenir à la fois des chaînes de noms de paramètres et RequestParameterdes objets. Pour les chaînes, les propriétés Required et Caching prendront par défaut la valeur false.

Type : Liste de [String | RequestParameter]

Obligatoire : non

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

RestApiId

Identifiant d'une RestApi ressource, 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.

Cela ne peut pas référencer une ressource AWS::Serverless::Api 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.

TimeoutInMillis

Délai d'attente personnalisé compris entre 50 et 29 000 millisecondes.

Note

Lorsque vous spécifiez cette propriété, cela AWS SAM modifie votre définition OpenAPI. La définition OpenAPI doit être spécifiée en ligne à l'aide de la propriété DefinitionBody.

Type : entier

Obligatoire : non

Par défaut : 29 000 millisecondes ou 29 secondes

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

Exemples

Exemple de base

YAML

Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
      RequestParameters:
        - method.request.header.Authorization
        - method.request.querystring.keyword:
            Required: true
            Caching: false