DomainConfiguration

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.

YAML

  AccessAssociation: DomainAccessAssociation
  BasePath: List
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  MutualTlsAuthentication: MutualTlsAuthentication
  NormalizeBasePath: Boolean
  OwnershipVerificationCertificateArn: String
  Policy: Json
  Route53: Route53Configuration
  SecurityPolicy: String

Propiedades

AccessAssociation

La configuración necesaria para generar el AWS::ApiGateway::DomainNameAccessAssociation recurso.

AWS SAM genera un AWS::ApiGateway::DomainNameAccessAssociationrecurso cuando se establece esta propiedad. Para obtener información sobre AWS CloudFormation los recursos generados, consulteAWS CloudFormation Recursos generados para AWS SAM.

Tipo: DomainAccessAssociation

Obligatorio: no

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

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 BasePath propiedad de un AWS::ApiGateway::BasePathMapping recurso. AWS SAM crea varios AWS::ApiGateway::BasePathMapping recursos, uno por cada uno de los BasePath especificados en esta propiedad.

CertificateArn

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

Tipo: cadena

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad es similar a la CertificateArn propiedad de un AWS::ApiGateway::DomainName recurso. 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. Si EndpointConfiguration se establece enPRIVATE, esta propiedad se pasa al recurso AWS::ApiGateway::DomainNameV2.

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

DomainName

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

AWS SAM genera un AWS::ApiGateway::DomainNamerecurso 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::ApiGateway::DomainName recurso o AWS::ApiGateway::DomainNameV2cuando EndpointConfiguration se establece enPRIVATE.

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

Valores válidos: EDGE, REGIONAL o PRIVATE

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

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.

Usa NormalizeBasePath con la propiedad de BasePath.

Tipo: Booleano

Obligatorio: no

Valor predeterminado: True

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

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

Policy

La política de IAM que se debe adjuntar al nombre de dominio de API Gateway. Solo se aplica cuando EndpointConfiguration está establecido en. PRIVATE

Tipo: Json

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Policy propiedad de un AWS::ApiGateway::DomainNameV2 recurso cuando EndpointConfiguration se establece enPRIVATE. Para ver ejemplos de documentos de política válidos, consulte la AWS::ApiGateway::DomainNameV2.

Route53

Define una configuración de Amazon Route 53.

Tipo: Route53Configuration

Obligatorio: no

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

SecurityPolicy

La versión de TLS más conjunto de cifrado para este nombre de dominio.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la SecurityPolicy propiedad de un AWS::ApiGateway::DomainName recurso o AWS::ApiGateway::DomainNameV2cuando EndpointConfiguration se establece enPRIVATE. Para los PRIVATE puntos finales, solo se admite TLS_1_2.

Ejemplos

DomainName

DomainName ejemplo

YAML

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