DomainConfiguration

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
  NormalizeBasePath: Boolean
  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 de AWS CloudFormation: esta propiedad es similar a la propiedad BasePath de un recurso AWS::ApiGateway::BasePathMapping. AWS SAM crea varios recursos de AWS::ApiGateway::BasePathMapping, uno por cada una de las BasePath especificadas en esta propiedad.

NormalizeBasePath

Indica si se permiten caracteres no alfanuméricos en las rutas base definidas por la propiedad de BasePath. Si se establece en True, los caracteres no alfanuméricos se eliminan de las rutas base.

Use NormalizeBasePath con la propiedad de BasePath.

Tipo: Booleano

Obligatorio: no

Valor predeterminado: True

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

CertificateArn

El nombre de recurso de Amazon (ARN) de un certificado administrado de AWS del 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 es similar a la propiedad CertificateArn de un recurso AWS::ApiGateway::DomainName. Si EndpointConfiguration se establece en REGIONAL (el valor predeterminado), se CertificateArn asigna a RegionalCertificateArninAWS::ApiGateway::DomainName. Si EndpointConfiguration está establecido enEDGE, se CertificateArn asigna a CertificateArndentroAWS::ApiGateway::DomainName.

Notas adicionales: para un punto de conexión de EDGE, debe crear el certificado en la región us-east-1 de AWS.

DomainName

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

AWS SAM genera un recurso AWS::ApiGateway::DomainName cuando se establece esta propiedad. Para obtener información acerca de esta situación, consulte DomainNamese especifica la propiedad. 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::ApiGateway::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.

Valores válidos: REGIONAL o EDGE

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::ApiGateway::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 de un recurso AWS::ApiGateway::DomainName.

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 de TLS más conjunto de cifrado para este nombre de dominio.

Tipo: cadena

Obligatorio: no

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

Ejemplos

DomainName

DomainName ejemplo

YAML

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