Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
HttpApiDomainConfiguration
Configure un domaine personnalisé pour une API.
Syntaxe
Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante :
YAML
BasePath:ListCertificateArn:StringDomainName:StringEndpointConfiguration:StringMutualTlsAuthentication:MutualTlsAuthenticationOwnershipVerificationCertificateArn:StringRoute53:Route53ConfigurationSecurityPolicy:String
Propriétés
-
BasePath -
Une liste des chemins de base à configurer avec le nom de domaine Amazon API Gateway.
Type : liste
Obligatoire : non
Par défaut : /
Compatibilité AWS CloudFormation : cette propriété est similaire à la propriété
ApiMappingKeyd'une ressourceAWS::ApiGatewayV2::ApiMapping. AWS SAM crée plusieurs ressourcesAWS::ApiGatewayV2::ApiMapping, une par valeur spécifiée dans cette propriété. -
CertificateArn -
L'Amazon Resource Name (ARN) d'un certificat géré par AWS est le point de terminaison de ce nom de domaine. AWS Certificate Manager est la seule source prise en charge.
Type : chaîne
Obligatoire : oui
Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété
CertificateArnd'une ressourceAWS::ApiGateway2::DomainName DomainNameConfiguration. -
DomainName -
Le nom de domaine personnalisé pour votre API dans Amazon API Gateway. Les majuscules ne sont pas prises en charge.
AWS SAM génère une ressource
AWS::ApiGatewayV2::DomainNamelorsque cette propriété est définie. Pour plus d'informations sur ce scénario, consultez DomainNamela propriété est spécifiée. Pour plus d'informations sur les ressources AWS CloudFormation générées, consultez AWS CloudFormation Ressources générées pour AWS SAM.Type : chaîne
Obligatoire : oui
Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété
DomainNamed'une ressourceAWS::ApiGateway2::DomainName. -
EndpointConfiguration -
Définit le type de point de terminaison API Gateway à mapper au domaine personnalisé. La valeur de cette propriété détermine comment la propriété
CertificateArnest mappée dans AWS CloudFormation.La seule valeur valide pour les API HTTP est
REGIONAL.Type : chaîne
Obligatoire : non
Par défaut :
REGIONALCompatibilité AWS CloudFormation : cette propriété est unique pour AWS SAM et ne dispose pas d'équivalent AWS CloudFormation.
-
MutualTlsAuthentication -
La configuration d'authentification de protocole TLS (Transport Layer Security) mutuelle pour un nom de domaine personnalisé.
Type : MutualTlsAuthentication
Obligatoire : non
Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété
MutualTlsAuthenticationd'une ressourceAWS::ApiGatewayV2::DomainName. -
OwnershipVerificationCertificateArn -
ARN du certificat public que vous avez généré dans pour valider la propriété de votre domaine personnalisé. Obligatoire uniquement lorsque vous configurez le protocole TLS mutuel et que vous précisez un ARN de certificat d'autorité de certification privé ou importé ACM pour le
CertificateArn.Type : chaîne
Obligatoire : non
Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété
OwnershipVerificationCertificateArndu type de donnéesAWS::ApiGatewayV2::DomainNameDomainNameConfiguration. -
Route53 -
Définit une configuration Amazon Route 53.
Type : Route53Configuration
Obligatoire : non
Compatibilité AWS CloudFormation : cette propriété est unique pour AWS SAM et ne dispose pas d'équivalent AWS CloudFormation.
-
SecurityPolicy -
La version TLS de la stratégie de sécurité pour ce nom de domaine.
La seule valeur valide pour les API HTTP est
TLS_1_2.Type : chaîne
Obligatoire : non
Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété
SecurityPolicydu type de donnéesAWS::ApiGatewayV2::DomainNameDomainNameConfiguration.
Exemples
DomainName
DomainName exemple
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: REGIONAL Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar
