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 tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.
YAML
BasePath:ListCertificateArn:StringDomainName:StringEndpointConfiguration:StringMutualTlsAuthentication:MutualTlsAuthenticationOwnershipVerificationCertificateArn:StringRoute53:Route53ConfigurationSecurityPolicy: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 CloudFormation compatibilità: questa proprietà è simile alla
ApiMappingKeyproprietà di unaAWS::ApiGatewayV2::ApiMappingrisorsa. AWS SAM crea piùAWS::ApiGatewayV2::ApiMappingrisorse, 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 CloudFormation compatibilità: questa proprietà viene passata direttamente alla
CertificateArnproprietà di unaAWS::ApiGateway2::DomainName DomainNameConfigurationrisorsa. -
DomainName -
Il nome di dominio personalizzato per l'API API Gateway. Le lettere maiuscole non sono supportate.
AWS SAM genera una
AWS::ApiGatewayV2::DomainNamerisorsa quando questa proprietà è impostata. Per informazioni su questo scenario, vedereDomainNamela proprietà è specificata. Per informazioni sulle AWS CloudFormation risorse generate, vedereAWS CloudFormation Risorse generate per AWS SAM.Tipo: Stringa
Campo obbligatorio: sì
AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla
DomainNameproprietà di unaAWS::ApiGateway2::DomainNamerisorsa. -
EndpointConfiguration -
Definisce il tipo di endpoint API Gateway da mappare al dominio personalizzato. Il valore di questa proprietà determina il modo in cui la
CertificateArnproprietà viene mappata. AWS CloudFormationL'unico valore valido per HTTP APIs è
REGIONAL.Tipo: Stringa
Required: No
Default:
REGIONALAWS CloudFormation compatibilità: 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 CloudFormation compatibilità: questa proprietà viene passata direttamente alla
MutualTlsAuthenticationproprietà di unaAWS::ApiGatewayV2::DomainNamerisorsa. -
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.
CertificateArnTipo: Stringa
Required: No
AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla
OwnershipVerificationCertificateArnproprietà del tipo di dati.AWS::ApiGatewayV2::DomainNameDomainNameConfiguration -
Route53 -
Definisce una configurazione Amazon Route 53.
Tipo: configurazione Route53
Required: No
AWS CloudFormation compatibilità: 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 HTTP APIs è
TLS_1_2.Tipo: Stringa
Required: No
AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla
SecurityPolicyproprietà del tipo diAWS::ApiGatewayV2::DomainNameDomainNameConfigurationdati.
Esempi
DomainName
DomainName esempio
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: REGIONAL Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar