HttpApiDomainConfiguration

Configura un dominio personalizado para una API.

Sintaxis

Para declarar esta entidad en suAWS Serverless Application Model(AWS SAM), utilice la siguiente sintaxis.

YAML

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

Properties

BasePath

Lista de las rutas de base para configurar con el nombre de dominio de Amazon API Gateway.

Type: List

Obligatorio: No

Predeterminado:/

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laApiMappingKeypropiedad de unAWS::ApiGatewayV2::ApiMappingrecurso.AWS SAMcrea variosAWS::ApiGatewayV2::ApiMappingresources, uno por valor especificado en esta propiedad.

CertificateArn

El nombre de recurso de Amazon (ARN) de unAWScertificado administrado para el endpoint de este nombre de dominio.AWS Certificate Manageres el único origen admitido.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alCertificateArnpropiedad de unAWS::ApiGateway2::DomainName DomainNameConfigurationrecurso.

DomainName

Es el nombre de dominio personalizado para la API de API Gateway. No se admiten letras mayúsculas.

AWS SAMgenera unAWS::ApiGatewayV2::DomainNamerecurso cuando se establece esta propiedad. Para obtener información acerca de esta situación, consulteSe especifica la propiedad domainName. Para obtener información sobre generadosAWS CloudFormationrecursos, consulteGeneradoAWS CloudFormationrecursos.

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alDomainNamepropiedad de unAWS::ApiGateway2::DomainNamerecurso.

EndpointConfiguration

Define el tipo de extremo de API Gateway que se va a asignar al dominio personalizado. El valor de esta propiedad determina la forma en que elCertificateArnla propiedad está asignada enAWS CloudFormation.

El único valor válido para las API de HTTP esREGIONAL.

Type: Cadena

Obligatorio: No

Valor predeterminado: REGIONAL

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

MutualTlsAuthentication

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

Type: MutualTlsAutenticación

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alMutualTlsAuthenticationpropiedad de unAWS::ApiGatewayV2::DomainNamerecurso.

OwnershipVerificationCertificateArn

El ARN del certificado público emitido por ACM para validar la propiedad de su dominio personalizado. Obligatorio solo cuando se configura TLS mutuo y especifica un ARN de certificado de CA privado o importado de ACM para elCertificateArn.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alOwnershipVerificationCertificateArnpropiedad delAWS::ApiGatewayV2::DomainName DomainNameConfigurationTipos de datos de datos.

Route53

Define una configuración de Amazon Route 53.

Type: Configuración de la ruta 53

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad es específica deAWS SAMy no tieneAWS CloudFormationequivalente.

SecurityPolicy

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

El único valor válido para las API de HTTP esTLS_1_2.

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alSecurityPolicypropiedad delAWS::ApiGatewayV2::DomainName DomainNameConfigurationTipos de datos de datos.

Ejemplos

DomainName

DomainNameejemplo

YAML

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