DomainConfiguration - AWS Serverless Application Model

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.

DomainConfiguration

Configura un dominio personalizado para una API.

Sintaxis

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

Properties

BasePath

Una lista de las rutas de acceso de base que se van a configurar con el nombre de dominio de Amazon API Gateway.

Type: List

Obligatorio: No

Predeterminado:/

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laBasePathpropiedad de unAWS::ApiGateway::BasePathMappingrecurso.AWS SAMcrea variosAWS::ApiGateway::BasePathMappingrecursos, uno porBasePathespecificada en esta propiedad.

CertificateArn

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

Type: Cadena

Obligatorio: Sí

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laCertificateArnpropiedad de unAWS::ApiGateway::DomainNamerecurso. SiEndpointConfigurationtoma el valorREGIONAL(valor predeterminado),CertificateArnmapas aRegionalCertificateArnenAWS::ApiGateway::DomainName. Si el archivo deEndpointConfigurationtoma el valorEDGE,CertificateArnmapas aCertificateArnenAWS::ApiGateway::DomainName.

Notas adicionales: Para unEDGEpunto de enlace, debe crear el certificado en elus-east-1 AWSRegión .

DomainName

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

AWS SAMgenera unAWS::ApiGateway::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::ApiGateway::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.

Valores válidos: REGIONAL o EDGE

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 Transport Layer Security (TLS) para un nombre de dominio personalizado.

Type: MutualTlsAutenticación

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alMutualTlsAuthenticationpropiedad de unAWS::ApiGateway::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 de unAWS::ApiGateway::DomainNamerecurso.

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

Type: Cadena

Obligatorio: No

AWS CloudFormationcompatibilidad: Esta propiedad se transfiere directamente alSecurityPolicypropiedad de unAWS::ApiGateway::DomainNamerecurso.

Ejemplos

DomainName

DomainNameejemplo

YAML

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