AWS::ApiGateway::RestApi EndpointConfiguration - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGateway::RestApi EndpointConfiguration

EndpointConfiguration 属性类型指定 REST API 的终端节点类型。

EndpointConfigurationAWS::ApiGateway::RestApi 资源的属性。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Types" : [ String, ... ], "VpcEndpointIds" : [ String, ... ] }

YAML

Types: - String VpcEndpointIds: - String

属性

Types

API 或其自定义域名的终端节点类型的列表。有效值包括:

  • EDGE:对于边缘优化 API 及其自定义域名。

  • REGIONAL:对于区域 API 及其自定义域名。

  • PRIVATE:用于私有 API。

必需:否

类型:字符串列表

Update requires: No interruption

VpcEndpointIds

要创建 Route53 别名的 API (AWS::ApiGateway::RestApi) 的 VPC 终端节点 ID 列表。仅 PRIVATE 终端节点类型支持它。

必需:否

类型:字符串列表

Update requires: No interruption

另请参阅

  • Amazon API Gateway REST API 参考中的 RestApi