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.

# WebSocketApiDomainConfiguration
<a name="sam-property-websocketapi-websocketapidomainconfiguration"></a>

Configure un domaine personnalisé pour une WebSocket API.

## Syntaxe
<a name="sam-property-websocketapi-websocketapidomainconfiguration-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-websocketapi-websocketapidomainconfiguration-syntax.yaml"></a>

```
  [BasePath](#sam-websocketapi-websocketapidomainconfiguration-basepath): {{List}}
  [CertificateArn](#sam-websocketapi-websocketapidomainconfiguration-certificatearn): {{String}}
  [DomainName](#sam-websocketapi-websocketapidomainconfiguration-domainname): {{String}}
  [EndpointConfiguration](#sam-websocketapi-websocketapidomainconfiguration-endpointconfiguration): {{String}}
  [Route53](#sam-websocketapi-websocketapidomainconfiguration-route53): {{Route53Configuration}}
  [SecurityPolicy](#sam-websocketapi-websocketapidomainconfiguration-securitypolicy): {{String}}
```

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

 `BasePath`   <a name="sam-websocketapi-websocketapidomainconfiguration-basepath"></a>
Une liste des chemins de base à configurer avec le nom de domaine Amazon API Gateway.  
*Type* : liste  
*Obligatoire* : non  
*Par défaut* : /  
*CloudFormation compatibilité* : cette propriété est similaire à celle `[ApiMappingKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey)` d'une `AWS::ApiGatewayV2::ApiMapping` ressource. AWS SAM crée plusieurs `AWS::ApiGatewayV2::ApiMapping` ressources, une par valeur spécifiée dans cette propriété.

 `CertificateArn`   <a name="sam-websocketapi-websocketapidomainconfiguration-certificatearn"></a>
Le nom de ressource Amazon (ARN) d'un certificat AWS géré pour le point de terminaison de ce nom de domaine. AWS Certificate Manager est la seule source prise en charge.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn)` propriété d'une `AWS::ApiGatewayV2::DomainName DomainNameConfiguration` ressource.

 `DomainName`   <a name="sam-websocketapi-websocketapidomainconfiguration-domainname"></a>
Le nom de domaine personnalisé de votre API WebSocket API Gateway. Les majuscules ne sont pas prises en charge.  
AWS SAM génère une `AWS::ApiGatewayV2::DomainName` ressource lorsque cette propriété est définie. Pour plus d'informations sur CloudFormation les ressources générées, consultez[CloudFormation Ressources générées pour AWS SAM](sam-specification-generated-resources.md).  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname)` propriété d'une `AWS::ApiGatewayV2::DomainName` ressource.

 `EndpointConfiguration`   <a name="sam-websocketapi-websocketapidomainconfiguration-endpointconfiguration"></a>
Définit le type de point de terminaison API Gateway à mapper au domaine personnalisé. La valeur de cette propriété détermine la manière dont la `CertificateArn` propriété est mappée CloudFormation.  
La seule valeur valide pour WebSocket APIs est`REGIONAL`.  
*Type* : chaîne  
*Obligatoire* : non  
*Par défaut* : `REGIONAL`  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Route53`   <a name="sam-websocketapi-websocketapidomainconfiguration-route53"></a>
Définit une configuration Route 53.  
*Type* : [Route53Configuration](sam-property-websocketapi-route53configuration.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `SecurityPolicy`   <a name="sam-websocketapi-websocketapidomainconfiguration-securitypolicy"></a>
La version TLS de la stratégie de sécurité pour ce nom de domaine.  
La seule valeur valide pour WebSocket APIs est`TLS_1_2`.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy)` propriété du type de `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` données.

## Exemples
<a name="sam-property-websocketapi-websocketapidomainconfiguration--examples"></a>

### DomainName
<a name="sam-property-websocketapi-websocketapidomainconfiguration--examples--domainname"></a>

DomainName exemple

#### YAML
<a name="sam-property-websocketapi-websocketapidomainconfiguration--examples--domainname--yaml"></a>

```
Domain:
  DomainName: ws.example.com
  CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - v1
    - v2
```