DomainConfiguration

Configuration requise pour générer une AWS::ApiGateway::DomainNameAccessAssociation ressource.

AWS SAM génère un AWS::ApiGateway::DomainNameAccessAssociationressource lorsque cette propriété est définie. Pour plus d'informations sur CloudFormation les ressources générées, consultezCloudFormation Ressources générées pour AWS SAM.

Type : DomainAccessAssociation

Obligatoire : non

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

Une liste des chemins de base à configurer avec le nom de domaine Amazon API Gateway.

Type : liste

Obligatoire : non

Par défaut : /

CloudFormation compatibilité : cette propriété est similaire à celle BasePath d'une AWS::ApiGateway::BasePathMapping ressource. AWS SAM crée plusieurs AWS::ApiGateway::BasePathMapping ressources, une par ressource BasePath spécifiée dans cette propriété.

Le nom de ressource Amazon (ARN) d'un certificat AWS géré 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

CloudFormation compatibilité : cette propriété est similaire à celle CertificateArn d'une AWS::ApiGateway::DomainName ressource. 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. Si elle EndpointConfiguration est définie surPRIVATE, cette propriété est transmise à la ressource AWS::ApiGateway::DomainNameV2.

Remarques supplémentaires : Pour un EDGE point de terminaison, vous devez créer le certificat dans la us-east-1 AWS région.

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 un AWS::ApiGateway::DomainNameressource 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 CloudFormation les ressources générées, consultezCloudFormation Ressources générées pour AWS SAM.

Type : chaîne

Obligatoire : oui

CloudFormation compatibilité : cette propriété est transmise directement à la DomainName propriété d'une AWS::ApiGateway::DomainName ressource, ou à AWS::ApiGateway::DomainNameV2when EndpointConfiguration est définie surPRIVATE.

Définit le type de point de terminaison API Gateway à mapper au domaine personnalisé. La valeur de cette propriété détermine la manière dont la CertificateArn propriété est mappée CloudFormation.

Valeurs valides : EDGE, REGIONAL ou PRIVATE

Type : chaîne

Obligatoire : non

Par défaut : REGIONAL

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

La configuration d'authentification de protocole TLS (Transport Layer Security) mutuelle pour un nom de domaine personnalisé.

Type : MutualTlsAuthentication

Obligatoire : non

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

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

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

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

La politique IAM à associer au nom de domaine API Gateway. Applicable uniquement lorsque EndpointConfiguration ce paramètre est défini surPRIVATE.

Type : Json

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la Policy propriété d'une AWS::ApiGateway::DomainNameV2 ressource lorsqu'elle EndpointConfiguration est définie surPRIVATE. Pour des exemples de documents de politique valides, voir AWS::ApiGateway::DomainNameV2.

Définit une configuration Amazon Route 53.

Type : Route53Configuration

Obligatoire : non

CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

Type : chaîne

Obligatoire : non

CloudFormation compatibilité : cette propriété est transmise directement à la SecurityPolicy propriété d'une AWS::ApiGateway::DomainName ressource, ou à AWS::ApiGateway::DomainNameV2when EndpointConfiguration est définie surPRIVATE. Pour les PRIVATE points de terminaison, seul le TLS_1_2 est pris en charge.