HttpApiDomainConfiguration

Configura um domínio personalizado para uma API.

Sintaxe

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

YAML

  BasePath: List
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  MutualTlsAuthentication: MutualTlsAuthentication
  OwnershipVerificationCertificateArn: String
  Route53: Route53Configuration
  SecurityPolicy: String

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

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

CertificateArn

O nome de recurso da Amazon (ARN) de um certificado gerenciado AWS para o endpoint desse nome de domínio. AWS Certificate Manager é a única origem compatível.

Tipo: string

Obrigatório: Sim

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

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 recurso AWS::ApiGatewayV2::DomainName quando essa propriedade é definida. Para obter informações sobre esse cenário, consulte DomainNamepropriedade é especificada. Para obter informações sobre recursos gerados do AWS CloudFormation, consulte AWS CloudFormation Recursos gerados.

Tipo: string

Obrigatório: Sim

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

EndpointConfiguration

Define o tipo de endpoint do API Gateway a ser mapeado para o domínio personalizado. O valor dessa propriedade determina como a propriedade CertificateArn é mapeadaAWS CloudFormation.

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

Tipo: string

Obrigatório: não

Padrão: REGIONAL

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

MutualTlsAuthentication

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

Tipo: MutualTlsAuthentication

Obrigatório: não

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

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.

Tipo: string

Obrigatório: não

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

Route53

Define uma configuração do Amazon Route 53.

Tipo:: Route53Configuration

Obrigatório: não

Compatibilidade AWS CloudFormation: Essa propriedade é exclusiva do 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 APIs HTTP é TLS_1_2.

Tipo: string

Obrigatório: não

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

Exemplos

DomainName

DomainName exemplo

YAML

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