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.

# HttpApiDomainConfiguration
<a name="sam-property-httpapi-httpapidomainconfiguration"></a>

Configure un domaine personnalisé pour une API.

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

```
  [BasePath](#sam-httpapi-httpapidomainconfiguration-basepath): List
  [CertificateArn](#sam-httpapi-httpapidomainconfiguration-certificatearn): String
  [DomainName](#sam-httpapi-httpapidomainconfiguration-domainname): String
  [EndpointConfiguration](#sam-httpapi-httpapidomainconfiguration-endpointconfiguration): String
  [MutualTlsAuthentication](#sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)
  [OwnershipVerificationCertificateArn](#sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn): String
  [Route53](#sam-httpapi-httpapidomainconfiguration-route53): Route53Configuration
  [SecurityPolicy](#sam-httpapi-httpapidomainconfiguration-securitypolicy): String
```

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

 `BasePath`   <a name="sam-httpapi-httpapidomainconfiguration-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-httpapi-httpapidomainconfiguration-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::ApiGateway2::DomainName DomainNameConfiguration` ressource.

 `DomainName`   <a name="sam-httpapi-httpapidomainconfiguration-domainname"></a>
Le nom de domaine personnalisé pour votre API dans Amazon 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 ce scénario, consultez [DomainName la propriété est spécifiée](sam-specification-generated-resources-httpapi.md#sam-specification-generated-resources-httpapi-domain-name). 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::ApiGateway2::DomainName` ressource.

 `EndpointConfiguration`   <a name="sam-httpapi-httpapidomainconfiguration-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 HTTP 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.

 `MutualTlsAuthentication`   <a name="sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication"></a>
La configuration d'authentification de protocole TLS (Transport Layer Security) mutuelle pour un nom de domaine personnalisé.  
*Type :* [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)` propriété d'une `AWS::ApiGatewayV2::DomainName` ressource.

 `OwnershipVerificationCertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn"></a>
 ARN du certificat public que vous avez généré dans pour valider la propriété de votre domaine personnalisé. Obligatoire uniquement lorsque vous configurez le protocole TLS mutuel et que vous précisez un ARN de certificat d'autorité de certification privé ou importé ACM pour le `CertificateArn`.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn)` propriété du type de `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` données.

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

 `SecurityPolicy`   <a name="sam-httpapi-httpapidomainconfiguration-securitypolicy"></a>
La version TLS de la stratégie de sécurité pour ce nom de domaine.  
La seule valeur valide pour HTTP 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-httpapi-httpapidomainconfiguration--examples"></a>

### DomainName
<a name="sam-property-httpapi-httpapidomainconfiguration--examples--domainname"></a>

DomainName exemple

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

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: REGIONAL
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
  BasePath:
    - foo
    - bar
```