HttpApiDomainConfiguration - AWS Serverless Application Model
SintaxePropriedadesExemplos

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

Configura um domínio personalizado para uma API.

Sintaxe

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

Propriedades

BasePath

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: /

AWS CloudFormation compatibilidade: essa propriedade é semelhante à ApiMappingKey propriedade de um AWS::ApiGatewayV2::ApiMapping recurso. AWS SAM cria vários AWS::ApiGatewayV2::ApiMapping recursos, um por valor especificado nessa propriedade.

CertificateArn

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.

Type: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a CertificateArn propriedade de um AWS::ApiGateway2::DomainName DomainNameConfiguration recurso.

DomainName

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 DomainNamepropriedade é especificada. Para obter informações sobre AWS CloudFormation os recursos gerados, consulteAWS CloudFormation Recursos gerados para AWS SAM.

Type: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a DomainName propriedade de um AWS::ApiGateway2::DomainName recurso.

EndpointConfiguration

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 AWS CloudFormation.

O único valor válido para HTTP APIs éREGIONAL.

Type: string

Obrigatório: não

Padrão: REGIONAL

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

MutualTlsAuthentication

A Transport Layer Security (TLS) mútua para um nome de domínio personalizado.

Digite: MutualTlsAuthentication

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a MutualTlsAuthentication propriedade de um AWS::ApiGatewayV2::DomainName recurso.

OwnershipVerificationCertificateArn

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.

Type: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a OwnershipVerificationCertificateArn propriedade do tipo de AWS::ApiGatewayV2::DomainName DomainNameConfiguration dados.

Route53

Define uma configuração do Amazon Route 53.

Tipo:: Route53Configuration

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

SecurityPolicy

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.

Type: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a SecurityPolicy propriedade do tipo de AWS::ApiGatewayV2::DomainName DomainNameConfiguration dados.

Exemplos

DomainName

DomainName exemplo

YAML

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