Route53Configuration

Configura os conjuntos de registros Route53 para uma API.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

YAML

  DistributionDomainName: String
  EvaluateTargetHealth: Boolean
  HostedZoneId: String
  HostedZoneName: String
  IpV6: Boolean
  Region: String
  SetIdentifier: String

Propriedades

DistributionDomainName

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.

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade DNSName de um recurso AWS::Route53::RecordSetGroup AliasTarget.

Notas adicionais: O nome de domínio de uma CloudFrontdistribuição.

EvaluateTargetHealth

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

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade EvaluateTargetHealth de um recurso AWS::Route53::RecordSetGroup AliasTarget.

Observações adicionais: você não pode EvaluateTargetHealth definir como verdadeiro quando o destino do alias é uma CloudFront distribuição.

HostedZoneId

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

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade HostedZoneId de um recurso AWS::Route53::RecordSetGroup RecordSet.

HostedZoneName

O nome 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

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade HostedZoneName de um recurso AWS::Route53::RecordSetGroup RecordSet.

IpV6

Quando essa propriedade é definida, AWS SAM cria um AWS::Route53::RecordSet recurso e define Type como AAAA para o fornecido HostedZone.

Tipo: booliano

Obrigatório: não

Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem AWS CloudFormation equivalente.

Region

Somente conjuntos de registros de recursos baseados em latência: a região do Amazon EC2 na qual você criou o recurso ao qual esse conjunto de registros de recursos se refere. O recurso normalmente é um recurso da AWS, como uma instância do EC2 ou um balanceador de carga do ELB, e tem como referência um endereço IP ou um nome de domínio DNS, dependendo do tipo de registro.

Quando o Amazon Route 53 recebe uma consulta de DNS do nome e tipo de domínio para os quais você criou conjuntos de registros de recursos de latência, o Route 53 seleciona o conjunto de registros de recurso de latência que tem a mais baixa latência entre o usuário final e a região do Amazon EC2 associada. 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.

• Só é possível criar um conjunto de registros de recursos de latência para cada região do Amazon EC2.

• Não é necessário criar conjuntos de registros de recursos de latência para todas as regiões do Amazon EC2. 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

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade Region de um tipo de dados AWS::Route53::RecordSetGroup RecordSet.

SetIdentifier

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 no Guia do desenvolvedor do Amazon Route 53.

Tipo: string

Obrigatório: não

Compatibilidade AWS CloudFormation: essa propriedade é passada diretamente para a propriedade SetIdentifier de um tipo de dados AWS::Route53::RecordSetGroup RecordSet.

Exemplos

Exemplo básico

Neste exemplo, configuramos um domínio personalizado e conjuntos de registros do Route 53 para nossa API.

YAML

Resources:
  MyApi:
    Type: AWS::Serverless::Api
    Properties:
      StageName: Prod
      Domain:
        DomainName: www.example.com
        CertificateArn: arn:aws:acm:us-east-1:123456789012:certificate/abcdef12-3456-7890-abcd-ef1234567890
        EndpointConfiguration: REGIONAL
        Route53:
          HostedZoneId: ABCDEFGHIJKLMNOP