AWS workspaces documentation change
Summary
Updated documentation for modifying WorkSpaces streaming protocol to include AWS Management Console support, removed GPU restriction for protocol modification, added detailed console and CLI procedures, updated protocol parameter from DCV to WSP, extended modification time to 40 minutes, and added failure handling with automatic snapshots.
Security assessment
The changes are procedural updates for protocol migration from PCoIP to DCV (WSP). No security vulnerabilities, weaknesses, or incidents are mentioned. The changes focus on user experience, feature availability, and operational procedures without introducing or documenting security features.
Diff
diff --git a/workspaces/latest/adminguide/modify-workspaces.md b/workspaces/latest/adminguide/modify-workspaces.md index 30fd95d3b..3fde9d8d5 100644 --- a//workspaces/latest/adminguide/modify-workspaces.md +++ b//workspaces/latest/adminguide/modify-workspaces.md @@ -17 +17 @@ After you launch a WorkSpace, you can modify its configuration in three ways: - * You can modify the streaming protocol using the AWS CLI or Amazon WorkSpaces API if your WorkSpace was created with PCoIP bundles. + * You can modify the streaming protocol using the AWS Management Console, AWS CLI or Amazon WorkSpaces API if your WorkSpace was created with PCoIP bundles. @@ -177 +177 @@ Use the [modify-workspace-properties](https://docs.aws.amazon.com/cli/latest/ref -If your WorkSpace is created with PCoIP bundles, you can modify their streaming protocol using the AWS CLI or the Amazon WorkSpaces API. This allows you to migrate the protocol using your existing WorkSpace without using the WorkSpace migration feature. This also allows you to use DCV and maintain your root volume without re-creating existing PCoIP WorkSpaces during the migration process. +If your WorkSpace is created with PCoIP bundles, you can modify their streaming protocol using the AWS Management Console, AWS CLI, or Amazon WorkSpaces API. This allows you to migrate the protocol using your existing WorkSpace without using the WorkSpace migration feature. This also allows you to use DCV and maintain your root volume without re-creating existing PCoIP WorkSpaces during the migration process. @@ -179 +179 @@ If your WorkSpace is created with PCoIP bundles, you can modify their streaming - * You can only modify your protocol if your WorkSpace was created with PCoIP bundles and is not a GPU-enabled WorkSpace. + * You can only modify your protocol if your WorkSpace was created with PCoIP bundles. @@ -191,2 +190,0 @@ If your WorkSpace is created with PCoIP bundles, you can modify their streaming - * For the best experience with video conferencing we recommend using Power, PowerPro, GeneralPurpose.4xlarge, or GeneralPurpose.8xlarge only. - @@ -205 +203,35 @@ If your WorkSpace is created with PCoIP bundles, you can modify their streaming -###### To change the protocol of a WorkSpace +###### To change the protocol of a WorkSpace using the console + +The console provides a guided experience to change the protocol of a WorkSpace from PCoIP to DCV. + + 1. Open the [WorkSpaces console](https://console.aws.amazon.com/workspaces/v2/home). + + 2. Select the WorkSpace (ensure that it's in the `AVAILABLE` state and its current Protocol is `PCOIP`). + + 3. Choose Actions and then Modify Protocol. + + 4. Confirm to proceed with the modification. + + 5. It can take up to 40 minutes for the modification to complete. During the modification, the WorkSpace Status will show as _Modifying Protocol._ + + 6. To confirm completion, verify in the console that the WorkSpace Status is `AVAILABLE` and the current Protocol property has been changed to `DCV(WSP)`. + + + + +###### Note + + * During protocol modification, session provisioning is blocked. End users who attempt to connect will receive an error message indicating the WorkSpace is being modified. + + * In case of a protocol modification failure, the WorkSpace Status will show as _Modify Protocol Failed_. You can view all the WorkSpaces that failed during protocol modification by either selecting the _View failed WorkSpaces_ button in the console banner or by using the filters with combination of `PROTOCOL` and `UPDATE_FAILED`. + + * Before protocol modification begins, a checkpoint snapshot of the WorkSpace is automatically taken. In case of a protocol modification failure, you can restore the WorkSpace to this pre-modification state to ensure no data is lost. To restore, use the [Restore WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html) action. + + * After the WorkSpace has been restored to the checkpoint snapshot, try the Modify Protocol action again. If the failure persists, contact AWS Support. + + * After successful protocol modification, another WorkSpace snapshot is taken ensuring that the Restore WorkSpace action restores to the updated protocol. + + + + +###### To change the protocol of a WorkSpace using the CLI @@ -219 +251 @@ If your WorkSpace is created with PCoIP bundles, you can modify their streaming -The `Protocols` property is case-sensitive. Ensure that you use `PCOIP` or `DCV`. +The `Protocols` property is case-sensitive. Ensure that you use `PCOIP` or `WSP`. The input parameter for DCV (WSP) is `WSP`. @@ -221 +253 @@ The `Protocols` property is case-sensitive. Ensure that you use `PCOIP` or `DCV` - 4. After you run the command, it can take up to 20 minutes for the WorkSpace to reboot and complete the necessary configurations. + 4. After you run the command, it can take up to 40 minutes for the WorkSpace to complete the protocol modification workflow. @@ -229 +261,7 @@ The `Protocols` property is case-sensitive. Ensure that you use `PCOIP` or `DCV` - * If the WorkSpace remains in an `UNHEALTHY` state after 20 min, reboot the WorkSpace in the console. + * During protocol modification, session provisioning is blocked. End users who attempt to connect will receive an error message indicating the WorkSpace is being modified. + + * Protocol modification has failed if the WorkSpace is in an `UNHEALTHY` State with `RESOURCE: PROTOCOL` and `STATE: UPDATE_FAILED`. + + * Before protocol modification begins, a checkpoint snapshot of the WorkSpace is automatically taken. In case of a protocol modification failure, you can restore the WorkSpace to this pre-modification state to ensure no data is lost. To restore, use the [`restore-workspace`](https://docs.aws.amazon.com/cli/latest/reference/workspaces/restore-workspace.html) command. See [Restore WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html) documentation for details. + + * After the WorkSpace has been restored to the checkpoint snapshot, try the `modify-workspace-properties` command again. If the failure persists, contact AWS Support. @@ -231 +269 @@ The `Protocols` property is case-sensitive. Ensure that you use `PCOIP` or `DCV` - 6. You can now connect to your WorkSpace. + * After successful protocol modification, another WorkSpace snapshot is taken ensuring that the Restore WorkSpace action restores to the updated protocol.