5.2.3 スタックの削除
機能
この部品は，AWS CloudFormation環境で，スタックを削除します。スタックを削除すると，スタックに関連するAWSリソースもAWS CloudFormationによってすべて削除されます。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。
この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。
・Remove-CFNStack -StackName "スタック名(AWS.stackNameプロパティ)の値"
-Force
上記コマンドレットを実行したあと，削除したスタックが存在しないことを確認します。
AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
利用場面
この部品は，テンプレートファイルから作成したAWSリソースを削除する時に使用できます。また，AWSリソース作成に失敗したスタックなど，不要なスタックを削除する時も使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
・AWS Tools for Windows PowerShell
・Microsoft .Net Framework 3.5以降
【実行対象サーバ内前提製品の稼働OS】
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
ただし，Server Coreインストール環境は除く。
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) 削除対象の存在チェック行い，存在しない場合は戻り値12の異常終了となります。
(3) 削除対象の存在チェック行い，存在する場合かつステータスが"DELETE_IN_PROGRESS"の場合は戻り値12の異常終了となります。
(4) AWSリソースを削除できなかった場合，スタックは削除されずに残ります。
(5) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
実行権限
(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。
・スタックの削除および情報取得
・AWSリソースの削除
バージョン
02.01.00
部品のタグ
Delete VM,AWS
タスクログに表示される部品の名称
awsDeleteStack
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
AWS.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
− |
入力 |
○ |
|
AWS.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
− |
入力 |
○ |
|
AWS.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
− |
入力 |
○ |
|
AWS.stackName |
スタック名 |
スタックの名称を指定します。 |
− |
入力 |
○ |
|
AWS.checkStackDeletionCount |
スタックの削除完了の確認回数 |
スタックの削除が完了したか確認する際の確認回数を指定します。スタックの削除完了の確認間隔と組み合わせて最大待ち時間となります。 |
− |
入力 |
○ |
|
AWS.checkStackDeletionInterval |
スタックの削除完了の確認間隔 |
スタックの削除が完了したか確認する際の確認間隔を秒単位で指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |