実行時アクションパラメーターとは、ジョブの アクションパラメーターを指定する方法 として「ジョブの実行時にアクションパラメーターを指定する」方法を選択した際に、ジョブの実行時に渡すパラメーターです。
実行時アクションパラメーターを利用したジョブ実行、作成方法については ジョブ実行時にアクションパラメーターを指定するジョブを作成する のマニュアルをご参照ください。
アクション毎の指定可能なパラメーター
実行時アクションパラメーターで指定可能なパラメーターはアクション毎に異なります。
現在は以下のアクションが「ジョブの実行時にアクションパラメーターを指定する」方法に対応しています。
EC2: インスタンスを起動
パラメーター名 |
必須 |
説明 |
---|---|---|
region | 必須 |
対象のEC2インスタンスが存在するAWSリージョン (例: ap-northeast-1) |
specify_instance | 必須 |
対象のEC2インスタンスの特定方法 |
instance_id | オプション | 対象の EC2 インスタンス ID ※ specify_instance でidentifier を指定した場合は必須 |
tag_key | オプション | EC2 インスタンス特定に利用するタグのキー ※ specify_instance で tag を指定した場合は必須 |
tag_value | オプション | EC2 インスタンス特定に利用するタグのキー ※ specify_instance で tag を指定した場合は必須 |
trace_status | オプション | EC2 インスタンスの起動完了をジョブ完了の判定にするフラグ |
例:
{
"region": "ap-northeast-1",
"specify_instance": "identifier",
"instance_id": "i-xxxxxxxxxxxxxxxx",
"trace_status": "false"
}
EC2: インスタンスを停止
パラメーター名 |
必須 |
説明 |
---|---|---|
region | 必須 |
対象のEC2インスタンスが存在するAWSリージョン ( 例: ap-northeast-1 ) |
specify_instance | 必須 |
対象のEC2インスタンスの特定方法 |
instance_id | オプション | 対象の EC2 インスタンス ID ※ specify_instance でidentifier を指定した場合は必須 |
tag_key | オプション | EC2 インスタンス特定に利用するタグのキー ※ specify_instance で tag を指定した場合は必須 |
tag_value | オプション | EC2 インスタンス特定に利用するタグのキー ※ specify_instance で tag を指定した場合は必須 |
trace_status | オプション | EC2 インスタンスの起動完了をジョブ完了の判定にするフラグ |
例:
{
"region": "ap-northeast-1",
"specify_instance": "identifier",
"instance_id": "i-xxxxxxxxxxxxxxxx",
"trace_status": "false"
}