HttpApiDomainConfiguration - AWS Serverless Application Model

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

HttpApiDomainConfiguration

Configura un dominio personalizzato per un'API.

Sintassi

Per dichiarare questa entità nel tuoAWS Serverless Application Model(AWS SAM) template, utilizzare la seguente sintassi.

Proprietà

BasePath

Un elenco dei percorsi di base da configurare con il nome di dominio di Amazon API Gateway.

Type: Elenco

Campo obbligatorio: No

Default:/

AWS CloudFormationcompatibilità: Questa proprietà è simile alApiMappingKeyproprietà di unAWS::ApiGatewayV2::ApiMappingrisorsa.AWS SAMcrea piùAWS::ApiGatewayV2::ApiMappingresources, uno per valore specificato in questa proprietà.

CertificateArn

L'Amazon Resource Name (ARN) di unAWScertificato gestito per l'endpoint di questo nome di dominio.AWS Certificate Managerè l'unica origine supportata.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alCertificateArnproprietà di unAWS::ApiGateway2::DomainName DomainNameConfigurationrisorsa.

DomainName

Il nome di dominio personalizzato per l'API Gateway API. Le lettere maiuscole non sono supportate.

AWS SAMgenera unAWS::ApiGatewayV2::DomainNamerisorsa quando questa proprietà è impostata. Per ulteriori informazioni su questo scenario, consultaViene specificata la proprietà DomainName. Per informazioni sulla generazioneAWS CloudFormationPer le risorse, consultaAWS CloudFormationRisorse generate.

Type: Stringa

Campo obbligatorio: Sì

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alDomainNameproprietà di unAWS::ApiGateway2::DomainNamerisorsa.

EndpointConfiguration

Definisce il tipo di endpoint API Gateway da mappare al dominio personalizzato. Il valore di questa proprietà determina comeCertificateArnla proprietà è mappata inAWS CloudFormation.

L'unico valore valido per le API HTTP èREGIONAL.

Type: Stringa

Campo obbligatorio: No

Default: REGIONAL

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

MutualTlsAuthentication

La configurazione di autenticazione TLS (Mutual Transport Layer Security) per un nome di dominio personalizzato.

Type: MutualTlsAutenticazione

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alMutualTlsAuthenticationproprietà di unAWS::ApiGatewayV2::DomainNamerisorsa.

OwnershipVerificationCertificateArn

L'ARN del certificato pubblico rilasciato da ACM per convalidare la proprietà del dominio personalizzato. Richiesto solo quando si configura TLS reciproco e si specifica un ARN certificato CA importato o privato ACM per ilCertificateArn.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alOwnershipVerificationCertificateArnproprietà delAWS::ApiGatewayV2::DomainName DomainNameConfigurationtipo di dati.

Route53

Definisce una configurazione Amazon Route 53.

Type: Configurazione Route 53

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà è univoco perAWS SAMe non dispone di unAWS CloudFormationequivalente.

SecurityPolicy

La versione TLS della policy di sicurezza per questo nome di dominio.

L'unico valore valido per le API HTTP èTLS_1_2.

Type: Stringa

Campo obbligatorio: No

AWS CloudFormationcompatibilità: Questa proprietà viene trasmessa direttamente alSecurityPolicyproprietà delAWS::ApiGatewayV2::DomainName DomainNameConfigurationtipo di dati.

Esempi

DomainName

DomainNameesempio

YAML

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