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

Amazon API Gateway DocumentationPart Location

Location プロパティで、ドキュメントが適用される Amazon API Gateway API エンティティの場所を指定します。LocationAWS::ApiGateway::DocumentationPart リソースのプロパティです。

構文

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

JSON

Copy
{ "Method" : String, "Name" : String, "Path" : String, "StatusCode" : String, "Type" : String }

YAML

Copy
Method: String Name: String Path: String StatusCode: String Type: String

プロパティ

注記

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

Method

メソッドの HTTP 動詞。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

Name

ターゲット API エンティティの名前。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

Path

ターゲットの URL パス。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

StatusCode

レスポンスの HTTP ステータスコード。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

Type

ドキュメントコンテンツが適用される API エンティティのタイプ。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 置換。

このページの内容: