AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::RestApi

AWS::ApiGateway::RestApi 资源包含可通过 HTTPS 终端节点调用的 Amazon API Gateway 资源和方法的集合。有关更多信息,请参阅 Amazon API Gateway REST API 参考 中的 restapi:create

注意

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

语法

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

JSON

{ "Type" : "AWS::ApiGateway::RestApi", "Properties" : { "BinaryMediaTypes" : [ String, ... ], "Body" : JSON object, "BodyS3Location" : S3Location, "CloneFrom" : String, "Description" : String, "FailOnWarnings" : Boolean, "Name" : String, "Parameters" : [ String, ... ] } }

YAML

Type: "AWS::ApiGateway::RestApi" Properties: BinaryMediaTypes: - 字符串 Body: JSON object BodyS3Location: S3Location CloneFrom: String Description: String FailOnWarnings: Boolean Name: String Parameters: - 字符串

属性

BinaryMediaTypes

RestApi 资源支持的二进制媒体类型的列表,例如 image/pngapplication/octet-stream 等。默认情况下,RestApi 只支持 UTF-8 编码的文本有效负载。有关更多信息,请参阅 API 网关 开发人员指南 中的在 API Gateway 中启用二进制有效负载支持。不允许重复项。

Required: No

Type: List of String values

更新要求无需中断

Body

定义一组 JSON 格式的 RESTful API 的 OpenAPI 规范。对于 YAML 模板,您还可以提供 YAML 格式的规范。

Required: No

Type: JSON object

更新要求无需中断

BodyS3Location

指向 OpenAPI 文件的 Amazon Simple Storage Service (Amazon S3) 位置,以 JSON 或 YAML 格式定义一组 RESTful API。

Required: No

Type: Amazon API Gateway RestApi S3Location

更新要求无需中断

CloneFrom

您要克隆的 API 网关 RestApi 资源的 ID。

Required: No

Type: String

更新要求无需中断

Description

此 API 网关 RestApi 资源用途的描述。

Required: No

Type: String

更新要求无需中断

FailOnWarnings

如果在 API 网关 创建 RestApi 资源时出现警告,请指示是否回滚资源。

Required: No

Type: Boolean

更新要求无需中断

Name

API 网关 RestApi 资源的名称。

Required: Conditional。如果您未指定 OpenAPI 定义,则此属性是必需的。

Type: String

更新要求无需中断

Parameters

自定义请求的标头参数。

Required: No

Type: List of String values

更新要求无需中断

返回值

Ref

Ref 内部函数提供此资源的逻辑 ID 时,Ref 返回 RestApi ID,例如 a1bcdef2gh

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。此部分列出了可用属性和示例返回值。

RootResourceId

RestApi 资源的根资源 ID,例如 a0bc123d4e

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

示例

以下示例创建一个 API 网关 RestApi 资源。

JSON

"MyRestApi": { "Type": "AWS::ApiGateway::RestApi", "Properties": { "Body": { OpenAPI specification } "Description": "A test API", "Name": "MyRestAPI" } }

YAML

MyRestApi: Type: "AWS::ApiGateway::RestApi" Properties: Body: OpenAPI specification Description: "A test API" Name: "MyRestAPI"

本页内容: