

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

# Route53Configuration
<a name="sam-property-httpapi-route53configuration"></a>

Configura los conjuntos de registros de Route53 para una API.

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

```
  [DistributionDomainName](#sam-httpapi-route53configuration-distributiondomainname): String
  [EvaluateTargetHealth](#sam-httpapi-route53configuration-evaluatetargethealth): Boolean
  [HostedZoneId](#sam-httpapi-route53configuration-hostedzoneid): String
  [HostedZoneName](#sam-httpapi-route53configuration-hostedzonename): String
  [IpV6](#sam-httpapi-route53configuration-ipv6): Boolean
  Region: String
  SetIdentifier: String
```

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

 `DistributionDomainName`   <a name="sam-httpapi-route53configuration-distributiondomainname"></a>
Configura una distribución personalizada del nombre de dominio personalizado de la API.  
*Tipo:* cadena  
*Obligatorio*: no  
*Predeterminado*: utilice la distribución de API Gateway.  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname)` propiedad de un `AWS::Route53::RecordSetGroup AliasTarget` recurso.  
*Notas adicionales*: El nombre de dominio de una [CloudFrontdistribución](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).

 `EvaluateTargetHealth`   <a name="sam-httpapi-route53configuration-evaluatetargethealth"></a>
Si EvaluateTargetHealth es verdadero, un registro de alias hereda el estado del AWS recurso al que se hace referencia, como un balanceador de cargas de Elastic Load Balancing u otro registro de la zona alojada.  
*Tipo*: Booleano  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)` propiedad de un `AWS::Route53::RecordSetGroup AliasTarget` recurso.  
*Notas adicionales*: No se puede EvaluateTargetHealth establecer en true cuando el alias objetivo es una CloudFront distribución.

 `HostedZoneId`   <a name="sam-httpapi-route53configuration-hostedzoneid"></a>
ID de la zona alojada en la que desea crear registros.  
Especifica `HostedZoneName` o `HostedZoneId`, pero no ambos. Si tiene múltiples zonas hospedadas con el mismo nombre de dominio, debe especificar la zona hospedada mediante `HostedZoneId`.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid)` propiedad de un `AWS::Route53::RecordSetGroup RecordSet` recurso.

 `HostedZoneName`   <a name="sam-httpapi-route53configuration-hostedzonename"></a>
El nombre de la zona alojada en la que desea crear registros. Debe incluir un punto final (por ejemplo, `www.example.com.`) como parte del `HostedZoneName`.  
Especifica `HostedZoneName` o `HostedZoneId`, pero no ambos. Si tiene múltiples zonas hospedadas con el mismo nombre de dominio, debe especificar la zona hospedada mediante `HostedZoneId`.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename)` propiedad de un `AWS::Route53::RecordSetGroup RecordSet` recurso.

 `IpV6`   <a name="sam-httpapi-route53configuration-ipv6"></a>
Cuando se establece esta propiedad, AWS SAM crea un `AWS::Route53::RecordSet` recurso y establece [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type) en `AAAA` el valor proporcionado HostedZone.  
*Tipo*: Booleano  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.

`Region`  <a name="sam-httpapi-route53configuration-region"></a>
*Solo conjuntos de registros de recursos basados en la latencia: la* EC2 región de Amazon en la que creó el recurso al que hace referencia este conjunto de registros de recursos. El recurso suele ser un AWS recurso, como una EC2 instancia o un balanceador de cargas ELB, y se hace referencia a él mediante una dirección IP o un nombre de dominio DNS, según el tipo de registro.  
Cuando Amazon Route 53 recibe una consulta de DNS para un nombre y un tipo de dominio para los que ha creado conjuntos de registros de recursos de latencia, Route 53 selecciona el conjunto de registros de recursos de latencia que tiene la latencia más baja entre el usuario final y la EC2 región de Amazon asociada. Route 53 devuelve a continuación el valor asociado con el conjunto de registros de recursos seleccionados.  
Tenga en cuenta lo siguiente:  
+ Solo puede especificar un `ResourceRecord` por conjunto de registros de recursos de latencia.
+ Solo puedes crear un conjunto de registros de recursos de latencia para cada EC2 región de Amazon.
+ No es necesario que crees conjuntos de registros de recursos de latencia para todas las EC2 regiones de Amazon. Route 53 elige la región con la mejor latencia entre las regiones para las que crea conjuntos de registros de recursos de latencia.
+ No puede crear conjuntos de registros de recursos sin latencia que tengan los mismos valores `Name` y `Type` que los conjuntos de registros de recursos de latencia.
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[ Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-region)` propiedad de un tipo de `AWS::Route53::RecordSetGroup` `RecordSet` datos.

`SetIdentifier`  <a name="sam-httpapi-route53configuration-setidentifier"></a>
*Conjuntos de registros de recursos que tienen una política de direccionamiento que no es simple:* Un identificador que diferencia entre varios conjuntos de registros de recursos con la misma combinación de nombre y tipo, como varios conjuntos de registros de recursos ponderados denominados acme.example.com de tipo A. En un grupo de conjuntos de registros de recursos que tengan el mismo nombre y tipo, el valor de `SetIdentifier` debe ser exclusivo para cada conjunto de registros de recursos.  
Para obtener información sobre cómo dirigir las políticas, consulta [Elección de una política de direccionamiento](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) en la *Guía para desarrolladores de Amazon Route 53*.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ SetIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-setidentifier)` propiedad de un tipo de `AWS::Route53::RecordSetGroup` `RecordSet` datos.

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

### Ejemplo de configuración de Route 53
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example"></a>

En este ejemplo se muestra cómo configurar Route 53.

#### YAML
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example--yaml"></a>

```
Domain:
  DomainName: www.example.com
  CertificateArn: arn-example
  EndpointConfiguration: EDGE
  Route53:
    HostedZoneId: Z1PA6795UKMFR9
    EvaluateTargetHealth: true
    DistributionDomainName: xyz
```