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

AWS::ApiGateway::Resource

AWS::ApiGateway::Resource 资源在 Amazon API Gateway (API 网关) API 中创建资源。

语法

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

JSON

Copy
{ "Type" : "AWS::ApiGateway::Resource", "Properties" : { "ParentId" : String, "PathPart" : String, "RestApiId" : String } }

YAML

Copy
Type: "AWS::ApiGateway::Resource" Properties: ParentId: String PathPart: String RestApiId: String

属性

ParentId

如果您需要创建子资源,则为父资源的 ID。对于没有父资源的资源,指定 RestApi 根资源 ID,例如 { "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }

Required: Yes

Type: String

更新要求替换

PathPart

资源的路径名称。

Required: Yes

Type: String

更新要求替换

RestApiId

您要在其中创建此资源的 RestApi 资源的 ID。

Required: Yes

Type: String

更新要求替换

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回此资源 ID,如 abc123

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

示例

下面的示例为 MyApi API 创建 stack 资源。

JSON

Copy
"Stack": { "Type": "AWS::ApiGateway::Resource", "Properties": { "RestApiId": { "Ref": "MyApi" }, "ParentId": { "Fn::GetAtt": ["MyApi", "RootResourceId"] }, "PathPart": "stack" } }

YAML

Copy
Stack: Type: "AWS::ApiGateway::Resource" Properties: RestApiId: Ref: "MyApi" ParentId: Fn::GetAtt: - "MyApi" - "RootResourceId" PathPart: "stack"

本页内容: