Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Configura un dominio personalizado para una API.

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

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

### 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
```

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

 `BasePath`   <a name="sam-httpapi-httpapidomainconfiguration-basepath"></a>
Una lista de las rutas base que se deben configurar con el nombre de dominio de Amazon API Gateway.  
*Tipo*: lista  
*Obligatorio*: no  
*Valor predeterminado*: /  
*CloudFormation compatibilidad*: esta propiedad es similar a la `[ApiMappingKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey)` propiedad de un `AWS::ApiGatewayV2::ApiMapping` recurso. AWS SAM crea varios `AWS::ApiGatewayV2::ApiMapping` recursos, uno por cada valor especificado en esta propiedad.

 `CertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-certificatearn"></a>
El nombre de recurso de Amazon (ARN) de un certificado AWS administrado para el punto final de este nombre de dominio. AWS Certificate Manager es la única fuente compatible.  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn)` propiedad de un `AWS::ApiGateway2::DomainName DomainNameConfiguration` recurso.

 `DomainName`   <a name="sam-httpapi-httpapidomainconfiguration-domainname"></a>
El nombre de dominio personalizado para su API de API Gateway. No se admiten letras mayúsculas.  
AWS SAM genera un `AWS::ApiGatewayV2::DomainName` recurso cuando se establece esta propiedad. Para obtener información acerca de esta situación, consulta [DomainName se especifica la propiedad](sam-specification-generated-resources-httpapi.md#sam-specification-generated-resources-httpapi-domain-name). Para obtener información sobre CloudFormation los recursos generados, consulte[CloudFormation Recursos generados para AWS SAM](sam-specification-generated-resources.md).  
*Tipo:* cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname)` propiedad de un `AWS::ApiGateway2::DomainName` recurso.

 `EndpointConfiguration`   <a name="sam-httpapi-httpapidomainconfiguration-endpointconfiguration"></a>
Define el tipo de punto de conexión de API Gateway que se va a asignar al dominio personalizado. El valor de esta propiedad determina cómo se mapea la `CertificateArn` propiedad. CloudFormation  
El único valor válido para HTTP APIs es`REGIONAL`.  
*Tipo:* cadena  
*Obligatorio*: no  
*Valor predeterminado*: `REGIONAL`  
*CloudFormation compatibilidad*: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

 `MutualTlsAuthentication`   <a name="sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication"></a>
La configuración de autenticación mutua de seguridad de la capa de transporte (TLS) para un nombre de dominio personalizado.  
*Tipo:* [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)` propiedad de un `AWS::ApiGatewayV2::DomainName` recurso.

 `OwnershipVerificationCertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn"></a>
El ARN del certificado público emitido por ACM para validar la propiedad de su dominio personalizado. Solo se requiere cuando se configura TLS mutua y se especifica un ARN de certificado de CA privado o importado de ACM para `CertificateArn`.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn)` propiedad del tipo de `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` datos.

 `Route53`   <a name="sam-httpapi-httpapidomainconfiguration-route53"></a>
Define una configuración de Amazon Route 53.  
*Tipo*: [Route53Configuration](sam-property-httpapi-route53configuration.md)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es exclusiva AWS SAM y no tiene un CloudFormation equivalente.

 `SecurityPolicy`   <a name="sam-httpapi-httpapidomainconfiguration-securitypolicy"></a>
La versión TLS de la política de seguridad para este nombre de dominio.  
El único valor válido para HTTP APIs es`TLS_1_2`.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy)` propiedad del tipo de `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` datos.

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

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

DomainName ejemplo

#### 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
```