DomainConfiguration

生成 AWS::ApiGateway::DomainNameAccessAssociation 资源所需的配置。

如果设置了此属性，Amazon SAM 会生成 AWS::ApiGateway::DomainNameAccessAssociation 资源。有关生成的 Amazon CloudFormation 资源的信息，请参阅 为 Amazon SAM 生成的 Amazon CloudFormation 资源。

类型：DomainAccessAssociation

必需：否

Amazon CloudFormation 兼容性：此属性为 Amazon SAM 独有，没有 Amazon CloudFormation 等效属性。

要使用 Amazon API Gateway 域名配置的基本路径列表。

类型：列表

必需：否

默认值：/

Amazon CloudFormation 兼容性：此属性类似于 AWS::ApiGateway::BasePathMapping 资源的 BasePath 属性。Amazon SAM 创建多个 AWS::ApiGateway::BasePathMapping 资源，在此属性中每个 BasePath 指定一个。

Amazon 托管证书的 Amazon 资源名称（ARN）该域名的端点。Amazon Certificate Manager 是唯一受支持的源。

类型：字符串

必需：是

Amazon CloudFormation 兼容性：此属性类似于 AWS::ApiGateway::DomainName 资源的 CertificateArn 属性。如果将 EndpointConfiguration 设置为 REGIONAL（默认值），则 CertificateArn 映射到 AWS::ApiGateway::DomainName 中的 RegionalCertificateArn。如果将 EndpointConfiguration 设置为 EDGE，则 CertificateArn 映射到 AWS::ApiGateway::DomainName 中的 CertificateArn。如果 EndpointConfiguration 设置为 PRIVATE，则此属性将传递给 AWS::ApiGateway::DomainNameV2 资源。

附加说明：对于 EDGE 端点，您必须在 us-east-1 Amazon 区域中创建证书。

API Gateway API 的自定义域名。不支持大写字母。

如果设置了此属性，Amazon SAM 会生成 AWS::ApiGateway::DomainName 资源。有关此场景的更多信息，请参阅指定了 DomainName 属性。有关生成的 Amazon CloudFormation 资源的信息，请参阅 为 Amazon SAM 生成的 Amazon CloudFormation 资源。

类型：字符串

必需：是

Amazon CloudFormation 兼容性：该属性将直接传递给 AWS::ApiGateway::DomainName 资源的 DomainName 属性，或在 EndpointConfiguration 设置为 PRIVATE 时传递给 AWS::ApiGateway::DomainNameV2。

定义要映射到自定义域的 API Gateway 端点的类型。此属性的值决定了 CertificateArn 属性在 Amazon CloudFormation 中的映射方式。

有效值：EDGE、REGIONAL 或 PRIVATE

类型：字符串

必需：否

默认值：REGIONAL

Amazon CloudFormation 兼容性：此属性为 Amazon SAM 独有，没有 Amazon CloudFormation 等效属性。

自定义域名的相互传输层安全性协议（TLS）身份验证配置。

类型：MutualTlsAuthentication

必需：否

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::ApiGateway::DomainName 资源的 MutualTlsAuthentication 属性。

表示 BasePath 属性定义的基本路径中是否允许非字母数字字符。如果设置为 True，则将从基本路径中移除非字母数字字符。

针对 BasePath 属性使用 NormalizeBasePath。

类型：布尔值

必需：否

默认值：True

Amazon CloudFormation 兼容性：此属性为 Amazon SAM 独有，没有 Amazon CloudFormation 等效属性。

ACM 颁发的用于验证自定义域所有权的公有证书的 ARN。只有在配置双向 TLS 并且为 CertificateArn 指定了 ACM 导入的或私有 CA 证书 ARN 时才需要。

类型：字符串

必需：否

Amazon CloudFormation 兼容性：此属性直接传递给 AWS::ApiGateway::DomainName 资源的 OwnershipVerificationCertificateArn 属性。

要附加到该 AP Gateway 域名的 IAM 策略。仅当 EndpointConfiguration 设置为 PRIVATE 时适用。

类型：Json

必需：否

Amazon CloudFormation 兼容性：当 EndpointConfiguration 设置为 PRIVATE 时，该属性将直接传递给 AWS::ApiGateway::DomainNameV2 资源的 Policy 属性。有关有效策略文件的示例，请参阅 AWS::ApiGateway::DomainNameV2。

定义 Amazon Route 53 配置。

类型：Route53Configuration

必需：否

Amazon CloudFormation 兼容性：此属性为 Amazon SAM 独有，没有 Amazon CloudFormation 等效属性。

此域名的 TLS 版本加密码套件。

类型：字符串

必需：否

Amazon CloudFormation 兼容性：该属性将直接传递给 AWS::ApiGateway::DomainName 资源的 SecurityPolicy 属性，或在 EndpointConfiguration 设置为 PRIVATE 时传递给 AWS::ApiGateway::DomainNameV2。对于PRIVATE 端点，仅支持 TLS_1_2。