5.2.13 仮想サーバの起動
機能
この部品は,Amazon EC2環境でインスタンスを起動します。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降,「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され,実行されます。
・インスタンス
Amazon EC2環境の仮想ホストのことで,一般的な仮想サーバのことです。
この部品内のスクリプトでは,次に示すAWS Toolsのコマンドレットを実行します。
・Start-EC2Instance -InstanceId "インスタンスID(AWS.instanceIdプロパティ)の値"
上記コマンドレットを実行したあと,起動したインスタンスの状態が"running"になることを確認します。
AWS Toolsのコマンドレットの詳細については,AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
利用場面
この部品は,Amazon EC2環境でインスタンスを起動する場合に使用します。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】/【実行対象システム内前提製品】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
・AWS Tools for Windows PowerShell
・Microsoft .Net Framework 3.5以降
【実行対象サーバ内前提製品の稼働OS】
・Windows Server
【実行対象システム内前提製品】
なし。
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) その他の注意事項については,AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
実行権限
(1) AWSにログインするIAMユーザーが,次に示すアクションを行えるようにポリシー設定されている必要があります。
・インスタンスの起動および状態取得
バージョン
02.00.00
部品のタグ
Control VM,AWS
タスクログに表示される部品の名称
awsPowerOnVM
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
23 |
異常(環境不正) 前提環境不正 |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
AWS.accessKeyId |
アクセスキーID |
AWSに接続するためのアクセスキーIDを指定します。 |
− |
入力 |
○ |
|
AWS.secretAccessKey |
シークレットアクセスキー |
AWSに接続するためのシークレットアクセスキーを指定します。 |
− |
入力 |
○ |
|
AWS.region |
リージョン |
接続先となるAWSのリージョンを指定します。 |
− |
入力 |
○ |
|
AWS.instanceId |
インスタンスID |
インスタンスのIDを指定します。 |
− |
入力 |
○ |
|
AWS.checkInstanceEnabledCount |
インスタンスの起動完了の確認回数 |
インスタンスの起動が完了したか確認する際の確認回数を指定します。インスタンスの起動完了の確認間隔と組み合わせて最大待ち時間となります。 |
− |
入力 |
○ |
|
AWS.checkInstanceEnabledInterval |
インスタンスの起動完了の確認間隔 |
インスタンスの起動が完了したか確認する際の確認間隔を秒単位で指定します。 |
− |
入力 |
○ |
|
AWS.instanceState |
インスタンスの状態 |
インスタンスの状態が格納されます。 |
− |
出力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |