本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DomainConfiguration
設定的自訂網域。API
語法
若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。
YAML
BasePath:ListNormalizeBasePath:BooleanCertificateArn:StringDomainName:StringEndpointConfiguration:StringMutualTlsAuthentication:MutualTlsAuthenticationOwnershipVerificationCertificateArn:StringRoute53:Route53ConfigurationSecurityPolicy:String
屬性
-
BasePath -
要使用 Amazon API 閘道網域名稱設定的基本路徑清單。
類型：列表
必要：否
預設值：/
AWS CloudFormation 兼容性：此屬性類似於
AWS::ApiGateway::BasePathMapping資源的BasePath屬性。 AWS SAM 會建立多個AWS::ApiGateway::BasePathMapping資源，每個在此屬性中BasePath指定一個資源。 -
NormalizeBasePath -
指出屬性定義的
BasePath基本路徑中是否允許使用非英數字元。設定為時True，會從基本路徑移除非英數字元。NormalizeBasePath與BasePath屬性一起使用。類型：布林值
必要：否
預設值：真
AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。
-
CertificateArn -
此網域名稱端點的 AWS 受管憑證的 Amazon 資源名稱 (ARN)。 AWS Certificate Manager 是唯一受支援的來源。
類型：字串
必要：是
AWS CloudFormation 兼容性：此屬性類似於
AWS::ApiGateway::DomainName資源的CertificateArn屬性。如果設定EndpointConfiguration為REGIONAL(預設值)，則對CertificateArn映至RegionalCertificateArn中AWS::ApiGateway::DomainName。如果設定EndpointConfiguration為EDGE，則對CertificateArn映至CertificateArn中AWS::ApiGateway::DomainName。其他注意事項：對於
EDGE端點，您必須在「us-east-1AWS 區域」中建立憑證。 -
DomainName -
API閘道的自訂網域名稱API。不支援大寫字母。
AWS SAM 設置此屬性時生成一個AWS::ApiGateway::DomainName資源。如需有關此案例的資訊，請參閱DomainName屬性已指定。如需有關已產生 AWS CloudFormation 資源的資訊，請參閱產生的 AWS CloudFormation 資源 AWS SAM。
類型：字串
必要：是
AWS CloudFormation 兼容性：此屬性直接傳遞給
AWS::ApiGateway::DomainName資源的DomainName屬性。 -
EndpointConfiguration -
定義要對應至自訂網域的API閘道端點類型。此屬性的值決定了對應
CertificateArn性質的方式 AWS CloudFormation。有效值：
REGIONAL或EDGE類型：字串
必要：否
預設：
REGIONALAWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。
-
MutualTlsAuthentication -
自訂網域名稱的相互傳輸層安全性 (TLS) 驗證組態。
必要：否
AWS CloudFormation 兼容性：此屬性直接傳遞給
AWS::ApiGateway::DomainName資源的MutualTlsAuthentication屬性。 -
OwnershipVerificationCertificateArn -
驗證自訂網域擁有ACM權所發行的公用憑證。ARN只有當您設定相互TLS並指定ACM匯入或私人 CA 憑證ARN給
CertificateArn.類型：字串
必要：否
AWS CloudFormation 兼容性：此屬性直接傳遞給
AWS::ApiGateway::DomainName資源的OwnershipVerificationCertificateArn屬性。 -
Route53 -
定義 Amazon 路線 53 配置。
類型：路線 53 配置
必要：否
AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。
-
SecurityPolicy -
此域名的TLS版本加密套件。
類型：字串
必要：否
AWS CloudFormation 兼容性：此屬性直接傳遞給
AWS::ApiGateway::DomainName資源的SecurityPolicy屬性。
範例
DomainName
DomainName 例子
YAML
Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: EDGE Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar
