メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::ApiGateway::Resource

AWS::ApiGateway::Resource リソースは Amazon API Gateway (API Gateway) 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。親のないリソースの場合は、{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] } のような RestApi のルートリソース ID を指定します。

Required: Yes

Type: String

更新に伴う要件: 置換

PathPart

リソースのパス名。

Required: Yes

Type: String

更新に伴う要件: 置換

RestApiId

このリソースを作成する RestApi リソースの ID。

Required: Yes

Type: String

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により abc123 のようなリソース ID が返されます。

Ref 関数の使用方法の詳細については、「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"

このページの内容: