5.2.15 仮想サーバの削除
機能
この部品は，Amazon EC2環境でインスタンスを削除します。インスタンスに接続されているネットワークインターフェイスもすべて削除します。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。
・インスタンス
Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。
この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。
(1)インスタンスの削除
・Stop-EC2Instance -Instance "インスタンスID(AWS.instanceIdプロパティ)の値"
-Terminate
-Force
上記コマンドレットを実行したあと，削除したインスタンスの状態が"terminated"になることを確認します。
(2)インスタンスに接続されているネットワークインターフェイスの削除
・Remove-EC2NetworkInterface -NetworkInterfaceId "Get-EC2Instanceコマンドレットで取得したネットワークインターフェイスID"
-Force
上記コマンドレットを実行したあと，削除したネットワークインターフェイスが存在しないことを確認します。
AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
利用場面
この部品は，Amazon EC2環境でインスタンスを削除する場合に使用します。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働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) インスタンスの前提OS
・Windows Server 2008 R2 Standard/Enterprise/Datacenter
・Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
・Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
・Red Hat Enterprise Linux Server 7 (64-bit x86_64)
・Red Hat Enterprise Linux Server 8 (64-bit x86_64)
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) インスタンスにユーザーがログインしていても，インスタンスは削除されます。
(3) 削除されたインスタンスはしばらくの間コンソールに表示されたままで状態取得もできますが，起動はできません。
(4) この部品が戻り値1で異常終了した場合，インスタンスに追加したネットワークインターフェイスは削除されずに残ります。
(5) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
実行権限
(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。
・インスタンスの削除および状態取得
・ネットワークインターフェイスの削除
バージョン
02.00.01
部品のタグ
Delete VM,AWS
タスクログに表示される部品の名称
awsDeleteVM
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
1 |
異常(インスタンス削除後にエラーを検知) ネットワークインターフェイス削除エラー |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
AWS.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
− |
入力 |
○ |
|
AWS.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
− |
入力 |
○ |
|
AWS.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
− |
入力 |
○ |
|
AWS.instanceId |
インスタンスID |
インスタンスのIDを指定します。 |
− |
入力 |
○ |
|
AWS.checkInstanceDeletionCount |
インスタンスの削除完了の確認回数 |
インスタンスの削除が完了したか確認する際の確認回数を指定します。インスタンスの削除完了の確認間隔と組み合わせて最大待ち時間となります。このプロパティは，ネットワークインターフェイスの削除が完了したか確認する際も使用します。 |
− |
入力 |
○ |
|
AWS.checkInstanceDeletionInterval |
インスタンスの削除完了の確認間隔 |
インスタンスの削除が完了したか確認する際の確認間隔を秒単位で指定します。このプロパティは，ネットワークインターフェイスの削除が完了したか確認する際も使用します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |