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.

# HttpApi
<a name="sam-property-function-httpapi"></a>

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
<a name="sam-property-function-httpapi-syntax"></a>

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

### YAML
<a name="sam-property-function-httpapi-syntax.yaml"></a>

```
  [ApiId](#sam-function-httpapi-apiid): String
  [Auth](#sam-function-httpapi-auth): HttpApiFunctionAuth
  [Method](#sam-function-httpapi-method): String
  [Path](#sam-function-httpapi-path): String
  [PayloadFormatVersion](#sam-function-httpapi-payloadformatversion): String
  [RouteSettings](#sam-function-httpapi-routesettings): [RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)
  [TimeoutInMillis](#sam-function-httpapi-timeoutinmillis): Integer
```

## Propriétés
<a name="sam-property-function-httpapi-properties"></a>

 `ApiId`   <a name="sam-function-httpapi-apiid"></a>
Identificateur d'une ressource [AWS::Serverless::HttpApi](sam-resource-httpapi.md) définie dans ce modèle.  
Si elle n'est pas définie, une [AWS::Serverless::HttpApi](sam-resource-httpapi.md) 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 de`ApiId`.  
Cela ne peut pas référencer une ressource [AWS::Serverless::HttpApi](sam-resource-httpapi.md) définie dans un autre modèle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Auth`   <a name="sam-function-httpapi-auth"></a>
Configuration d'authentification pour cette méthode Api\$1Chemin\$1Mé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é.  
*Type :* [HttpApiFunctionAuth](sam-property-function-httpapifunctionauth.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Method`   <a name="sam-function-httpapi-method"></a>
Méthode HTTP pour laquelle cette fonction est appelée.  
 \$1Si non`Path`and`Method`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  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Path`   <a name="sam-function-httpapi-path"></a>
Chemin d'accès d'URI pour lequel cette fonction est appelée. Doit commencer par `/`.  
Si aucun `Path` et `Method` 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  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `PayloadFormatVersion`   <a name="sam-function-httpapi-payloadformatversion"></a>
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  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `RouteSettings`   <a name="sam-function-httpapi-routesettings"></a>
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 RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html)le *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` propriété d'une `AWS::ApiGatewayV2::Stage` ressource.

 `TimeoutInMillis`   <a name="sam-function-httpapi-timeoutinmillis"></a>
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  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

## Exemples
<a name="sam-property-function-httpapi--examples"></a>

### HttpApi Événement par défaut
<a name="sam-property-function-httpapi--examples--default-httpapi-event"></a>

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
<a name="sam-property-function-httpapi--examples--default-httpapi-event--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
```

### HttpApi
<a name="sam-property-function-httpapi--examples--httpapi"></a>

HttpApi Evénement utilisant un chemin et une méthode spécifiques.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /
      Method: GET
```

### HttpApi Autorisation
<a name="sam-property-function-httpapi--examples--httpapi-authorization"></a>

HttpApi Événement utilisant un autorisateur.

#### YAML
<a name="sam-property-function-httpapi--examples--httpapi-authorization--yaml"></a>

```
Events:
  HttpApiEvent:
    Type: HttpApi
    Properties:
      Path: /authenticated
      Method: GET
      Auth:
        Authorizer: OpenIdAuth
        AuthorizationScopes:
          - scope1
          - scope2
```