本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # DomainConfiguration 設定 API 的自訂網域。 ## 語法若要在 AWS Serverless Application Model (AWS SAM) 範本中宣告此實體，請使用下列語法。 ### YAML ``` [AccessAssociation](#sam-api-domainconfiguration-domainaccessassociation): DomainAccessAssociation [BasePath](#sam-api-domainconfiguration-basepath): List [CertificateArn](#sam-api-domainconfiguration-certificatearn): String [DomainName](#sam-api-domainconfiguration-domainname): String [EndpointConfiguration](#sam-api-domainconfiguration-endpointconfiguration): String [MutualTlsAuthentication](#sam-api-domainconfiguration-mutualtlsauthentication): [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication) [NormalizeBasePath](#sam-api-domainconfiguration-normalizebasepath): Boolean [OwnershipVerificationCertificateArn](#sam-api-domainconfiguration-ownershipverificationcertificatearn): String [Policy: ](#sam-api-domainconfiguration-policy)Json [Route53](#sam-api-domainconfiguration-route53): Route53Configuration [SecurityPolicy](#sam-api-domainconfiguration-securitypolicy): String ``` ## Properties `AccessAssociation` 產生` AWS::ApiGateway::DomainNameAccessAssociation`資源所需的組態。 AWS SAM 會在設定此屬性時產生 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html) 資源。如需所產生 CloudFormation 資源的資訊，請參閱 [為產生 CloudFormation 資源 AWS SAM](sam-specification-generated-resources.md)。 *類型*：[DomainAccessAssociation](sam-property-api-domainaccessassociation.md) *必要*：否 *CloudFormation 相容性*：此屬性對是唯一的 AWS SAM ，並且沒有 CloudFormation 同等屬性。 `BasePath` 使用 Amazon API Gateway 網域名稱設定的基本路徑清單。 *類型：*清單 *必要*：否 *預設*：/ *CloudFormation 相容性*：此屬性類似於 `AWS::ApiGateway::BasePathMapping` 資源的 `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` 屬性。會 AWS SAM 建立多個`AWS::ApiGateway::BasePathMapping`資源，此屬性中`BasePath`指定的每個資源一個。 `CertificateArn` 此網域名稱端點 AWS 受管憑證的 Amazon Resource Name (ARN)。 AWS Certificate Manager 是唯一支援的來源。 *類型：*字串 *必要*：是 *CloudFormation 相容性*：此屬性類似於 `AWS::ApiGateway::DomainName` 資源的 `[CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)` 屬性。如果 `EndpointConfiguration` 設定為 `REGIONAL`（預設值），則會`CertificateArn`映射至中的 [RegionalCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn)`AWS::ApiGateway::DomainName`。如果 `EndpointConfiguration` 設定為 `EDGE`，會`CertificateArn`映射至中的 [CertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn)`AWS::ApiGateway::DomainName`。如果 `EndpointConfiguration` 設定為 `PRIVATE`，則此屬性會傳遞至 [AWS：：ApiGateway：：DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2) 資源。 *其他備註*：對於 `EDGE`端點，您必須在 `us-east-1` AWS 區域中建立憑證。 `DomainName` API Gateway API 的自訂網域名稱。不支援大寫字母。 AWS SAM 會在設定此屬性時產生 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) 資源。如需此案例的資訊，請參閱 [已指定 DomainName 屬性](sam-specification-generated-resources-api.md#sam-specification-generated-resources-api-domain-name)。如需所產生 CloudFormation 資源的資訊，請參閱 [為產生 CloudFormation 資源 AWS SAM](sam-specification-generated-resources.md)。 *類型：*字串 *必要*：是 *CloudFormation 相容性*：此屬性會直接傳遞至 `AWS::ApiGateway::DomainName` 資源的 `[DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname)` 屬性，或在 EndpointConfiguration 設定為 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)時傳遞至 `PRIVATE`。 `EndpointConfiguration` 定義要映射到自訂網域的 API Gateway 端點類型。此屬性的值會決定`CertificateArn`屬性的映射方式 CloudFormation。 *有效值*：`EDGE`、`REGIONAL` 或 `PRIVATE` *類型：*字串 *必要*：否 *預設*：`REGIONAL` *CloudFormation 相容性*：此屬性對是唯一的 AWS SAM ，並且沒有 CloudFormation 同等的。 `MutualTlsAuthentication` 自訂網域名稱的相互 Transport Layer Security (TLS) 身分驗證組態。 *類型*：[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication) *必要*：否 *CloudFormation 相容性*：此屬性會直接傳遞至 `AWS::ApiGateway::DomainName` 資源的 `[MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication)` 屬性。 `NormalizeBasePath` 指出`BasePath`屬性定義的 Basepaths 中是否允許非英數字元。設為時`True`，會從 basepaths 中移除非英數字元。 `NormalizeBasePath` 搭配 `BasePath` 屬性使用。 *類型*：布林值 *必要*：否 *預設*：True *CloudFormation 相容性*：此屬性對是唯一的 AWS SAM ，並且沒有 CloudFormation 同等的。 `OwnershipVerificationCertificateArn` ACM 核發之公有憑證的 ARN，用於驗證您的自訂網域的擁有權。只有在您設定交互 TLS 並指定的 ACM 匯入或私有 CA 憑證 ARN 時才需要`CertificateArn`。 *類型：*字串 *必要*：否 *CloudFormation 相容性*：此屬性會直接傳遞至 `AWS::ApiGateway::DomainName` 資源的 `[OwnershipVerificationCertificateArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn)` 屬性。 `Policy` 要連接至 API Gateway 網域名稱的 IAM 政策。僅適用於 `EndpointConfiguration` 設定為時`PRIVATE`。 *類型*：Json *必要*：否 *CloudFormation 相容性*：`EndpointConfiguration`當設定為時，此屬性會直接傳遞至 `AWS::ApiGateway::DomainNameV2` 資源的 `Policy` 屬性`PRIVATE`。如需有效政策文件的範例，請參閱 [AWS：：ApiGateway：：DomainNameV2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)。 `Route53` 定義 Amazon Route 53 組態。 *類型*：[Route53Configuration](sam-property-api-route53configuration.md) *必要*：否 *CloudFormation 相容性*：此屬性對是唯一的 AWS SAM ，並且沒有 CloudFormation 同等的。 `SecurityPolicy` 此網域名稱的 TLS 版本加上密碼套件。 *類型：*字串 *必要*：否 *CloudFormation 相容性*：此屬性會直接傳遞至 `AWS::ApiGateway::DomainName` 資源的 `[SecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy)` 屬性，或在 `EndpointConfiguration` 設定為 [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2)時傳遞至 `PRIVATE`。對於`PRIVATE`端點，僅支援 TLS\$11\$12。 ## 範例 ### DomainName DomainName 範例 #### YAML ``` Domain: DomainName: www.example.com CertificateArn: arn-example EndpointConfiguration: EDGE Route53: HostedZoneId: Z1PA6795UKMFR9 BasePath: - foo - bar ```