3.4.1 仮想サーバの削除
機能
このサービステンプレートは,Amazon EC2環境でインスタンスを削除します。また,インスタンスに接続しているすべてのネットワークインターフェイスも削除します。
このサービステンプレートが前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降,「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され,実行されます。
・インスタンス
Amazon EC2環境の仮想ホストのことで,一般的な仮想サーバのことです。
処理の概要を次に示します。
(1) インスタンスID(aws.instanceIdプロパティ)に指定したインスタンスを削除します。
(2) インスタンスに接続しているすべてのネットワークインターフェイスを削除します。
プロパティ設定の留意点を次に示します。
(1) インスタンスを削除する際には,インスタンスの削除完了の確認間隔(aws.checkInstanceDeletionIntervalプロパティ)に指定した秒数待ってインスタンスの状態を確認する動作を,インスタンスの削除完了の確認回数(aws.checkInstanceDeletionCountプロパティ)に指定した回数繰り返します。各プロパティの値は,利用している環境に合わせて調整してください。
前提条件
【サービステンプレート実行対象サーバ内前提製品】/【サービステンプレート実行対象サーバ内前提製品の稼働OS】/【サービステンプレート実行対象システム内前提製品】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【サービステンプレート実行対象サーバ内前提製品】
・AWS Tools for Windows PowerShell
・Microsoft .Net Framework 3.5以降
【サービステンプレート実行対象サーバ内前提製品の稼働OS】
・Windows Server
【サービステンプレート実行対象システム内前提製品】
なし。
【サービステンプレート実行対象システム内前提製品の使用条件】
(1) 本製品に関する条件
・このサービスを実行する場合,エージェントレス接続先として実行対象サーバを設定する必要があります。実行対象サーバとしてローカルサーバを使用する場合,"localhost"で解決されるループバックアドレスを設定する必要があります。
注意事項
(1) インスタンスにユーザーがログインしていても,インスタンスは削除されます。
(2) 削除されたインスタンスはしばらくの間コンソールに表示されたままで状態取得もできますが,起動はできません。
(3) インスタンスの削除(/awsDeleteVMステップ)が戻り値1で異常終了した場合,削除できなかったネットワークインターフェイスが残ります。
実行権限
(1) AWSにログインするIAMユーザーが,次に示すアクションを行えるようにポリシー設定されている必要があります。
・インスタンスの削除および状態取得
・ネットワークインターフェイスの削除および状態取得
バージョン
02.00.01
タグ
Delete VM,AWS
プロパティ一覧
プロパティに設定されているプロパティグループの一覧を次に示します。
プロパティグループ |
説明 |
初期表示 |
---|---|---|
仮想システム環境情報 |
AWSの情報を指定してください。 |
表示されます。 |
インスタンス情報 |
削除するインスタンスの情報を指定してください。 |
表示されます。 |
実行時オプション |
インスタンスの削除を行う際の状態確認に関するプロパティです。必要に応じて変更してください。 |
表示されません。 |
[サービス設定]画面に表示されるプロパティの一覧を次に示します。
- (凡例)
-
○:プロパティの指定は必須です。
△:プロパティの指定は省略可能です。ただし,ほかのプロパティの指定内容によっては,指定が必須になります。各プロパティの「説明」を確認してください。
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
---|---|---|---|---|---|---|
aws.targetHost |
AWS操作サーバのホスト名 |
AWS操作サーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
aws.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
aws.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
aws.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
入力 |
無効 |
○ |
仮想システム環境情報 |
aws.checkInstanceDeletionCount |
インスタンスの削除完了の確認回数 |
インスタンスが削除されたことを確認する際の確認回数を指定します。インスタンスの削除完了の確認間隔と組み合わせて最大待ち時間となります。このプロパティは,ネットワークインターフェイスの削除が完了したか確認する際も使用します。 |
入力 |
無効 |
○ |
実行時オプション |
aws.checkInstanceDeletionInterval |
インスタンスの削除完了の確認間隔 |
インスタンスが削除されたことを確認する際の確認間隔を秒単位で指定します。このプロパティは,ネットワークインターフェイスの削除が完了したか確認する際も使用します。 |
入力 |
無効 |
○ |
実行時オプション |
[サービス設定]画面および[サービス実行]画面に表示されるプロパティの一覧を次に示します。
プロパティキー |
プロパティ名 |
説明 |
入出力種別 |
共有設定 |
必須区分 |
プロパティグループ |
---|---|---|---|---|---|---|
aws.instanceId |
インスタンスID |
インスタンスのIDを指定します。 |
入力 |
無効 |
○ |
インスタンス情報 |
[サービス設定]画面に表示されるプロパティの入力制限を次に示します。
プロパティキー |
入力可能文字 |
---|---|
aws.targetHost |
256文字以内の半角英数字および「.」,「-」。 |
aws.accessKeyId |
64文字以内の半角英数字および半角記号。ただし,「<」,「>」,「|」,「"」,「'」,「;」,「&」を除く。 |
aws.secretAccessKey |
128文字以内の半角英数字および半角記号。ただし,「<」,「>」,「|」,「"」,「'」,「;」,「&」を除く。 |
aws.region |
32文字以内の半角英数字および「-」。 |
aws.checkInstanceDeletionCount |
1〜2147483647の整数値。 |
aws.checkInstanceDeletionInterval |
1〜60の整数値。 |
[サービス設定]画面および[サービス実行]画面に表示されるプロパティの入力制限を次に示します。
プロパティキー |
入力可能文字 |
---|---|
aws.instanceId |
32文字以内の半角英数字および「-」。 |
フロー仕様詳細
フロー仕様詳細を次の表に示します。
階層 |
[タスク詳細]画面での表示名 |
ステップ名 |
部品 |
||
---|---|---|---|---|---|
部品名 |
説明 |
エラー時の回復方法 |
|||
1 |
インスタンスの削除 |
インスタンスの削除 |
仮想サーバの削除 |
Amazon EC2環境で,インスタンスを削除します。 |
エラーの原因を取り除いたあと,サービスを再実行して下さい。なお,戻り値1でエラーになった場合は,サービスを再実行する必要はありませんが,残ったネットワークインターフェイスを必要に応じて削除してください。 |