As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Configura um domínio personalizado para uma API.

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

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

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

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

 `BasePath`   <a name="sam-httpapi-httpapidomainconfiguration-basepath"></a>
Uma lista dos caminhos básicos a serem configurados com o nome de domínio do Amazon API Gateway.  
*Tipo*: lista  
*Obrigatório*: não  
*Padrão*: /  
*CloudFormation compatibilidade*: essa propriedade é semelhante à `[ApiMappingKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey)` propriedade de um `AWS::ApiGatewayV2::ApiMapping` recurso. AWS SAM cria vários `AWS::ApiGatewayV2::ApiMapping` recursos, um por valor especificado nessa propriedade.

 `CertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-certificatearn"></a>
O Amazon Resource Name (ARN) de um certificado AWS gerenciado para o endpoint desse nome de domínio. AWS Certificate Manager é a única fonte compatível.  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn)` propriedade de um `AWS::ApiGateway2::DomainName DomainNameConfiguration` recurso.

 `DomainName`   <a name="sam-httpapi-httpapidomainconfiguration-domainname"></a>
O nome de domínio personalizado para a sua API Gateway API. Letras maiúsculas não são compatíveis.  
AWS SAM gera um `AWS::ApiGatewayV2::DomainName` recurso quando essa propriedade é definida. Para obter informações sobre esse cenário, consulte [DomainName propriedade é especificada](sam-specification-generated-resources-httpapi.md#sam-specification-generated-resources-httpapi-domain-name). Para obter informações sobre CloudFormation os recursos gerados, consulte[CloudFormation Recursos gerados para AWS SAM](sam-specification-generated-resources.md).  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname)` propriedade de um `AWS::ApiGateway2::DomainName` recurso.

 `EndpointConfiguration`   <a name="sam-httpapi-httpapidomainconfiguration-endpointconfiguration"></a>
Define o tipo de endpoint do API Gateway a ser mapeado para o domínio personalizado. O valor dessa propriedade determina como a `CertificateArn` propriedade é mapeada CloudFormation.  
O único valor válido para HTTP APIs é`REGIONAL`.  
*Tipo:* string  
*Obrigatório*: não  
*Padrão*: `REGIONAL`  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `MutualTlsAuthentication`   <a name="sam-httpapi-httpapidomainconfiguration-mutualtlsauthentication"></a>
A Transport Layer Security (TLS) mútua para um nome de domínio personalizado.  
*Digite*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-mutualtlsauthentication)` propriedade de um `AWS::ApiGatewayV2::DomainName` recurso.

 `OwnershipVerificationCertificateArn`   <a name="sam-httpapi-httpapidomainconfiguration-ownershipverificationcertificatearn"></a>
O ARN do certificado público emitido pelo ACM para validar a propriedade do domínio personalizado. Necessário somente para configurar o TLS mútuo e para especificar um ARN de CA privado ou importado do ACM para o `CertificateArn`.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-ownershipverificationcertificatearn)` propriedade do tipo de `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` dados.

 `Route53`   <a name="sam-httpapi-httpapidomainconfiguration-route53"></a>
Define uma configuração do Amazon Route 53.  
*Tipo:*: [Route53Configuration](sam-property-httpapi-route53configuration.md)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `SecurityPolicy`   <a name="sam-httpapi-httpapidomainconfiguration-securitypolicy"></a>
A versão da política de segurança da TLS para esse nome de domínio.  
O único valor válido para HTTP APIs é`TLS_1_2`.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-securitypolicy)` propriedade do tipo de `AWS::ApiGatewayV2::DomainName` `DomainNameConfiguration` dados.

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

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

DomainName exemplo

#### 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 os conjuntos de registros Route53 para uma API.

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

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

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

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

 `DistributionDomainName`   <a name="sam-httpapi-route53configuration-distributiondomainname"></a>
Configura uma distribuição personalizada do nome de domínio personalizado da API.  
*Tipo:* string  
*Obrigatório*: não  
*Padrão*: use a distribuição do API Gateway.  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[DNSName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html#cfn-route53-aliastarget-dnshostname)` propriedade de um `AWS::Route53::RecordSetGroup AliasTarget` recurso.  
*Notas adicionais*: O nome de domínio de uma [CloudFrontdistribuição](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html).

 `EvaluateTargetHealth`   <a name="sam-httpapi-route53configuration-evaluatetargethealth"></a>
Quando EvaluateTargetHealth verdadeiro, um registro de alias herda a integridade do AWS recurso referenciado, como um balanceador de carga do Elastic Load Balancing ou outro registro na zona hospedada.  
*Tipo*: booliano  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[EvaluateTargetHealth](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html#cfn-route53-aliastarget-evaluatetargethealth)` propriedade de um `AWS::Route53::RecordSetGroup AliasTarget` recurso.  
*Observações adicionais*: você não pode EvaluateTargetHealth definir como verdadeiro quando o destino do alias é uma CloudFront distribuição.

 `HostedZoneId`   <a name="sam-httpapi-route53configuration-hostedzoneid"></a>
O ID da zona hospedada na qual você deseja criar registros.  
Especifique `HostedZoneName` ou `HostedZoneId`, mas não ambos. Se houver várias zonas hospedadas com o mesmo nome de domínio, especifique a zona hospedada usando `HostedZoneId`.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[HostedZoneId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzoneid)` propriedade de um `AWS::Route53::RecordSetGroup RecordSet` recurso.

 `HostedZoneName`   <a name="sam-httpapi-route53configuration-hostedzonename"></a>
O nome da zona hospedada na qual você deseja criar registros. Você deve incluir um ponto final (por exemplo, `www.example.com.`) como parte do `HostedZoneName`.  
Especifique `HostedZoneName` ou `HostedZoneId`, mas não ambos. Se houver várias zonas hospedadas com o mesmo nome de domínio, especifique a zona hospedada usando `HostedZoneId`.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[HostedZoneName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-hostedzonename)` propriedade de um `AWS::Route53::RecordSetGroup RecordSet` recurso.

 `IpV6`   <a name="sam-httpapi-route53configuration-ipv6"></a>
Quando essa propriedade é definida, AWS SAM cria um `AWS::Route53::RecordSet` recurso e define [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset.html#cfn-route53-recordset-type) como `AAAA` para o fornecido HostedZone.  
*Tipo*: booliano  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

`Region`  <a name="sam-httpapi-route53configuration-region"></a>
*Somente conjuntos de registros de recursos baseados em latência: a* EC2 região amazônica onde você criou o recurso ao qual esse conjunto de registros de recursos se refere. O recurso normalmente é um AWS recurso, como uma EC2 instância ou um balanceador de carga ELB, e é referido por um endereço IP ou nome de domínio DNS, dependendo do tipo de registro.  
Quando o Amazon Route 53 recebe uma consulta de DNS para um nome e tipo de domínio para o qual você criou conjuntos de registros de recursos de latência, o Route 53 seleciona o conjunto de registros de recursos de latência que tem a menor latência entre o usuário final e a região da Amazon associada. EC2 O Route 53 retorna o valor associado ao conjunto de registros de recursos selecionado.  
Observe o seguinte:  
+ Só é possível especificar um `ResourceRecord` por conjunto de registros de recursos de latência.
+ Você só pode criar um conjunto de registros de recursos de latência para cada EC2 região da Amazon.
+ Você não precisa criar conjuntos de registros de recursos de latência para todas as EC2 regiões da Amazon. O Route 53 selecionará a região com a melhor latência entre as regiões para as quais você cria conjuntos de registros de recursos de latência.
+ Não é possível criar conjuntos de registros de recursos que não sejam de latência e tenham os mesmos valores para os elementos `Name` e `Type` como conjuntos registros de recursos de latência.
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[ Region](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-region)` propriedade de um tipo de `AWS::Route53::RecordSetGroup` `RecordSet` dados.

`SetIdentifier`  <a name="sam-httpapi-route53configuration-setidentifier"></a>
*Conjuntos de registros de recursos que têm uma política de roteamento diferente da simples:* um identificador que diferencia entre vários conjuntos de registros de recursos que têm a mesma combinação de nome e tipo, como vários conjuntos de registros de recursos ponderados chamados acme.example.com que tenham um tipo de A. Em um grupo de conjuntos de registros de recursos que têm o mesmo nome e tipo, o valor de `SetIdentifier` deve ser exclusivo para cada conjunto de registros de recursos.  
Para obter informações sobre políticas de roteamento, consulte [Escolher uma política de roteamento](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) no *Guia do desenvolvedor do Amazon Route 53*.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[ SetIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html#cfn-route53-recordset-setidentifier)` propriedade de um tipo de `AWS::Route53::RecordSetGroup` `RecordSet` dados.

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

### Exemplo de configuração do Route 53
<a name="sam-property-httpapi-route53configuration--examples--route-53-configuration-example"></a>

Este exemplo mostra como configurar o 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
```