HttpApiDomainConfiguration

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
  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 ApiMappingKey proprietà di una AWS::ApiGatewayV2::ApiMapping risorsa. AWS SAMcrea più AWS::ApiGatewayV2::ApiMapping risorse, una per valore specificato in questa proprietà.

CertificateArn

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

Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla CertificateArn proprietà di una AWS::ApiGateway2::DomainName DomainNameConfiguration risorsa.

DomainName

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

AWS SAMgenera una AWS::ApiGatewayV2::DomainName risorsa quando questa proprietà è impostata. Per informazioni su questo scenario, vedereViene specificata la proprietà DomainName. 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::ApiGateway2::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

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

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::ApiGatewayV2::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à del tipo di dati. AWS::ApiGatewayV2::DomainName DomainNameConfiguration

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 della politica di sicurezza per questo nome di dominio.

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

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla SecurityPolicy proprietà del tipo di AWS::ApiGatewayV2::DomainName DomainNameConfiguration dati.

Esempi

DomainName

DomainName esempio

YAML

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