HttpApiDomainConfiguration - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

HttpApiDomainConfiguration

Configura un dominio personalizado para una API.

Sintaxis

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

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

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

CertificateArn

El nombre de recurso de Amazon (ARN) de un certificado AWS administrado para el punto final de este nombre de dominio. AWS Certificate Manager es la única fuente compatible.

Tipo: cadena

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la CertificateArn propiedad de un AWS::ApiGateway2::DomainName DomainNameConfiguration recurso.

DomainName

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

AWS SAM genera un AWS::ApiGatewayV2::DomainName recurso cuando se establece esta propiedad. Para obtener información acerca de esta situación, consulta DomainNamese especifica la propiedad. Para obtener información sobre AWS CloudFormation los recursos generados, consulteAWS CloudFormation Recursos generados para AWS SAM.

Tipo: cadena

Obligatorio: sí

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

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

El único valor válido para HTTP APIs esREGIONAL.

Tipo: cadena

Obligatorio: no

Valor predeterminado: REGIONAL

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

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la MutualTlsAuthentication propiedad de un AWS::ApiGatewayV2::DomainName recurso.

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la OwnershipVerificationCertificateArn propiedad del tipo de AWS::ApiGatewayV2::DomainName DomainNameConfiguration datos.

Route53

Define una configuración de Amazon Route 53.

Tipo: Route53Configuration

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.

SecurityPolicy

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

El único valor válido para HTTP APIs esTLS_1_2.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la SecurityPolicy propiedad del tipo de AWS::ApiGatewayV2::DomainName DomainNameConfiguration datos.

Ejemplos

DomainName

DomainName ejemplo

YAML

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