HttpApiDomainConfiguration

Configura un dominio personalizado para una API.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), use la siguiente sintaxis:

YAML

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

Propiedades

BasePath

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

Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad ApiMappingKey de un recurso AWS::ApiGatewayV2::ApiMapping. AWS SAM crea varios recursos AWS::ApiGatewayV2::ApiMapping, uno por cada valor especificado en esta propiedad.

CertificateArn

El nombre de recurso de Amazon (ARN) de un certificado AWS administrado para el punto de conexión de este nombre de dominio. AWS Certificate Manager es el único origen admitido.

Tipo: cadena

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad CertificateArn de un recurso AWS::ApiGateway2::DomainName DomainNameConfiguration.

DomainName

El nombre de dominio personalizado para su API de API Gateway. No se admiten letras mayúsculas.

AWS SAM genera un recurso AWS::ApiGatewayV2::DomainName cuando se establece esta propiedad. Para obtener información acerca de esta situación, consulte Se ha especificado la propiedad DomainName. Para obtener información sobre los recursos generados de AWS CloudFormation, consulte Recursos de AWS CloudFormation generados.

Tipo: cadena

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad DomainName de un recurso AWS::ApiGateway2::DomainName.

EndpointConfiguration

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 propiedad de CertificateArn en AWS CloudFormation.

El único valor válido para las API HTTP es REGIONAL.

Tipo: cadena

Obligatorio: no

Valor predeterminado: REGIONAL

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

MutualTlsAuthentication

La configuración de autenticación mutua de seguridad de la capa de transporte (TLS) para un nombre de dominio personalizado.

Tipo: MutualTlsAuthentication

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad MutualTlsAuthentication de un recurso AWS::ApiGatewayV2::DomainName.

OwnershipVerificationCertificateArn

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

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad OwnershipVerificationCertificateArn del tipo de datos AWS::ApiGatewayV2::DomainName DomainNameConfiguration.

Route53

Define una configuración de Amazon Route 53.

Tipo: Route53Configuration

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

SecurityPolicy

La versión TLS de la política de seguridad para este nombre de dominio.

El único valor válido para las API HTTP es TLS_1_2.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad SecurityPolicy del tipo de datos AWS::ApiGatewayV2::DomainName DomainNameConfiguration.

Ejemplos

DomainName

DomainName ejemplo

YAML

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