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

AWS::ApiGateway::RestApi S3Location

S3LocationAWS::ApiGateway::RestApi 资源的一个属性,可指定 OpenAPI(之前称为 Swagger)文件的 Amazon S3 位置,该文件定义一组 JSON 或 YAML 格式的 RESTful API。

注意

2016 年 1 月 1 日,Swagger 规范提供给 OpenAPI 计划,作为 OpenAPI 规范的基础。

语法

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

JSON

{ "Bucket" : String, "ETag" : String, "Key" : String, "Version" : String }

YAML

Bucket: String ETag: String Key: String Version: String

属性

Bucket

存储了 OpenAPI 文件的 S3 存储桶的名称。

必需:否

类型:字符串

Update requires: No interruption

ETag

OpenAPI 文件的 Amazon S3 ETag(文件校验和)。如果您未指定值,API Gateway 将跳过 OpenAPI 文件的 ETag 验证。

必需:否

类型:字符串

Update requires: No interruption

Key

OpenAPI 文件的文件名(Amazon S3 对象名称)。

必需:否

类型:字符串

Update requires: No interruption

Version

对于启用了版本控制的存储桶,则为 OpenAPI 文件的特定版本。

必需:否

类型:字符串

Update requires: No interruption

另请参阅

  • Amazon API Gateway REST API 参考中的 RestApi