ALIYUN::ApiGateway::Deployment は、指定された実行ステージに API をリリースするか、リリースされた API を指定されたバージョンに切り替える場合に使用できます。
構文
{ “Type” : “ALIYUN::ApiGateway::Deployment”, “Properties” : { “HistoryVersion” : String, “ApiId” : String, “Description” : String, “StageName” : String, “GroupId” : String }}
プロパティ
名前 | データ型 | 必須/省略可能 | 更新可/不可 | 説明 |
ApiId | String | 必須 | 不可 | API ID |
StageName | String | 必須 | 可 | 実行ステージ名。値 : TEST、PRE、または RELEASE |
GroupId | String | 必須 | 不可 | API グループ ID |
HistoryVersion | String | 省略可能 | 可 | このパラメーターを指定する場合は、リリース済み API を指定したバージョンに切り替えます。 このパラメーターを指定しない場合は、API をリリースします。 StageName と HistoryVersion は同時に更新できません。 |
Description | String | 省略可能 | 可 | リリースの備考 |
コーディング例
{ “ROSTemplateFormatVersion”: “2015-09-01”, “Parameters”: { “GroupId”: { “Type”: “String”, “Description”: “API group ID” }, “ApiId”: { “Type”: “String”, “Description”: “API ID” } }, “Resources”: { “Deployment”: { “Type”: “ALIYUN::ApiGateway::Deployment”, “Properties”: { “GroupId”: { “Ref”: “GroupId” }, “ApiId”: { “Ref”: “ApiId” }, “StageName”: “PRE”, “Description”: “TEST_ONLY_CHANGE” } } }}
</article>
</main>