DomainConfiguration

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: List
  NormalizeBasePath: Boolean
  CertificateArn: String
  DomainName: String
  EndpointConfiguration: String
  MutualTlsAuthentication: MutualTlsAuthentication
  OwnershipVerificationCertificateArn: String
  Route53: Route53Configuration
  SecurityPolicy: 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é BasePath d'une ressource AWS::ApiGateway::BasePathMapping. AWS SAM crée plusieurs ressources AWS::ApiGateway::BasePathMapping, une par BasePath spécifié dans cette propriété.

NormalizeBasePath

Indique si les caractères non alphanumériques sont autorisés dans les chemins de base définis par la propriété BasePath. Lorsque ce paramètre est défini sur True, les caractères non alphanumériques sont supprimés des chemins de base.

Utilisez NormalizeBasePath avec la propriété BasePath.

Type : valeur booléenne

Obligatoire : non

Valeur par défaut : VRAI

Compatibilité AWS CloudFormation : cette propriété est unique pour AWS SAM et ne dispose pas d'équivalent AWS CloudFormation.

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 similaire à la propriété CertificateArn d'une ressource AWS::ApiGateway::DomainName. S'il EndpointConfiguration est défini sur REGIONAL (valeur par défaut), il est CertificateArn mappé sur RegionalCertificateArninAWS::ApiGateway::DomainName. Si le EndpointConfiguration est défini surEDGE, CertificateArn correspond à CertificateArninAWS::ApiGateway::DomainName.

Informations complémentaires : pour un point de terminaison EDGE, vous devez créer le certificat dans le fichier de la région us-east-1 AWS.

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::ApiGateway::DomainName lorsque 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 Ressources AWS CloudFormation générées.

Type : chaîne

Obligatoire : oui

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété DomainName d'une ressource AWS::ApiGateway::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é CertificateArn est mappée dans AWS CloudFormation.

Valeurs valides : REGIONAL ou EDGE

Type : chaîne

Obligatoire : non

Par défaut : REGIONAL

Compatibilité 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é MutualTlsAuthentication d'une ressource AWS::ApiGateway::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é OwnershipVerificationCertificateArn d'une ressource AWS::ApiGateway::DomainName.

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

Version du protocole TLS plus suite de chiffrement pour ce nom de domaine.

Type : chaîne

Obligatoire : non

Compatibilité AWS CloudFormation : cette propriété est directement transmise à la propriété SecurityPolicy d'une ressource AWS::ApiGateway::DomainName.

Exemples

DomainName

DomainName exemple

YAML

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