Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
L'objet décrivant une source d'événement avec type HttpApi.
Si une OpenApi définition du chemin et de la méthode spécifiés existe dans l'API, SAM ajoutera la section Intégration et sécurité Lambda (le cas échéant) pour vous.
Si aucune OpenApi définition pour le chemin et la méthode spécifiés n'existe dans l'API, SAM créera cette définition pour vous.
Syntaxe
Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.
YAML
ApiId: String
Auth: HttpApiFunctionAuth
Method: String
Path: String
PayloadFormatVersion: String
RouteSettings: RouteSettings
TimeoutInMillis: Integer
Propriétés
-
ApiId
-
Identificateur d'une ressource AWS::Serverless::HttpApi définie dans ce modèle.
Si elle n'est pas définie, une AWS::Serverless::HttpApi ressource par défaut est créée appelée à
ServerlessHttpApi
l'aide d'un OpenApi document généré contenant une union de tous les chemins et méthodes définis par les événements Api définis dans ce modèle qui ne spécifient pas deApiId
.Cela ne peut pas référencer une ressource AWS::Serverless::HttpApi 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.
-
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'aucunDefaultAuthorizer
n'est spécifié.Type : HttpApiFunctionAuth
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.
$Si non
Path
andMethod
sont spécifiés, SAM créera un chemin d'API par défaut qui achemine toute requête qui ne mappe pas à un autre point de terminaison vers cette fonction Lambda. Seul un de ces chemins par défaut peut exister par API.Type : chaîne
Obligatoire : non
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
/
.Si aucun
Path
etMethod
ne sont spécifiés, SAM créera un chemin d'API par défaut qui acheminera toute demande qui ne mappe pas à un autre point de terminaison vers cette fonction Lambda. Seul un de ces chemins par défaut peut exister par API.Type : chaîne
Obligatoire : non
AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.
-
PayloadFormatVersion
-
Spécifie le format de la charge utile envoyée à une intégration.
REMARQUE : PayloadFormatVersion nécessite que SAM modifie votre définition d'OpenAPI, de sorte que cela ne fonctionne qu'avec les éléments en ligne OpenApi définis dans la propriété.
DefinitionBody
Type : chaîne
Obligatoire : non
Par défaut : 2.0
AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.
-
RouteSettings
-
Les paramètres d'acheminement par acheminement pour cette API HTTP. Pour plus d'informations sur les paramètres d'itinéraire, consultez AWS::ApiGatewayV2::Stage RouteSettingsle guide du développeur d'API Gateway.
Remarque : S' RouteSettings ils sont spécifiés à la fois dans la source de HttpApi ressource et dans la source d'événement, AWS SAM fusionnez-les avec les propriétés de la source d'événements prioritaires.
Type : RouteSettings
Obligatoire : non
AWS CloudFormation compatibilité : cette propriété est transmise directement à la
RouteSettings
propriété d'uneAWS::ApiGatewayV2::Stage
ressource. -
TimeoutInMillis
-
Délai d'attente personnalisé compris entre 50 et 29 000 millisecondes.
REMARQUE : TimeoutInMillis nécessite que SAM modifie votre définition d'OpenAPI, de sorte que cela ne fonctionne qu'avec les éléments en ligne OpenApi définis dans la propriété.
DefinitionBody
Type : entier
Obligatoire : non
Par défaut : 5000
AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.
Exemples
HttpApi Événement par défaut
HttpApi Evénement utilisant le chemin par défaut. Tous les chemins d‘accès et méthodes non mappés sur cette API seront acheminés vers ce point de terminaison.
YAML
Events:
HttpApiEvent:
Type: HttpApi
HttpApi
HttpApi Evénement utilisant un chemin et une méthode spécifiques.
YAML
Events:
HttpApiEvent:
Type: HttpApi
Properties:
Path: /
Method: GET
HttpApi Autorisation
HttpApi Événement qui utilise un autorisateur.
YAML
Events:
HttpApiEvent:
Type: HttpApi
Properties:
Path: /authenticated
Method: GET
Auth:
Authorizer: OpenIdAuth
AuthorizationScopes:
- scope1
- scope2