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

AWS::ApiGateway::Deployment

AWS::ApiGateway::Deployment リソースは Amazon API Gateway (API Gateway) の RestApi リソースをステージにデプロイして、クライアントがインターネットを介して API を呼び出すことができるようにします。ステージは環境として機能します。

構文

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

JSON

Copy
{ "Type" : "AWS::ApiGateway::Deployment", "Properties" : { "Description" : String, "RestApiId" : String, "StageDescription" : StageDescription, "StageName" : String } }

YAML

Copy
Type: "AWS::ApiGateway::Deployment" Properties: Description: String RestApiId: String StageDescription: StageDescription StageName: String

プロパティ

Description

API Gateway デプロイメントの説明。

Required: No

Type: String

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

RestApiId

デプロイする RestApi リソースの ID。

Required: Yes

Type: String

更新に伴う要件: 置換

StageDescription

このデプロイメントで API Gateway が作成するステージを設定します。

Required: No

Type: Amazon API Gateway デプロイの StageDescription

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

StageName

このデプロイメントで API Gateway が作成するステージの名前。英数字のみを使用します。

Required: No

Type: String

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

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により 123abc のようなデプロイメント ID が返されます。

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

以下のセクションでは、API Gateway デプロイメントを宣言する例を示します。

空の埋め込みステージでのデプロイメント

次の例では、MyApi API を DummyStage という名前のステージにデプロイします。

JSON

Copy
"Deployment": { "Type": "AWS::ApiGateway::Deployment", "Properties": { "RestApiId": { "Ref": "MyApi" }, "Description": "My deployment", "StageName": "DummyStage" } }

YAML

Copy
Deployment: Type: "AWS::ApiGateway::Deployment" Properties: RestApiId: Ref: "MyApi" Description: "My deployment" StageName: "DummyStage"

AWS::ApiGateway::Method 依存関係

AWS::ApiGateway::RestApi リソースとそのメソッド (AWS::ApiGateway::Methodを使用して) をデプロイメントと同じテンプレートに作成する場合、デプロイメントは RestApi のメソッドに依存する必要があります。依存関係を作成するには、デプロイメントに DependsOn 属性を追加します。追加しないと、AWS CloudFormation によってメソッドを含まない RestApi リソースの作成後すぐにデプロイメントが作成され、AWS CloudFormation でエラー The REST API doesn't contain any methods が発生します。

JSON

Copy
"Deployment": { "DependsOn": "MyMethod", "Type": "AWS::ApiGateway::Deployment", "Properties": { "RestApiId": { "Ref": "MyApi" }, "Description": "My deployment", "StageName": "DummyStage" } }

YAML

Copy
Deployment: DependsOn: "MyMethod" Type: "AWS::ApiGateway::Deployment" Properties: RestApiId: Ref: "MyApi" Description: "My deployment" StageName: "DummyStage"

このページの内容: