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

AWS::ApiGateway::DocumentationVersion

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

トピック

構文

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

JSON

Copy
{ "Type" : "AWS::ApiGateway::DocumentationVersion", "Properties" : { "Description" : String, "DocumentationVersion" : String, "RestApiId" : String } }

YAML

Copy
Type: "AWS::ApiGateway::DocumentationVersion" Properties: Description: String DocumentationVersion: String RestApiId: String

プロパティ

注記

各プロパティの詳細については、『Amazon API Gateway REST API リファレンス』の 「DocumentationVersion」を参照してください。

Description

API ドキュメントスナップショットの説明。

必須: いいえ

タイプ: 文字列

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

DocumentationVersion

API ドキュメントスナップショットのバージョン識別子。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換。

RestApiId

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

必須: はい

タイプ: 文字列

更新に伴う要件: 置換。

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

JSON

Copy
{ "Parameters": { "apiName": { "Type": "String" }, "description": { "Type": "String" }, "property": { "Type": "String" }, "stageName": { "Type": "String" }, "type": { "Type": "String" }, "version": { "Type": "String" } }, "Resources": { "Deployment": { "Type": "AWS::ApiGateway::Deployment", "Properties": { "RestApiId": { "Ref": "RestApi" } }, "DependsOn": [ "Method" ] }, "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" }, "Method": { "Type": "AWS::ApiGateway::Method", "Properties": { "AuthorizationType": "NONE", "HttpMethod": "POST", "ResourceId": { "Fn::GetAtt": [ "RestApi", "RootResourceId" ] }, "RestApiId": { "Ref": "RestApi" }, "Integration": { "Type": "MOCK" } } }, "RestApi": { "Type": "AWS::ApiGateway::RestApi", "Properties": { "Name": { "Ref": "apiName" } } }, "Stage": { "Type": "AWS::ApiGateway::Stage", "Properties": { "DeploymentId": { "Ref": "Deployment" }, "DocumentationVersion": { "Ref": "version" }, "RestApiId": { "Ref": "RestApi" }, "StageName": { "Ref": "stageName" } }, "DependsOn": "DocumentationVersion" } } }

YAML

Copy
Parameters: apiName: Type: String description: Type: String property: Type: String stageName: Type: String type: Type: String version: Type: String Resources: Deployment: Type: 'AWS::ApiGateway::Deployment' Properties: RestApiId: !Ref RestApi DependsOn: - Method 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 Method: Type: 'AWS::ApiGateway::Method' Properties: AuthorizationType: NONE HttpMethod: POST ResourceId: !GetAtt - RestApi - RootResourceId RestApiId: !Ref RestApi Integration: Type: MOCK RestApi: Type: 'AWS::ApiGateway::RestApi' Properties: Name: !Ref apiName Stage: Type: 'AWS::ApiGateway::Stage' Properties: DeploymentId: !Ref Deployment DocumentationVersion: !Ref version RestApiId: !Ref RestApi StageName: !Ref stageName DependsOn: DocumentationVersion

このページの内容: