DomainConfiguration

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

类型：列表

必需：否

默认值:/

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

的 Amazon 资源名称 (ARN)Amazon托管证书此域名的终端节点。Amazon Certificate Manager是唯一受支持的源。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性类似于CertificateArn的财产AWS::ApiGateway::DomainName资源。如果EndpointConfiguration设置为REGIONAL（默认值），CertificateArn映射到RegionalCertificateArn在AWS::ApiGateway::DomainName. 如果EndpointConfiguration设置为EDGE、CertificateArn映射到CertificateArn在AWS::ApiGateway::DomainName.

附加说明：对于EDGE终端节点，您必须在us-east-1 Amazon区域。

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

Amazon SAM生成AWS::ApiGateway::DomainName设置此属性时的资源。有关此方案的信息，请参阅指定了 DomainName 属性. 有关生成的信息Amazon CloudFormation资源，请参阅生成Amazon CloudFormation资源.

类型：字符串

必需：是

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

定义要映射到自定义域的 API Gateway 终端节点的类型。此属性的价值决定了CertificateArn属性被映射在Amazon CloudFormation.

有效值：REGIONAL 或 EDGE

类型：字符串

必需：否

默认值：REGIONAL

Amazon CloudFormation兼容性：该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效函数。

自定义域名的相互传输层安全性 (TLS) 身份验证配置。

类型：MutualTls身份验证

必需：否

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

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

类型：字符串

必需：否

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

定义亚马逊路线 53 配置。

类型：Route53 配置

必需：否

Amazon CloudFormation兼容性：该属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效函数。

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

类型：字符串

必需：否

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