aws:changeInstanceState – インスタンスの状態を変更またはアサートする

インスタンスの状態を変更またはアサートします。

このアクションは、アサートモードで使用できます (API は実行して状態を変更することはしませんが、インスタンスが目的の状態であることを検証します)。アサートモードを使用するには、CheckStateOnly パラメータを true に設定します。このモードは、Windows で Sysprep (バックグラウンドで長期に実行できる非同期コマンド) を実行するときに役立ちます。Amazon Machine Image (AMI) を作成する前に、インスタンスが停止していることを確認できます。

注記

このアクションのデフォルトのタイムアウト値は 3600 秒 (1 時間) です。timeoutSeconds ステップで aws:changeInstanceState パラメータを指定して、タイムアウトを制限または延長することができます。

[Input] (入力)

YAML

name: stopMyInstance
action: aws:changeInstanceState
maxAttempts: 3
timeoutSeconds: 3600
onFailure: Abort
inputs:
  InstanceIds:
  - i-1234567890abcdef0
  CheckStateOnly: true
  DesiredState: stopped

JSON

{
    "name":"stopMyInstance",
    "action": "aws:changeInstanceState",
    "maxAttempts": 3,
    "timeoutSeconds": 3600,
    "onFailure": "Abort",
    "inputs": {
        "InstanceIds": ["i-1234567890abcdef0"],
        "CheckStateOnly": true,
        "DesiredState": "stopped"
    }
}

InstanceIds

インスタンスの ID。

タイプ: StringList

必須: はい

CheckStateOnly

false の場合、インスタンスの状態は目的の状態に設定されます。true の場合、ポーリングを使用して目的の状態をアサートします。

デフォルト: false

タイプ: ブール値

必須: いいえ

DesiredState

目的の状態。running に設定されている場合、このアクションは Amazon EC2 の状態が Running、インスタンスの状態が OK、および完了する前にシステム状態が OK になるのを待ちます。

型: 文字列

有効な値: running | stopped | terminated

必須: はい

Force

設定した場合、インスタンスが強制的に停止されます。インスタンスによって、ファイルシステムキャッシュまたはファイルシステムメタデータがフラッシュされることはありません。このオプションを使用する場合は、ファイルシステムのチェックと修復の手順を手動で実行する必要があります。このオプションは Windows Server の EC2 インスタンスにはお勧めしません。

タイプ: ブール値

必須: いいえ

AdditionalInfo

リザーブド。

型: 文字列

必須: いいえ

出力

なし