DomainConfiguration

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

Type: liste

Obligatoire : non

Par défaut : /

AWS 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é.

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

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

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

AWS 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.

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 passerelleAPI. Les majuscules ne sont pas prises en charge.

AWS SAM génère une 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 AWS CloudFormation les ressources générées, consultezAWS CloudFormation Ressources générées pour AWS SAM.

Type : chaîne

Obligatoire : oui

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

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

Valeurs valides : REGIONAL ou EDGE

Type : chaîne

Obligatoire : non

Par défaut : REGIONAL

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

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

Type : MutualTlsAuthentication

Obligatoire : non

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

Le ARN certificat public émis par ACM pour valider la propriété de votre domaine personnalisé. Obligatoire uniquement lorsque vous configurez la mutuelle TLS et que vous spécifiez un certificat CA ACM importé ou privé ARN pour leCertificateArn.

Type : chaîne

Obligatoire : non

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

Définit une configuration Amazon Route 53.

Type : Route53Configuration

Obligatoire : non

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

TLSVersion et suite de chiffrement pour ce nom de domaine.

Type : chaîne

Obligatoire : non

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