View a markdown version of this page

AWSSupport-RecoverWorkSpaceWithApproval - AWS Systems Manager オートメーションランブックリファレンス

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWSSupport-RecoverWorkSpaceWithApproval

説明

AWSSupport-RecoverWorkSpaceWithApproval ランブックは、運用状態が の場合に指定した Amazon WorkSpaces (WorkSpaces) インスタンスで復旧ステップを実行しますUnhealthy。入力パラメータと使用可能なスナップショットに指定した値に応じて、ランブックはステータスが になるまで WorkSpaces を再起動、復元、再構築しますAvailable。このランブックは自動化アクションを使用します。このaws:approveアクションは、指定されたプリンシパルが選択した復旧アクションを承認または拒否するまで、自動化を一時的に一時停止します。

重要

WorkSpace の復元または再構築は、データが失われる可能性のある潜在的に破壊的なアクションです。これは、WorkSpace が最後に利用可能なスナップショットから復元され、スナップショットから復旧したデータは 12 時間前のものである可能性があるためです。

復元オプションは、最新のスナップショットに基づいて、ルートボリュームとユーザーボリュームの両方を再作成します。再構築オプションは、最新のスナップショットからユーザーボリュームを再作成し、WorkSpace の作成元のバンドルに関連付けられたイメージから WorkSpace を再作成します。WorkSpace の作成後にインストールされたアプリケーション、または変更されたシステム設定は失われます。WorkSpaces の復元と再構築の詳細については、「Amazon WorkSpaces 管理ガイド」の「WorkSpace の復元」および「WorkSpace の再構築」を参照してください。

このランブックを使用する前に、Amazon WorkSpaces 管理ガイド」の「Amazon WorkSpaces の問題のトラブルシューティングAmazon WorkSpaces 」トピックを確認することをお勧めします。

仕組み

ランブックは次の復旧アクションを順番に実行し、WorkSpaces が Available状態になるとすぐに停止します。

  • WorkSpaces の初期状態を取得し、復旧可能な状態 (UnhealthyErrorImpairedStopped、または ) であることを確認しますAvailable

  • WorkSpaces が の場合Stopped、 はそれを開始し、結果を待機します。

  • WorkSpaces で使用可能な再構築スナップショットと復元スナップショットを取得します。

  • Amazon Simple Notification Service (Amazon SNS) を介して、指定された承認者に承認通知を送信し、承認または拒否されるまで一時停止します。

  • 承認され、 が に設定されている場合YesRebootは WorkSpaces を再起動し、結果を待機します。

  • WorkSpaces がまだ ではなくAvailable、 に設定されている場合YesRestoreは最新のスナップショットから WorkSpaces を復元し、結果を待機します。

  • WorkSpaces がまだ ではなくAvailable、 に設定されている場合YesRebuildは最新のバンドルイメージから WorkSpaces を再構築し、結果を待機します。

  • WorkSpaces の最終状態が であることを確認しますAvailable

このオートメーションを実行する (コンソール)

ドキュメントタイプ

オートメーション

[所有者]

Amazon

[Platforms] (プラットフォーム)

/

必要な IAM アクセス許可

AutomationAssumeRole パラメータでは、ランブックを正常に使用するために、次のアクションが必要です。

  • sns:Publish

  • workspaces:DescribeWorkspaces

  • workspaces:DescribeWorkspaceSnapshots

  • workspaces:RebootWorkspaces

  • workspaces:RebuildWorkspaces

  • workspaces:RestoreWorkspace

  • workspaces:StartWorkspaces

IAM ポリシーの例:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workspaces:DescribeWorkspaces", "workspaces:DescribeWorkspaceSnapshots", "workspaces:RebootWorkspaces", "workspaces:RebuildWorkspaces", "workspaces:RestoreWorkspace", "workspaces:StartWorkspaces" ], "Resource": "*" }, { "Effect": "Allow", "Action": "sns:Publish", "Resource": "arn:aws:sns:*:*:Automation*" } ] }
指示

次の手順に従って自動化を設定します。

  1. ドキュメントの Systems Manager で AWSSupport-RecoverWorkSpaceWithApproval を開きます。

  2. [Execute automation (自動化の実行)] を選択してください。

  3. 入力パラメータには、次のように入力します。

    • AutomationAssumeRole(オプション):

      Systems Manager Automation AWS がユーザーに代わってアクションを実行できるようにする IAM ロール ARN。ロールを指定しない場合、Systems Manager Automation はこのランブックを開始するユーザーのアクセス許可を使用します。型: AWS::IAM::Role::Arn

    • WorkspaceId (必須):

      復旧する WorkSpaces の ID。パターン と一致する必要があります^ws-[0-9a-z]{8,63}$。型: String

    • 再起動 (オプション):

      WorkSpaces を再起動Yesできるようにするには、 に設定します。デフォルト: Yes。使用できる値: Yes | No。型: String

    • 復元 (オプション):

      WorkSpaces の復元Yesを許可するには、 に設定します。システムは、ルートボリュームの最新のスナップショットに復元されます。最新のスナップショットの作成後にインストールされたアプリケーションまたはシステム設定は失われます。ユーザーボリュームは最新のスナップショットから再作成され、現在のコンテンツは上書きされます。デフォルト: No。使用できる値: Yes | No。型: String

    • 再構築 (オプション):

      WorkSpaces の再構築Yesを許可するには、 に設定します。システムは、WorkSpaces が作成されたバンドルの最新のイメージで更新されます。WorkSpaces の作成後にインストールされたアプリケーションまたはシステム設定は失われます。ユーザーボリュームは最新のスナップショットから再作成され、現在のコンテンツは上書きされます。デフォルト: No。使用できる値: Yes | No。型: String

    • 確認 (必須):

      と入力Yesして、復元アクションと再構築アクションの両方が最新のスナップショットから WorkSpaces を復元し、スナップショットから復元されたデータが 12 時間経過できることを承認します。許可されるパターン: ^[Yy][Ee][Ss]$。型: String

    • 承認者 (必須):

      自動化アクションの承認者の IAM ユーザー名または ARNs のリスト。プリンシパルは、IAM ユーザー名、IAM ユーザー ARN、IAM ロール ARN、または IAM 継承ロールユーザー ARN として指定できます。最小: 1、最大: 10。型: StringList

    • MinRequiredApprovals (オプション):

      自動化の実行を再開するために必要な承認の最小数。値は、 Approversパラメータで定義された承認者の数を超えることはできません。デフォルト: 1。使用できる値: 110。型: Integer

    • SNSTopicArn (必須):

      保留中の承認通知の送信に使用される Amazon SNS トピック ARN。Amazon SNS トピック名には というプレフィックスを付ける必要がありますAutomation。型: String

  4. [実行] を選択してください。

  5. 自動化が開始されます。

  6. ドキュメントは以下のステップを実行します。

    • getWorkSpaceInitialState: WorkSpaces の現在の状態を取得します。

    • assertWorkSpaceInitialState: WorkSpaces が回復可能な状態 (AvailableError、、Unhealthy、または Stopped) であることを確認しますImpaired。WorkSpaces が他の状態にある場合、オートメーションは終了します。

    • branchOnWorkSpaceInitialState: 最初の WorkSpaces 状態に基づいて分岐します。の場合Stopped、WorkSpaces の開始に進みます。UnhealthyError、または の場合Impaired、 はスナップショットの取得に進みます。

    • startWorkSpace: Stopped状態の場合、WorkSpaces を開始します。

    • waitForStartWorkSpace: WorkSpaces が Starting ステータスになるまで最大 10 分待ちます。

    • waitForStartWorkSpaceResult: WorkSpaces が起動後に UnhealthyErrorImpaired、または Availableステータスになるまで最大 30 分待ちます。

    • getWorkSpaceStateAfterStart: 開始試行後に WorkSpaces 状態を取得します。

    • branchOnWorkSpaceStateAfterStart: WorkSpaces が の場合Available、 は最終的なアサーションに進みます。それ以外の場合、 はスナップショットの取得に進みます。

    • getWorkSpaceSnapshots: WorkSpaces で使用可能な再構築スナップショットと復元スナップショットを取得します。

    • approval: 指定された Amazon SNS トピックに承認通知を送信し、指定された承認者が復旧アクションを承認または拒否するまで最大 24 時間自動化を一時停止します。

    • branchOnRebootAllowed: Rebootが に設定されている場合Yes、 は WorkSpaces の再起動に進みます。それ以外の場合、 は復元ブランチに進みます。

    • rebootWorkSpace: WorkSpaces を再起動します。

    • waitForRebootWorkSpace: WorkSpaces が Rebooting ステータスになるまで最大 10 分待ちます。

    • waitForRebootWorkSpaceResult: 再起動後に WorkSpaces が UnhealthyError、または Availableステータスになるまで最大 30 分待ちます。

    • getWorkSpaceStateAfterReboot: 再起動の試行後に WorkSpaces 状態を取得します。

    • branchOnWorkSpaceStateAfterReboot: WorkSpaces が の場合Available、 は最終的なアサーションに進みます。それ以外の場合、 は復元ブランチに進みます。

    • branchOnRestoreAllowed: Restoreが に設定されている場合Yes、 は WorkSpaces の復元に進みます。それ以外の場合、 は再構築ブランチに進みます。

    • restoreWorkSpace: 最新のスナップショットから WorkSpaces を復元します。復元が失敗すると、オートメーションは再構築ブランチに進みます。

    • waitForRestoreWorkSpace: WorkSpaces が Restoring ステータスになるまで最大 10 分待ちます。

    • waitForRestoreWorkSpaceResult: 復元後に WorkSpaces が UnhealthyError、または Availableステータスになるまで最大 30 分待ちます。

    • getWorkSpaceStateAfterRestore: 復元の試行後に WorkSpaces の状態を取得します。

    • branchOnWorkSpaceStateAfterRestore: WorkSpaces が の場合Available、 は最終的なアサーションに進みます。それ以外の場合、 は再構築ブランチに進みます。

    • branchOnRebuildAllowed: Rebuildが に設定されている場合Yes、 は WorkSpaces の再構築に進みます。それ以外の場合、 は最終的なアサーションに進みます。

    • rebuildWorkSpace: 最新のバンドルイメージから WorkSpaces を再構築します。

    • waitForRebuildWorkSpace: WorkSpaces が Rebuilding ステータスになるまで最大 10 分待ちます。

    • waitForRebuildWorkSpaceResult: 再構築後に WorkSpaces が UnhealthyError、または Availableステータスになるまで最大 30 分待ちます。

    • getWorkSpaceStateAfterRebuild: 再構築の試行後に WorkSpaces 状態を取得します。

    • assertWorkSpaceFinalState: WorkSpaces のステータスが であることを確認しますAvailable。WorkSpaces が Available状態でない場合、オートメーションは失敗します。

  7. 完了したら、出力セクションで実行の詳細な結果を確認します。

リファレンス

Systems Manager Automation