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

AWS::ApiGateway::DocumentationPart

AWS::ApiGateway::DocumentationPart リソースで、Amazon API Gateway API エンティティのドキュメントパーツを作成します。詳細については、『API Gateway 開発者ガイド』の「API Gateway での API ドキュメントの表現」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

Copy
{ "Type" : "AWS::ApiGateway::DocumentationPart", "Properties" : { "Location" : Location, "Properties" : String, "RestApiId" : String } }

YAML

Copy
Type: "AWS::ApiGateway::DocumentationPart" Properties: Location: Location Properties: String RestApiId: String

プロパティ

注記

各プロパティの詳細 (制約や有効な値など) については、『Amazon API Gateway REST API リファレンス』の「DocumentationPart」を参照してください。

Location

ドキュメントが適用される API エンティティの場所。

必須: はい

タイプ: Amazon API Gateway DocumentationPart Location

更新に伴う要件: 置換。

Properties

ターゲット API エンティティのドキュメントコンテンツマップ。

必須: はい

タイプ: 文字列

更新に伴う要件: 中断はありません。

RestApiId

ターゲット API エンティティの識別子。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換。

戻り値

参照番号

AWS::ApiGateway::DocumentationPart リソースの論理 ID を Ref 組み込み関数に渡すと、その関数はドキュメントパーツの ID (abc123 など) を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

以下の例では、API エンティティのドキュメントパーツをドキュメントバージョンに関連付けています。

JSON

Copy
{ "Parameters": { "apiName": { "Type": "String" }, "description": { "Type": "String" }, "version": { "Type": "String" }, "type": { "Type": "String" }, "property": { "Type": "String" } }, "Resources": { "RestApi": { "Type": "AWS::ApiGateway::RestApi", "Properties": { "Name": { "Ref": "apiName" } } }, "DocumentationPart": { "Type": "AWS::ApiGateway::DocumentationPart", "Properties": { "Location": { "Type": { "Ref": "type" } }, "RestApiId": { "Ref": "RestApi" }, "Property": { "Ref": "property" } } }, "DocumentationVersion": { "Type": "AWS::ApiGateway::DocumentationVersion", "Properties": { "Description": { "Ref": "description" }, "DocumentationVersion": { "Ref": "version" }, "RestApiId": { "Ref": "RestApi" } }, "DependsOn": "DocumentationPart" } } }

YAML

Copy
Parameters: apiName: Type: String description: Type: String version: Type: String type: Type: String property: Type: String Resources: RestApi: Type: 'AWS::ApiGateway::RestApi' Properties: Name: !Ref apiName DocumentationPart: Type: 'AWS::ApiGateway::DocumentationPart' Properties: Location: Type: !Ref type RestApiId: !Ref RestApi Property: !Ref property DocumentationVersion: Type: 'AWS::ApiGateway::DocumentationVersion' Properties: Description: !Ref description DocumentationVersion: !Ref version RestApiId: !Ref RestApi DependsOn: DocumentationPart

このページの内容: