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.

# CloudFormation ressources générées lorsque cela AWS::Serverless::WebSocketApi est spécifié
<a name="sam-specification-generated-resources-websocketapi"></a>

Lorsqu'un `AWS::Serverless::WebSocketApi` est spécifié, AWS Serverless Application Model (AWS SAM) génère une CloudFormation ressource `AWS::ApiGatewayV2::Api` de base. En outre, il génère toujours une `AWS::ApiGatewayV2::Stage` ressource et, pour chaque itinéraire défini dans la `Routes` propriété `AWS::ApiGatewayV2::Route``AWS::ApiGatewayV2::Integration`, AWS SAM génère des `AWS::Lambda::Permission` ressources.

**`AWS::ApiGatewayV2::Api`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}`  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

**`AWS::ApiGatewayV2::Stage`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<stage‑name>}}Stage`  
`{{<stage‑name>}}` est la chaîne sur laquelle la propriété `StageName` est définie. Si `StageName` ce n'est pas spécifié, la valeur par défaut est`default`. Par exemple, si vous définissez `StageName` sur `prod`, le `LogicalId` est `{{MyWebSocketApi}}prodStage`.  
*Propriété référençable :*`{{<websocketapi‑LogicalId>}}.Stage`

**`AWS::ApiGatewayV2::Route`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Route`  
`{{<normalized‑route‑key>}}`est la clé de route dont les caractères spéciaux ont été supprimés. Par exemple, pour la clé de route`$connect`, le `LogicalId` est`{{MyWebSocketApi}}connectRoute`.  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

**`AWS::ApiGatewayV2::Integration`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Integration`  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

**`AWS::Lambda::Permission`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<normalized‑route‑key>}}Permission`  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

Outre ces CloudFormation ressources, lorsqu'elles `AWS::Serverless::WebSocketApi` sont spécifiées, elles génèrent AWS SAM également CloudFormation des ressources pour les scénarios suivants :

**Topics**
+ [La propriété d'authentification est spécifiée et définie AuthType sur CUSTOM](#sam-specification-generated-resources-websocketapi-auth)
+ [DomainName la propriété est spécifiée](#sam-specification-generated-resources-websocketapi-domain-name)
+ [BasePath la propriété est spécifiée](#sam-specification-generated-resources-websocketapi-basepath)
+ [La propriété Route53 est spécifiée](#sam-specification-generated-resources-websocketapi-route53)

## La propriété d'authentification est spécifiée et définie AuthType sur CUSTOM
<a name="sam-specification-generated-resources-websocketapi-auth"></a>

Lorsque la `Auth` propriété de an `AWS::Serverless::WebSocketApi` est spécifiée avec `AuthType` set to`CUSTOM`, AWS SAM génère une `AWS::ApiGatewayV2::Authorizer` CloudFormation ressource. Si `InvokeRole` ce n'est pas spécifié, génère AWS SAM également une `AWS::Lambda::Permission` ressource pour permettre à API Gateway d'invoquer la fonction d'autorisation.

**`AWS::ApiGatewayV2::Authorizer`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}Authorizer`  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

**`AWS::Lambda::Permission`(quand n'`InvokeRole`est pas précisé)**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}AuthorizerPermission`  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

## DomainName la propriété est spécifiée
<a name="sam-specification-generated-resources-websocketapi-domain-name"></a>

Lorsque la `DomainName` propriété de la `Domain` propriété de an `AWS::Serverless::WebSocketApi` est spécifiée, AWS SAM génère la `AWS::ApiGatewayV2::DomainName` CloudFormation ressource.

**`AWS::ApiGatewayV2::DomainName`**  
*`LogicalId`: *`ApiGatewayDomainNameV2{{<sha>}}`  
`{{<sha>}}` est une valeur de hachage unique qui est générée lors de la création de la pile. Par exemple : `ApiGatewayDomainNameV2{{926eeb5ff1}}`.  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

## BasePath la propriété est spécifiée
<a name="sam-specification-generated-resources-websocketapi-basepath"></a>

Lorsque la `BasePath` propriété de la `Domain` propriété de an `AWS::Serverless::WebSocketApi` est spécifiée, AWS SAM génère `AWS::ApiGatewayV2::ApiMapping` CloudFormation des ressources, une pour chaque chemin de base spécifié.

**`AWS::ApiGatewayV2::ApiMapping`**  
*`LogicalId`: *`{{<websocketapi‑LogicalId>}}{{<basepath>}}ApiMapping`  
`{{<basepath>}}`est la valeur du chemin de base. Par exemple, si vous le spécifiez `v1` comme chemin de base, le `LogicalId` est`{{MyWebSocketApi}}v1ApiMapping`.  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)

## La propriété Route53 est spécifiée
<a name="sam-specification-generated-resources-websocketapi-route53"></a>

Lorsque la `Route53` propriété de la `Domain` propriété de an `AWS::Serverless::WebSocketApi` est spécifiée, AWS SAM génère une `AWS::Route53::RecordSetGroup` CloudFormation ressource.

**`AWS::Route53::RecordSetGroup`**  
*`LogicalId`: *`RecordSetGroup{{<sha>}}`  
`{{<sha>}}` est une valeur de hachage unique qui est générée lors de la création de la pile. Par exemple : `RecordSetGroup{{926eeb5ff1}}`.  
*Propriété référençable :* N/A (vous devez utiliser le `LogicalId` pour référencer cette CloudFormation ressource)