本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# Amazon WorkSpaces
AWS Systems Manager 自動化為 Amazon WorkSpaces 提供預先定義的 Runbook。如需有關執行手冊的詳細資訊，請參閱 [Working with runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents.html)。如需如何檢視 Runbook 內容的詳細資訊，請參閱 [檢視 Runbook 內容](automation-runbook-reference.md#view-automation-json)。
**Topics**
+ [`AWS-CreateWorkSpace`](aws-create-workspace.md)
+ [`AWSSupport-RecoverWorkSpace`](automation-awssupport-recover-workspace.md)
# `AWS-CreateWorkSpace`
**Description**
`AWS-CreateWorkSpace` Runbook 會根據您為輸入參數指定的值，建立新的 Amazon WorkSpaces 虛擬桌面，稱為 WorkSpace。如需 WorkSpaces 的相關資訊，請參閱《[Amazon WorkSpaces 管理指南》中的什麼是 Amazon WorkSpaces？](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces.html)。 *Amazon WorkSpaces *
[執行此自動化 （主控台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-CreateWorkspace)
**文件類型**
自動化
**擁有者**
Amazon
**平台**
Linux、macOS、 Windows
**參數**
+ AutomationAssumeRole
類型：字串
描述：（選用） 允許 Systems Manager Automation 代表您執行動作的 (IAM) 角色的 AWS Identity and Access Management Amazon Resource Name (ARN)。如果未指定角色，Systems Manager Automation 會使用啟動此 Runbook 之使用者的許可。
+ BundleId
類型：字串
描述：（必要） 用於 WorkSpace 的套件 ID。
+ ComputeTypeName
類型：字串
有效值：VALUE \$1 STANDARD \$1 PERFORMANCE \$1 POWER \$1 GRAPHICS \$1 POWERPRO \$1 GRAPHICSPRO
描述：（選用） WorkSpace 的運算類型。
+ DirectoryId
類型：字串
描述：（必要） 要新增 WorkSpace 的目錄 ID。
+ RootVolumeEncryptionEnabled
類型：布林值
有效值：true \$1 false
預設：false
描述：（選用） 判斷 WorkSpace 的根磁碟區是否已加密。
+ RootVolumeSizeGib
類型：整數
描述：（必要） WorkSpace 根磁碟區的大小。
+ RunningMode
類型：字串
有效值：ALWAYS\$1ON \$1 AUTO\$1STOP
描述：（必要） WorkSpace 的執行模式。
+ RunningModeAutoStopTimeoutInMinutes
類型：整數
描述：（選用） 使用者在 WorkSpaces 停止時登出後的時間。以 60 分鐘的間隔指定值。
+ Tags (標籤)
類型：字串
描述：（選用） 您要套用至 WorkSpace 的標籤。
+ UserName
類型：字串
描述：（必要） 要與 WorkSpace 建立關聯的使用者名稱。
+ UserVolumeEncryptionEnabled
類型：布林值
有效值：true \$1 false
預設：false
描述：（選用） 判斷 WorkSpace 的使用者磁碟區是否已加密。
+ UserVolumeSizeGib
類型：整數
描述：（必要） WorkSpace 的使用者磁碟區大小。
+ VolumeEncryptionKey
類型：字串
描述：（選用） 您要用來加密 WorkSpace 上存放資料的對稱 AWS Key Management Service 金鑰。
**必要的 IAM 許可**
`AutomationAssumeRole` 參數需要下列動作才能成功使用 Runbook。
+ `workspaces:CreateWorkspaces`
+ `workspaces:DescribeWorkspaces`
**文件步驟**
+ `aws:executeScript` - 根據您為輸入參數指定的值建立 WorkSpace。
+ `aws:waitForAwsResourceProperty` - 驗證 WorkSpace 的狀態為 `AVAILABLE`。
**輸出**
`CreateWorkspace.WorkspaceId`
# `AWSSupport-RecoverWorkSpace`
**Description**
`AWSSupport-RecoverWorkSpace` Runbook 會在您指定的 Amazon WorkSpaces 虛擬桌面上執行復原步驟，稱為 WorkSpace。Runbook 會重新啟動 WorkSpace，如果狀態仍然為 `UNHEALTHY` ， 會根據您為輸入參數指定的值來還原或重建 WorkSpace。使用此 Runbook 之前，建議您檢閱《Amazon [ WorkSpaces 管理指南》中的對 WorkSpaces 問題進行故障診斷](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-troubleshooting.html)。 *Amazon WorkSpaces *
**重要**
還原或重建 WorkSpace 是可能導致資料遺失的潛在破壞性動作。這是因為 WorkSpace 從最後一個可用的快照還原，而從快照復原的資料可能長達 12 小時。
還原選項會根據最新的快照重新建立根磁碟區和使用者磁碟區。重建選項會從最新的快照重新建立使用者磁碟區，並從與建立 WorkSpace 之套件相關聯的映像重新建立 WorkSpace。已安裝的應用程式或在建立 WorkSpace 後變更的系統設定將會遺失。如需還原和重建 WorkSpaces 的詳細資訊，請參閱《Amazon [ WorkSpaces 管理指南》中的還原](https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html) WorkSpace 和[重建 WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/rebuild-workspace.html) WorkSpace。 *Amazon WorkSpaces *
[執行此自動化 （主控台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSSupport-RecoverWorkSpace)
**文件類型**
自動化
**擁有者**
Amazon
**平台**
Linux、macOS、 Windows
**參數**
+ AutomationAssumeRole
類型：字串
描述：（選用） 允許 Systems Manager Automation 代表您執行動作的 (IAM) 角色的 AWS Identity and Access Management Amazon Resource Name (ARN)。如果未指定角色，Systems Manager Automation 會使用啟動此 Runbook 之使用者的許可。
+ 確認
類型：字串
有效值：是
描述：（必要） 輸入 yes 表示您了解還原和重建動作會嘗試從最新的快照復原 WorkSpace，而且從這些快照還原的資料可能長達 12 小時。
+ 重新啟動
類型：字串
有效值：是 \$1 否
預設：是
描述：（必要） 判斷 WorkSpace 是否重新啟動。
+ 重建
類型：字串
有效值：是 \$1 否
預設：否
描述：（必要） 決定是否重建 WorkSpace。
+ 還原
類型：字串
有效值：是 \$1 否
預設：否
描述：（必要） 決定是否還原 WorkSpace。
+ WorkspaceId
類型：字串
描述：（必要） 您要復原的 WorkSpace ID。
**必要的 IAM 許可**
`AutomationAssumeRole` 參數需要下列動作才能成功使用 Runbook。
+ `ssm:StartAutomationExecution`
+ `ssm:GetAutomationExecution`
+ `workspaces:DescribeWorkspaces`
+ `workspaces:DescribeWorkspaceSnapshots`
+ `workspaces:RebootWorkspaces`
+ `workspaces:RebuildWorkspaces`
+ `workspaces:RestoreWorkspace`
+ `workspaces:StartWorkspaces`
**文件步驟**
+ `aws:executeAwsApi` - 收集您在 `WorkspaceId` 參數中指定的 WorkSpace 狀態。
+ `aws:assertAwsResourceProperty` - 驗證 WorkSpace 的狀態為 `AVAILABLE` 、`ERROR`、、 `IMPAIRED` `STOPPED` 或 `UNHEALTHY` 。
+ `aws:branch` - 根據 WorkSpace 狀態的分支。
+ `aws:executeAwsApi` - 啟動 WorkSpace。
+ `aws:branch` - 根據您為 `Action` 參數指定的值進行分支。
+ `aws:waitForAwsResourceProperty` - 在啟動後等待 WorkSpace 狀態。
+ `aws:waitForAwsResourceProperty` - 等待 WorkSpace 狀態在啟動`UNHEALTHY`後變更為 `AVAILABLE` 、、 `ERROR` `IMPAIRED` 或 。
+ `aws:executeAwsApi` - 開始後收集 WorkSpace 的狀態。
+ `aws:branch` - 啟動後根據 WorkSpace 狀態進行分支。
+ `aws:executeAwsApi` - 收集可用於還原或重建 WorkSpace 的快照。
+ `aws:branch` - 根據您為 `Reboot` 參數指定的值進行分支。
+ `aws:executeAwsApi` - 重新啟動 WorkSpace。
+ `aws:executeAwsApi` - 開始後收集 WorkSpace 的狀態。
+ `aws:waitForAwsResourceProperty` - 等待 WorkSpace 的狀態變更為 `REBOOTING` 。
+ `aws:waitForAwsResourceProperty` - 重新啟動`UNHEALTHY`後，等待 WorkSpace 狀態變更為 `AVAILABLE` 、 `ERROR` 或 。
+ `aws:executeAwsApi` - 在重新啟動後收集 WorkSpace 的狀態。
+ `aws:branch` - 重新啟動後，根據 WorkSpace 狀態進行分支。
+ `aws:branch` - 根據您為 `Restore` 參數指定的值進行分支。
+ `aws:executeAwsApi` - 還原 WorkSpace。如果還原失敗，執行手冊會嘗試重建 WorkSpace。
+ `aws:waitForAwsResourceProperty` - 等待 WorkSpace 的狀態變更為 `RESTORING` 。
+ `aws:waitForAwsResourceProperty` - 等待 WorkSpace 狀態在還原`UNHEALTHY`後變更為 `AVAILABLE` 、 `ERROR` 或 。
+ `aws:executeAwsApi` - 在還原後收集 WorkSpace 的狀態。
+ `aws:branch` - 還原後根據 WorkSpace 狀態進行分支。
+ `aws:branch` - 根據您為 `Rebuild` 參數指定的值進行分支。
+ `aws:executeAwsApi` - 重建 WorkSpace。
+ `aws:waitForAwsResourceProperty` - 等待 WorkSpace 的狀態變更為 `REBUILDING` 。
+ `aws:waitForAwsResourceProperty` - 等待 WorkSpace 狀態在重建`UNHEALTHY`後變更為 `AVAILABLE` 、 `ERROR` 或 。
+ `aws:executeAwsApi` - 在重建後收集 WorkSpace 的狀態。
+ `aws:assertAwsResourceProperty` - 確認 WorkSpace 的狀態為 `AVAILABLE` 。