DomainConfiguration

Configura un dominio personalizzato per un'API.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

YAML

  BasePath: List
  NormalizeBasePath: Boolean
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  MutualTlsAuthentication: MutualTlsAuthentication
  OwnershipVerificationCertificateArn: String
  Route53: Route53Configuration
  SecurityPolicy: String

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 alla BasePath proprietà di una AWS::ApiGateway::BasePathMapping risorsa. AWS SAMcrea più AWS::ApiGateway::BasePathMapping risorse, una per quelle BasePath specificate in questa proprietà.

NormalizeBasePath

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

Utilizzare con la proprietà. NormalizeBasePath BasePath

Tipo: Booleano

Required: No

Impostazione predefinita: True

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

CertificateArn

L'Amazon Resource Name (ARN) di un certificato AWS gestito, endpoint di questo nome di dominio. AWS Certificate Managerè l'unica fonte supportata.

Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormationcompatibilità: questa proprietà è simile alla CertificateArn proprietà di una AWS::ApiGateway::DomainName risorsa. Se EndpointConfiguration è impostato su REGIONAL (il valore predefinito), viene CertificateArn mappato a RegionalCertificateArninAWS::ApiGateway::DomainName. Se EndpointConfiguration è impostato suEDGE, viene CertificateArn mappato a CertificateArndentroAWS::ApiGateway::DomainName.

Note aggiuntive: per un EDGE endpoint, è necessario creare il certificato nella us-east-1 AWS regione.

DomainName

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

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

Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla DomainName proprietà di una AWS::ApiGateway::DomainName risorsa.

EndpointConfiguration

Definisce il tipo di endpoint API Gateway da mappare al dominio personalizzato. Il valore di questa proprietà determina il modo in cui la CertificateArn proprietà viene mappata. AWS CloudFormation

Valori validi: REGIONAL o EDGE

Tipo: stringa

Required: No

Default: REGIONAL

AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.

MutualTlsAuthentication

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

Tipo: MutualTlsAuthentication

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla MutualTlsAuthentication proprietà di una AWS::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. CertificateArn

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla OwnershipVerificationCertificateArn proprietà di una risorsa. AWS::ApiGateway::DomainName

Route53

Definisce una configurazione Amazon Route 53.

Tipo: configurazione Route53

Required: No

AWS CloudFormationcompatibilità: Questa proprietà è unica AWS SAM e non ha un equivalente. AWS CloudFormation

SecurityPolicy

La versione TLS più la suite di crittografia per questo nome di dominio.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla SecurityPolicy proprietà di una risorsa. AWS::ApiGateway::DomainName

Esempi

DomainName

DomainName esempio

YAML

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