5.2.1 AMIの作成
機能
この部品は，Amazon EC2環境で，インスタンスからAMI(Amazonマシンイメージ) を作成します。
この部品が前提とするサーバを次に示します。
・AWS操作サーバ(実行対象サーバ)
AWS Tools for Windows PowerShell(以降，「AWS Tools」と呼ぶ)がインストールされているサーバです。本製品によってこのサーバに部品が転送され，実行されます。
・インスタンス
Amazon EC2環境の仮想ホストのことで，一般的な仮想サーバのことです。
この部品内のスクリプトでは，次に示すAWS Toolsのコマンドレットを実行します。
・New-EC2Image -InstanceId "インスタンスID(AWS.instanceIdプロパティ)の値"
-Name "AMI名(AWS.amiNameプロパティ)の値"
-Description "AMIの説明(AWS.amiDescriptionプロパティ)の値"
-NoReboot "インスタンス再起動抑止(AWS.instanceNoRebootプロパティ)の値"
-Force
上記コマンドレットを実行したあと，作成したAMIの状態が"available"になることを確認します。
AWS Toolsのコマンドレットの詳細については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」を参照してください。
利用場面
この部品は，Amazon EC2環境でカスタマイズしたインスタンスからAMIを作成する場合に使用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働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) インスタンスに関する条件
・使用するインスタンスの状態が"running"または"stopped"であること。
注意事項
(1) この部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
(2) AMI名(AWS.amiNameプロパティ)には，作成済みのAMI名を指定しないでください。指定した場合，タスクが異常終了します。
(3) その他の注意事項については，AWSドキュメントの「AWS Tools for Windows PowerShell Cmdlet Reference」の注意事項を参照してください。
実行権限
(1) AWSにログインするIAMユーザーが，次に示すアクションを行えるようにポリシー設定されている必要があります。
・イメージの作成
バージョン
02.01.00
部品のタグ
Add VM Template,AWS
タスクログに表示される部品の名称
awsCreateImage
戻り値
|
戻り値 |
説明 |
|---|---|
|
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.amiName |
AMI名 |
作成するAMIの名称を指定します。 |
− |
入力 |
○ |
|
AWS.amiDescription |
AMIの説明 |
作成するAMIに設定する説明を指定します。 |
− |
入力 |
△ |
|
AWS.instanceNoReboot |
インスタンス再起動抑止 |
AMIを作成する前にインスタンスを停止しない場合は"true"を指定します。"true"以外の場合は，インスタンスをいったん停止してAMIを作成し，そのあと再起動します。 |
− |
入力 |
△ |
|
AWS.checkAmiCreationCount |
AMIの作成完了の確認回数 |
AMIの作成が完了したか確認する際の確認回数を指定します。AMIの作成完了の確認間隔と組み合わせて最大待ち時間となります。 |
− |
入力 |
○ |
|
AWS.checkAmiCreationInterval |
AMIの作成完了の確認間隔 |
AMIの作成が完了したか確認する際の確認間隔を秒単位で指定します。 |
− |
入力 |
○ |
|
AWS.amiIdOutput |
AMI ID |
作成したAMIのIDが格納されます。 |
− |
出力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |