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

DomainConfiguration

Configura un dominio personalizzato per un'API.

Sintassi

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

Proprietà

BasePath

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

Tipo: Elenco

Required: No

Predefinito:/

AWS CloudFormationcompatibilità: questa proprietà è simile allaBasePath proprietà di unaAWS::ApiGateway::BasePathMapping risorsa. AWS SAMcrea piùAWS::ApiGateway::BasePathMapping risorse, una per ciascuna delle risorseBasePath specificate in questa proprietà.

NormalizeBasePath

Indica se i caratteri non alfanumerici sono consentiti nei percorsi di base definiti dallaBasePath proprietà. Se impostato suTrue, i caratteri non alfanumerici vengono rimossi dai percorsi di base.

Da utilizzareNormalizeBasePath con laBasePath proprietà.

Tipo: Booleano

Required: No

Impostazione predefinita: True

AWS CloudFormationcompatibilità: questa proprietà è unicaAWS SAM e non ha unAWS CloudFormation equivalente.

CertificateArn

Il nome della risorsa Amazon (ARN) diAWS un endpoint di questo nome di dominio. AWS Certificate Managerè l'unica origine supportata.

Tipo: stringa

Required: Yes

AWS CloudFormationcompatibilità: questa proprietà è simile allaCertificateArn proprietà di unaAWS::ApiGateway::DomainName risorsa. SeEndpointConfiguration è impostato suREGIONAL (il valore predefinito), vieneCertificateArn mappato a RegionalCertificateArninAWS::ApiGateway::DomainName. SeEndpointConfiguration è impostato suEDGE,CertificateArn mapping to CertificateArninAWS::ApiGateway::DomainName.

Note aggiuntive: per unEDGE endpoint, è necessario creare il certificato nellaus-east-1AWS regione.

DomainName

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

AWS SAMgenera una AWS::ApiGateway::DomainNamerisorsa quando questa proprietà è impostata. Per informazioni su questo scenario, consultaViene specificata la proprietà DomainName. Per informazioni sulleAWS CloudFormation risorse generate, vedereAWS CloudFormationRisorse generate.

Tipo: stringa

Required: Yes

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaDomainName proprietà di unaAWS::ApiGateway::DomainName risorsa.

EndpointConfiguration

Definisce il tipo di endpoint API Gateway da mappare al dominio personalizzato. Il valore di questa proprietà determina la modalità di mappatura dellaCertificateArn proprietàAWS CloudFormation.

Valori validi: REGIONAL o EDGE

Tipo: stringa

Required: No

Default: REGIONAL

AWS CloudFormationcompatibilità: questa proprietà è unicaAWS SAM e non ha unAWS CloudFormation equivalente.

MutualTlsAuthentication

La configurazione di autenticazione TLS) per un nome di dominio personalizzato per un nome di dominio.

Tipo: MutualTlsAuthentication

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaMutualTlsAuthentication proprietà di unaAWS::ApiGateway::DomainName risorsa.

OwnershipVerificationCertificateArn

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

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaOwnershipVerificationCertificateArn proprietà di unaAWS::ApiGateway::DomainName risorsa.

Route53

Definisce una configurazione Amazon Route 53.

Tipo: configurazione Route53

Required: No

AWS CloudFormationcompatibilità: questa proprietà è unicaAWS SAM e non ha unAWS CloudFormation equivalente.

SecurityPolicy

La suite di crittografia per questo nome di dominio.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaSecurityPolicy proprietà di unaAWS::ApiGateway::DomainName risorsa.

Esempi

DomainName

DomainName esempio

YAML

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