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

AWS::ApiGateway::Resource

AWS::ApiGateway::Resource 资源在 API 中创建资源。

语法

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

JSON

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

YAML

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

属性

ParentId

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

必需:是

类型:字符串

Update requires: Replacement

PathPart

资源的路径名称。

必需:是

类型:字符串

Update requires: Replacement

RestApiId

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

必需:是

类型:字符串

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回资源 ID,例如 abc123

For more information about using the Ref function, see Ref.

示例

创建资源

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

JSON

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

YAML

Stack: Type: 'AWS::ApiGateway::Resource' Properties: RestApiId: !Ref MyApi ParentId: !GetAtt - MyApi - RootResourceId PathPart: stack

另请参阅