DomainConfiguration

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

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

Tipo: DomainAccessAssociation

Obligatorio: no

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

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 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.

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 CloudFormation: esta propiedad es similar a la propiedad CertificateArn de un recurso AWS::ApiGateway::DomainName. Si EndpointConfiguration se establece en REGIONAL (el valor predeterminado), CertificateArn se mapea a RegionalCertificatEarn en AWS::ApiGateway::DomainName. Si EndpointConfiguration se establece enEDGE, CertificateArn se mapea a CertificatEarn in en AWS::ApiGateway::DomainName. Si EndpointConfiguration se establece en PRIVATE, esta propiedad se trasfiere al recurso AWS::ApiGateway::DomainNameV2.

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

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, consulta Se ha especificado la propiedad DomainName. Para obtener información sobre los recursos generados de CloudFormation, consulta Recursos de CloudFormation generados para AWS SAM.

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad de DomainName de un recurso de AWS::ApiGateway::DomainName, o a AWS::ApiGateway::DomainNameV2 cuando EndpointConfiguration está establecido en PRIVATE.

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 CloudFormation.

Valores válidos: EDGE, REGIONAL o PRIVATE

Tipo: cadena

Obligatorio: no

Valor predeterminado: REGIONAL

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

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

Type: MutualTlsAuthentication

Obligatorio: no

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

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

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

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 CloudFormation: esta propiedad se transfiere directamente a la propiedad OwnershipVerificationCertificateArn de un recurso AWS::ApiGateway::DomainName.

La política de IAM que se va a asociar al nombre de dominio de API Gateway. Solo es aplicable cuando EndpointConfiguration se establece en PRIVATE.

Tipo: Json

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Policy de un recurso AWS::ApiGateway::DomainNameV2 cuando EndpointConfiguration se establece en PRIVATE. Para ver ejemplos de documentos de política válidos, consulte AWS::ApiGateway::DomainNameV2.

Define una configuración de Amazon Route 53.

Tipo: Route53Configuration

Obligatorio: no

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

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

Tipo: cadena

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad SecurityPolicy de un recurso de AWS::ApiGateway::DomainName, o a AWS::ApiGateway::DomainNameV2 cuando EndpointConfiguration se establece en PRIVATE. En los puntos de conexión de PRIVATE, solo TLS_1_2 es compatible.