id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
workspaces-ag-107 | workspaces-ag.pdf | 107 | By default, the WorkSpaces client applications use the proxy server that’s specified in the device operating system settings for HTTPS (port 443) traffic. The Amazon WorkSpaces client applications use the HTTPS port for updates, registration, and authentication. Note Proxy servers that require authentication with sign-in credentials are not supported. You can configure the device proxy server settings for your Windows WorkSpaces through Group Policy by following the steps in Configure device proxy and internet connectivity settings in the Microsoft documentation. For more information about configuring the proxy settings in the WorkSpaces Windows client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces macOS client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces Web Access client application, see Proxy Server in the Amazon WorkSpaces User Guide. Proxying desktop traffic For PCoIP WorkSpaces, the desktop client applications do not support the use of a proxy server nor TLS decryption and inspection for port 4172 traffic in UDP (for desktop traffic). They require a direct connection to ports 4172. Manage Windows WorkSpaces 331 Amazon WorkSpaces Administration Guide For DCV WorkSpaces, the WorkSpaces Windows client application (version 5.1 and above) and macOS client application (version 5.4 and above) support the use of HTTP proxy servers for port 4195 TCP traffic. TLS decryption and inspection are not supported. DCV does not support the use of proxy for desktop traffic over UDP. Only WorkSpaces Windows and macOS desktop client applications and web access support the use of proxy, for TCP traffic. Note If you choose to use a proxy server, the API calls that the client application makes to the WorkSpaces services are also proxied. Both API calls and desktop traffic should pass through the same proxy server. Recommendation on the use of proxy servers We do not recommend the use of a proxy server with your WorkSpaces desktop traffic. Amazon WorkSpaces desktop traffic is already encrypted, so proxies do not improve security. A proxy represents an additional hop in the network path that could impact streaming quality by introducing latency. Proxies could also potentially reduce throughput if a proxy is not properly sized to handle desktop streaming traffic. Furthermore, most proxies are not designed for supporting long running WebSocket (TCP) connections and may affect streaming quality and stability. If you must use a proxy, please locate your proxy server as close to the WorkSpace client as possible, preferably in the same network, to avoid adding network latency, which could negatively impact streaming quality and responsiveness. Enable Amazon WorkSpaces for Zoom Meeting Media Plugin support Zoom supports optimized real-time communication for DCV and PCoIP Windows-based WorkSpaces, with the Zoom VDI Plugin. Direct client communication allows video calls to bypass the cloud-based virtual desktop and provide a local-like Zoom experience when the meeting is running inside the your user’s WorkSpace. Enable Zoom Meeting Media Plugin for DCV Before installing the Zoom VDI components, update your WorkSpaces configuration to support Zoom optimization. Manage Windows WorkSpaces 332 Amazon WorkSpaces Prerequisites Administration Guide Before using the plugin, make sure the following requirements are met. • Windows WorkSpaces client version 5.10.0+ with Zoom VDI Plugin version 5.17.10+ • Within your WorkSpaces — Zoom VDI Meeting client version 5.17.10+ Before you begin 1. Enable the Extensions Group Policy setting. For more information, see Configure extensions for DCV. 2. Disable the Automatic reconnect Group Policy setting. For more information, see Set the session resume timeout for DCV. Installing the Zoom components To enable Zoom optimization, install two components, provided by Zoom, on your Windows WorkSpaces. For more information, see Using Zoom for Amazon Web Services. 1. 2. Install the Zoom VDI Meeting client version 5.12.6+ within your WorkSpace. Install the Zoom VDI Plugin (Windows Universal Installer) version 5.12.6+ on the client where your WorkSpace is installed 3. Validate the plugin is optimizing the Zoom traffic, by confirming that your VDI Plugin Status shows as Connected within the Zoom VDI client. For more information, see How to confirm Amazon WorkSpaces optimization . Enable Zoom Meeting Media Plugin for PCoIP Users with administrative permission to Active Directory can generate a registry key using their Group Policy Object (GPO). This allows users to send the registry key to all the Windows WorkSpaces within your domain using a forced update. Alternatively, users with administrative rights can also install registry keys individually on their WorkSpaces host. Prerequisites Before using the plugin, make sure the following requirements are met. • Windows WorkSpaces client version 5.4.0+ with Zoom VDI Plugin version 5.12.6+. Manage Windows WorkSpaces 333 Amazon WorkSpaces Administration Guide • Within your WorkSpaces — Zoom VDI Meeting client version 5.12.6+. Create the registry key on a Windows WorkSpaces host Complete the following procedure to |
workspaces-ag-108 | workspaces-ag.pdf | 108 | registry key using their Group Policy Object (GPO). This allows users to send the registry key to all the Windows WorkSpaces within your domain using a forced update. Alternatively, users with administrative rights can also install registry keys individually on their WorkSpaces host. Prerequisites Before using the plugin, make sure the following requirements are met. • Windows WorkSpaces client version 5.4.0+ with Zoom VDI Plugin version 5.12.6+. Manage Windows WorkSpaces 333 Amazon WorkSpaces Administration Guide • Within your WorkSpaces — Zoom VDI Meeting client version 5.12.6+. Create the registry key on a Windows WorkSpaces host Complete the following procedure to create a registry key on a Windows WorkSpaces host. The registry key is required to use Zoom on Windows WorkSpaces. 1. Open Windows Registry Editor as an administrator. 2. Go to \HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Amazon. 3. 4. If the Extension key doesn't exist, right-click and choose New > Key and name it Extension. In the new Extension key, right-click and choose New > DWORD and name it enable. The name must be in lower-case. 5. Choose the new DWORD and change the Value to 1. 6. Reboot the computer to complete the process. 7. On your WorkSpaces host, download and install the latest Zoom VDI client. On your WorkSpaces client (5.4 or higher), download and install the latest Zoom VDI client plugin for Amazon WorkSpaces. For more information, see VDI releases and downloads on the Zoom support website. Launch Zoom to start your video call. Troubleshooting Complete the following actions to troubleshoot Zoom on Windows WorkSpaces. • Confirm that The Registry Key Activation and Applied Correctly. • Go to C:\ProgramData\Amazon\Amazon WorkSpaces Extension. You should see wse_core_dll. • Make sure that the versions on the host and clients are correct and the same. If you continue to experience difficulty, contact Support using the Support Center. You can use the following examples to apply a GPO as an administrator of your directory. • WSE.adml <?xml version="1.0" encoding="utf-8"?> Manage Windows WorkSpaces 334 Amazon WorkSpaces Administration Guide <policyDefinitionResources xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" revision="1.0" schemaVersion="1.0" xmlns="http://www.microsoft.com/GroupPolicy/PolicyDefinitions"> <!-- 'displayName' and 'description' don't appear anywhere. All Windows native GPO template files have them set like this. --> <displayName>enter display name here</displayName> <description>enter description here</description> <resources> <stringTable> <string id="SUPPORTED_ProductOnly">N/A</string> <string id="Amazon">Amazon</string> <string id="Amazon_Help">Amazon Group Policies</string> <string id="WorkspacesExtension">Workspaces Extension</string> <string id="WorkspacesExtension_Help">Workspace Extension Group Policies</ string> <!-- Extension Itself --> <string id="ToggleExtension">Enable/disable Extension Virtual Channel</ string> <string id="ToggleExtension_Help"> Allows two-way Virtual Channel data communication for multiple purposes By default, Extension is disabled.</string> </stringTable> </resources> </policyDefinitionResources> • WSE.admx <?xml version="1.0" encoding="utf-8"?> <policyDefinitions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http:// www.w3.org/2001/XMLSchema-instance" revision="1.0" schemaVersion="1.0" xmlns="http:// www.microsoft.com/GroupPolicy/PolicyDefinitions"> <policyNamespaces> <target prefix="WorkspacesExtension" namespace="Microsoft.Policies.Amazon.WorkspacesExtension" /> </policyNamespaces> <supersededAdm fileName="wse.adm" /> <resources minRequiredRevision="1.0" /> <supportedOn> <definitions> Manage Windows WorkSpaces 335 Amazon WorkSpaces Administration Guide <definition name="SUPPORTED_ProductOnly" displayName="$(string.SUPPORTED_ProductOnly)"/> </definitions> </supportedOn> <categories> <category name="Amazon" displayName="$(string.Amazon)" explainText="$(string.Amazon_Help)" /> <category name="WorkspacesExtension" displayName="$(string.WorkspacesExtension)" explainText="$(string.WorkspacesExtension_Help)"> <parentCategory ref="Amazon" /> </category> </categories> <policies> <policy name="ToggleExtension" class="Machine" displayName="$(string.ToggleExtension)" explainText="$(string.ToggleExtension_Help)" key="Software\Policies\Amazon\Extension" valueName="enable"> <parentCategory ref="WorkspacesExtension" /> <supportedOn ref="SUPPORTED_ProductOnly" /> <enabledValue> <decimal value="1" /> </enabledValue> <disabledValue> <decimal value="0" /> </disabledValue> </policy> </policies> </policyDefinitions> Manage your Amazon Linux 2 WorkSpaces in WorkSpaces Personal For workloads that require RPM Package Manager (RPM), we recommend using Red Hat Enterprise Linux or Rocky Linux. Amazon Linux 2 may not provide the latest versions of some applications and libraries, such as Firefox and glibc, that you may need. Because Linux instances do not adhere to Group Policy, we recommend that you use a configuration management solution to distribute and enforce policy. For example, you can use Ansible. Manage your Amazon Linux 2 WorkSpaces 336 Amazon WorkSpaces Note Local printer redirection is not available for Amazon Linux WorkSpaces. Administration Guide Control DCV behavior on Amazon Linux WorkSpaces The behavior of DCV is controlled by configuration settings in the wsp.conf file, which is located in the /etc/wsp/ directory. To deploy and enforce changes to the policy, use a configuration management solution that supports Amazon Linux. Any changes take effect when the agent starts up. Note • If you make incorrect or unsupported changes to the wsp.conf file, policy changes may not be applied to the newly established connections on your WorkSpace. • Amazon Linux WorkSpaces on DCV bundles currently have the following limitations: • Currently only available in the AWS GovCloud (US-West) and AWS GovCloud (US-East). • Video-in is not supported. • Disconnect session on screen lock is not supported. The following sections describe how to enable or disable certain features. Configure clipboard redirection for DCV Amazon Linux WorkSpaces By default, WorkSpaces supports clipboard redirection. Use the DCV configuration file to configure this feature, if needed. This setting takes effect when you disconnect and reconnect the WorkSpace. To configure clipboard redirection for DCV Amazon Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. clipboard = X Manage your Amazon Linux 2 WorkSpaces 337 |
workspaces-ag-109 | workspaces-ag.pdf | 109 | is not supported. • Disconnect session on screen lock is not supported. The following sections describe how to enable or disable certain features. Configure clipboard redirection for DCV Amazon Linux WorkSpaces By default, WorkSpaces supports clipboard redirection. Use the DCV configuration file to configure this feature, if needed. This setting takes effect when you disconnect and reconnect the WorkSpace. To configure clipboard redirection for DCV Amazon Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. clipboard = X Manage your Amazon Linux 2 WorkSpaces 337 Amazon WorkSpaces Administration Guide Where the possible values for X are: enabled — Clipboard redirection is enabled in both directions (default) disabled — Clipboard redirection is disabled in both directions paste-only — Clipboard redirection is enabled but only allows you to copy contents from the local client device and paste it to the remote host desktop copy-only — Clipboard redirection is enabled but only allows you to copy contents from the remote host desktop and paste it to the local client device Enable or disable audio-in redirection for DCV Amazon Linux WorkSpaces By default, WorkSpaces supports audio-in redirection. Use the DCV configuration file to disable this feature, if needed. This setting takes effect when you disconnect and reconnect to the WorkSpace. To enable or disable audio-in redirection for DCV Amazon Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the file. audio-in = X Where the possible values for X are: enabled — Audio-in redirection is enabled (default) disabled — Audio-in redirection is disabled Enable or disable time zone redirection for DCV Amazon Linux WorkSpaces By default, the time within a Workspace is set to mirror the time zone of the client that is being used to connect to the WorkSpace. This behavior is controlled through time zone redirection. You might want to turn off time zone direction for reasons such as the following: Manage your Amazon Linux 2 WorkSpaces 338 Amazon WorkSpaces Administration Guide • Your company wants all employees to work in a certain time zone (even if some employees are in other time zones). • You have scheduled tasks in a WorkSpace that are meant to run at a certain time in a specific time zone. • Your users who travel a lot want to keep their WorkSpaces in one time zone for consistency and personal preference. Use the DCV configuration file to configure this feature, if needed. This setting takes effect after you disconnect and reconnect to the WorkSpace. To enable or disable time zone redirection for DCV Amazon Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp-agent/wsp.conf 2. Add the following line to the end of the file. timezone_redirect= X Where the possible values for X are: enabled — Time zone redirection is enabled (default) disabled — Time zone redirection is disabled Control PCoIP Agent behavior on Amazon Linux WorkSpaces The behavior of the PCoIP Agent is controlled by configuration settings in the pcoip-agent.conf file, which is located in the /etc/pcoip-agent/ directory. To deploy and enforce changes to the policy, use a configuration management solution that supports Amazon Linux. Any changes take effect when the agent starts up. Restarting the agent ends any open connections and restarts the window manager. To apply any changes, we recommend rebooting the WorkSpace. Note If you make incorrect or unsupported changes to the pcoip-agent.conf file, you might cause your WorkSpace to stop working. If your WorkSpace stops working, you might need Manage your Amazon Linux 2 WorkSpaces 339 Amazon WorkSpaces Administration Guide to either connect to your WorkSpace using SSH to roll back the changes, or you might have to rebuild the WorkSpace. The following sections describe how to enable or disable certain features. For a full listing of the available settings, run man pcoip-agent.conf from the terminal on any Amazon Linux WorkSpace. Configure clipboard redirection for PCoIP Amazon Linux WorkSpaces By default, WorkSpaces supports clipboard redirection. Use the PCoIP Agent conf to disable this feature, if needed. This setting takes effect when you reboot the WorkSpace. To configure clipboard redirection for PCoIP Amazon Linux WorkSpaces 1. Open the pcoip-agent.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/pcoip-agent/pcoip-agent.conf 2. Add the following line to the end of the file. pcoip.server_clipboard_state = X Where the possible values for X are: 0 — Clipboard redirection is disabled in both directions 1 — Clipboard redirection is enabled in both directions 2 — Clipboard redirection is enabled client to agent only (allow copy and paste only from |
workspaces-ag-110 | workspaces-ag.pdf | 110 | to disable this feature, if needed. This setting takes effect when you reboot the WorkSpace. To configure clipboard redirection for PCoIP Amazon Linux WorkSpaces 1. Open the pcoip-agent.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/pcoip-agent/pcoip-agent.conf 2. Add the following line to the end of the file. pcoip.server_clipboard_state = X Where the possible values for X are: 0 — Clipboard redirection is disabled in both directions 1 — Clipboard redirection is enabled in both directions 2 — Clipboard redirection is enabled client to agent only (allow copy and paste only from local client device to the remote host desktop) 3 — Clipboard redirection is enabled agent to client only (allow copy and paste only from the remote host desktop to the local client device) Manage your Amazon Linux 2 WorkSpaces 340 Amazon WorkSpaces Note Administration Guide Clipboard redirection is implemented as a virtual channel. If virtual channels are disabled, clipboard redirection doesn't work. To enable virtual channels, see PCoIP Virtual Channels in the Teradici documentation. Enable or disable audio-in redirection for PCoIP Amazon Linux WorkSpaces By default, WorkSpaces supports audio-in redirection. Use the PCoIP Agent conf to disable this feature, if needed. This setting takes effect when you reboot the WorkSpace. To enable or disable audio-in redirection for PCoIP Amazon Linux WorkSpaces 1. Open the pcoip-agent.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/pcoip-agent/pcoip-agent.conf 2. Add the following line to the end of the file. pcoip.enable_audio = X Where the possible values for X are: 0 — Audio-in redirection is disabled 1 — Audio-in redirection is enabled Enable or disable time zone redirection for PCoIP Amazon Linux WorkSpaces By default, the time within a Workspace is set to mirror the time zone of the client that is being used to connect to the WorkSpace. This behavior is controlled through time zone redirection. You might want to turn off time zone direction for reasons such as the following: • Your company wants all employees to work in a certain time zone (even if some employees are in other time zones). • You have scheduled tasks in a WorkSpace that are meant to run at a certain time in a specific time zone. Manage your Amazon Linux 2 WorkSpaces 341 Amazon WorkSpaces Administration Guide • Your users who travel a lot want to keep their WorkSpaces in one time zone for consistency and personal preference. If needed for Linux WorkSpaces, you can use the PCoIP Agent conf to disable this feature. This setting takes effect when you reboot the WorkSpace. To enable or disable time zone redirection for PCoIP Amazon Linux WorkSpaces 1. Open the pcoip-agent.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/pcoip-agent/pcoip-agent.conf 2. Add the following line to the end of the file. pcoip.enable_timezone_redirect= X Where the possible values for X are: 0 — Time zone redirection is disabled 1 — Time zone redirection is enabled Grant SSH access to Amazon Linux WorkSpaces administrators By default, only assigned users and accounts in the Domain Admins group can connect to Amazon Linux WorkSpaces by using SSH. We recommend that you create a dedicated administrators group for your Amazon Linux WorkSpaces administrators in Active Directory. To enable sudo access for members of the Linux_Workspaces_Admins Active Directory group 1. Edit the sudoers file by using visudo, as shown in the following example. [example\username@workspace-id ~]$ sudo visudo 2. Add the following line. Manage your Amazon Linux 2 WorkSpaces 342 Amazon WorkSpaces Administration Guide %example.com\\Linux_WorkSpaces_Admins ALL=(ALL) ALL After you create the dedicated administrators group, follow these steps to enable login for members of the group. To enable login for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit /etc/security/access.conf with elevated rights. [example\username@workspace-id ~]$ sudo vi /etc/security/access.conf 2. Add the following line. +:(example\Linux_WorkSpaces_Admins):ALL For more information about enabling SSH connections, see Enable SSH connections for your Linux WorkSpaces in WorkSpaces Personal. Override the default shell for Amazon Linux WorkSpaces To override the default shell for Linux WorkSpaces, we recommend that you edit the user's ~/.bashrc file. For example, to use Z shell instead of Bash shell, add the following lines to / home/username/.bashrc. export SHELL=$(which zsh) [ -n "$SSH_TTY" ] && exec $SHELL Note After making this change, you must either reboot the WorkSpace or log out of the WorkSpace (not just disconnect) and then log back in for the change to take effect. Protect custom repositories from unauthorized access To control access to your custom repositories, we recommend using the security features built into Amazon Virtual Private Cloud (Amazon VPC) rather than using passwords. For example, use Manage your Amazon Linux 2 WorkSpaces 343 Amazon WorkSpaces Administration Guide network access control lists (ACLs) and security groups. For |
workspaces-ag-111 | workspaces-ag.pdf | 111 | following lines to / home/username/.bashrc. export SHELL=$(which zsh) [ -n "$SSH_TTY" ] && exec $SHELL Note After making this change, you must either reboot the WorkSpace or log out of the WorkSpace (not just disconnect) and then log back in for the change to take effect. Protect custom repositories from unauthorized access To control access to your custom repositories, we recommend using the security features built into Amazon Virtual Private Cloud (Amazon VPC) rather than using passwords. For example, use Manage your Amazon Linux 2 WorkSpaces 343 Amazon WorkSpaces Administration Guide network access control lists (ACLs) and security groups. For more information about these features, see Security in the Amazon VPC User Guide. If you must use passwords to protect your repositories, be sure to create your yum repository definition files as shown in Repository Definition Files in the Fedora documentation. Use the Amazon Linux Extras Library repository With Amazon Linux, you can use the Extras Library to install application and software updates on your instances. For information about using the Extras Library, see Extras Library (Amazon Linux) in the Amazon EC2 User Guide for Linux Instances. Note If you are using the Amazon Linux repository, your Amazon Linux WorkSpaces must have internet access, or you must configure virtual private cloud (VPC) endpoints to this repository and to the main Amazon Linux repository. For more information, see Provide internet access for WorkSpaces Personal. Use smart cards for authentication on Linux WorkSpaces Linux WorkSpaces on DCV bundles allow the use of Common Access Card (CAC) and Personal Identity Verification (PIV) smart cards for authentication. For more information, see Use smart cards for authentication in WorkSpaces Personal. Configure device proxy server settings for internet access By default, the WorkSpaces client applications use the proxy server that’s specified in the device operating system settings for HTTPS (port 443) traffic. The Amazon WorkSpaces client applications use the HTTPS port for updates, registration, and authentication. Note Proxy servers that require authentication with sign-in credentials are not supported. You can configure the device proxy server settings for your Linux WorkSpaces through Group Policy by following the steps in Configure device proxy and internet connectivity settings in the Microsoft documentation. Manage your Amazon Linux 2 WorkSpaces 344 Amazon WorkSpaces Administration Guide For more information about configuring the proxy settings in the WorkSpaces Windows client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces macOS client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces Web Access client application, see Proxy Server in the Amazon WorkSpaces User Guide. Proxying desktop traffic For PCoIP WorkSpaces, the desktop client applications do not support the use of a proxy server nor TLS decryption and inspection for port 4172 traffic in UDP (for desktop traffic). They require a direct connection to ports 4172. For DCV WorkSpaces, the WorkSpaces Windows client application (version 5.1 and above) and macOS client application (version 5.4 and above) support the use of HTTP proxy servers for port 4195 TCP traffic. TLS decryption and inspection are not supported. DCV does not support the use of proxy for desktop traffic over UDP. Only WorkSpaces Windows and macOS desktop client applications and web access support the use of proxy, for TCP traffic. Note If you choose to use a proxy server, the API calls that the client application makes to the WorkSpaces services are also proxied. Both API calls and desktop traffic should pass through the same proxy server. Recommendation on the use of proxy servers We do not recommend the use of a proxy server with your WorkSpaces desktop traffic. Amazon WorkSpaces desktop traffic is already encrypted, so proxies do not improve security. A proxy represents an additional hop in the network path that could impact streaming quality by introducing latency. Proxies could also potentially reduce throughput if a proxy is not properly sized to handle desktop streaming traffic. Furthermore, most proxies are not designed for supporting long running WebSocket (TCP) connections and may affect streaming quality and stability. Manage your Amazon Linux 2 WorkSpaces 345 Amazon WorkSpaces Administration Guide If you must use a proxy, please locate your proxy server as close to the WorkSpace client as possible, preferably in the same network, to avoid adding network latency, which could negatively impact streaming quality and responsiveness. Manage your Ubuntu WorkSpaces in WorkSpaces Personal As with Windows and Amazon Linux WorkSpaces, Ubuntu WorkSpaces are domain joined, so you can use Active Directory Users and Groups to: • Administer your Ubuntu WorkSpaces • Provide access to those WorkSpaces for users You can manage Ubuntu WorkSpaces with Group Policy by using ADsys. See the Ubuntu Active Directory integration FAQ for more information. You can also use other |
workspaces-ag-112 | workspaces-ag.pdf | 112 | proxy, please locate your proxy server as close to the WorkSpace client as possible, preferably in the same network, to avoid adding network latency, which could negatively impact streaming quality and responsiveness. Manage your Ubuntu WorkSpaces in WorkSpaces Personal As with Windows and Amazon Linux WorkSpaces, Ubuntu WorkSpaces are domain joined, so you can use Active Directory Users and Groups to: • Administer your Ubuntu WorkSpaces • Provide access to those WorkSpaces for users You can manage Ubuntu WorkSpaces with Group Policy by using ADsys. See the Ubuntu Active Directory integration FAQ for more information. You can also use other configuration and management solutions, such as Landscape and Ansible. Control DCV behavior on Ubuntu WorkSpaces The behavior of DCV is controlled by configuration settings in the wsp.conf file, which is located in the /etc/wsp/ directory. To deploy and enforce changes to the policy, use a configuration management solution that supports Ubuntu. Any changes take effect when the agent starts up. Note If you make incorrect or unsupported changes to the wsp.conf policies may not be applied to the new established connections to your WorkSpace. The following sections describe how to enable or disable certain features. Enable or disable clipboard redirection for Ubuntu WorkSpaces By default, WorkSpaces supports clipboard redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable clipboard redirection for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. Manage your Ubuntu WorkSpaces 346 Amazon WorkSpaces Administration Guide [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. clipboard = X Where the possible values for X are: enabled — Clipboard redirection is enabled in both directions (default) disabled — Clipboard redirection is disabled in both directions paste-only — Clipboard redirection is enabled and only allows you to copy contents from the local client device and paste it to the remote host desktop copy-only — Clipboard redirection is enabled and only allows you to copy contents from the remote host desktop and paste it to the local client device Enable or disable audio-in redirection for Ubuntu WorkSpaces By default, WorkSpaces supports audio-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable audio-in redirection for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. audio-in = X Where the possible values for X are: enabled — Audio-in redirection is enabled (default) disabled — Audio-in redirection is disabled Manage your Ubuntu WorkSpaces 347 Amazon WorkSpaces Administration Guide Enable or disable video-in redirection for Ubuntu WorkSpaces By default, WorkSpaces supports video-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable video-in redirection for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. video-in = X Where the possible values for X are: enabled — Video-in redirection is enabled (default) disabled — Video-in redirection is disabled Enable or disable time zone redirection for Ubuntu WorkSpaces By default, the time within a Workspace is set to mirror the time zone of the client that is being used to connect to the WorkSpace. This behavior is controlled through time zone redirection. You might want to turn off time zone direction for reasons such as the following: • Your company wants all employees to work in a certain time zone (even if some employees are in other time zones). • You have scheduled tasks in a WorkSpace that are meant to run at a certain time in a specific time zone. • Your users travel a lot and want to keep their WorkSpaces in one time zone for consistency and personal preference. Use the DCV configuration file to configure this feature, if needed. To enable or disable time zone redirection for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. Manage your Ubuntu WorkSpaces 348 Amazon WorkSpaces Administration Guide [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. timezone-redirection = X Where the possible values for X are: enabled — Time zone redirection is enabled (default) disabled — Time zone redirection is disabled Enable or disable printer redirection for Ubuntu WorkSpaces By default, WorkSpaces supports printer redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable printer redirection for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the |
workspaces-ag-113 | workspaces-ag.pdf | 113 | command. Manage your Ubuntu WorkSpaces 348 Amazon WorkSpaces Administration Guide [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. timezone-redirection = X Where the possible values for X are: enabled — Time zone redirection is enabled (default) disabled — Time zone redirection is disabled Enable or disable printer redirection for Ubuntu WorkSpaces By default, WorkSpaces supports printer redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable printer redirection for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. remote-printing = X Where the possible values for X are: enabled — Printer redirection is enabled (default) disabled — Printer redirection is disabled Manage your Ubuntu WorkSpaces 349 Amazon WorkSpaces Administration Guide Enable or disable disconnect session on screen lock for DCV Enable disconnect session on screen lock to allow your users to end their WorkSpaces session when the lock screen is detected. To reconnect from the WorkSpaces client, users can use their passwords or their smart cards to authenticate themselves, depending on which type of authentication has been enabled for their WorkSpaces. By default, WorkSpaces doesn’t support disconnecting session on screen lock. Use the DCV configuration file to enable this feature, if needed. To enable or disable disconnect session on screen lock for Ubuntu WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. disconnect-on-lock = X Where the possible values for X are: enabled — Disconnect on screen lock is enabled disabled — Disconnect on screen lock is disabled (default) Grant SSH access to Ubuntu WorkSpaces administrators By default, only assigned users and accounts in the Domain Admins group can connect to Ubuntu WorkSpaces by using SSH. To enable other users and accounts to connect to Ubuntu WorkSpaces using SSH, we recommend that you create a dedicated administrators group for your Ubuntu WorkSpaces administrators in Active Directory. To enable sudo access for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit the sudoers file by using visudo, as shown in the following example. [username@workspace-id ~]$ sudo visudo Manage your Ubuntu WorkSpaces 350 Amazon WorkSpaces 2. Add the following line. Administration Guide %Linux_WorkSpaces_Admins ALL=(ALL) ALL After you create the dedicated administrators group, follow these steps to enable login for members of the group. To enable login for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit /etc/security/access.conf with elevated rights. [username@workspace-id ~]$ sudo vi /etc/security/access.conf 2. Add the following line. +:(Linux_WorkSpaces_Admins):ALL With Ubuntu WorkSpaces you do not need to add a domain name when specifying username for SSH connection, and by default, password authentication is disabled. To connect via SSH, you needs to either add your SSH public key to $HOME/.ssh/authorized_keys on your Ubuntu WorkSpace, or edit /etc/ssh/sshd_config to set PasswordAuthentication to yes. For more information about enabling SSH connections, see Enable SSH connections for your Linux WorkSpaces. Override the default shell for Ubuntu WorkSpaces To override the default shell for Ubuntu WorkSpaces, we recommend that you edit the user's ~/.bashrc file. For example, to use Z shell instead of Bash shell, add the following lines to / home/username/.bashrc. export SHELL=$(which zsh) [ -n "$SSH_TTY" ] && exec $SHELL Manage your Ubuntu WorkSpaces 351 Amazon WorkSpaces Administration Guide Note After making this change, you must either reboot the WorkSpace or log out of the WorkSpace (not just disconnect) and then log back in for the change to take effect. Configure device proxy server settings for internet access By default, the WorkSpaces client applications use the proxy server that’s specified in the device operating system settings for HTTPS (port 443) traffic. The Amazon WorkSpaces client applications use the HTTPS port for updates, registration, and authentication. Note Proxy servers that require authentication with sign-in credentials are not supported. You can configure the device proxy server settings for your Ubuntu WorkSpaces through Group Policy by following the steps in Configure device proxy and internet connectivity settings in the Microsoft documentation. For more information about configuring the proxy settings in the WorkSpaces Windows client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces macOS client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces Web Access client application, see Proxy Server in the Amazon WorkSpaces User Guide. Proxying desktop traffic For PCoIP WorkSpaces, the desktop client applications do not support the use of a proxy server nor TLS decryption and inspection for port 4172 traffic in |
workspaces-ag-114 | workspaces-ag.pdf | 114 | documentation. For more information about configuring the proxy settings in the WorkSpaces Windows client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces macOS client application, see Proxy Server in the Amazon WorkSpaces User Guide. For more information about configuring the proxy settings in the WorkSpaces Web Access client application, see Proxy Server in the Amazon WorkSpaces User Guide. Proxying desktop traffic For PCoIP WorkSpaces, the desktop client applications do not support the use of a proxy server nor TLS decryption and inspection for port 4172 traffic in UDP (for desktop traffic). They require a direct connection to ports 4172. Manage your Ubuntu WorkSpaces 352 Amazon WorkSpaces Administration Guide For DCV WorkSpaces, the WorkSpaces Windows client application (version 5.1 and above) and macOS client application (version 5.4 and above) support the use of HTTP proxy servers for port 4195 TCP traffic. TLS decryption and inspection are not supported. DCV does not support the use of proxy for desktop traffic over UDP. Only WorkSpaces Windows and macOS desktop client applications and web access support the use of proxy, for TCP traffic. Note If you choose to use a proxy server, the API calls that the client application makes to the WorkSpaces services are also proxied. Both API calls and desktop traffic should pass through the same proxy server. Recommendation on the use of proxy servers We do not recommend the use of a proxy server with your WorkSpaces desktop traffic. Amazon WorkSpaces desktop traffic is already encrypted, so proxies do not improve security. A proxy represents an additional hop in the network path that could impact streaming quality by introducing latency. Proxies could also potentially reduce throughput if a proxy is not properly sized to handle desktop streaming traffic. Furthermore, most proxies are not designed for supporting long running WebSocket (TCP) connections and may affect streaming quality and stability. If you must use a proxy, please locate your proxy server as close to the WorkSpace client as possible, preferably in the same network, to avoid adding network latency, which could negatively impact streaming quality and responsiveness. Manage your Rocky Linux WorkSpaces You can manage Rocky Linux WorkSpaces with configuration and management solutions, such as Ansible. Note You may not remove, modify, or obscure any copyright, trademark, or other proprietary or confidentiality notices that are contained in or on the Rocky Linux software. Manage your Rocky Linux WorkSpaces 353 Amazon WorkSpaces Administration Guide Control DCV behavior on Rocky Linux WorkSpaces The behavior of DCV is controlled by configuration settings in the wsp.conf file, which is located in the /etc/wsp/ directory. To deploy and enforce changes to the policy, use a configuration management solution that supports Rocky Linux. Any changes take effect when the agent starts up. Note If you make incorrect or unsupported changes to the wsp.conf policies may not be applied to the new established connections to your WorkSpace. The following sections describe how to enable or disable certain features. Enable or disable clipboard redirection for Rocky Linux WorkSpaces By default, WorkSpaces supports clipboard redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable clipboard redirection for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. clipboard = X Where the possible values for X are: enabled — Clipboard redirection is enabled in both directions (default) disabled — Clipboard redirection is disabled in both directions paste-only — Clipboard redirection is enabled and only allows you to copy contents from the local client device and paste it to the remote host desktop copy-only — Clipboard redirection is enabled and only allows you to copy contents from the remote host desktop and paste it to the local client device Manage your Rocky Linux WorkSpaces 354 Amazon WorkSpaces Administration Guide Enable or disable audio-in redirection for Rocky Linux WorkSpaces By default, WorkSpaces supports audio-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable audio-in redirection for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. audio-in = X Where the possible values for X are: enabled — Audio-in redirection is enabled (default) disabled — Audio-in redirection is disabled Enable or disable video-in redirection for Rocky Linux WorkSpaces By default, WorkSpaces supports video-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable video-in redirection for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights |
workspaces-ag-115 | workspaces-ag.pdf | 115 | wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. audio-in = X Where the possible values for X are: enabled — Audio-in redirection is enabled (default) disabled — Audio-in redirection is disabled Enable or disable video-in redirection for Rocky Linux WorkSpaces By default, WorkSpaces supports video-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable video-in redirection for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. video-in = X Where the possible values for X are: enabled — Video-in redirection is enabled (default) Manage your Rocky Linux WorkSpaces 355 Amazon WorkSpaces Administration Guide disabled — Video-in redirection is disabled Enable or disable time zone redirection for Rocky Linux WorkSpaces By default, the time within a Workspace is set to mirror the time zone of the client that is being used to connect to the WorkSpace. This behavior is controlled through time zone redirection. You might want to turn off time zone direction for reasons such as the following: • Your company wants all employees to work in a certain time zone (even if some employees are in other time zones). • You have scheduled tasks in a WorkSpace that are meant to run at a certain time in a specific time zone. • Your users travel a lot and want to keep their WorkSpaces in one time zone for consistency and personal preference. Use the DCV configuration file to configure this feature, if needed. To enable or disable time zone redirection for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. timezone-redirection = X Where the possible values for X are: enabled — Time zone redirection is enabled (default) disabled — Time zone redirection is disabled Manage your Rocky Linux WorkSpaces 356 Amazon WorkSpaces Administration Guide Enable or disable printer redirection for Rocky Linux WorkSpaces By default, WorkSpaces supports printer redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable printer redirection for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. remote-printing = X Where the possible values for X are: enabled — Printer redirection is enabled (default) disabled — Printer redirection is disabled Enable or disable disconnect session on screen lock for DCV Enable disconnect session on screen lock to allow your users to end their WorkSpaces session when the lock screen is detected. To reconnect from the WorkSpaces client, users can use their passwords or their smart cards to authenticate themselves, depending on which type of authentication has been enabled for their WorkSpaces. By default, WorkSpaces doesn’t support disconnecting session on screen lock. Use the DCV configuration file to enable this feature, if needed. To enable or disable disconnect session on screen lock for Rocky Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. disconnect-on-lock = X Manage your Rocky Linux WorkSpaces 357 Amazon WorkSpaces Administration Guide Where the possible values for X are: enabled — Disconnect on screen lock is enabled disabled — Disconnect on screen lock is disabled (default) Grant SSH access to Rocky Linux WorkSpaces administrators By default, only assigned users and accounts in the Domain Admins group can connect to Rocky Linux WorkSpaces by using SSH. To enable other users and accounts to connect to Rocky Linux WorkSpaces using SSH, we recommend that you create a dedicated administrators group for your Rocky Linux WorkSpaces administrators in Active Directory. To enable sudo access for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit the sudoers file by using visudo, as shown in the following example. [username@workspace-id ~]$ sudo visudo 2. Add the following line. %Linux_WorkSpaces_Admins ALL=(ALL) ALL After you create the dedicated administrators group, follow these steps to enable login for members of the group. To enable login for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit /etc/security/access.conf with elevated rights. [username@workspace-id ~]$ sudo vi /etc/security/access.conf 2. Add the following line. Manage your Rocky Linux WorkSpaces 358 Amazon WorkSpaces Administration Guide +:(Linux_WorkSpaces_Admins):ALL With Rocky Linux WorkSpaces you do not need to add a domain name when specifying username for SSH connection, |
workspaces-ag-116 | workspaces-ag.pdf | 116 | Edit the sudoers file by using visudo, as shown in the following example. [username@workspace-id ~]$ sudo visudo 2. Add the following line. %Linux_WorkSpaces_Admins ALL=(ALL) ALL After you create the dedicated administrators group, follow these steps to enable login for members of the group. To enable login for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit /etc/security/access.conf with elevated rights. [username@workspace-id ~]$ sudo vi /etc/security/access.conf 2. Add the following line. Manage your Rocky Linux WorkSpaces 358 Amazon WorkSpaces Administration Guide +:(Linux_WorkSpaces_Admins):ALL With Rocky Linux WorkSpaces you do not need to add a domain name when specifying username for SSH connection, and by default, password authentication is disabled. To connect via SSH, you needs to either add your SSH public key to $HOME/.ssh/authorized_keys on your Rocky Linux WorkSpace, or edit /etc/ssh/sshd_config to set PasswordAuthentication to yes. For more information about enabling SSH connections, see Enable SSH connections for your Linux WorkSpaces. Override the default shell for Rocky Linux WorkSpaces To override the default shell for Rocky Linux WorkSpaces, we recommend that you edit the user's ~/.bashrc file. For example, to use Z shell instead of Bash shell, add the following lines to / home/username/.bashrc. export SHELL=$(which zsh) [ -n "$SSH_TTY" ] && exec $SHELL Note After making this change, you must either reboot the WorkSpace or log out of the WorkSpace (not just disconnect) and then log back in for the change to take effect. Manage your Red Hat Enterprise Linux WorkSpaces As with Windows and Amazon Linux WorkSpaces, Red Hat Enterprise Linux WorkSpaces are domain joined, so you can use Active Directory Users and Groups to: • Administer your Red Hat Enterprise Linux WorkSpaces • Provide access to those WorkSpaces for users Manage your Red Hat Enterprise Linux WorkSpaces 359 Amazon WorkSpaces Administration Guide You can manage Red Hat Enterprise Linux WorkSpaces with Group Policy by using ADsys. See the Red Hat Enterprise Linux Active Directory integration FAQ for more information. You can also use other configuration and management solutions, such as Landscape and Ansible. Control DCV behavior on Red Hat Enterprise Linux WorkSpaces The behavior of DCV is controlled by configuration settings in the wsp.conf file, which is located in the /etc/wsp/ directory. To deploy and enforce changes to the policy, use a configuration management solution that supports Red Hat Enterprise Linux. Any changes take effect when the agent starts up. Note If you make incorrect or unsupported changes to the wsp.conf policies may not be applied to the new established connections to your WorkSpace. The following sections describe how to enable or disable certain features. Enable or disable clipboard redirection for Red Hat Enterprise Linux WorkSpaces By default, WorkSpaces supports clipboard redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable clipboard redirection for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. clipboard = X Where the possible values for X are: enabled — Clipboard redirection is enabled in both directions (default) disabled — Clipboard redirection is disabled in both directions Manage your Red Hat Enterprise Linux WorkSpaces 360 Amazon WorkSpaces Administration Guide paste-only — Clipboard redirection is enabled and only allows you to copy contents from the local client device and paste it to the remote host desktop copy-only — Clipboard redirection is enabled and only allows you to copy contents from the remote host desktop and paste it to the local client device Enable or disable audio-in redirection for Red Hat Enterprise Linux WorkSpaces By default, WorkSpaces supports audio-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable audio-in redirection for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. audio-in = X Where the possible values for X are: enabled — Audio-in redirection is enabled (default) disabled — Audio-in redirection is disabled Enable or disable video-in redirection for Red Hat Enterprise Linux WorkSpaces By default, WorkSpaces supports video-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable video-in redirection for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. Manage your Red Hat Enterprise Linux WorkSpaces 361 Amazon WorkSpaces video-in = X Administration Guide Where the possible values for X are: enabled — Video-in redirection is enabled (default) disabled — Video-in redirection is disabled Enable or disable |
workspaces-ag-117 | workspaces-ag.pdf | 117 | By default, WorkSpaces supports video-in redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable video-in redirection for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. Manage your Red Hat Enterprise Linux WorkSpaces 361 Amazon WorkSpaces video-in = X Administration Guide Where the possible values for X are: enabled — Video-in redirection is enabled (default) disabled — Video-in redirection is disabled Enable or disable time zone redirection for Red Hat Enterprise Linux WorkSpaces By default, the time within a Workspace is set to mirror the time zone of the client that is being used to connect to the WorkSpace. This behavior is controlled through time zone redirection. You might want to turn off time zone direction for reasons such as the following: • Your company wants all employees to work in a certain time zone (even if some employees are in other time zones). • You have scheduled tasks in a WorkSpace that are meant to run at a certain time in a specific time zone. • Your users travel a lot and want to keep their WorkSpaces in one time zone for consistency and personal preference. Use the DCV configuration file to configure this feature, if needed. To enable or disable time zone redirection for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. timezone-redirection = X Where the possible values for X are: Manage your Red Hat Enterprise Linux WorkSpaces 362 Amazon WorkSpaces Administration Guide enabled — Time zone redirection is enabled (default) disabled — Time zone redirection is disabled Enable or disable printer redirection for Red Hat Enterprise Linux WorkSpaces By default, WorkSpaces supports printer redirection. Use the DCV configuration file to disable this feature, if needed. To enable or disable printer redirection for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. remote-printing = X Where the possible values for X are: enabled — Printer redirection is enabled (default) disabled — Printer redirection is disabled Enable or disable disconnect session on screen lock for DCV Enable disconnect session on screen lock to allow your users to end their WorkSpaces session when the lock screen is detected. To reconnect from the WorkSpaces client, users can use their passwords or their smart cards to authenticate themselves, depending on which type of authentication has been enabled for their WorkSpaces. By default, WorkSpaces doesn’t support disconnecting session on screen lock. Use the DCV configuration file to enable this feature, if needed. To enable or disable disconnect session on screen lock for Red Hat Enterprise Linux WorkSpaces 1. Open the wsp.conf file in an editor with elevated rights by using the following command. Manage your Red Hat Enterprise Linux WorkSpaces 363 Amazon WorkSpaces Administration Guide [domain\username@workspace-id ~]$ sudo vi /etc/wsp/wsp.conf 2. Add the following line to the end of the [policies] group. disconnect-on-lock = X Where the possible values for X are: enabled — Disconnect on screen lock is enabled disabled — Disconnect on screen lock is disabled (default) Grant SSH access to Red Hat Enterprise Linux WorkSpaces administrators By default, only assigned users and accounts in the Domain Admins group can connect to Red Hat Enterprise Linux WorkSpaces by using SSH. To enable other users and accounts to connect to Red Hat Enterprise Linux WorkSpaces using SSH, we recommend that you create a dedicated administrators group for your Red Hat Enterprise Linux WorkSpaces administrators in Active Directory. To enable sudo access for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit the sudoers file by using visudo, as shown in the following example. [username@workspace-id ~]$ sudo visudo 2. Add the following line. %Linux_WorkSpaces_Admins ALL=(ALL) ALL After you create the dedicated administrators group, follow these steps to enable login for members of the group. Manage your Red Hat Enterprise Linux WorkSpaces 364 Amazon WorkSpaces Administration Guide To enable login for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit /etc/security/access.conf with elevated rights. [username@workspace-id ~]$ sudo vi /etc/security/access.conf 2. Add the following line. +:(Linux_WorkSpaces_Admins):ALL With Red Hat Enterprise Linux WorkSpaces you do not need to add a domain name when specifying username for SSH connection, and by default, password authentication is disabled. To connect via SSH, you needs to either add your SSH public key to $HOME/.ssh/authorized_keys on your Red Hat Enterprise Linux WorkSpace, or edit /etc/ssh/sshd_config |
workspaces-ag-118 | workspaces-ag.pdf | 118 | enable login for members of the group. Manage your Red Hat Enterprise Linux WorkSpaces 364 Amazon WorkSpaces Administration Guide To enable login for members of the Linux_WorkSpaces_Admins Active Directory group 1. Edit /etc/security/access.conf with elevated rights. [username@workspace-id ~]$ sudo vi /etc/security/access.conf 2. Add the following line. +:(Linux_WorkSpaces_Admins):ALL With Red Hat Enterprise Linux WorkSpaces you do not need to add a domain name when specifying username for SSH connection, and by default, password authentication is disabled. To connect via SSH, you needs to either add your SSH public key to $HOME/.ssh/authorized_keys on your Red Hat Enterprise Linux WorkSpace, or edit /etc/ssh/sshd_config to set PasswordAuthentication to yes. For more information about enabling SSH connections, see Enable SSH connections for your Linux WorkSpaces. Override the default shell for Red Hat Enterprise Linux WorkSpaces To override the default shell for Red Hat Enterprise Linux WorkSpaces, we recommend that you edit the user's ~/.bashrc file. For example, to use Z shell instead of Bash shell, add the following lines to /home/username/.bashrc. export SHELL=$(which zsh) [ -n "$SSH_TTY" ] && exec $SHELL Note After making this change, you must either reboot the WorkSpace or log out of the WorkSpace (not just disconnect) and then log back in for the change to take effect. Manage your Red Hat Enterprise Linux WorkSpaces 365 Amazon WorkSpaces Administration Guide Optimize WorkSpaces for real-time communication in WorkSpaces Personal Amazon WorkSpaces offers a diverse range of techniques to facilitate the deployment of Unified Communication (UC) applications like Microsoft Teams, Zoom, Webex and others. In contemporary application landscapes, most UC applications consist of a variety of features, including 1:1 chat rooms, collaborative group chat channels, seamless file storage and exchange, live events, webinars, broadcasts, interactive screen sharing and control, whiteboarding, and offline audio/ video messaging capabilities. Most of this functionality is seamlessly available on WorkSpaces as standard features, without the need for additional fine-tuning or enhancement. However, it's worth noting that real-time communication elements, particularly one-on-one calling and collective group meetings, represent an exception to this rule. The successful incorporation of such functionality frequently demands dedicated focus and planning during the process of WorkSpaces deployment. When planning your implementation of real-time communication functionalities of UC applications on Amazon WorkSpaces, you have three distinct Real-Time Communication (RTC) configuration modes to choose from. The selection of which depends on the specific application or applications that you intend to provide to your users and the client devices you plan to use. This document focus on optimizing the user experience for the most common UC applications in Amazon WorkSpaces. For WorkSpaces Core specific optimizations, please refer to the partner- specific documentation. Topics • Overview of media optimization modes • Which RTC optimization mode to use? • RTC Optimization Guidance Overview of media optimization modes Following are the media optimization options available. Option 1: Media Optimized Real-Time Communication (Media Optimized RTC) In this mode, third-party UC and VoIP applications are executed on the remote WorkSpace, while their media framework is offloaded to the supported client for direct communication. The following UC applications use this approach on Amazon WorkSpaces: Optimize for real-time communication 366 Amazon WorkSpaces • Zoom meetings • Cisco Webex meetings Administration Guide For Media Optimized RTC mode to function, the UC application vendor should develop the integration with WorkSpaces using one of the available Software Development Kits (SDK), such as the DCV Extension SDK. This mode requires the UC components to be installed on the client device. For more information about configuring this mode, see Configure Media Optimized RTC. Option 2: In-Session Optimized Real-Time Communication (In-session Optimized RTC) In this mode, the unaltered UC application runs on the WorkSpace, channeling audio and video traffic via the DCV to the client device. Local audio from the microphone and video stream from a webcam are redirected to the WorkSpace, where they are consumed by the UC application. This mode provides broad application compatibility and efficiently delivers the UC application from the remote WorkSpace to a variety of client platforms. You don't need to deploy the UC application components to the client device. For more information about configuring this mode, see Configure In-session Optimized RTC. Option 3: Direct Real-Time Communication (Direct RTC) In this mode, the application operating within the WorkSpace takes control over the physical or virtual telephone set located on the user's desk or client OS. This results in the audio traffic traversing directly from the physical telephone at the user's workstation or the virtual phone operating on the client device to the remote call peer. Notable instances of applications functioning within this mode encompass: • Amazon Connect Optimization for Amazon WorkSpaces • Genesys Cloud WebRTC media helper • Microsoft Teams SIP Gateway • Microsoft Teams Desk phones and Teams displays • Participation in audio conferencing through the dial-in or "dial my phone" features of the UC |
workspaces-ag-119 | workspaces-ag.pdf | 119 | the WorkSpace takes control over the physical or virtual telephone set located on the user's desk or client OS. This results in the audio traffic traversing directly from the physical telephone at the user's workstation or the virtual phone operating on the client device to the remote call peer. Notable instances of applications functioning within this mode encompass: • Amazon Connect Optimization for Amazon WorkSpaces • Genesys Cloud WebRTC media helper • Microsoft Teams SIP Gateway • Microsoft Teams Desk phones and Teams displays • Participation in audio conferencing through the dial-in or "dial my phone" features of the UC application. For more information about configuring this mode, see Configure Direct RTC. Optimize for real-time communication 367 Amazon WorkSpaces Administration Guide Which RTC optimization mode to use? Different RTC optimization modes can be employed concurrently or set up to complement each other as a fallback. For instance, consider enabling Media Optimized RTC for Cisco Webex meetings. This configuration ensures that users experience optimized communication when accessing WorkSpace through a desktop client. However, in scenarios where Webex is accessed from a shared internet kiosk lacking UC optimization components, Webex will seamlessly transition to In-session Optimized RTC mode to maintain functionality. When users engage with multiple UC applications, the RTC configuration modes may vary based on their unique requirements. The following table represents common UC application features and defines which RTC configuration mode provides the best result. Feature Direct RTC Media Optimized RTC In-session Optimized RTC 1:1 chat Does not require RTC configuration Group chat rooms Does not require RTC configuration Group audio conferencing Group video conferencing 1:1 audio calls 1:1 video calls Whiteboarding Best Good Best Good Best Best Best Best Good Good Good Good Does not require RTC configuration Audio/video clips/ messaging Not applicable Good File Sharing Not applicable Screen sharing and control Not applicable Depends on UC application Depends on UC application Best Best Best Optimize for real-time communication 368 Amazon WorkSpaces Administration Guide Feature Direct RTC Media Optimized RTC In-session Optimized RTC Webinars/Broadcast events Not applicable Good Best RTC Optimization Guidance Configure Media Optimized RTC Media Optimized RTC mode is made possible by the UC application vendor use of the SDKs provided by Amazon. The architecture requires UC vendor to develop a UC-specific plugin or extension and deploy it to the client. The SDK, which includes publicly available options like the DCV Extension SDK and customized private versions, establishes a control channel between the UC application module operating within the WorkSpace and a plugin on the client side. Typically, this control channel instructs the client extension to initiate or join a call. Once the call is established through the client-side extension, the UC plugin captures audio from the microphone and video from the webcam, which are then transmitted directly to the UC cloud or a call peer. The incoming audio is played locally, and video is overlaid on the remote client UI. The control channel is responsible for communicating the call's status. Amazon WorkSpaces currently supports following applications with Media Optimized RTC mode: • Zoom meetings (for PCoIP and DCV WorkSpaces) Optimize for real-time communication 369 Amazon WorkSpaces Administration Guide • Cisco Webex meetings (for DCV WorkSpaces only) If you are using an application that is not on the list, it is advisable to engage the application vendor and request support for WorkSpaces Media Optimized RTC. To expedite this process, encourage them to contact aws-av-offloading@amazon.com. While Media Optimized RTC mode enhances call performance and minimizes WorkSpace resource utilization, it does possess certain limitations: • The UC client extension must be installed on the client device. • The UC client extension requires independent management and updates. • UC client extensions might not be available on certain client platforms, such as, mobile platforms, or web clients. • Some UC application functionalities could be constrained in this mode; for instance, screen sharing behavior might differ. • Usage of client-side extensions might not be suitable for scenarios like Bring Your Own Device (BYOD) or shared kiosks. If Media Optimized RTC mode proves unsuitable for your environment or certain users are unable to install the client extension, configuring In-session Optimized RTC mode as a fallback option is recommended. Configure In-session Optimized RTC In the In-session Optimized RTC mode, the UC application operates on the WorkSpace without any modifications, providing a like-local experience. The audio and video streams generated by the application are captured by DCV and transmitted to the client side. At the client, the microphone (on both DCV and PCoIP WorkSpaces) and webcam (only on DCV WorkSpaces) signals are captured, redirected back to the WorkSpace, and seamlessly passed to the UC application. Notably, this option ensures exceptional compatibility, even with legacy applications, offering a cohesive user experience regardless of the application's origin. In-session optimization works with web client as well. Optimize for |
workspaces-ag-120 | workspaces-ag.pdf | 120 | the In-session Optimized RTC mode, the UC application operates on the WorkSpace without any modifications, providing a like-local experience. The audio and video streams generated by the application are captured by DCV and transmitted to the client side. At the client, the microphone (on both DCV and PCoIP WorkSpaces) and webcam (only on DCV WorkSpaces) signals are captured, redirected back to the WorkSpace, and seamlessly passed to the UC application. Notably, this option ensures exceptional compatibility, even with legacy applications, offering a cohesive user experience regardless of the application's origin. In-session optimization works with web client as well. Optimize for real-time communication 370 Amazon WorkSpaces Administration Guide DCV has been meticulously optimized to enhance the performance of Remote RTC mode. The optimization measures encompass: • Utilization of an Adaptive UDP-based QUIC transport, ensuring efficient data transmission. • Establishment of a low-latency audio path, facilitating fast audio input and output. • Implementation of voice-optimized audio codecs to maintain audio quality while reducing CPU and network utilization. • Webcam redirection, enabling the integration of webcam functionalities. • Configuration of webcam resolution to optimize performance. • Integration of adaptive display codecs to balance speed and visual quality. • Audio jitter correction, guaranteeing smooth audio transmission. These optimizations collectively contribute to a robust and fluid experience in Remote RTC mode. Sizing recommendations To effectively support Remote RTC mode, it's crucial to ensure proper sizing of Amazon WorkSpaces. The remote WorkSpace must meet or exceed the system requirements of the respective Unified Communication (UC) application. The following table outlines the minimum supported and recommended WorkSpaces configurations for popular UC applications when used for video and audio calls: Optimize for real-time communication 371 Amazon WorkSpaces Administration Guide Video calls Audio calls Applicati on CPU requireme RAM requireme Minimally supported Recommend ed Minimally supported Recommend ed Reference nts for nts for WorkSpace WorkSpace WorkSpace WorkSpace RTC app RTC app Microsoft Teams 2 core required, 4.0 GB RAM 4 core recommend ed Power (4 vCPU, 16 GB memory) Zoom 2 core required, 4.0 GB RAM 4 core recommend ed Power (4 vCPU, 16 GB memory) • PowerPro • PowerPro (8 vCPU, 32 GB Performan ce (2 vCPU, 8 GB (8 vCPU, 32 GB Hardware requireme nts for Microsoft memory) memory) memory) Teams • GeneralPu rpose.4xl arge (16vCPU, 64 GB memory) • GeneralPu rpose.4xl arge (16vCPU, 64 GB memory) • GeneralPu • GeneralPu rpose.8xl arge (32vCPU, 128 GB memory) rpose.8xl arge (32vCPU, 128 GB memory) • PowerPro • PowerPro (8 Performan ce (2 vCPU, 32 GB memory) vCPU, 8 GB memory) • GeneralPu rpose.4xl arge (16vCPU, 64 GB memory) Zoom system requireme nts: Windows, macOS, Linux (8 vCPU, 32 GB memory) • GeneralPu rpose.4xl arge (16vCPU, 64 GB memory) Optimize for real-time communication 372 Amazon WorkSpaces Administration Guide Video calls Audio calls Applicati on CPU requireme RAM requireme Minimally supported Recommend ed Minimally supported Recommend ed Reference nts for nts for WorkSpace WorkSpace WorkSpace WorkSpace RTC app RTC app • GeneralPu • GeneralPu rpose.8xl arge (32vCPU, 128 GB memory) rpose.8xl arge (32vCPU, 128 GB memory) Webex 2 core required 4.0 GB RAM Power (4 vCPU, 16 GB memory) • PowerPro • PowerPro (8 vCPU, 32 GB Performan ce (2 vCPU, 8 GB (8 vCPU, 32 GB System requireme nts for Webex memory) memory) memory) services • GeneralPu • GeneralPu rpose.4xl arge (16vCPU, 64 GB memory) rpose.4xl arge (16vCPU, 64 GB memory) • GeneralPu • GeneralPu rpose.8xl arge (32vCPU, 128 GB memory) rpose.8xl arge (32vCPU, 128 GB memory) It's important to note that video conferencing involves significant resource usage for video encoding and decoding. In physical machine scenarios, these tasks are offloaded to the GPU. In non-GPU WorkSpaces, these tasks are performed on the CPU in parallel with remote protocol Optimize for real-time communication 373 Amazon WorkSpaces Administration Guide encoding. Therefore, for users regularly engaged in video streaming or video calls, opting for the PowerPro or higher configuration is highly recommended. Screen sharing also consumes notable resources, with resource consumption increasing with higher resolutions. As result, on non-GPU WorkSpaces, screen sharing is often limited to a lower frame rate. Leverage the UDP-based QUIC transport with DCV UDP transport is particularly well-suited for transmitting RTC applications. To maximize efficiency, ensure that your network is set up to utilize QUIC transport for DCV. Note that UDP-based transport is available with native clients only. Configure UC application for WorkSpaces For enhanced video processing capabilities, such as background blur, virtual backgrounds, reactions, or hosting live events, opting for a GPU-enabled WorkSpace is essential to achieve optimal performance. Most of the UC applications provide guidance to disable advanced video processing to reduce CPU utilization on non-GPU WorkSpaces. For more information, refer to the following resources. • Microsoft Teams: Teams for Virtualized Desktop Infrastructure • Zoom Meetings: Managing the user experience for incompatible VDI plugins • |
workspaces-ag-121 | workspaces-ag.pdf | 121 | your network is set up to utilize QUIC transport for DCV. Note that UDP-based transport is available with native clients only. Configure UC application for WorkSpaces For enhanced video processing capabilities, such as background blur, virtual backgrounds, reactions, or hosting live events, opting for a GPU-enabled WorkSpace is essential to achieve optimal performance. Most of the UC applications provide guidance to disable advanced video processing to reduce CPU utilization on non-GPU WorkSpaces. For more information, refer to the following resources. • Microsoft Teams: Teams for Virtualized Desktop Infrastructure • Zoom Meetings: Managing the user experience for incompatible VDI plugins • Webex: Deployment guide for Webex App for Virtual Desktop Infrastructure (VDI) - Manage and troubleshoot Webex App for VDI [Webex App] • Google Meet: Using VDI Enable bi-directional audio and webcam redirection Amazon WorkSpaces inherently support audio-in, audio-out, and camera redirection through video-in by default. However, if these features have been disabled for any specific reasons, you can follow the provided guidance to re-enable redirection. For more information, refer to Enable or disable video-in redirection for DCV in the Amazon WorkSpaces Administration Guide. Users need to select the camera they want to use in session after connecting. For more information, users should refer to Webcams and other video devices in the Amazon WorkSpaces User Guide. Optimize for real-time communication 374 Amazon WorkSpaces Administration Guide Limit maximum webcam resolution For users employing Power, PowerPro, GeneralPurpose.4xlarge, or GeneralPurpose.8xlarge WorkSpaces for video conferencing, it is strongly recommended to restrict the maximum resolution of redirected webcams. In the case of PowerPro, GeneralPurpose.4xlarge, or GeneralPurpose.8xlarge, the recommended maximum resolution is 640 pixels in width by 480 pixels in height. For Power, the recommended maximum resolution is 320 pixels in width by 240 pixels in height. Complete the following steps to configure the maximum webcam resolution. 1. Open the Windows Registry Editor. 2. Navigate to the following registry path: HKEY_USERS/S-1-5-18/Software/GSettings/com/nicesoftware/dcv/webcam 3. Create a string value named max-resolution and set it to the desired resolution in the (X,Y) format, where X represents the horizontal pixel count (width) and Y represents the vertical pixel count (height). For example, specify (640,480)) to represent a resolution that is 640 pixels in width and 480 pixel in height. Enable voice-optimized audio configuration By default, WorkSpaces are set to deliver 7.1 high-fidelity audio from WorkSpaces to the client, ensuring superior music playback quality. However, if your primary use case involves audio or video conferencing, modifying the audio codec profile to a voice-optimized setting can conserve CPU and network resources. Complete the following steps to set the audio profile to voice optimized. 1. Open the Windows Registry Editor. 2. Navigate to the following registry path: HKEY_USERS/S-1-5-18/Software/GSettings/com/nicesoftware/dcv/audio 3. Create a string value name default-profile and set it to voice. Optimize for real-time communication 375 Amazon WorkSpaces Administration Guide Use good quality headsets for audio and video calls To enhance the audio experience and prevent echo, it's crucial to utilize high-quality headsets. Utilizing desktop speakers can lead to echo issues on the remote end of the call. Configure Direct RTC The configuration of Direct RTC mode depends on the specific Unified Communication (UC) application and does not necessitate any changes in the WorkSpaces configuration. The following list offers a non-exhaustive compilation of optimizations for various UC applications. • Microsoft Teams: • Plan for SIP Gateway • Audio Conferencing in Microsoft 365 • Plan your Teams voice solution • Zoom Meetings: • Enabling or disabling toll call dial-in numbers • Using desk phone call control • Desk phone companion mode • Webex: • Webex App | Make calls with your desk phone • Webex App | Supported calling options • BlueJeans: • Dialing into a Meeting from a Desk Telephone Optimize for real-time communication 376 Amazon WorkSpaces • Genesys: • Genesys Cloud WebRTC media helper • Amazon Connect: • Amazon Connect Optimization for Amazon WorkSpaces • Google Meet: • Use a phone for audio in a video meeting Administration Guide Manage the running mode in WorkSpaces Personal The running mode of a WorkSpace determines its immediate availability and how you pay for it (monthly or hourly). You can choose between the following running modes when you create the WorkSpace: • AlwaysOn — Use when paying a fixed monthly fee for unlimited usage of your WorkSpaces. This mode is best for users who use their WorkSpace full time as their primary desktop. • AutoStop — Use when paying for your WorkSpaces by the hour. With this mode, your WorkSpaces stop after a specified period of disconnection, and the state of apps and data is saved. For more information, see WorkSpaces Pricing. AutoStop WorkSpaces To set the automatic stop time, select the WorkSpace in the Amazon WorkSpaces console, choose Actions, Modify Running Mode Properties, and then set AutoStop Time (hours). By default, AutoStop Time (hours) is set to |
workspaces-ag-122 | workspaces-ag.pdf | 122 | fixed monthly fee for unlimited usage of your WorkSpaces. This mode is best for users who use their WorkSpace full time as their primary desktop. • AutoStop — Use when paying for your WorkSpaces by the hour. With this mode, your WorkSpaces stop after a specified period of disconnection, and the state of apps and data is saved. For more information, see WorkSpaces Pricing. AutoStop WorkSpaces To set the automatic stop time, select the WorkSpace in the Amazon WorkSpaces console, choose Actions, Modify Running Mode Properties, and then set AutoStop Time (hours). By default, AutoStop Time (hours) is set to 1 hour, which means that the WorkSpace stops automatically an hour after the WorkSpace is disconnected. After a WorkSpace is disconnected and the AutoStop Time period has expired, it might take several additional minutes for the WorkSpace to automatically stop. However, billing stops as soon as the AutoStop Time period expires, and you aren't charged for that additional time. When the WorkSpaces support hibernation, the state of the desktop is saved to the root volume of the WorkSpace. The WorkSpace resumes when a user logs in. All open documents and running programs return to their saved state with all WorkSpaces operating systems supporting hibernation. Manage the running mode 377 Amazon WorkSpaces Administration Guide AutoStop Graphics.g4dn, GraphicsPro.g4dn, Graphics, GraphicsPro, and GeneralPurpose.4xlarge or GeneralPurpose.8xlarge do not support hibernation therefore cannot preserve the state of data and programs when they stop. For these Autostop WorkSpaces, we recommend saving your work when you’re done using them each time. For Bring Your Own License (BYOL) AutoStop WorkSpaces, a large number of concurrent logins could result in significantly increased time for WorkSpaces to be available. If you expect many users to log into your BYOL AutoStop WorkSpaces at the same time, please consult your account manager for advice. Important AutoStop WorkSpaces stop automatically only if the WorkSpaces are disconnected. A WorkSpace is disconnected only in the following circumstances: • If the user manually disconnects from the WorkSpace or quits the Amazon WorkSpaces client application. • If the client device is shut down. • If there's no connection between the client device and the WorkSpace for more than 20 minutes. As a best practice, AutoStop WorkSpace users should manually disconnect from their WorkSpaces when they're done using them each day. To manually disconnect, choose Disconnect WorkSpace or Quit Amazon WorkSpaces from the Amazon WorkSpaces menu in the WorkSpaces client applications for Linux, macOS, or Windows. For Android or iPad, choose Disconnect from the sidebar menu. AutoStop WorkSpaces may not stop automatically in the following situations: • If the client device is only locked, sleeping, or otherwise inactive (for example, the laptop lid is closed) instead of shut down, the WorkSpaces application might still be running in the background. As long as the WorkSpaces application is still running, the WorkSpace might not be disconnected, and therefore the WorkSpace might not automatically stop. • WorkSpaces can detect disconnection only when users are using WorkSpaces clients. If users are using third-party clients, WorkSpaces might not be able to detect disconnection, and therefore the WorkSpaces might not automatically stop and billing might not be suspended. Manage the running mode 378 Amazon WorkSpaces Administration Guide Modify the running mode You can switch between running modes at any time. To modify the running mode of a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose WorkSpaces. Select the WorkSpace to modify and choose Actions, Modify running mode. Select the new running mode, AlwaysOn or AutoStop, and then choose Save. To modify the running mode of a WorkSpace using the AWS CLI Use the modify-workspace-properties command. Stop and start an AutoStop WorkSpace When your AutoStop WorkSpaces are disconnected, they stop automatically after a specified period of disconnection, and hourly billing is suspended. To further optimize costs, you can manually suspend the hourly charges associated with AutoStop WorkSpaces. The WorkSpace stops and all apps and data are saved for the next time a user logs in to the WorkSpace. When a user reconnects to a stopped WorkSpace, it resumes from where it left off, typically in under 90 seconds. You can reboot (restart) AutoStop WorkSpaces that are available or in an error state. To stop an AutoStop WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace to stop and choose Actions, Stop WorkSpaces. 4. When prompted for confirmation, choose Stop WorkSpace. To start an AutoStop WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose WorkSpaces. Manage the running mode 379 Amazon WorkSpaces Administration Guide 3. Select the WorkSpaces to start and choose Actions, Start WorkSpaces. 4. When prompted for confirmation, choose Start WorkSpace. To remove the fixed infrastructure costs that are associated with |
workspaces-ag-123 | workspaces-ag.pdf | 123 | or in an error state. To stop an AutoStop WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace to stop and choose Actions, Stop WorkSpaces. 4. When prompted for confirmation, choose Stop WorkSpace. To start an AutoStop WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose WorkSpaces. Manage the running mode 379 Amazon WorkSpaces Administration Guide 3. Select the WorkSpaces to start and choose Actions, Start WorkSpaces. 4. When prompted for confirmation, choose Start WorkSpace. To remove the fixed infrastructure costs that are associated with AutoStop WorkSpaces, remove the WorkSpace from your account. For more information, see Delete a WorkSpace in WorkSpaces Personal. To stop and start an AutoStop WorkSpace using the AWS CLI Use the stop-WorkSpaces and start-WorkSpaces commands. Manage applications in WorkSpaces Personal After you launch a WorkSpace, you can see the list of all of the application bundles that are associated with your WorkSpace on the WorkSpaces console. To see the list of all the application bundles associated to your WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. From the left navigation pane, choose WorkSpaces. Select the WorkSpace and choose View Details. 4. Under Applications, find the list of applications that are associated with this WorkSpace, along with their installation status. You can update the application bundles on your WorkSpace in the following ways: • Install application bundles on your WorkSpace • Uninstall application bundles from your WorkSpace • Install application bundles and uninstall a different set of application bundles on your WorkSpace Note • To update application bundles, the WorkSpace must have a status of AVAILABLE or STOPPED. • Manage applications is only available for Windows WorkSpaces. Manage applications 380 Amazon WorkSpaces Administration Guide • Manage applications is only available for application bundles that are subscribed through AWS. Supported bundles for Manage applications Manage applications allows you install and uninstall the following applications on your WorkSpaces. For Microsoft Office 2016 bundle and Microsoft Office 2019, you can only uninstall. • Microsoft Office LTSC Professional Plus 2021 • Microsoft Visio LTSC Professional 2021 • Microsoft Project Professional 2021 • Microsoft Office LTSC Standard 2021 • Microsoft Visio LTSC Standard 2021 • Microsoft Project Standard 2021 • Microsoft Visual Studio Professional 2022 • Microsoft Visual Studio Enterprise 2022 The following table shows the list of supported and unsupported application and operating system combinations: Microsoft Office Microsoft Office Microsoft LTSC Microsoft Project Microsoft LTSC Visio Professional / Microsoft Visual Professio Professio Office Professio Standard 2021 (64- Studio nal Plus nal Plus Professio nal / bit) 2016 2019 nal Standard (32-bit) (64-bit) Plus / 2021 Standard (64-bit) 2021 (64-bit) Professio nal / Enterpris e 2022 Uninstall Not supported Not supported Not supported Not supported Not supported 381 Windows Server 2016 Manage applications Amazon WorkSpaces Administration Guide Microsoft Office Microsoft Office Microsoft LTSC Microsoft Project Microsoft LTSC Visio Professional / Microsoft Visual Professio Professio Office Professio Standard 2021 (64- Studio nal Plus nal Plus Professio nal / bit) 2016 2019 nal Standard (32-bit) (64-bit) Plus / 2021 Standard (64-bit) 2021 (64-bit) Professio nal / Enterpris e 2022 Windows Server Not supported Uninstall Install/u ninstall Install/u ninstall Install/uninstall Not supported 2019 Windows Server Not supported Uninstall Install/u ninstall Install/u ninstall Install/uninstall 2022 Windows 10 Windows 11 Uninstall Uninstall Install/u ninstall Install/u ninstall Install/uninstall Uninstall Uninstall Install/u ninstall Install/u ninstall Install/uninstall Install/u ninstall Install/u ninstall Install/u ninstall Important • Microsoft Office/Visio/Project must follow the same editions. For example, you cannot mix Standard applications with Professional applications. • Microsoft Office/Visio/Project must follow the same versions. For example, you cannot mix 2019 applications with 2021 applications. • Microsoft Office/Visio/Project 2021 Standard/Professional are not supported for Value, Graphics, and GraphicsPro WorkSpaces bundles. • Value, Standard, Graphics, and GraphicsPro WorkSpaces bundles are not supported for Microsoft Visual Studio 2022 Enterprise/Professional. Performance bundles can be used for Visual Studio workloads that are less resource intensive. However, for best results, we recommended using Visual Studio with quad-core or higher bundle types. Manage applications 382 Amazon WorkSpaces Administration Guide The bundle types Power, PowerPro, General Purpose.4xlarge, General Purpose.8xlarge, Graphics.g4dn, and GraphicsPro.g4dn meet this requirement. For more information, see Visual Studio 2022 Product Family System Requirements. • When you uninstall Plus applications bundle for Microsoft Office 2016 from your WorkSpaces, you will lose access to any Trend Micro solutions that were included as part of that Amazon WorkSpaces bundle. If you want to continue using Trend Micro solutions with your Amazon WorkSpaces, you can purchase them separately on the AWS marketplace. • In order to install/uninstall Microsoft 365 apps, you need to bring in your own tools and installers, Manage application workflow cannot install/uninstall Microsoft 365 apps. • You can create a custom image of WorkSpaces with applications installed/uninstalled through Manage applications. • For |
workspaces-ag-124 | workspaces-ag.pdf | 124 | System Requirements. • When you uninstall Plus applications bundle for Microsoft Office 2016 from your WorkSpaces, you will lose access to any Trend Micro solutions that were included as part of that Amazon WorkSpaces bundle. If you want to continue using Trend Micro solutions with your Amazon WorkSpaces, you can purchase them separately on the AWS marketplace. • In order to install/uninstall Microsoft 365 apps, you need to bring in your own tools and installers, Manage application workflow cannot install/uninstall Microsoft 365 apps. • You can create a custom image of WorkSpaces with applications installed/uninstalled through Manage applications. • For opt-in Regions, such as Africa (Cape Town), WorkSpaces internet connection must be enabled at the directory level. Update application bundles on a WorkSpace 1. 2. 3. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. In the navigation pane, choose WorkSpaces. Select the WorkSpace and choose Actions, Manage applications. 4. Under Current applications you will see a list of application bundles that are already installed on this WorkSpace and under Choose applications you have a list of application bundles that are available to install on this WorkSpace. 5. To install application bundles on this WorkSpace: a. Select an application bundle that you want to install on this WorkSpace, and choose Associate. b. Repeat the previous step to install other application bundles. c. While the application bundles are installing, you will see them under Current applications with the Pending install deployment status. 6. To uninstall application bundles from this WorkSpace: Manage applications 383 Amazon WorkSpaces Administration Guide a. Under Choose applications, select an application bundle that you want to uninstall and choose Disassociate. b. Repeat the previous step to uninstall other application bundles. c. While the application bundles are uninstalling, you will see them under Current applications with the Pending uninstall deployment status. 7. To revert the bundles installation or installation state, do one of the following. • If you want to revert the bundles from the Pending uninstall deployment state, select the application you want to revert, then choose Associate. • If you want to revert the bundles from the Pending install deployment state, select the application you want to revert, then choose Disassociate. 8. After the application bundles you chose to install or uninstall are in pending states, choose Deploy applications. Important After you select Deploy applications, the end user session will terminate and WorkSpaces will not be accessible while the applications are being installed or uninstalled. 9. To confirm your actions, type confirm. Choose force to install or uninstall applications bundles that are in an Error state. 10. To monitor the progress of your application bundles: a. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. b. In the navigation pane, choose WorkSpaces. You can see the status under Status including the following. • UPDATING - The application bundle update is still ongoing. • AVAILABLE / STOPPED - The application bundle update is complete and the WorkSpace is back to its original state. c. To monitor the installation or uninstallation status of your application bundles, select the WorkSpace and choose View Details. Under Applications, you can see the status under Status, including Pending install, Pending uninstall, and Installed. Manage applications 384 Amazon WorkSpaces Note Administration Guide If your users observe that their newly installed application bundles through Managed Applications are not license activated, you can perform a manual WorkSpace reboot. Your users can begin using those applications following a reboot. For additional support, contact AWS Support. Update Microsoft Visual Studio 2022 workloads on a WorkSpace By default Microsoft Visual Studio 2022 is installed with the following workloads and requires 18 GB of hard disk space: • Visual Studio core editor • Azure development • Data storage and processing • .NET desktop development • NET Multi-platform App UI development • ASP.NET and web development • Node.js development Users have the flexibility to add or remove workloads and individual components, allowing them to tailor the application to their specific requirements. It's important to note that installing additional workloads requires more disk space. To learn more about workload configurations, see Modify Visual Studio workloads, components, and language packs. Managing WorkSpaces modified using Manage applications After installing or uninstalling application bundles on your WorkSpaces, the following actions can impact existing configurations. • Restore a WorkSpace - Restoring a WorkSpace recreates both the root volume and user volume, based on the most recent snapshots of these volumes that were created when the WorkSpace was healthy. Full WorkSpace snapshots are taken every 12 hours. For more information, see Restore a WorkSpace. Ensure you wait for at least 12 hours before restoring your WorkSpaces Manage applications 385 Amazon WorkSpaces Administration Guide that were modified using Manage applications. Restoring your WorkSpaces before the next full snapshot, which were modified using Manage applications, will result in the following: • The application bundles that |
workspaces-ag-125 | workspaces-ag.pdf | 125 | impact existing configurations. • Restore a WorkSpace - Restoring a WorkSpace recreates both the root volume and user volume, based on the most recent snapshots of these volumes that were created when the WorkSpace was healthy. Full WorkSpace snapshots are taken every 12 hours. For more information, see Restore a WorkSpace. Ensure you wait for at least 12 hours before restoring your WorkSpaces Manage applications 385 Amazon WorkSpaces Administration Guide that were modified using Manage applications. Restoring your WorkSpaces before the next full snapshot, which were modified using Manage applications, will result in the following: • The application bundles that were installed on your WorkSpaces using the Manage applications workflow will be removed from your WorkSpaces but the license will still be activated and your WorkSpaces will be billed for those applications. To get those application bundles back on your WorkSpaces you need to run the Manage application workflow again, uninstall the application to start fresh, and then install again. • The application bundles that were removed from your WorkSpaces using the Manage applications workflow will be back on your WorkSpaces. However, those application bundles won’t work properly because the license activation will be missing. In order to get rid of those application bundles, run a manual uninstall of those application bundles from your WorkSpaces. • Rebuild a WorkSpace - Rebuilding a WorkSpace recreates the root volume. For more information, see Rebuild a WorkSpace. Rebuilding your WorkSpaces that were modified using Manage applications will result in the following: • The application bundles that were installed on your WorkSpaces using the Manage applications workflow will be removed and deactivated from your WorkSpaces. In order to get those applications back on your WorkSpaces you need to run the Manage applications workflow again. • The application bundles that were removed from your WorkSpaces via Manage applications workflow will be installed and activated on your WorkSpaces. In order to remove those application bundles from your WorkSpaces, you need to run the Manage applications workflow again. • Migrate a WorkSpace - The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. A new WorkSpace with a new WorkSpace ID is created. For more information, see Migrate a WorkSpace Migrating your WorkSpaces that were modified using Manage applications will result in the following: • All the application bundle from the source WorkSpaces will be removed and deactivated. The new destination WorkSpaces will inherit applications from the destination WorkSpaces bundle. Source WorkSpaces application bundles will be billed for the full month but application bundles on destination bundle will have a pro-rated bill. Manage applications 386 Amazon WorkSpaces Administration Guide Modify a WorkSpace in WorkSpaces Personal After you launch a WorkSpace, you can modify its configuration in three ways: • You can change the size of its root volume (for Windows, drive C; for Linux, /) and its user volume (for Windows, drive D; for Linux /home). • You can change its compute type to select a new bundle. • You can modify the streaming protocol using the AWS CLI or Amazon WorkSpaces API if your WorkSpace was created with PCoIP bundles. To see the current modification state of a WorkSpace, select the arrow to show more details about that WorkSpace. The possible values for State are Modifying Compute, Modifying Storage, and None. If you want to modify a WorkSpace, it must have a status of AVAILABLE or STOPPED. You can't change the volume size and the compute type at the same time. Changing the volume size or compute type of a WorkSpace will change the billing rate for the WorkSpace. To allow your users to modify their volumes and compute types themselves, see Enable self-service WorkSpaces management capabilities for your users in WorkSpaces Personal. Modify volume sizes You can increase the size of the root and user volumes for a WorkSpace, up to 2000 GB each. WorkSpace root and user volumes come in set groups that can't be changed. The available groups are: [Root (GB), User (GB)] [80, 10] [80, 50] [80, 100] [175 to 2000, 100 to 2000] Modify a WorkSpace 387 Amazon WorkSpaces Administration Guide You can expand the root and user volumes whether they are encrypted or unencrypted, and you can expand both volumes once in a 6-hour period. However, you can't increase the size of the root and user volumes at the same time. For more information, see Limitations for Increasing Volumes. Note When you expand a volume for a WorkSpace, WorkSpaces automatically extends the volume's partition within Windows or Linux. When the process is finished, you must reboot the WorkSpace for the changes to take effect. To ensure that your data is preserved, you cannot decrease the size of the root or |
workspaces-ag-126 | workspaces-ag.pdf | 126 | You can expand the root and user volumes whether they are encrypted or unencrypted, and you can expand both volumes once in a 6-hour period. However, you can't increase the size of the root and user volumes at the same time. For more information, see Limitations for Increasing Volumes. Note When you expand a volume for a WorkSpace, WorkSpaces automatically extends the volume's partition within Windows or Linux. When the process is finished, you must reboot the WorkSpace for the changes to take effect. To ensure that your data is preserved, you cannot decrease the size of the root or user volumes after you launch a WorkSpace. Instead, make sure that you specify the minimum sizes for these volumes when launching a WorkSpace. • You can launch a Value, Standard, Performance, Power, or PowerPro WorkSpace with a minimum of 80 GB for the root volume and 10 GB for the user volume. • You can launch a GeneralPurpose.4xlarge or GeneralPurpose.8xlarge WorkSpace with a minimum of 175GB for the root volume and 100 GB for the user volume. • You can launch a Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro WorkSpace with a minimum of 100 GB for the root volume and 100 GB for the user volume. While a WorkSpace disk size increase is in progress, users can perform most tasks on their WorkSpace. However, they can't change their WorkSpace compute type, switch the WorkSpace running mode, rebuild their WorkSpace, or reboot (restart) their WorkSpace. Note If you want your users to be able to use their WorkSpaces while the disk size increase is in progress, make sure the WorkSpaces have a status of AVAILABLE instead of STOPPED before you resize the volumes of the WorkSpaces. If the WorkSpaces are STOPPED, they can't be started while the disk size increase is in progress. In most cases, the disk size increase process might take up to two hours. However, if you're modifying the volume sizes for a large number of WorkSpaces, the process can take significantly Modify a WorkSpace 388 Amazon WorkSpaces Administration Guide longer. If you have a large number of WorkSpaces to modify, we recommend contacting AWS Support for assistance. Limitations for increasing volumes • You can resize only SSD volumes. • When you launch a WorkSpace, you must wait 6 hours before you can modify the sizes of its volumes. • You cannot increase the size of the root and user volumes at the same time. To increase the root volume, you must first change the user volume to 100 GB. After that change is made, you can then update the root volume to any value between 175 and 2000 GB. After the root volume has been changed to any value between 175 and 2000 GB, you can then update the user volume further, to any value between 100 and 2000 GB. Note If you want to increase both volumes, you must wait 20-30 minutes for the first operation to finish before you can start the second operation. • Unless the WorkSpace is a Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro WorkSpace, the root volume cannot be less than 175 GB when the user volume is 100 GB. Graphics.g4dn, GraphicsPro.g4dn, Graphics, and GraphicsPro WorkSpaces can have the root and user volumes both set to 100 GB minimum. • If the user volume is 50 GB, you cannot update the root volume to anything other than 80 GB. If the root volume is 80 GB, the user volume can only be 10, 50, or 100 GB. To modify the root volume of a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace and choose Actions, Modify root volume.. 4. Under Root volume sizes, choose a volume size or choose Custom to enter a custom volume size. 5. Choose Save changes. Modify a WorkSpace 389 Amazon WorkSpaces Administration Guide 6. When the disk size increase is finished, you must reboot the WorkSpace for the changes to take effect. To avoid data loss, make sure the user saves any open files before you reboot the WorkSpace. To modify the user volume of a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace and choose Actions, Modify user volume.. 4. Under User volume sizes, choose a volume size or choose Custom to enter a custom volume size. 5. Choose Save changes. 6. When the disk size increase is finished, you must reboot the WorkSpace for the changes to take effect. To avoid data loss, make sure the user saves any open files before you reboot the WorkSpace. To change the volume sizes of a WorkSpace Use the modify-workspace-properties command with the RootVolumeSizeGib or UserVolumeSizeGib property. Modify compute type You can switch a WorkSpace between the Standard, |
workspaces-ag-127 | workspaces-ag.pdf | 127 | navigation pane, choose WorkSpaces. Select the WorkSpace and choose Actions, Modify user volume.. 4. Under User volume sizes, choose a volume size or choose Custom to enter a custom volume size. 5. Choose Save changes. 6. When the disk size increase is finished, you must reboot the WorkSpace for the changes to take effect. To avoid data loss, make sure the user saves any open files before you reboot the WorkSpace. To change the volume sizes of a WorkSpace Use the modify-workspace-properties command with the RootVolumeSizeGib or UserVolumeSizeGib property. Modify compute type You can switch a WorkSpace between the Standard, Power, Performance, PowerPro GeneralPurpose.4xlarge, and GeneralPurpose.8xlarge compute types. For more information about these compute types, see Amazon WorkSpaces Bundles. Note • If your source operating system is anything other than Windows Server 2022 or Windows 11, you cannot change your compute type from PowerPro to GeneralPurpose. • If you are modifying the compute type from a non-GPU-enabled bundles to GeneralPurpose.4xlarge or GeneralPurpose.8xlarge, your WorkSpaces must meet the minimum root volume size of 175 GB and user volume size of 100 GB. To increase the volume size of your WorkSpaces, see Modify volume sizes. Modify a WorkSpace 390 Amazon WorkSpaces Administration Guide • You can change the compute type from Graphics.g4dn to GraphicsPro.g4dn, or from GraphicsPro.g4dn to Graphics.g4dn. You cannot change the compute type of Graphics.g4dn and GraphicsPro.g4dn to any other value. • Graphics bundle is no longer supported after November 30, 2023. We recommend migrating your WorkSpaces to Graphics.g4dn bundle. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • GraphicsPro bundle reaches end-of-life on October 31, 2025. We recommend migrating your GraphicsPro WorkSpaces to supported bundles before October 31, 2025. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • You cannot change the compute type of Graphics and GraphicsPro to any other value. When you request a compute change, WorkSpaces reboots the WorkSpace using the new compute type. WorkSpaces preserves the operating system, applications, data, and storage settings for the WorkSpace. You can request a larger compute type once in a 6-hour period or a smaller compute type once every 30 days. For a newly launched WorkSpace, you must wait 6 hours before requesting a larger compute type. When a WorkSpace compute type change is in progress, users are disconnected from their WorkSpace, and they can't use or change the WorkSpace. The WorkSpace is automatically rebooted during the compute type change process. Important To avoid data loss, make sure users save any open documents and other application files before you change the WorkSpace compute type. The compute type change process might take up to an hour. To change the compute type of a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace and choose Actions, Modify compute type. Modify a WorkSpace 391 Amazon WorkSpaces Administration Guide 4. Under Compute type, choose a compute type. 5. Choose Save changes. To change the compute type of a WorkSpace Use the modify-workspace-properties command with the ComputeTypeName property. Modify protocols 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. • You can only modify your protocol if your WorkSpace was created with PCoIP bundles and is not a GPU-enabled WorkSpace. • Before you modify the protocol to DCV, ensure that your WorkSpace meets the following requirements for a DCV WorkSpace. • Your WorkSpaces client supports DCV • The region where your WorkSpace is deployed supports DCV • The IP address and port requirements for DCV are open. For more information, see IP address and port requirements for WorkSpaces. • Ensure your current bundle is available with DCV. • For the best experience with video conferencing we recommend using Power, PowerPro, GeneralPurpose.4xlarge, or GeneralPurpose.8xlarge only. Note • We highly recommend testing with your non-production WorkSpaces before you start changing the protocol. • If you modify the protocol from PCoIP to DCV, and then modify the protocol back to PCoIP, you won't be able to connect to WorkSpaces through Web Access. Modify a WorkSpace 392 Amazon WorkSpaces Administration Guide To change the protocol of a WorkSpace 1. 2. [Optional] Reboot your WorkSpace and wait until it’s in the AVAILABLE state before modifying the protocol. [Optional] Use the describe-workspaces command to list the WorkSpace properties. Ensure that it’s in the AVAILABLE state and its current Protocol is accurate. 3. Use the modify-workspace-properties command and modify the Protocols property from PCOIP to DCV, or the other way around. aws workspaces modify-workspace-properties --workspace-id |
workspaces-ag-128 | workspaces-ag.pdf | 128 | to DCV, and then modify the protocol back to PCoIP, you won't be able to connect to WorkSpaces through Web Access. Modify a WorkSpace 392 Amazon WorkSpaces Administration Guide To change the protocol of a WorkSpace 1. 2. [Optional] Reboot your WorkSpace and wait until it’s in the AVAILABLE state before modifying the protocol. [Optional] Use the describe-workspaces command to list the WorkSpace properties. Ensure that it’s in the AVAILABLE state and its current Protocol is accurate. 3. Use the modify-workspace-properties command and modify the Protocols property from PCOIP to DCV, or the other way around. aws workspaces modify-workspace-properties --workspace-id <value> --workspace-properties "Protocols=[WSP]" Important 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. 5. Use the describe-workspaces command again to list the WorkSpace properties and verify that it’s in an AVAILABLE state and the current Protocols property has been changed to the correct protocol. Note • Modifying the WorkSpace's protocol will not update the bundle description in the console. The Launch Bundle description will not change. • If the WorkSpace remains in an UNHEALTHY state after 20 min, reboot the WorkSpace in the console. 6. You can now connect to your WorkSpace. Customize branding in WorkSpaces Personal Amazon WorkSpaces allows you to create a familiar WorkSpaces experience for your users by using APIs to customize the appearance of your WorkSpace's login page with your own branding logo, IT Customize branding 393 Amazon WorkSpaces Administration Guide support information, forgot password link, and login message. Your branding will be displayed to your users in their WorkSpace login page rather than the default WorkSpaces branding. The following clients are supported: • Windows • Linux • Android • MacOS • iOS • Web Access Note To modify branding elements using the ClientBranding APIs in the AWS GovCloud (US) Region, use a WorkSpaces client version that is 5.10.0. Import custom branding To import your client branding customization, use the action ImportClientBranding, which includes the following elements. See ImportClientBranding API reference for more information. Important Client branding attributes are public facing. Ensure that you don't include sensitive information. Customize branding 394 Amazon WorkSpaces Administration Guide 1. Support link 2. Logo 3. Forgot password link 4. Login message Custom branding elements Branding element Description Requirements and recommendations Support link Customize branding Allows you to specify a support email link for users • For each platform type, the SupportEmail 395 Amazon WorkSpaces Administration Guide Branding element Description Requirements and recommendations to contact for help with their WorkSpaces. You can use the SupportEmail attribute or provide a link to your support page using the SupportLi nk attribute. and SupportLink parameters are mutually exclusive. You can specify a single parameter for each platform type, but not both. • The default email is workspaces-feedbac k@amazon.com . • Length constraints: Minimum length of 1. Maximum length of 200. • The only image format accepted is a binary data object that is converted from a .png file. • Recommended resolutions: • Android: 978 x 190 • Desktop: 319 x 55 • iOS@2x: 110 x 200 • iOS@3x: 1650 x 300 Length Constraints: Minimum length of 1. Maximum length of 200. Logo Allows you to customize your organization's logo using the Logo attribute. Forgot password link Allows you to add a web address using the ForgotPas swordLink attribute that users can go to if they forget their password to their WorkSpace. Customize branding 396 Amazon WorkSpaces Administration Guide Branding element Description Requirements and recommendations Login message Allows you to customize a message using the • Length Constraints: Minimum length of 0. LoginMessage attribute on the sign in screen. Maximum length of 2000 characters for integrati on with HTML tags and different font size. For default cases without HTML tags, it is recommended to keep the login message under 600 characters. • HTML tags supported: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul The following are sample code snippets for using ImportClientBranding. AWS CLI Version 2 Warning Importing custom branding overwrites the attributes, within that platform, that you specify with your custom data. It also overwrites the attributes that you don't specify with default custom branding attribute values. You must include the data for any attribute that you don't want to overwrite. aws workspaces import-client-branding \ --cli-input-json file://~/Downloads/import-input.json \ Customize branding 397 Amazon WorkSpaces --region us-west-2 Administration Guide The import JSON file should look like the following sample code: { "ResourceId": "<directory-id>", "DeviceTypeOsx": { "Logo": "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAC0lEQVR42mNgQAcAABIAAeRVjecAAAAASUVORK5CYII=", "ForgotPasswordLink": "https://amazon.com/", "SupportLink": "https://amazon.com/", "LoginMessage": { "en_US": "Hello!!" } } } The following sample Java code snippet converts the logo image into a base64-encoded string: // |
workspaces-ag-129 | workspaces-ag.pdf | 129 | attributes, within that platform, that you specify with your custom data. It also overwrites the attributes that you don't specify with default custom branding attribute values. You must include the data for any attribute that you don't want to overwrite. aws workspaces import-client-branding \ --cli-input-json file://~/Downloads/import-input.json \ Customize branding 397 Amazon WorkSpaces --region us-west-2 Administration Guide The import JSON file should look like the following sample code: { "ResourceId": "<directory-id>", "DeviceTypeOsx": { "Logo": "iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAC0lEQVR42mNgQAcAABIAAeRVjecAAAAASUVORK5CYII=", "ForgotPasswordLink": "https://amazon.com/", "SupportLink": "https://amazon.com/", "LoginMessage": { "en_US": "Hello!!" } } } The following sample Java code snippet converts the logo image into a base64-encoded string: // Read image as BufferImage BufferedImage bi = ImageIO.read(new File("~/Downloads/logo.png")); // convert BufferedImage to byte[] ByteArrayOutputStream baos = new ByteArrayOutputStream(); ImageIO.write(bi, "png", baos); byte[] bytes = baos.toByteArray(); //convert byte[] to base64 format and print it String bytesBase64 = Base64.encodeBase64String(bytes); System.out.println(bytesBase64); The following sample Python code snippet converts the logo image into a base64-encoded string: # Read logo into base64-encoded string with open("~/Downloads/logo.png", "rb") as image_file: f = image_file.read() base64_string = base64.b64encode(f) print(base64_string) Customize branding 398 Amazon WorkSpaces Java Warning Administration Guide Importing custom branding overwrites the attributes, within that platform, that you specify with your custom data. It also overwrites the attributes that you don't specify with default custom branding attribute values. You must include the data for any attribute that you don't want to overwrite. // Create WS Client WorkSpacesClient client = WorkSpacesClient.builder().build(); // Read image as BufferImage BufferedImage bi = ImageIO.read(new File("~/Downloads/logo.png")); // convert BufferedImage to byte[] ByteArrayOutputStream baos = new ByteArrayOutputStream(); ImageIO.write(bi, "png", baos); byte[] bytes = baos.toByteArray(); // Create import attributes for the plateform DefaultImportClientBrandingAttributes attributes = DefaultImportClientBrandingAttributes.builder() .logo(SdkBytes.fromByteArray(bytes)) .forgotPasswordLink("https://aws.amazon.com/") .supportLink("https://aws.amazon.com/") .build(); // Create import request ImportClientBrandingRequest request = ImportClientBrandingRequest.builder() .resourceId("<directory-id>") .deviceTypeOsx(attributes) .build(); // Call ImportClientBranding API ImportClientBrandingResponse response = client.importClientBranding(request); Customize branding 399 Amazon WorkSpaces Python Warning Administration Guide Importing custom branding overwrites the attributes, within that platform, that you specify with your custom data. It also overwrites the attributes that you don't specify with default custom branding attribute values. You must include the data for any attribute that you don't want to overwrite. import boto3 # Read logo into bytearray with open("~/Downloads/logo.png", "rb") as image_file: f = image_file.read() bytes = bytearray(f) # Create WorkSpaces client client = boto3.client('workspaces') # Call import API response = client.import_client_branding( ResourceId='<directory-id>', DeviceTypeOsx={ 'Logo': bytes, 'SupportLink': 'https://aws.amazon.com/', 'ForgotPasswordLink': 'https://aws.amazon.com/', 'LoginMessage': { 'en_US': 'Hello!!' } } ) PowerShell #Requires -Modules @{ ModuleName="AWS.Tools.WorkSpaces"; ModuleVersion="4.1.56"} # Specify Image Path $imagePath = "~/Downloads/logo.png" # Create Byte Array from image file Customize branding 400 Amazon WorkSpaces Administration Guide $imageByte = ([System.IO.File]::ReadAllBytes($imagePath)) # Call import API Import-WKSClientBranding -ResourceId <directory-id> ` -DeviceTypeLinux_LoginMessage @{en_US="Hello!!"} ` -DeviceTypeLinux_Logo $imageByte ` -DeviceTypeLinux_ForgotPasswordLink "https://aws.amazon.com/" ` -DeviceTypeLinux_SupportLink "https://aws.amazon.com/" To preview the login page, launch the WorkSpaces application or web login page. Note Changes may take up to 1 minute to appear. Describe custom branding To see the details of the client branding customization you currently have, use the action DescribeCustomBranding. The following is the sample script for using DescribeClientBranding. See DescribeClientBranding API reference for more information. aws workspaces describe-client-branding \ --resource-id <directory-id> \ --region us-west-2 Delete custom branding To delete your client branding customization, use the action DeleteCustomBranding. The following is the sample script for using DeleteClientBranding. See DeleteClientBranding API reference for more information. aws workspaces delete-client-branding \ --resource-id <directory-id> \ --platforms DeviceTypeAndroid DeviceTypeIos \ --region us-west-2 Note Changes may take up to 1 minute to appear. Customize branding 401 Amazon WorkSpaces Administration Guide Tag resources in WorkSpaces Personal You can organize and manage the resources for your WorkSpaces by assigning your own metadata to each resource in the form of tags. You specify a key and a value for each tag. A key can be a general category, such as "project," "owner," or "environment," with specific associated values. Using tags is a simple yet powerful way to manage AWS resources and to organize data, including billing data. When you add tags to an existing resource, those tags don't appear in your cost allocation report until the first day of the following month. For example, if you add tags to an existing WorkSpace on July 15, the tags won't appear in your cost allocation report until August 1. For more information, see Using Cost Allocation Tags in the AWS Billing User Guide. Note To view your WorkSpaces resource tags in the Cost Explorer, you must activate the tags that you have applied to your WorkSpaces resources by following the instructions in Activating User-Defined Cost Allocation Tags in the AWS Billing User Guide. Although tags appear 24 hours after activation, it can take 4 to 5 days for values associated with those tags to appear in the Cost Explorer. Additionally, to appear and provide cost data in Cost Explorer, WorkSpaces resources that have been tagged must incur charges during that time. Cost Explorer only shows |
workspaces-ag-130 | workspaces-ag.pdf | 130 | Allocation Tags in the AWS Billing User Guide. Note To view your WorkSpaces resource tags in the Cost Explorer, you must activate the tags that you have applied to your WorkSpaces resources by following the instructions in Activating User-Defined Cost Allocation Tags in the AWS Billing User Guide. Although tags appear 24 hours after activation, it can take 4 to 5 days for values associated with those tags to appear in the Cost Explorer. Additionally, to appear and provide cost data in Cost Explorer, WorkSpaces resources that have been tagged must incur charges during that time. Cost Explorer only shows cost data from the time when the tags were activated and onward. No historical data is available at this time. Resources that you can tag • You can add tags to the following resources when you create them—WorkSpaces, imported images, and IP access control groups. • You can add tags to existing resources of the following types—WorkSpaces, registered directories, custom bundles, images, and IP access control groups. Tag restrictions • Maximum number of tags per resource—50 • Maximum key length—127 Unicode characters • Maximum value length—255 Unicode characters Tag resources 402 Amazon WorkSpaces Administration Guide • Tag keys and values are case-sensitive. Allowed characters are letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. Do not use leading or trailing spaces. • Do not use the aws: or aws:workspaces: prefixes in your tag names or values because they are reserved for AWS use. You can't edit or delete tag names or values with these prefixes. To update the tags for an existing resource using the console (directories, WorkSpaces, or IP access control groups) 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose one of the following resource types: Directories, WorkSpaces, or IP Access Controls. 3. Select the resource to open its details page. 4. Do one or more of the following: • To update a tag, edit the values of Key and Value. • To add a tag, choose Add Tag and then edit the values of Key and Value. • To delete a tag, choose the delete icon (X) next to the tag. 5. When you are finished updating tags, choose Save. To update the tags for an existing resource using the console (images or bundles) 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose one of the following resource types: Bundles or Images. 3. Choose the resource to open its details page. 4. Under Tags, choose Manage tags. 5. Do one or more of the following: • To update a tag, edit the values of Key and Value. • To add a tag, choose Add new tag and then edit the values of Key and Value. • To delete a tag, choose Remove next to the tag. 6. When you are finished updating tags, choose Save changes. To update the tags for an existing resource using the AWS CLI Tag resources 403 Amazon WorkSpaces Administration Guide Use the create-tags and delete-tags commands. Maintenance in WorkSpaces Personal We recommend that you maintain your WorkSpaces on a regular basis. WorkSpaces schedules default maintenance windows for your WorkSpaces. During the maintenance window, the WorkSpace installs important updates from Amazon WorkSpaces and reboots as necessary. If available, operating system updates are also installed from the OS update server that the WorkSpace is configured to use. During maintenance, your WorkSpaces might be unavailable. By default, your Windows WorkSpaces are configured to receive updates from Windows Update. To configure your own automatic update mechanisms for Windows, see the documentation for Windows Server Update Services (WSUS) and Configuration Manager. Requirement Your WorkSpaces must have access to the internet so that you can install updates to the operating system and deploy applications. For more information, see the section called “Internet access”. Maintenance windows for AlwaysOn WorkSpaces For AlwaysOn WorkSpaces, the maintenance window is determined by operating system settings. The default is a four-hour period from 00h00 to 04h00, in the time zone of the WorkSpace, each Sunday morning. By default, the time zone of an AlwaysOn WorkSpace is the time zone of the AWS Region for the WorkSpace. However, if you connect from another Region and time zone redirection is enabled, and then you disconnect, the time zone of the WorkSpace is updated to the time zone of the Region that you connected from. You can disable time zone redirection for Windows WorkSpaces using Group Policy. You can disable time zone redirection for Linux WorkSpaces by using the PCoIP Agent conf. For Windows WorkSpaces, you can configure the maintenance window using Group Policy; see Configure Group Policy Settings for Automatic Updates. You cannot configure the maintenance window for Linux WorkSpaces. Maintenance windows for AutoStop WorkSpaces AutoStop WorkSpaces |
workspaces-ag-131 | workspaces-ag.pdf | 131 | WorkSpace. However, if you connect from another Region and time zone redirection is enabled, and then you disconnect, the time zone of the WorkSpace is updated to the time zone of the Region that you connected from. You can disable time zone redirection for Windows WorkSpaces using Group Policy. You can disable time zone redirection for Linux WorkSpaces by using the PCoIP Agent conf. For Windows WorkSpaces, you can configure the maintenance window using Group Policy; see Configure Group Policy Settings for Automatic Updates. You cannot configure the maintenance window for Linux WorkSpaces. Maintenance windows for AutoStop WorkSpaces AutoStop WorkSpaces are started automatically once a month in order to install important updates. Beginning on the third Monday of the month, and for up to two weeks, the maintenance Maintenance 404 Amazon WorkSpaces Administration Guide window is open each day from about 00h00 to 05h00, in the time zone of the AWS Region for the WorkSpace. The WorkSpace can be maintained on any one day in the maintenance window. During this window, only WorkSpaces older than 7 days are maintained. During the time period when the WorkSpace is undergoing maintenance, the state of the WorkSpace is set to MAINTENANCE. Although you cannot modify the time zone that is used for maintaining AutoStop WorkSpaces, you can disable the maintenance window for your AutoStop WorkSpaces as follows. If you disable maintenance mode, your WorkSpaces are not rebooted and do not enter the MAINTENANCE state. To disable maintenance mode 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. 5. In the navigation pane, choose Directories. Select your directory, and choose Actions, Update Details. Expand Maintenance Mode. To enable automatic updates, choose Enabled. If you prefer to manage updates manually, choose Disabled. 6. Choose Update and Exit. Manual maintenance If you prefer, you can maintain your WorkSpaces on your own schedule. When you perform maintenance tasks, we recommend that you change the state of the WorkSpace to Maintenance. When you are finished, change the state of the WorkSpace to Available. When a WorkSpace is in Maintenance state, the following behaviors occur: • The WorkSpace does not respond to requests to reboot, stop, start, or rebuild. • Users cannot log in to the WorkSpace. • An AutoStop WorkSpace is not hibernated. Maintenance 405 Amazon WorkSpaces Administration Guide To change the state of the WorkSpace using the console Note To change the state of a WorkSpace, the WorkSpace must be in the Available state. The Modify state setting is not available when a WorkSpace is not in the Available state. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select your WorkSpace, and choose Actions, Modify state. 4. Under Modify state, choose Available or Maintenance. 5. Choose Save. To change the state of the WorkSpace using the AWS CLI Use the modify-workspace-state command. Encrypted WorkSpaces in WorkSpaces Personal WorkSpaces is integrated with the AWS Key Management Service (AWS KMS). This enables you to encrypt storage volumes of WorkSpaces using AWS KMS Key. When you launch a WorkSpace, you can encrypt the root volume (for Microsoft Windows, the C drive; for Linux, /) and the user volume (for Windows, the D drive; for Linux, /home). Doing so ensures that the data stored at rest, disk I/O to the volume, and snapshots created from the volumes are all encrypted. Note • In addition to encrypting your WorkSpaces, you can also use FIPS endpoint encryption in certain AWS US Regions. For more information, see Configure FedRAMP authorization or DoD SRG compliance for WorkSpaces Personal. • BitLocker encryption is not supported for Amazon WorkSpaces. Contents • Prerequisites Encrypted WorkSpaces 406 Amazon WorkSpaces • Limits • Overview of WorkSpaces encryption using AWS KMS • WorkSpaces encryption context • Grant WorkSpaces permission to use a KMS Key on your behalf Administration Guide • Encrypt a WorkSpace • View encrypted WorkSpaces Prerequisites You need an AWS KMS Key before you can begin the encryption process. This KMS Key can be either the AWS managed KMS Key for Amazon WorkSpaces (aws/workspaces) or a symmetric customer managed KMS Key. • AWS managed KMS Keys – The first time that you launch an unencrypted WorkSpace from the WorkSpaces console in a Region, Amazon WorkSpaces automatically creates an AWS managed KMS Key (aws/workspaces) in your account. You can select this AWS managed KMS Key to encrypt the user and root volumes of your WorkSpace. For details, see Overview of WorkSpaces encryption using AWS KMS. You can view this AWS managed KMS Key, including its policies and grants, and can track its use in AWS CloudTrail logs, but you cannot use or manage this KMS Key. Amazon WorkSpaces creates and manages this KMS Key. Only Amazon WorkSpaces can use this KMS Key, and WorkSpaces can use it only to encrypt WorkSpaces resources |
workspaces-ag-132 | workspaces-ag.pdf | 132 | a Region, Amazon WorkSpaces automatically creates an AWS managed KMS Key (aws/workspaces) in your account. You can select this AWS managed KMS Key to encrypt the user and root volumes of your WorkSpace. For details, see Overview of WorkSpaces encryption using AWS KMS. You can view this AWS managed KMS Key, including its policies and grants, and can track its use in AWS CloudTrail logs, but you cannot use or manage this KMS Key. Amazon WorkSpaces creates and manages this KMS Key. Only Amazon WorkSpaces can use this KMS Key, and WorkSpaces can use it only to encrypt WorkSpaces resources in your account. AWS managed KMS Key, including the one that Amazon WorkSpaces supports, are rotated every year. For details, see Rotating AWS KMS Key in the AWS Key Management Service Developer Guide. • Customer managed KMS Key – Alternatively, you can select a symmetric customer managed KMS Key that you created using AWS KMS. You can view, use, and manage this KMS Key, including setting its policies. For more information about creating KMS Keys, see Creating Keys in the AWS Key Management Service Developer Guide. For more information about creating KMS Keys using the AWS KMS API, see Working with Keys in the AWS Key Management Service Developer Guide. Customer managed KMS Keys are not automatically rotated unless you decide to enable automatic key rotation. For details, see Rotating AWS KMS Keys in the AWS Key Management Service Developer Guide. Encrypted WorkSpaces 407 Amazon WorkSpaces Important Administration Guide When you manually rotate KMS Keys, you must keep both the original KMS Key and the new KMS Key enabled so that AWS KMS can decrypt the WorkSpaces that the original KMS Key encrypted. If you don't want to keep the original KMS Key enabled, you must recreate your WorkSpaces and encrypt them using the new KMS Key. You must meet the following requirements to use an AWS KMS Key to encrypt your WorkSpaces: • The KMS Key must be symmetric. Amazon WorkSpaces does not support asymmetric KMS Keys. For information about distinguishing between symmetric and asymmetric KMS Keys, see Identifying Symmetric and Asymmetric KMS Keys in the AWS Key Management Service Developer Guide. • The KMS Key must be enabled. To determine whether a KMS Key is enabled, see Displaying KMS Key Details in the AWS Key Management Service Developer Guide. • You must have the correct permissions and policies associated with the KMS Key. For more information, see Part 2: Grant WorkSpaces administrators additional permissions using an IAM policy. Limits • You can't encrypt an existing WorkSpace. You must encrypt a WorkSpace when you launch it. • Creating a custom image from an encrypted WorkSpace is not supported. • Disabling encryption for an encrypted WorkSpace is not currently supported. • WorkSpaces launched with root volume encryption enabled might take up to an hour to provision. • To reboot or rebuild an encrypted WorkSpace, first make sure that the AWS KMS Key is enabled; otherwise, the WorkSpace becomes unusable. To determine whether a KMS Key is enabled, see Displaying KMS Key Details in the AWS Key Management Service Developer Guide. Overview of WorkSpaces encryption using AWS KMS When you create WorkSpaces with encrypted volumes, WorkSpaces uses Amazon Elastic Block Store (Amazon EBS) to create and manage those volumes. Amazon EBS encrypts your volumes Encrypted WorkSpaces 408 Amazon WorkSpaces Administration Guide with a data key using the industry-standard AES-256 algorithm. Both Amazon EBS and Amazon WorkSpaces use your KMS Key to work with the encrypted volumes. For more information about EBS volume encryption, see Amazon EBS Encryption in the Amazon EC2 User Guide. When you launch WorkSpaces with encrypted volumes, the end-to-end process works like this: 1. You specify the KMS Key to use for encryption as well as the user and directory for the WorkSpace. This action creates a grant that allows WorkSpaces to use your KMS Key only for this WorkSpace—that is, only for the WorkSpace associated with the specified user and directory. 2. WorkSpaces creates an encrypted EBS volume for the WorkSpace and specifies the KMS Key to use as well as the volume's user and directory. This action creates a grant that allows Amazon EBS to use your KMS Key only for this WorkSpace and volume—that is, only for the WorkSpace associated with the specified user and directory, and only for the specified volume. 3. Amazon EBS requests a volume data key that is encrypted under your KMS Key and specifies the WorkSpace user's Active Directory security identifier (SID) and AWS Directory Service directory ID as well as the Amazon EBS volume ID as the encryption context. 4. AWS KMS creates a new data key, encrypts it under your KMS Key, and then sends the encrypted data key to Amazon EBS. 5. WorkSpaces uses Amazon EBS to |
workspaces-ag-133 | workspaces-ag.pdf | 133 | your KMS Key only for this WorkSpace and volume—that is, only for the WorkSpace associated with the specified user and directory, and only for the specified volume. 3. Amazon EBS requests a volume data key that is encrypted under your KMS Key and specifies the WorkSpace user's Active Directory security identifier (SID) and AWS Directory Service directory ID as well as the Amazon EBS volume ID as the encryption context. 4. AWS KMS creates a new data key, encrypts it under your KMS Key, and then sends the encrypted data key to Amazon EBS. 5. WorkSpaces uses Amazon EBS to attach the encrypted volume to your WorkSpace. Amazon EBS sends the encrypted data key to AWS KMS with a Decrypt request and specifies the WorkSpace user's SID, the directory ID, and the volume ID, which is used as the encryption context. 6. AWS KMS uses your KMS Key to decrypt the data key, and then sends the plain text data key to Amazon EBS. 7. Amazon EBS uses the plain text data key to encrypt all data going to and from the encrypted volume. Amazon EBS keeps the plain text data key in memory for as long as the volume is attached to the WorkSpace. 8. Amazon EBS stores the encrypted data key (received at Step 4) with the volume metadata for future use in case you reboot or rebuild the WorkSpace. 9. When you use the AWS Management Console to remove a WorkSpace (or use the TerminateWorkspaces action in the WorkSpaces API), WorkSpaces and Amazon EBS retire the grants that allowed them to use your KMS Key for that WorkSpace. Encrypted WorkSpaces 409 Amazon WorkSpaces Administration Guide WorkSpaces encryption context WorkSpaces doesn't use your KMS Key directly for cryptographic operations (such as Encrypt, Decrypt, GenerateDataKey, etc.), which means WorkSpaces doesn't send requests to AWS KMS that include an encryption context. However, when Amazon EBS requests an encrypted data key for the encrypted volumes of your WorkSpaces (Step 3 in the Overview of WorkSpaces encryption using AWS KMS) and when it requests a plain text copy of that data key (Step 5), it includes encryption context in the request. The encryption context provides additional authenticated data (AAD) that AWS KMS uses to ensure data integrity. The encryption context is also written to your AWS CloudTrail log files, which can help you understand why a given KMS Key was used. Amazon EBS uses the following for the encryption context: • The security identifier (SID) of the Active Directory user that is associated with the WorkSpace • The directory ID of the AWS Directory Service directory that is associated with the WorkSpace • The Amazon EBS volume ID of the encrypted volume The following example shows a JSON representation of the encryption context that Amazon EBS uses: { "aws:workspaces:sid-directoryid": "[S-1-5-21-277731876-1789304096-451871588-1107]@[d-1234abcd01]", "aws:ebs:id": "vol-1234abcd" } Grant WorkSpaces permission to use a KMS Key on your behalf You can protect your WorkSpace data under the AWS managed KMS Key for WorkSpaces (aws/ workspaces) or a customer managed KMS Key. If you use a customer managed KMS Key, you need to grant WorkSpaces permission to use the KMS Key on behalf of the WorkSpaces administrators in your account. The AWS managed KMS Key for WorkSpaces has the required permissions by default. To prepare your customer managed KMS Key for use with WorkSpaces, use the following procedure. 1. Add your WorkSpaces administrators to the list of key users in the KMS Key's key policy Encrypted WorkSpaces 410 Amazon WorkSpaces Administration Guide 2. Give your WorkSpaces administrators additional permissions with an IAM policy Your WorkSpaces administrators also need permission to use WorkSpaces. For more information about these permissions, go to Identity and access management for WorkSpaces. Part 1: Add WorkSpaces administrators to as key users To give WorkSpaces administrators the permissions that they require, you can use the AWS Management Console or the AWS KMS API. To add WorkSpaces administrators as key users for a KMS Key (console) 1. Sign in to the AWS Management Console and open the AWS Key Management Service (AWS KMS) console at https://console.aws.amazon.com/kms. 2. 3. To change the AWS Region, use the Region selector in the upper-right corner of the page. In the navigation pane, choose Customer managed keys. 4. Choose the key ID or alias of your preferred customer managed KMS Key. 5. Choose the Key policy tab. Under Key users, choose Add. 6. In the list of IAM users and roles, select the users and roles that correspond to your WorkSpaces administrators, and then choose Add. To add WorkSpaces administrators as key users for a KMS Key (API) 1. Use the GetKeyPolicy operation to get the existing key policy, and then save the policy document to a file. 2. Open the policy document in your preferred text editor. Add the IAM |
workspaces-ag-134 | workspaces-ag.pdf | 134 | navigation pane, choose Customer managed keys. 4. Choose the key ID or alias of your preferred customer managed KMS Key. 5. Choose the Key policy tab. Under Key users, choose Add. 6. In the list of IAM users and roles, select the users and roles that correspond to your WorkSpaces administrators, and then choose Add. To add WorkSpaces administrators as key users for a KMS Key (API) 1. Use the GetKeyPolicy operation to get the existing key policy, and then save the policy document to a file. 2. Open the policy document in your preferred text editor. Add the IAM users and roles that correspond to your WorkSpaces administrators to the policy statements that give permission to key users. Then save the file. 3. Use the PutKeyPolicy operation to apply the key policy to the KMS Key. Part 2: Grant WorkSpaces administrators additional permissions using an IAM policy If you select a customer managed KMS Key to use for encryption, you must establish IAM policies that allow Amazon WorkSpaces to use the KMS Key on behalf of an IAM user in your account who launches encrypted WorkSpaces. That user also needs permission to use Amazon WorkSpaces. For more information about creating and editing IAM user policies, see Managing IAM Policies in the IAM User Guide and Identity and access management for WorkSpaces. Encrypted WorkSpaces 411 Amazon WorkSpaces Administration Guide WorkSpaces encryption requires limited access to the KMS Key. The following is a sample key policy that you can use. This policy separates the principals who can manage the AWS KMS Key from those who can use it. Before you use this sample key policy, replace the example account ID and IAM user name with actual values from your account. The first statement matches the default AWS KMS key policy. It gives your account permission to use IAM policies to control access to the KMS Key. The second and third statements define which AWS principals can manage and use the key, respectively. The fourth statement enables AWS services that are integrated with AWS KMS to use the key on behalf of the specified principal. This statement enables AWS services to create and manage grants. The statement uses a condition element that limits grants on the KMS Key to those made by AWS services on behalf of users in your account. Note If your WorkSpaces administrators use the AWS Management Console to create WorkSpaces with encrypted volumes, the administrators need permission to list aliases and list keys (the "kms:ListAliases" and "kms:ListKeys" permissions). If your WorkSpaces administrators use only the Amazon WorkSpaces API (not the console), you can omit the "kms:ListAliases" and "kms:ListKeys" permissions. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Action": "kms:*", "Resource": "*" }, { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:user/Alice"}, "Action": [ "kms:Create*", "kms:Describe*", "kms:Enable*", "kms:List*", "kms:Put*", Encrypted WorkSpaces 412 Amazon WorkSpaces Administration Guide "kms:Update*", "kms:Revoke*", "kms:Disable*", "kms:Get*", "kms:Delete*" ], "Resource": "*" }, { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:user/Alice"}, "Action": [ "kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt", "kms:GenerateDataKey*", "kms:DescribeKey" ], "Resource": "*" }, { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:user/Alice"}, "Action": [ "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant" ], "Resource": "*", "Condition": {"Bool": {"kms:GrantIsForAWSResource": "true"}} } ] } The IAM policy for a user or role that is encrypting a WorkSpace must include usage permissions on the customer managed KMS Key, as well as access to WorkSpaces. To give an IAM user or role WorkSpaces permissions, you can attach the following sample policy to the IAM user or role. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", Encrypted WorkSpaces 413 Amazon WorkSpaces Administration Guide "Action": [ "ds:*", "ds:DescribeDirectories", "workspaces:*", "workspaces:DescribeWorkspaceBundles", "workspaces:CreateWorkspaces", "workspaces:DescribeWorkspaceBundles", "workspaces:DescribeWorkspaceDirectories", "workspaces:DescribeWorkspaces", "workspaces:RebootWorkspaces", "workspaces:RebuildWorkspaces" ], "Resource": "*" } ] } The following IAM policy is required by the user for using AWS KMS. It gives the user read-only access to the KMS Key along with the ability to create grants. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "kms:CreateGrant", "kms:Describe*", "kms:List*" ], "Resource": "*" } ] } If you want to specify the KMS Key in your policy, use an IAM policy similar to the following. Replace the example KMS Key ARN with a valid one. { "Version": "2012-10-17", "Statement": [ { Encrypted WorkSpaces 414 Amazon WorkSpaces Administration Guide "Effect": "Allow", "Action": "kms:CreateGrant", "Resource": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" }, { "Effect": "Allow", "Action": [ "kms:ListAliases", "kms:ListKeys" ], "Resource": "*" } ] } Encrypt a WorkSpace To encrypt a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Launch WorkSpaces and complete the first three steps. 3. For the WorkSpaces Configuration step, do the following: a. b. Select the volumes to encrypt: Root Volume, User Volume, or both volumes. For Encryption Key, select an AWS KMS Key, either the AWS managed KMS Key created by Amazon WorkSpaces or a KMS Key that you created. The KMS Key that you select must be |
workspaces-ag-135 | workspaces-ag.pdf | 135 | "Allow", "Action": "kms:CreateGrant", "Resource": "arn:aws:kms:us- west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" }, { "Effect": "Allow", "Action": [ "kms:ListAliases", "kms:ListKeys" ], "Resource": "*" } ] } Encrypt a WorkSpace To encrypt a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Launch WorkSpaces and complete the first three steps. 3. For the WorkSpaces Configuration step, do the following: a. b. Select the volumes to encrypt: Root Volume, User Volume, or both volumes. For Encryption Key, select an AWS KMS Key, either the AWS managed KMS Key created by Amazon WorkSpaces or a KMS Key that you created. The KMS Key that you select must be symmetric. Amazon WorkSpaces does not support asymmetric KMS Keys. c. Choose Next Step. 4. Choose Launch WorkSpaces. View encrypted WorkSpaces To see which WorkSpaces and volumes have been encrypted from the WorkSpaces console, choose WorkSpaces from the navigation bar on the left. The Volume Encryption column shows whether each WorkSpace has encryption enabled or disabled. To see which specific volumes have been encrypted, expand the WorkSpace entry to see the Encrypted Volumes field. Encrypted WorkSpaces 415 Amazon WorkSpaces Administration Guide Reboot a WorkSpace in WorkSpaces Personal Occasionally, you might need to reboot (restart) a WorkSpace manually. Rebooting a WorkSpace disconnects the user and then performs a shutdown and reboot of the WorkSpace. To avoid data loss, make sure the user saves any open documents and other application files before you reboot the WorkSpace. The user data, operating system, and system settings are not affected. Warning To reboot an encrypted WorkSpace, first make sure that the AWS KMS Key is enabled; otherwise, the WorkSpace becomes unusable. To determine whether a KMS Key is enabled, see Displaying KMS Key Details in the AWS Key Management Service Developer Guide. To reboot a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpaces to reboot and choose Actions, Reboot WorkSpaces. 4. When prompted for confirmation, choose Reboot WorkSpaces. To reboot a WorkSpace using the AWS CLI Use the reboot-workspaces command. To bulk reboot WorkSpaces Use the amazon-workspaces-admin-module. Rebuild a WorkSpace in WorkSpaces Personal Rebuilding a WorkSpace recreates the root volume of the most recent image of the bundle that the WorkSpace was launched from, its user volume, and its primary elastic network interface. Rebuilding a WorkSpace deletes more data than restoring a WorkSpace, but it only requires you to have a snapshot of the user volume. To restore a WorkSpace, see Restore a WorkSpace in WorkSpaces Personal. Rebuilding a WorkSpace causes the following to occur: Reboot a WorkSpace 416 Amazon WorkSpaces Administration Guide • The root volume (for Microsoft Windows, drive C; for Linux, /) is refreshed with the most recent image of the bundle that the WorkSpace was created from. Any applications that were installed, or system settings that were changed after the WorkSpace was created, are lost. • The user volume (for Microsoft Windows, the D drive; for Linux, /home) is recreated from the most recent snapshot. The current contents of the user volume are overwritten. Automatic snapshots for use when rebuilding a WorkSpace are scheduled every 12 hours. These snapshots of the user volume are taken regardless of the health of the WorkSpace. When you choose Actions, Rebuild / Restore WorkSpace, the date and time of the most recent snapshot is shown. When you rebuild a WorkSpace, new snapshots are also taken soon after the rebuild is finished (often within 30 minutes). • The primary elastic network interface is recreated. The WorkSpace receives a new private IP address. Important After January 14, 2020, WorkSpaces created from a public Windows 7 bundle can no longer be rebuilt. You might want to consider migrating your Windows 7 WorkSpaces to Windows 10. For more information, see Migrate a WorkSpace in WorkSpaces Personal. You can rebuild a WorkSpace only if the following conditions are met: • The WorkSpace must have a state of AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING. To rebuild a WorkSpace in the REBOOTING state, you must use the RebuildWorkspaces API operation or the rebuild-workspaces AWS CLI command. • A snapshot of the user volume must exist. Rebuild a WorkSpace 417 Amazon WorkSpaces To rebuild a WorkSpace Warning Administration Guide To rebuild an encrypted WorkSpace, first make sure that the AWS KMS Key is enabled; otherwise, the WorkSpace becomes unusable. To determine whether a KMS Key is enabled, see Displaying KMS Key Details in the AWS Key Management Service Developer Guide. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace to rebuild and choose Actions, Rebuild / Restore WorkSpace. 4. Under Snapshot, select the snapshot's time stamp. 5. Choose Rebuild. To rebuild a WorkSpace using the AWS CLI Use the rebuild-workspaces command. Troubleshooting If you rebuild a WorkSpace after changing the user's sAMAccountName user naming |
workspaces-ag-136 | workspaces-ag.pdf | 136 | WorkSpace, first make sure that the AWS KMS Key is enabled; otherwise, the WorkSpace becomes unusable. To determine whether a KMS Key is enabled, see Displaying KMS Key Details in the AWS Key Management Service Developer Guide. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace to rebuild and choose Actions, Rebuild / Restore WorkSpace. 4. Under Snapshot, select the snapshot's time stamp. 5. Choose Rebuild. To rebuild a WorkSpace using the AWS CLI Use the rebuild-workspaces command. Troubleshooting If you rebuild a WorkSpace after changing the user's sAMAccountName user naming attribute in Active Directory, you might receive the following error message: "ErrorCode": "InvalidUserConfiguration.Workspace" "ErrorMessage": "The user was either not found or is misconfigured." To work around this issue, either revert to the original user naming attribute and then re-initiate the rebuild, or create a new WorkSpace for that user. Rebuild Microsoft Entra ID-joined WorkSpaces When a user logs in to their WorkSpace for the first time after rebuilding, they need to go through the out-of-box experience (OOBE) again, similar to when they were assigned a new WorkSpace. As a result, a new user profile folder is created on the WorkSpace, overriding the original user profile folder. Hence, during the rebuild of an Entra joined WorkSpace, the content from the original user profile folder is saved under D:\Users\<USERNAME%MMddyyTHHmmss Rebuild a WorkSpace 418 Amazon WorkSpaces Administration Guide %.NotMigrated> on the rebuilt WorkSpace. The user needs to copy the original profile content from D:\Users\<USERNAME%MMddyyTHHmmss%.NotMigrated> to the user's profile folder at D: \Users\<USERNAME> to restore all user profile data including desktop icons, shortcuts, and data files. Note For Microsoft Entra ID-joined WorkSpaces, we recommend to always use Restore WorkSpaces, when possible, instead of Rebuild WorkSpaces. Restore a WorkSpace in WorkSpaces Personal Restoring a WorkSpace recreates both the root volume and user volume using a snapshot of each volume that was taken when the WorkSpace was health. Restoring a WorkSpace rolls back the data on both the root and user volumes to the point in time when the snapshots were created. Rebuilding a WorkSpace only rolls back the data on the user volume. This means that restoring requires you to have snapshots of both the root volume and user volume, while rebuilding a WorkSpace only requires a snapshot of the user volume. To rebuild a WorkSpace, see Rebuild a WorkSpace in WorkSpaces Personal. Restoring a WorkSpace causes the following to occur: • The root volume (for Microsoft Windows, drive C; for Linux, /) is restored to the date and time specified using a snapshot. Any applications that were installed, or system settings that were changed after the snapshot was created, are lost. • The user volume (for Microsoft Windows, the D drive; for Linux, /home) is recreated to the date and time specified using a snapshot. The current contents of the user volume are overwritten. The restore point When you choose Actions and Rebuild / Restore WorkSpace, the date and time of the snapshots used for the operation are shown. To verify the date and time of the snapshots used for the operation using the AWS CLI, use the describe-workspace-snapshots command. When snapshots are taken Snapshots of the root and user volume are taken on the following basis. Restore a WorkSpace 419 Amazon WorkSpaces Administration Guide • After a WorkSpace is first created — Typically, the initial snapshots of the root and user volumes are taken soon after a WorkSpace is created (often within 30 minutes). In some AWS Regions, it might take several hours to take the initial snapshots after a WorkSpace is created. If a WorkSpace becomes unhealthy before the initial snapshots are taken, the WorkSpace can't be restored. In that case, you can try rebuilding the WorkSpace or contact AWS Support for assistance. • During regular use — Automatic snapshots for use when restoring a WorkSpace are scheduled every 12 hours. If the WorkSpace is healthy, snapshots of both the root volume and user volume are created around the same time. If the WorkSpace is unhealthy, snapshots are created only for the user volume. • After a WorkSpace has been restored — When you restore a WorkSpace, new snapshots are taken soon after the restore is finished (often within 30 minutes). In some AWS Regions, it might take several hours to take these snapshots after a WorkSpace is restored. After a WorkSpace has been restored, if the WorkSpace becomes unhealthy before new snapshots can be taken, the WorkSpace can't be restored again. In that case, you can try rebuilding the WorkSpace or contact AWS Support for assistance. You can restore a WorkSpace only if the following conditions are met: • The WorkSpace must have a state of AVAILABLE, ERROR, UNHEALTHY, or STOPPED. • Snapshots of the root and user volumes must exist. |
workspaces-ag-137 | workspaces-ag.pdf | 137 | after the restore is finished (often within 30 minutes). In some AWS Regions, it might take several hours to take these snapshots after a WorkSpace is restored. After a WorkSpace has been restored, if the WorkSpace becomes unhealthy before new snapshots can be taken, the WorkSpace can't be restored again. In that case, you can try rebuilding the WorkSpace or contact AWS Support for assistance. You can restore a WorkSpace only if the following conditions are met: • The WorkSpace must have a state of AVAILABLE, ERROR, UNHEALTHY, or STOPPED. • Snapshots of the root and user volumes must exist. To restore a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select the WorkSpace to restore and choose Actions, Rebuild / Restore WorkSpace. 4. Under Snapshot, select the snapshot's time stamp. 5. Choose Restore. To restore a WorkSpace using the AWS CLI Use the restore-workspace command. Restore a WorkSpace 420 Amazon WorkSpaces Administration Guide Microsoft 365 Bring Your Own License (BYOL) in WorkSpaces Personal Amazon WorkSpaces allows you to bring your own Microsoft 365 licenses if they meet Microsoft's licensing requirements. These licenses allow you to install and activate Microsoft 365 Apps for enterprise software on WorkSpaces that are powered by the following operating systems: • Windows 10 (Bring Your Own License) • Windows 11 (Bring Your Own License) • Windows Server 2016 • Windows Server 2019 • Windows Server 2022 To use Microsoft 365 Apps for enterprise on WorkSpaces, you must have subscription to Microsoft 365 E3/E5, Microsoft 365 A3/A5, Microsoft 365 G3/G5, or Microsoft 365 Business Premium. On your Amazon WorkSpaces you can use your Microsoft 365 licenses to install and activate Microsoft 365 Apps for enterprise, including the following: • Microsoft Word • Microsoft Excel • Microsoft PowerPoint • Microsoft Outlook • Microsoft OneDrive For more information, see the full list of Microsoft 365 Apps for enterprise. You can also install Microsoft applications not included with Microsoft 365, such as Microsoft Project, Microsoft Visio, and Microsoft Power Automate on WorkSpaces but you need to bring in your own additional licenses. You can install and use Microsoft 365 and other Microsoft applications on primary WorkSpaces and failover WorkSpaces using Multi-Region Resilience. Contents • Create WorkSpaces with Microsoft 365 Apps for enterprise • Migrate your existing WorkSpaces to use Microsoft 365 Apps for enterprise Microsoft 365 BYOL 421 Amazon WorkSpaces Administration Guide • Update your Microsoft 365 Apps for enterprise on WorkSpaces Create WorkSpaces with Microsoft 365 Apps for enterprise To create WorkSpaces with Microsoft 365 Apps for enterprise, you must create a custom image with the applications installed, and use it to create a custom bundle. You can use the bundle to launch new WorkSpaces that have the applications installed. WorkSpaces does not provide public bundles with Microsoft 365 Apps for enterprise. To create WorkSpaces with Microsoft 365 Apps for enterprise: 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Launch a WorkSpace that you want to use as the image for other Microsoft application WorkSpaces. This is where you will install your Microsoft applications. For more information about launching a WorkSpace, see Launch a virtual desktop using WorkSpaces. 3. Start the client application at https://clients.amazonworkspaces.com/, enter the registration code from your invitation email, and choose Register. 4. When prompted to sign in, enter the user's sign-in credentials, and then choose Sign In. 5. Install and configure your Microsoft 365 Apps for enterprise. 6. Create a custom image from the WorkSpace, and use it to create a custom bundle. For more information about creating custom images and bundles, see Create a custom WorkSpaces image and bundle. 7. Launch WorkSpaces using the custom bundle that you created. These WorkSpaces have Microsoft 365 Apps for enterprise installed. Migrate your existing WorkSpaces to use Microsoft 365 Apps for enterprise If your WorkSpaces don't have a Microsoft Office license through AWS, you can install and configure Microsoft 365 Apps for enterprise on your WorkSpaces. If your WorkSpaces do have a Microsoft Office license through AWS, you must first deregister your Microsoft Office license before installing Microsoft 365 Apps for enterprise. Microsoft 365 BYOL 422 Amazon WorkSpaces Important Administration Guide Uninstalling Microsoft Office applications from your WorkSpaces doesn't deregister the licenses. To avoid being charged for Microsoft Office licenses, deregister your WorkSpaces from Microsoft Office applications through AWS by doing either of the following: • Manage applications (recommended) – You can uninstall Microsoft Office 2016 and 2019 from your WorkSpaces. For more information, see Manage applications. After you uninstall, you can install Microsoft 365 Apps for enterprise on your WorkSpaces. • Migrate a WorkSpace – You can migrate a WorkSpace from one bundle to another while retaining the data on the user volume. • Migrate your WorkSpaces to a bundle with an image that doesn’t have |
workspaces-ag-138 | workspaces-ag.pdf | 138 | WorkSpaces doesn't deregister the licenses. To avoid being charged for Microsoft Office licenses, deregister your WorkSpaces from Microsoft Office applications through AWS by doing either of the following: • Manage applications (recommended) – You can uninstall Microsoft Office 2016 and 2019 from your WorkSpaces. For more information, see Manage applications. After you uninstall, you can install Microsoft 365 Apps for enterprise on your WorkSpaces. • Migrate a WorkSpace – You can migrate a WorkSpace from one bundle to another while retaining the data on the user volume. • Migrate your WorkSpaces to a bundle with an image that doesn’t have a Microsoft Office subscription. After the migration is complete, you can install Microsoft 365 Apps for enterprise on your WorkSpaces. • Or, create a custom WorkSpaces image and bundle that already has Microsoft 365 Apps for enterprise installed on the image, and then migrate your WorkSpaces to this new custom bundle. After migration is complete, your WorkSpaces users can start using Microsoft 365 Apps for enterprise. • For more information on how to migrate WorkSpaces, see Migrate a WorkSpace. Update your Microsoft 365 Apps for enterprise on WorkSpaces By default, your WorkSpaces running on the Microsoft Windows Operating System are configured to receive updates from Windows Update. However, updates for Microsoft 365 Apps for enterprise aren't available using Windows Update. Set up updates to run automatically from the Office CDN, or use Windows Server Update Services (WSUS) in conjunction with Microsoft Configuration Manager to update Microsoft 365 Apps for enterprise. For more information, see Manage updates to Microsoft 365 Apps with Microsoft Configuration Manager. To set the frequency of Microsoft 365 application updates, specify an update channel and set it to Current or Monthly Enterprise to comply with the Microsoft 365 on WorkSpaces licensing policy. Upgrade Windows BYOL WorkSpaces in WorkSpaces Personal On your Windows Bring Your Own License (BYOL) WorkSpaces, you can upgrade to a newer version of Windows using the in-place upgrade process. Follow the instructions in this topic to do so. The in-place upgrade process applies only to Windows 10 and 11 BYOL WorkSpaces. Upgrade Windows BYOL WorkSpaces 423 Amazon WorkSpaces Important Administration Guide Do not run Sysprep on an upgraded WorkSpace. If you do so, an error that prevents Sysprep from finishing might occur. If you plan to run Sysprep, do so only on a WorkSpace that hasn't been upgraded. Note You can use this process to upgrade your Windows 10 and 11 WorkSpaces to a newer version. However, this process cannot be used to upgrade your Windows 10 WorkSpaces to Windows 11. Contents • Prerequisites • Considerations • Known limitations • Summary of registry key settings • Perform an in-place upgrade • Troubleshooting • Update your WorkSpace registry using a PowerShell script Prerequisites • If you have deferred or paused Windows 10 and 11 upgrades by using Group Policy or System Center Configuration Manager (SCCM), enable operating system upgrades for your Windows 10 and 11 WorkSpaces. • If the WorkSpace is an AutoStop WorkSpace, change it to an AlwaysOn WorkSpace before the in-place upgrade process so that it won't stop automatically while updates are being applied. For more information, see Modify the running mode. If you prefer to keep the WorkSpace set to AutoStop, change the AutoStop time to three hours or more while the upgrade takes place. • The in-place upgrade process recreates the user profile by making a copy of a special profile named Default User (C:\Users\Default). Do not use this default user profile to make Upgrade Windows BYOL WorkSpaces 424 Amazon WorkSpaces Administration Guide customizations. We recommend making any customizations to the user profile through Group Policy Objects (GPOs) instead. Customizations made through GPOs can be easily modified or rolled back and are less prone to error. • The in-place upgrade process can back up and recreate only one user profile. If you have multiple user profiles on drive D, delete all the profiles except for the one that you need. Considerations The in-place upgrade process uses two registry scripts (enable-inplace-upgrade.ps1 and update-pvdrivers.ps1) to make the necessary changes to your WorkSpaces that enable the Windows Update process to run. These changes involve creating a (temporary) user profile on drive C instead of drive D. If a user profile already exists on drive D, the data in that original user profile remains on drive D. By default, WorkSpaces creates the user profile in D:\Users\%USERNAME%. The enable- inplace-upgrade.ps1 script configures Windows to create a new user profile in C:\Users\ %USERNAME% and redirects the user shell folders to D:\Users\%USERNAME%. This new user profile is created when a user logs on the first time. After the in-place upgrade, you have the choice of leaving your user profiles on drive C to allow your users to use the Windows Update process to upgrade their machines in the |
workspaces-ag-139 | workspaces-ag.pdf | 139 | drive D. If a user profile already exists on drive D, the data in that original user profile remains on drive D. By default, WorkSpaces creates the user profile in D:\Users\%USERNAME%. The enable- inplace-upgrade.ps1 script configures Windows to create a new user profile in C:\Users\ %USERNAME% and redirects the user shell folders to D:\Users\%USERNAME%. This new user profile is created when a user logs on the first time. After the in-place upgrade, you have the choice of leaving your user profiles on drive C to allow your users to use the Windows Update process to upgrade their machines in the future. However, be aware that WorkSpaces with profiles stored on drive C can't be rebuilt or migrated without losing all of the data in the user's profile unless you back up and restore that data yourself. If you decide to leave the profiles on drive C, you can use the UserShellFoldersRedirection registry key to redirect the user shell folders to drive D, as explained later in this topic. To ensure that you can rebuild or migrate your WorkSpaces and to avoid any potential problems with user shell folder redirection, we recommend that you choose to restore your user profiles to drive D after the in-place upgrade. You can do so by using the PostUpgradeRestoreProfileOnD registry key, as explained later in this topic. Known limitations • The user profile location change from drive D to drive C does not happen during WorkSpace rebuilds or migrations. If you perform an in-place upgrade on a Windows 10 or 11 BYOL WorkSpace and then rebuild or migrate it, the new WorkSpace will have the user profile on drive D. Upgrade Windows BYOL WorkSpaces 425 Amazon WorkSpaces Warning Administration Guide If you leave the user profile on drive C after the in-place upgrade, the user profile data stored on drive C will be lost during rebuilds or migrations unless you manually back up the user profile data prior to rebuilding or migrating, and then manually restore the user profile data after running the rebuild or migration process. • If your default BYOL bundle contains an image that is based on an earlier release of Windows 10 and 11, you must perform the in-place upgrade again after the WorkSpace is rebuilt or migrated. Summary of registry key settings To enable the in-place upgrade process and to specify where you would like the user profile to be after the upgrade, you must set a number of registry keys. Registry path: HKLM:\Software\Amazon\WorkSpacesConfig\enable-inplace-upgrade.ps1 Registry key Enabled Type DWORD PostUpgradeRestore ProfileOnD DWORD UserShellFoldersRedirection DWORD Values 0 – (Default) Disables in-place upgrade 1 – Enables in-place upgrade 0 – (Default) Does not attempt to restore the user profile path after the in-place upgrade 1 – Restores the user profile path (ProfileImagePath) after the in-place upgrade 0 – Does not enable redirecti on of user shell folders 1 – (Default) Enables redirecti on of user shell folders to D:\Users\%USERNAME Upgrade Windows BYOL WorkSpaces 426 Amazon WorkSpaces Administration Guide Registry key Type Values NoReboot DWORD % after the user profile is regenerated on C:\Users\ %USERNAME% 0 – (Default) Allows you to control when a reboot occurs after modifying the registry for the user profile 1 – Does not allow the script to reboot the WorkSpace after modifying the registry for the user profile Registry path: HKLM:\Software\Amazon\WorkSpacesConfig\update-pvdrivers.ps1 Registry key Enabled Type DWORD Values 0 – (Default) Disables AWS PV drivers update 1 – Enables AWS PV drivers update Perform an in-place upgrade To enable in-place Windows upgrades on your BYOL WorkSpaces, you must set certain registry keys, as described in the following procedure. You must also set certain registry keys to indicate the drive (C or D) where you want the user profiles to be after the in-place upgrades are finished. You can make these registry changes manually. If you have multiple WorkSpaces to update, you can use Group Policy or SCCM to push a PowerShell script. For a sample PowerShell script, see Update your WorkSpace registry using a PowerShell script. Upgrade Windows BYOL WorkSpaces 427 Amazon WorkSpaces Administration Guide To perform an in-place upgrade of Windows 10 and 11 1. Make note of which version of Windows is currently running on the Windows 10 and 11 BYOL WorkSpaces that you are updating, and then reboot them. 2. Update the following Windows system registry keys to change the value data for Enabled from 0 to 1. These registry changes enable in-place upgrades for the WorkSpace. • HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1 • HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\update-pvdrivers.ps1 Note If these keys do not exist, reboot the WorkSpace. The keys should be added when the system is rebooted. (Optional) If you are using a managed workflow such as SCCM Task Sequences to perform the upgrade, set the following key value to 1 to prevent the computer from rebooting: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1\NoReboot 3. Decide |
workspaces-ag-140 | workspaces-ag.pdf | 140 | 10 and 11 BYOL WorkSpaces that you are updating, and then reboot them. 2. Update the following Windows system registry keys to change the value data for Enabled from 0 to 1. These registry changes enable in-place upgrades for the WorkSpace. • HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1 • HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\update-pvdrivers.ps1 Note If these keys do not exist, reboot the WorkSpace. The keys should be added when the system is rebooted. (Optional) If you are using a managed workflow such as SCCM Task Sequences to perform the upgrade, set the following key value to 1 to prevent the computer from rebooting: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1\NoReboot 3. Decide which drive you want user profiles to be on after the in-place upgrade process (for more information, see Considerations), and set the registry keys as follows: • Settings if you want the user profile on drive C after the upgrade: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1 Key name: PostUpgradeRestoreProfileOnD Key value: 0 Key name: UserShellFoldersRedirection Key value: 1 Upgrade Windows BYOL WorkSpaces 428 Amazon WorkSpaces Administration Guide • Settings if you want the user profile on drive D after the upgrade: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1 Key name: PostUpgradeRestoreProfileOnD Key value: 1 Key name: UserShellFoldersRedirection Key value: 0 4. After saving the changes to the registry, reboot the WorkSpace again so that the changes are applied. Note • After the reboot, logging in to the WorkSpace creates a new user profile. You might see placeholder icons in the Start menu. This behavior is automatically resolved after the in-place upgrade is complete. • Allow 10 minutes to ensure that the WorkSpace is unblocked. (Optional) Confirm that the following key value is set to 1, which unblocks the WorkSpace for updating: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1\profileImagePathDeleted 5. Perform the in-place upgrade. You can use whichever method you like, such as SCCM, ISO, or Windows Update (WU). Depending on your original Windows 10 and 11 version and how many apps were installed, this process can take from 40 to 120 minutes. Note The in-place upgrade process may take at least an hour. The WorkSpace instance status may appear as UNHEALTHY during the upgrade. Upgrade Windows BYOL WorkSpaces 429 Amazon WorkSpaces Administration Guide 6. After the update process is finished, confirm that the Windows version has been updated. Note If the in-place upgrade fails, Windows automatically rolls back to use the Windows 10 and 11 version that was in place before you started the upgrade. For more information about troubleshooting, see the Microsoft documentation. (Optional) To confirm that the update scripts have been run successfully, verify that the following key value is set to 1: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\WorkSpacesConfig\enable-inplace- upgrade.ps1\scriptExecutionComplete 7. If you modified the running mode of the WorkSpace by setting it to AlwaysOn or by changing the AutoStop time period so that the in-place upgrade process could run without interruption, set the running mode back to your original settings. For more information, see Modify the running mode. If you haven't set the PostUpgradeRestoreProfileOnD registry key to 1, the user profile is regenerated by Windows and placed in C:\Users\%USERNAME% after the in-place upgrade, so that you do not have to go through the above steps again for future Windows 10 and 11 in-place upgrades. By default, the enable-inplace-upgrade.ps1 script redirects the following shell folders to drive D: • D:\Users\%USERNAME%\Downloads • D:\Users\%USERNAME%\Desktop • D:\Users\%USERNAME%\Favorites • D:\Users\%USERNAME%\Music • D:\Users\%USERNAME%\Pictures • D:\Users\%USERNAME%\Videos • D:\Users\%USERNAME%\Documents • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Network Shortcuts • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Printer Shortcuts • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs Upgrade Windows BYOL WorkSpaces 430 Amazon WorkSpaces Administration Guide • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Recent • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\SendTo • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Start Menu • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs \Startup • D:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Templates If you redirect the shell folders to other locations on your WorkSpaces, perform the necessary operations on the WorkSpaces after the in-place upgrades. Troubleshooting If you encounter any issues with the update, you can check the following items to assist with troubleshooting: • Windows Logs, which are located, by default, in the following locations: C:\Program Files\Amazon\WorkSpacesConfig\Logs\ C:\Program Files\Amazon\WorkSpacesConfig\Logs\TRANSMITTED • Windows Event Viewer Windows Logs > Application > Source: Amazon WorkSpaces Tip During the in-place upgrade process, if you see that some icon shortcuts on the desktop no longer work, it's because WorkSpaces moves any user profiles located on drive D to drive C to prepare for the upgrade. After the upgrade is completed, the shortcuts will work as expected. Update your WorkSpace registry using a PowerShell script You can use the following sample PowerShell script to update the registry on your WorkSpaces to enable in-place upgrades. Follow the Perform an in-place upgrade, but use this script to update the registry on each WorkSpace. Upgrade Windows BYOL WorkSpaces 431 Amazon WorkSpaces Administration Guide # AWS WorkSpaces 1.28.20 # Enable In-Place Update Sample Scripts # These registry keys and values will enable scripts to run on the next reboot of the WorkSpace. $scriptlist = ("update-pvdrivers.ps1","enable-inplace-upgrade.ps1") $wsConfigRegistryRoot="HKLM:\Software\Amazon\WorkSpacesConfig" $Enabled = 1 $script:ErrorActionPreference = "Stop" foreach ($scriptName in $scriptlist) { $scriptRegKey = "$wsConfigRegistryRoot\$scriptName" try { if (-not(Test-Path $scriptRegKey)) { |
workspaces-ag-141 | workspaces-ag.pdf | 141 | a PowerShell script You can use the following sample PowerShell script to update the registry on your WorkSpaces to enable in-place upgrades. Follow the Perform an in-place upgrade, but use this script to update the registry on each WorkSpace. Upgrade Windows BYOL WorkSpaces 431 Amazon WorkSpaces Administration Guide # AWS WorkSpaces 1.28.20 # Enable In-Place Update Sample Scripts # These registry keys and values will enable scripts to run on the next reboot of the WorkSpace. $scriptlist = ("update-pvdrivers.ps1","enable-inplace-upgrade.ps1") $wsConfigRegistryRoot="HKLM:\Software\Amazon\WorkSpacesConfig" $Enabled = 1 $script:ErrorActionPreference = "Stop" foreach ($scriptName in $scriptlist) { $scriptRegKey = "$wsConfigRegistryRoot\$scriptName" try { if (-not(Test-Path $scriptRegKey)) { Write-Host "Registry key not found. Creating registry key '$scriptRegKey' with 'Update' enabled." New-Item -Path $wsConfigRegistryRoot -Name $scriptName | Out-Null New-ItemProperty -Path $scriptRegKey -Name Enabled -PropertyType DWord - Value $Enabled | Out-Null Write-Host "Value created. '$scriptRegKey' Enabled='$((Get-ItemProperty - Path $scriptRegKey).Enabled)'" } else { Write-Host "Registry key is already present with value '$scriptRegKey' Enabled='$((Get-ItemProperty -Path $scriptRegKey).Enabled)'" if((Get-ItemProperty -Path $scriptRegKey).Enabled -ne $Enabled) { Set-ItemProperty -Path $scriptRegKey -Name Enabled -Value $Enabled Write-Host "Value updated. '$scriptRegKey' Enabled='$((Get-ItemProperty -Path $scriptRegKey).Enabled)'" } } } catch { write-host "Stopping script, the following error was encountered:" `r`n$_ - ForegroundColor Red break Upgrade Windows BYOL WorkSpaces 432 Amazon WorkSpaces } } Administration Guide Migrate a WorkSpace in WorkSpaces Personal Note If you want to unsubscribe from or uninstall Microsoft Office version licenses through AWS from your WorkSpace, we recommend using Manage applications. You can migrate a WorkSpace from one bundle to another, while retaining the data on the user volume. The following are example scenarios: • You can migrate WorkSpaces from the Windows 7 desktop experience to the Windows 10 desktop experience. • You can migrate WorkSpaces from the PCoIP protocol to DCV. • You can migrate WorkSpaces from the 32-bit Microsoft Office on Windows Server 2016-powered WorkSpaces bundle to the 64-bit Microsoft Office on Windows Server 2019 and Windows Server 2022-powered WorkSpaces bundles. • You can migrate WorkSpaces from one public or custom bundle to another. For example, you can migrate from GPU-enabled (Graphics.g4dn. GraphicsPro.g4dn, Graphics, and GraphicsPro) bundles to non-GPU-enabled bundles, as well as in the other direction. • You can migrate WorkSpaces from the Windows 10 BYOL to the Windows 11 BYOL but migration from Windows 11 to Windows 10 is not supported. • Value bundles are not supported on Windows 11. To migrate your Windows 7 or 10 value bundle WorkSpaces to Windows 11, you need to switch your Value WorkSpaces to a bigger bundle offering first. • Before migrating WorkSpaces from Windows 7 to Windows 11, you need to migrate it to Windows 10. Log in to Windows 10 WorkSpace at least once before migrating it to Windows 11. Migrating from Windows 7 WorkSpaces directly to Windows 11 is not supported. • You can migrate Windows WorkSpaces that use Microsoft Office through AWS to a custom WorkSpaces bundle with Microsoft 365 applications. After the migration, your WorkSpaces are unsubscribed from Microsoft Office. Migrate a WorkSpace 433 Amazon WorkSpaces Administration Guide • You can migrate Windows WorkSpaces that use Microsoft Office through AWS to a WorkSpaces bundle with no Office 2016/2019 subscription. After the migration, your WorkSpaces are unsubscribed from Microsoft Office. • You can migrate BYOL BYOP WorkSpaces from Windows 10 to Windows 11, and license-included BYOP WorkSpaces from Windows Server 2019 to Windows Server 2022. For more information about Amazon WorkSpaces bundles, see Bundles and images for WorkSpaces Personal. The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. A new user profile is generated during migration for better compatibility. The old user profile is renamed, and then certain files in the old user profile are moved to the new user profile. (For details about what gets moved, see What happens during migration.) The migration process takes up to one hour per WorkSpace. When you initiate the migration process, a new WorkSpace is created. If an error occurs that prevents successful migration, the original WorkSpace is recovered and returned to its original state, and the new WorkSpace is terminated. Contents • Migration limits • Migration scenarios • What happens during migration • Best practices • Troubleshooting • How billing is affected • Migrating a WorkSpace Migration limits • You cannot migrate to a public or custom Windows 7 desktop experience bundle. You also cannot migrate to Bring Your Own License (BYOL) Windows 7 bundles. Migrate a WorkSpace 434 Amazon WorkSpaces Administration Guide • You can migrate BYOL WorkSpaces only to other BYOL bundles. To migrate a BYOL WorkSpace from PCoIP to DCV, you must first create a BYOL bundle with the DCV protocol. You can then migrate your PCoIP BYOL WorkSpaces to that DCV BYOL bundle. • You cannot migrate a WorkSpace created from |
workspaces-ag-142 | workspaces-ag.pdf | 142 | • Troubleshooting • How billing is affected • Migrating a WorkSpace Migration limits • You cannot migrate to a public or custom Windows 7 desktop experience bundle. You also cannot migrate to Bring Your Own License (BYOL) Windows 7 bundles. Migrate a WorkSpace 434 Amazon WorkSpaces Administration Guide • You can migrate BYOL WorkSpaces only to other BYOL bundles. To migrate a BYOL WorkSpace from PCoIP to DCV, you must first create a BYOL bundle with the DCV protocol. You can then migrate your PCoIP BYOL WorkSpaces to that DCV BYOL bundle. • You cannot migrate a WorkSpace created from public or custom bundles to a BYOL bundle. • Graphics.g4dn, GraphicsPro.g4dn, Graphics, and GraphicsPro bundles are available for the PCoIP protocol on Windows and Ubuntu. Graphics.g4dn and GraphicsPro.g4dn are available for the DCV protocol on Windows and Ubuntu. Graphics and GraphicsPro WorkSpaces can't be migrated to DCV yet. • Migrating Linux WorkSpaces is not currently supported. • In AWS Regions that support more than one language, you can migrate WorkSpaces between language bundles. • The source and target bundles must be different. (However, in Regions that support more than one language, you can migrate to the same Windows 10 bundle as long as the languages differ.) If you want to refresh your WorkSpace using the same bundle, rebuild the WorkSpace instead. • You cannot migrate WorkSpaces across Regions. • In some cases, if migration is unable to finish successfully, you might not receive an error message, and it might appear that the migration process did not start. If the WorkSpace bundle remains the same one hour after attempting migration, the migration is unsuccessful. Contact the AWS Support Center for assistance. • You cannot migrate BYOP WorkSpaces to PCoIP or DCV WorkSpaces. • You cannot migrate Active Directory domain-joined WorkSpaces to Microsoft Entra-joined WorkSpaces. Migration scenarios The following table shows which migration scenarios are available: Source OS Target OS Available? Public or custom bundle Windows 7 Public or custom bundle Windows 10 Custom bundle Windows 7 Public bundle Windows 7 Custom bundle Windows 7 Custom bundle Windows 7 Yes No No Migrate a WorkSpace 435 Amazon WorkSpaces Administration Guide Source OS Target OS Available? Public bundle Windows 7 Custom bundle Windows 7 Public or custom bundle Windows 10 Public or custom bundle Windows 7 No No Public or custom bundle Windows 10 Custom bundle Windows 10 Yes Windows 7 BYOL bundle Windows 7 BYOL bundle Windows 7 BYOL bundle Windows 10 BYOL bundle Windows 10 BYOL bundle Windows 7 BYOL bundle Windows 10 BYOL bundle Windows 10 BYOL bundle Windows Server 2016-powe red Public Windows 10 Windows Server 2019-powered Public bundle Windows 10 bundle No Yes No Yes Yes Windows Server 2019-powered Public Windows 10 bundle Windows Server 2016-powe red Public Windows 10 Yes bundle Windows 10 BYOL bundle Windows 11 BYOL bundle Windows 11 BYOL bundle Windows 10 BYOL bundle Windows Server 2016-powe red custom Windows 10 bundle Windows Server 2019-powe red Public Windows 10 bundle Yes No Yes Migrate a WorkSpace 436 Amazon WorkSpaces Administration Guide Source OS Target OS Available? Windows Server 2016-powe red custom Windows 10 Windows Server 2022-powe red Public Windows 10 bundle bundle Windows Server 2019-powe red custom Windows 10 Windows Server 2022-powe red Public Windows 10 bundle bundle Windows 10 BYOP BYOL Windows 11 BYOP BYOL Windows 11 BYOP BYOL Windows 10 BYOP BYOL Windows Server 2019-powe red Public BYOP Windows Server 2022-powe red Public BYOP Windows Server 2022-powe red Public BYOP Windows Server 2019-powe red Public BYOP Yes Yes Yes No Yes No Note Web access is not available for the Windows Server 2019-powered Public Windows 10 bundle PCoIP branch. Important The Windows Server 2016-powered Public Windows 10 plus bundle includes Microsoft Office 2016 and Trend Micro Worry-Free Business Security Services. The Windows Server 2019-powered Public Windows 10 plus bundle includes Microsoft Office 2019 only, and does not include Trend Micro Services. What happens during migration During migration, the data on the user volume (drive D) is preserved, but all of the data on the root volume (drive C) is lost. This means that none of the installed applications, settings, and changes Migrate a WorkSpace 437 Amazon WorkSpaces Administration Guide to the registry are preserved. The old user profile folder is renamed with the .NotMigrated suffix, and a new user profile is created. The migration process recreates drive D based on the last snapshot of the original user volume. During the first boot of the new WorkSpace, the migration process moves the original D:\Users\ %USERNAME% folder to a folder named D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. After the new user profile is created, the files in the following user shell folders are moved from the old .NotMigrated profile to the new profile: • D:\Users\%USERNAME%\Desktop • D:\Users\%USERNAME%\Documents • D:\Users\%USERNAME%\Downloads |
workspaces-ag-143 | workspaces-ag.pdf | 143 | are preserved. The old user profile folder is renamed with the .NotMigrated suffix, and a new user profile is created. The migration process recreates drive D based on the last snapshot of the original user volume. During the first boot of the new WorkSpace, the migration process moves the original D:\Users\ %USERNAME% folder to a folder named D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. After the new user profile is created, the files in the following user shell folders are moved from the old .NotMigrated profile to the new profile: • D:\Users\%USERNAME%\Desktop • D:\Users\%USERNAME%\Documents • D:\Users\%USERNAME%\Downloads • D:\Users\%USERNAME%\Favorites • D:\Users\%USERNAME%\Music • D:\Users\%USERNAME%\Pictures • D:\Users\%USERNAME%\Videos Important The migration process attempts to move the files from the old user profile to the new profile. Any files that weren't moved during migration remain in the D:\Users\ %USERNAME%MMddyyTHHmmss%.NotMigrated folder. If the migration is successful, you can see which files got moved in C:\Program Files\Amazon\WorkspacesConfig \Logs\MigrationLogs. You can manually move any files that didn't get moved automatically. By default, the public bundles have local search indexing disabled. If you were to enable it, the default is to search C:\Users and not D:\Users, so you need to adjust that as well. If you've set local search indexing specifically to D:\Users\username and not to D:\Users, then local search indexing might not work post-migration for any user files that are in the D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated folder. Migrate a WorkSpace 438 Amazon WorkSpaces Administration Guide Any tags assigned to the original WorkSpace are carried over during migration, and the running mode of the WorkSpace is preserved. However, the new WorkSpace gets a new WorkSpace ID, computer name, and IP address. Best practices Before you migrate a WorkSpace, do the following: • Back up any important data on drive C to another location. All data on drive C is erased during migration. • Make sure that the WorkSpace being migrated is at least 12 hours old, to ensure that a snapshot of the user volume has been created. On the Migrate WorkSpaces page in the Amazon WorkSpaces console, you can see the time of the last snapshot. Any data created after the last snapshot is lost during migration. • To avoid potential data loss, make sure that your users log out of their WorkSpaces and don't log back in until after the migration process is finished. Note that WorkSpaces cannot be migrated when they are in ADMIN_MAINTENANCE mode. • Make sure that the WorkSpaces you want to migrate have a status of AVAILABLE, STOPPED, or ERROR. • Make sure that you have enough IP addresses for the WorkSpaces you are migrating. During migration, new IP addresses will be allocated for the WorkSpaces. • If you are using scripts to migrate WorkSpaces, migrate them in batches of no more than 25 WorkSpaces at a time. Troubleshooting • If your users report missing files after migration, check to see if their user profile files did not get moved during the migration process. You can see which files got moved in C:\Program Files \Amazon\WorkspacesConfig\Logs\MigrationLogs. The files that didn't get moved will be located in the D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated folder. You can manually move any files that didn't get moved automatically. • If you are using the API to migrate WorkSpaces and the migration does not succeed, the target WorkSpace ID returned by the API will not be used, and the WorkSpace will still have the original WorkSpace ID. • If a migration does not successfully finish, check the Active Directory to see if it was cleaned up accordingly. You might need to manually remove WorkSpaces that you no longer need. Migrate a WorkSpace 439 Amazon WorkSpaces How billing is affected Administration Guide During the month in which migration occurs, you are charged prorated amounts for both the new and the original WorkSpaces. For example, if you migrate WorkSpace A to WorkSpace B on May 10, you will be charged for WorkSpace A from May 1 to May 10, and you will be charged for WorkSpace B from May 11 to May 30. Note If you are migrating a WorkSpace to a different bundle type (for example, from Performance to Power, or Value to Standard), the size of the root volume (drive C) and the user volume (drive D) might increase during the migration process. If necessary, the root volume increases to match the default root volume size for the new bundle. However, if you had already specified a different size (higher or lower) for the user volume than the default for the original bundle, that same user volume size is retained during the migration process. Otherwise, the migration process uses the larger of the source WorkSpace user volume size and the default user volume size for the new bundle. Migrating a WorkSpace You can migrate WorkSpaces through the Amazon WorkSpaces console, the AWS |
workspaces-ag-144 | workspaces-ag.pdf | 144 | the user volume (drive D) might increase during the migration process. If necessary, the root volume increases to match the default root volume size for the new bundle. However, if you had already specified a different size (higher or lower) for the user volume than the default for the original bundle, that same user volume size is retained during the migration process. Otherwise, the migration process uses the larger of the source WorkSpace user volume size and the default user volume size for the new bundle. Migrating a WorkSpace You can migrate WorkSpaces through the Amazon WorkSpaces console, the AWS CLI or the Amazon WorkSpaces API. To migrate a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select your WorkSpace and choose Actions, Migrate WorkSpaces. 4. Under Bundles, select the bundle that you'd like to migrate your WorkSpace to. Note To migrate a BYOL WorkSpace from PCoIP to DCV, you must first create a BYOL bundle with the DCV protocol. You can then migrate your PCoIP BYOL WorkSpaces to that DCV BYOL bundle. 5. Choose Migrate WorkSpaces. Migrate a WorkSpace 440 Amazon WorkSpaces Administration Guide A new WorkSpace with a status of PENDING appears in the Amazon WorkSpaces console. When the migration is finished, the original WorkSpace is terminated, and the status of the new WorkSpace is set to AVAILABLE. 6. (Optional) To delete any custom bundles and images that you no longer need, see Delete a custom bundle or image in WorkSpaces Personal. To migrate WorkSpaces through the AWS CLI, use the migrate-workspace command. To migrate WorkSpaces through the Amazon WorkSpaces API, see MigrateWorkSpace in the Amazon WorkSpaces API Reference. Delete a WorkSpace in WorkSpaces Personal When you are finished with a WorkSpace, you can delete it. You can also delete related resources. Warning Deleting a WorkSpace is a permanent action and cannot be undone. The WorkSpace user's data does not persist and is destroyed. For help with backing up user data, contact AWS Support. Note Simple AD and AD Connector are available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Service pricing terms. To delete empty directories, see Delete a directory for WorkSpaces Personal. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again. To delete a WorkSpace You can delete a WorkSpace that is in any state except Suspended. Delete a WorkSpace 441 Amazon WorkSpaces Administration Guide 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select your WorkSpace and choose Delete. 4. When prompted for confirmation, choose Delete WorkSpace. It takes approximately 5 minutes to delete a WorkSpace. During deletion, the status of the WorkSpace is set to Terminating. When the deletion is complete, the WorkSpace disappears from the console. 5. (Optional) To delete any custom bundles and images that you are finished with, see Delete a custom bundle or image in WorkSpaces Personal. 6. (Optional) After you delete all WorkSpaces in a directory, you can delete the directory. For more information, see Delete a directory for WorkSpaces Personal. 7. (Optional) After you delete all resources in the virtual private cloud (VPC) for your directory, you can delete the VPC and release the Elastic IP address used for the NAT gateway. For more information, see Deleting your VPC and Working with Elastic IP addresses in the Amazon VPC User Guide. To delete a WorkSpace using the AWS CLI Use the terminate-workspaces command. Bundles and images for WorkSpaces Personal A WorkSpace bundle is a combination of an operating system, and storage, compute, and software resources. When you launch a WorkSpace, you select the bundle that meets your needs. The default bundles available for WorkSpaces are called public bundles. For more information about the various public bundles available for WorkSpaces, see Amazon WorkSpaces Bundles. If you've launched a Windows or Linux WorkSpace and have customized it, you can create a custom image from that WorkSpace. A custom image contains only the OS, software, and settings for the WorkSpace. A custom bundle is a combination of both that custom image and the hardware from which a WorkSpace can be launched. After you create a custom image, you can build a custom bundle that combines the custom WorkSpace image and the underlying compute and storage configuration that you select. You Bundles and images 442 Amazon WorkSpaces Administration Guide can then specify this custom bundle when you launch new WorkSpaces to ensure that the new WorkSpaces have the |
workspaces-ag-145 | workspaces-ag.pdf | 145 | it, you can create a custom image from that WorkSpace. A custom image contains only the OS, software, and settings for the WorkSpace. A custom bundle is a combination of both that custom image and the hardware from which a WorkSpace can be launched. After you create a custom image, you can build a custom bundle that combines the custom WorkSpace image and the underlying compute and storage configuration that you select. You Bundles and images 442 Amazon WorkSpaces Administration Guide can then specify this custom bundle when you launch new WorkSpaces to ensure that the new WorkSpaces have the same consistent configuration (hardware and software). If you need to perform software updates or to install additional software on your WorkSpaces, you can update your custom bundle and use it to rebuild your WorkSpaces. WorkSpaces supports several different operating systems (OS), streaming protocols, and bundles. The following table provides information about the licensing, streaming protocols, and bundles that are supported by each OS. Operating System Licenses Streaming protocols Supported bundles Lifecycle policy / retiremen t date Windows Server 2016 Included DCV, PCoIP Value, Standard, Performan ce, Power, PowerPro, Graphics January 12, 2027 (retired), GraphicsPro, Graphics. g4dn, GraphicsPro.g4dn Windows Server 2019 Included DCV, PCoIP Value, Standard, Performan ce, Power, PowerPro, Graphics January 9, 2029 (retired), GraphicsPro, Graphics. g4dn, GraphicsPro.g4dn Windows Server 2022 Included DCV, PCoIP Standard, Performance, Power, PowerPro, GeneralPurpose.4xl October 14, 2031 arge, GeneralPurpose.8xlarge, Graphics (retired), GraphicsPro, Graphics.g4dn, GraphicsPro.g4dn Windows 10 Bring Your Own License (BYOL) DCV, PCoIP Value, Standard, Performan ce, Power, PowerPro, Graphics (retired), GraphicsPro, Graphics. g4dn, GraphicsPro.g4dn In support Bundles and images 443 Amazon WorkSpaces Operating System Licenses Streaming protocols Supported bundles Administration Guide Lifecycle policy / retiremen t date Windows 11 Bring Your Own License (BYOL) DCV Standard, Performance, Power, PowerPro, GeneralPurpose.4xl In support arge, GeneralPurpose.8xlarge Amazon Linux 2 Included DCV, PCoIP Value, Standard, Performance, Power, PowerPro In support Ubuntu 22.04 LTS Included DCV Value, Standard, Performance, Power, PowerPro, Graphics.g4dn, June, 2032 GraphicsPro.g4dn Rocky Linux 8 Included DCV Value, Standard, Performance, Power, PowerPro Red Hat Enterprise Linux 8 Included DCV Value, Standard, Performance, Power, PowerPro May 31, 2029 May 31, 2029 Note • Operating system versions that are no longer supported by the vender are not guaranteed to work and are not supported by AWS support. • For WorkSpaces running on Windows operating system, Graphics bundles only supports PCoIP streaming protocol. Contents • Bundle options for WorkSpaces Personal • Create a custom WorkSpaces image and bundle for WorkSpaces Personal • Update a custom bundle for WorkSpaces Personal Bundles and images 444 Amazon WorkSpaces Administration Guide • Copy a custom image in WorkSpaces Personal • Share or unshare a custom image in WorkSpaces Personal • Delete a custom bundle or image in WorkSpaces Personal Bundle options for WorkSpaces Personal Before selecting a bundle, ensure the bundle you want to select is compatible with your WorkSpaces' protocol, operating system, network, and compute type. For more information about protocols, see Protocols for Amazon WorkSpaces. For more information about networks, see Amazon WorkSpaces client network requirements. Note • We recommend not exceeding a 250 ms maximum network latency for PCoIP WorkSpaces. To get the best PCoIP WorkSpaces user experience, we recommend keeping the network latency under 100 ms. When the round-trip time (RTT) exceeds 375 ms, the WorkSpaces client connection will shut down. For the best DCV user experience, we recommend keeping the RTT under 250 ms. If the RTT is between 250 ms and 400 ms, the user can access the WorkSpace, but performance will decrease significantly. • We recommend testing the performance of bundles you want to choose in a test environment by running and using applications that replicate your users' daily tasks. • BYOP (Bring Your Own Protocol) bundles are for WorkSpaces Core. The BYOP bundles provided by Amazon WorkSpaces don't have a WorkSpaces provided streaming protocol installed. You won't be able to connect using WorkSpaces clients or gateways. To understand the shared responsibility model for Amazon WorkSpaces Core, see the Technology Partner Integration Guide for Amazon WorkSpaces Core. For more information, see Amazon WorkSpaces Core. Important • GraphicsPro bundle reaches end-of-life on October 31, 2025. We recommend migrating your GraphicsPro WorkSpaces to supported bundles before October 31, 2025. For more information, see Migrate a WorkSpace in WorkSpaces Personal. Bundle options 445 Amazon WorkSpaces Administration Guide • The Graphics bundle will no longer be supported after November 30, 2023. We recommend switching to the Graphics.g4dn bundle for WorkSpaces using the Graphics bundle. • Graphics and GraphicsPro bundles aren't currently available in the Asia Pacific (Mumbai) Region. The following are the bundles that WorkSpaces offers. For information about bundles in WorkSpaces, see Amazon WorkSpaces Bundles. Value bundle This bundle is well-suited for the following: • Basic text editing and data entry • Web browsing with light usage • |
workspaces-ag-146 | workspaces-ag.pdf | 146 | 31, 2025. For more information, see Migrate a WorkSpace in WorkSpaces Personal. Bundle options 445 Amazon WorkSpaces Administration Guide • The Graphics bundle will no longer be supported after November 30, 2023. We recommend switching to the Graphics.g4dn bundle for WorkSpaces using the Graphics bundle. • Graphics and GraphicsPro bundles aren't currently available in the Asia Pacific (Mumbai) Region. The following are the bundles that WorkSpaces offers. For information about bundles in WorkSpaces, see Amazon WorkSpaces Bundles. Value bundle This bundle is well-suited for the following: • Basic text editing and data entry • Web browsing with light usage • Instant messaging This bundle is not recommended for word processing, audio and video conferencing, screen sharing, software development tool, business intelligence applications, and graphics applications. Standard bundle This bundle is well-suited for the following: • Basic text editing and data entry • Web browsing • Instant messaging • Email This bundle is not recommended for audio and video conferencing, screen sharing, word processing, software development tool, business intelligence applications, and graphics applications. Performance bundle This bundle is well-suited for the following: Bundle options 446 Administration Guide Amazon WorkSpaces • Web browsing • Word processing • Instant messaging • Email • Spreadsheets • Audio processing • Courseware This bundle is not recommended for video conferencing, screen sharing, software development tool, business intelligence applications, and graphics applications. Power bundle This bundle is well-suited for the following: • Web browsing • Word processing • Email • Instant messaging • Spreadsheets • Audio processing • Software development (Integrated Development Environment (IDE)) • Entry to mid-level data processing • Audio and video conferencing This bundle is not recommended for screen sharing, software development tool, business intelligence applications, and graphics applications. PowerPro bundle This bundle is well-suited for the following: • Web browsing • Word processing • Email Bundle options 447 Administration Guide Amazon WorkSpaces • Instant messaging • Spreadsheets • Audio processing • Software development (Integrated Development Environment (IDE)) • Data warehousing • Business intelligence applications • Audio and video conferencing This bundle is not recommended for machine learning model training, and graphics applications. General purpose bundles These bundles, including GeneralPurpose.4xlarge and GeneralPurpose.8xlarge, are well-suited for the following: • Web browsing • Word processing • Email • Instant messaging • Spreadsheets • Audio processing • Software development (Integrated Development Environment (IDE)) • Data warehousing • Business intelligence applications • Audio and video conferencing • Batch processing • CPU-based ML (machine learning) model training This bundle is not recommended for 3D rendering, photo-realistic design, game streaming, or ML model training for complex models. GraphicsPro bundle This bundle offers a baseline level of graphics performance, and high level of CPU performance and memory for your WorkSpaces. It is well-suited for the following: Bundle options 448 Amazon WorkSpaces • Web browsing • Word processing • Email • Instant messaging • Spreadsheets • Audio conferencing Administration Guide • Software development (Integrated Development Environment (IDE)) • Data warehousing • Business intelligence applications • Graphic design • Image processing This bundle is not recommended for audio and video conferencing, 3D rendering, and photo- realistic design. Graphics.g4dn bundle This bundle offers a high level of graphics performance, and moderate level of CPU performance and memory for your WorkSpaces and is well-suited for the following: • Web browsing • Word processing • Email • Spreadsheets • Instant messaging • Audio conferencing • Software development (Integrated Development Environment (IDE)) • Entry to mid-level data processing • Data warehousing • Business intelligence applications • Graphic design • CAD/CAM (computer-aided design/computer-aided manufacturing) Bundle options 449 Amazon WorkSpaces Administration Guide This bundle is not recommended for audio and video conferencing, 3D rendering, photo-realistic design, and machine learning model training. GraphicsPro.g4dn bundle This bundle offers a high level of graphics performance, CPU performance, and memory for your WorkSpaces and is well-suited for the following: • Web browsing • Word processing • Email • Spreadsheets • Instant messaging • Audio conferencing • Software development (Integrated Development Environment (IDE)) • Entry to mid-level data processing • Data warehousing • Business intelligence applications • Graphic design • CAD/CAM (computer-aided design/computer-aided manufacturing) • Video transcoding • 3D rendering • Photo-realistic design • Game streaming • ML (machine learning) model training and ML inference This bundle is not recommended for audio and video conferencing. Create a custom WorkSpaces image and bundle for WorkSpaces Personal If you've launched a Windows or Linux WorkSpace and have customized it, you can create a custom image and custom bundles from that WorkSpace. Create a custom image and bundle 450 Amazon WorkSpaces Administration Guide A custom image contains only the OS, software, and settings for the WorkSpace. A custom bundle is a combination of both that custom image and the hardware from which a WorkSpace can be launched. Note Ensure you wait at least 2 hours after deleting |
workspaces-ag-147 | workspaces-ag.pdf | 147 | inference This bundle is not recommended for audio and video conferencing. Create a custom WorkSpaces image and bundle for WorkSpaces Personal If you've launched a Windows or Linux WorkSpace and have customized it, you can create a custom image and custom bundles from that WorkSpace. Create a custom image and bundle 450 Amazon WorkSpaces Administration Guide A custom image contains only the OS, software, and settings for the WorkSpace. A custom bundle is a combination of both that custom image and the hardware from which a WorkSpace can be launched. Note Ensure you wait at least 2 hours after deleting a bundle before creating a new bundle with the same name. After you create a custom image, you can build a custom bundle that combines the custom image and the underlying compute and storage configuration that you select. You can then specify this custom bundle when you launch new WorkSpaces to ensure that the new WorkSpaces have the same consistent configuration (hardware and software). You can use the same custom image to create various custom bundles by selecting different compute and storage options for each bundle. Important • If you plan to create an image from a Windows 10 WorkSpace, note that image creation is not supported on Windows 10 systems that have been upgraded from one version of Windows 10 to a newer version of Windows 10 (a Windows feature/version upgrade). However, Windows cumulative or security updates are supported by the WorkSpaces image-creation process. • After January 14, 2020, images cannot be created from public Windows 7 bundles. You might want to consider migrating your Windows 7 WorkSpaces to Windows 10. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • Graphics bundle is no longer supported after November 30, 2023. We recommend migrating your WorkSpaces to Graphics.g4dn bundle. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • GraphicsPro bundle reaches end-of-life on October 31, 2025. We recommend migrating your GraphicsPro WorkSpaces to supported bundles before October 31, 2025. For more information, see the section called “Migrate a WorkSpace”. • Graphics and GraphicsPro bundles aren't currently available in the Asia Pacific (Mumbai) Region. Create a custom image and bundle 451 Amazon WorkSpaces Administration Guide • Custom bundle storage volumes can't be smaller than image storage volumes. Custom bundles cost the same as the public bundles they are created from. For more information about pricing, see Amazon WorkSpaces Pricing. Contents • Requirements to create Windows custom images • Requirements to create Linux custom images • Best practices • (Optional) Step 1: Specify a custom computer name format for your image • Step 2: Run the Image Checker • Step 3: Create a custom image and custom bundle • What's included with Windows WorkSpaces custom images • What's included with Linux WorkSpace custom images Requirements to create Windows custom images Note Windows currently defines 1 GB as 1,073,741,824 bytes. Customers will need to ensure they have greater than 12,884,901,888 bytes (or 12 GiB) free on C drive and the user profile is less than 10,737,418,240 bytes (or 10 GiB) to create an image of a WorkSpace. • The status of the WorkSpace must be Available and its modification state must be None. • All applications and user profiles on WorkSpaces images must be compatible with Microsoft Sysprep. • All applications to include in the image must be installed on the C drive. • For Windows 7 WorkSpaces, and its total size (files and data) must be less than 10 GB. • For Windows 7 WorkSpaces, the C drive must have at least 12 GB of available space. • All application services running on the WorkSpace must use a local system account instead of domain user credentials. For example, you cannot have a Microsoft SQL Server Express installation running with a domain user's credentials. Create a custom image and bundle 452 Amazon WorkSpaces Administration Guide • The WorkSpace must not be encrypted. Image creation from an encrypted WorkSpace is not currently supported. • The following components are required in an image. Without these components, the WorkSpaces that you launch from the image will not function correctly. For more information, see the section called “Required configuration and service components”. • Windows PowerShell version 3.0 or later • Remote Desktop Services • AWS PV drivers • Windows Remote Management (WinRM) • Teradici PCoIP agents and drivers • STXHD agents and drivers • AWS and WorkSpaces certificates • Skylight agent Requirements to create Linux custom images • The status of the WorkSpace must be Available and its modification state must be None. • All applications to include in the image must be installed outside of the user volume (the /home directory). • The root volume (/) should be less than 97% full. • The WorkSpace must not be encrypted. Image creation from |
workspaces-ag-148 | workspaces-ag.pdf | 148 | Windows PowerShell version 3.0 or later • Remote Desktop Services • AWS PV drivers • Windows Remote Management (WinRM) • Teradici PCoIP agents and drivers • STXHD agents and drivers • AWS and WorkSpaces certificates • Skylight agent Requirements to create Linux custom images • The status of the WorkSpace must be Available and its modification state must be None. • All applications to include in the image must be installed outside of the user volume (the /home directory). • The root volume (/) should be less than 97% full. • The WorkSpace must not be encrypted. Image creation from an encrypted WorkSpace is not currently supported. • The following components are required in an image. Without these components, the WorkSpaces that you launch from the image will not function correctly: • Cloud-init • Teradici PCoIP or DCV agents and drivers • Skylight agent Best practices Before you create an image from a WorkSpace, do the following: • Use a separate VPC that is not connected to your production environment. Create a custom image and bundle 453 Amazon WorkSpaces Administration Guide • Deploy the WorkSpace in a private subnet and use a NAT instance for outbound traffic. • Use a small Simple AD directory. • Use the smallest volume size for the source WorkSpace, and then adjust the volume size as needed when creating the custom bundle. • Install all operating system updates (except Windows feature/version updates) and all application updates on the WorkSpace. For more information, see the Important note at the start of this topic. • Delete cached data from the WorkSpace that shouldn't be included in the bundle (for example, browser history, cached files, and browser cookies). • Delete configuration settings from the WorkSpace that shouldn't be included in the bundle (for example, email profiles). • Switch to dynamic IP address settings using DHCP. • Make sure that you haven't exceeded your quota for WorkSpace images allowed in a Region. By default, you're allowed 40 WorkSpace images per Region. If you've reached this quota, new attempts to create an image will fail. To request a quota increase, use the WorkSpaces Limits form. • Make sure that you aren't trying to create an image from an encrypted WorkSpace. Image creation from an encrypted WorkSpace is not currently supported. • If you're running any antivirus software on the WorkSpace, disable it while you're attempting to create an image. • If you have a firewall enabled on your WorkSpace, make sure that it isn't blocking any necessary ports. For more information, see IP address and port requirements for WorkSpaces Personal. • For Windows WorkSpaces, don't configure any Group Policy Objects (GPOs) before image creation. • For Windows WorkSpaces, do not customize the default user profile (C:\Users\Default) before creating an image. We recommend making any customizations to the user profile through GPOs, and applying them after image creation. GPOs can be easily modified or rolled back, and are therefore less prone to error than customizations made to the default user profile. • For Linux WorkSpaces, see also the "Best Practices to Prepare Your Amazon WorkSpaces for Linux Images" whitepaper. • If you want to use smart cards on Linux WorkSpaces with DCV enabled, see Use smart cards for authentication in WorkSpaces Personal for the customizations that you must make to your Linux WorkSpace before creating your image. Create a custom image and bundle 454 Amazon WorkSpaces Administration Guide • Ensure you update networking dependency drivers like ENA, NVMe, and PV drivers on your WorkSpaces. You should do this at least once every 6 months. For more information, see Install or upgrade Elastic Network Adapter (ENA) driver , AWS NVMe drivers for Windows instances, and Upgrade PV drivers on Windows instances. • Ensure you update the EC2Config, EC2Launch, and EC2Launch V2 agents to the latest versions periodically. You should do this at least once every 6 months. For more information, see Update EC2Config and EC2Launch. (Optional) Step 1: Specify a custom computer name format for your image For the WorkSpaces launched from your custom or Bring Your Own License (BYOL) images, you can specify a custom prefix for the computer name format instead of using the default computer name format. To specify a custom prefix, follow the appropriate procedure for your image type. To specify a custom computer name format for custom images Note By default, the format of the computer name for Windows 10 WorkSpaces is DESKTOP- XXXXX and for Windows 11 WorkSpaces, WORKSPA-XXXXX. 1. On the WorkSpace that you're using to create your custom image, open C:\ProgramData \Amazon\EC2-Windows\Launch\Sysprep\Unattend.xml in Notepad or another text editor. For more information about working with the Unattend.xml file, see Answer files (unattend.xml) in the Microsoft documentation. Note To access the C: drive from the Windows File Explorer on your WorkSpace, enter C:\ in the address |
workspaces-ag-149 | workspaces-ag.pdf | 149 | a custom prefix, follow the appropriate procedure for your image type. To specify a custom computer name format for custom images Note By default, the format of the computer name for Windows 10 WorkSpaces is DESKTOP- XXXXX and for Windows 11 WorkSpaces, WORKSPA-XXXXX. 1. On the WorkSpace that you're using to create your custom image, open C:\ProgramData \Amazon\EC2-Windows\Launch\Sysprep\Unattend.xml in Notepad or another text editor. For more information about working with the Unattend.xml file, see Answer files (unattend.xml) in the Microsoft documentation. Note To access the C: drive from the Windows File Explorer on your WorkSpace, enter C:\ in the address bar. 2. In the <settings pass="specialize"> section, make sure that <ComputerName> is set to an asterisk (*). If <ComputerName> is set to any other value, your custom computer name settings will be ignored. For more information about the <ComputerName> setting, see ComputerName in the Microsoft documentation. Create a custom image and bundle 455 Amazon WorkSpaces Administration Guide 3. In the <settings pass="specialize"> section, set <RegisteredOrganization> and <RegisteredOwner> to your preferred values. During Sysprep, the values that you specify for <RegisteredOwner> and <RegisteredOrganization> are concatenated together, and the first 7 characters of the combined string are used to create the computer name. For example, if you specify Amazon.com for <RegisteredOrganization> and EC2 for <RegisteredOwner>. For Windows 10-based images, the computer names for the WorkSpaces using custom bundles will start with EC2AMAZ-xxxxxxx. For Windows 11 based images, the computer names for the WorkSpaces using custom bundles will start with WORKSPA-xxxxxxx. Note • The <RegisteredOrganization> and <RegisteredOwner> values in the <settings pass="oobeSystem"> section are ignored by Sysprep. • Both <RegisteredOrganization> and <RegisteredOwner> are required values. 4. Save your changes to the Unattend.xml file. To specify a custom computer name format for BYOL images 1. 2. 3. If you are using Windows 10, open C:\Program Files\Amazon\Ec2ConfigService \Sysprep2008.xml in Notepad or another text editor. If you are using Windows 11, open C: \ProgramData\Amazon\EC2Launch\sysprep\OOBE_unattend.xml. In the <settings pass="specialize"> section, if you're using Windows 10, uncomment <ComputerName>*</ComputerName>. If you're using Windows 11, you won't need to uncomment this section. Make sure that <ComputerName> is set to an asterisk (*). If <ComputerName> is set to any other value, your custom computer name settings will be ignored. For more information about the <ComputerName> setting, see ComputerName in the Microsoft documentation. In the <settings pass="specialize"> section, the <RegisteredOrganization> field will be present for Windows 10 and Windows 11. The <RegisteredOwner> tag will only be present in Windows 10 by default. If you're using Windows 11, you will need to add this tag. Set <RegisteredOrganization> and <RegisteredOwner> to your preferred values. Create a custom image and bundle 456 Amazon WorkSpaces Administration Guide During Sysprep, the values that you specify for <RegisteredOwner> and <RegisteredOrganization> are concatenated together, and the first 7 characters of the combined string are used to create the computer name. For example, if you specify Amazon.com for <RegisteredOrganization> and EC2 for <RegisteredOwner>, the computer names for the WorkSpaces created from your custom bundle will start with EC2AMAZ-xxxxxxx. Note • The <RegisteredOrganization> and <RegisteredOwner> values in the <settings pass="oobeSystem"> section are ignored by Sysprep. • Both <RegisteredOrganization> and <RegisteredOwner> are required values. 4. If you are using Windows 10, save your changes to the Sysprep2008.xml file. If you are using Windows 11, save your changes to OOBE_unattend.xml Step 2: Run the Image Checker Note The Image Checker is available only for Windows WorkSpaces. If you are creating an image from a Linux WorkSpace, skip to Step 3: Create a custom image and custom bundle. To confirm that your Windows WorkSpace meets the requirements for image creation, we recommend running the Image Checker. The Image Checker performs a series of tests on the WorkSpace that you want to use to create your image, and provides guidance on how to resolve any issues it finds. Important • The WorkSpace must pass all of the tests run by the Image Checker before you can use it for image creation. • Before you run the Image Checker, verify that the latest Windows security and cumulative updates are installed on your WorkSpace. Create a custom image and bundle 457 Amazon WorkSpaces Administration Guide To get the Image Checker, do one of the following: • Reboot your WorkSpace. The Image Checker is downloaded automatically during the reboot and installed at C:\Program Files\Amazon\ImageChecker.exe. • Download the Amazon WorkSpaces Image Checker from https://tools.amazonworkspaces.com/ ImageChecker.zip and extract the ImageChecker.exe file. Copy this file to C:\Program Files\Amazon\. To run the Image Checker 1. Open the C:\Program Files\Amazon\ImageChecker.exe file. 2. In the Amazon WorkSpaces Image Checker dialog box, choose Run. 3. After each test is completed, you can view the status of the test. For any test with a status of FAILED, choose Info to display information about how to resolve the issue that caused the failure. For more information about |
workspaces-ag-150 | workspaces-ag.pdf | 150 | your WorkSpace. The Image Checker is downloaded automatically during the reboot and installed at C:\Program Files\Amazon\ImageChecker.exe. • Download the Amazon WorkSpaces Image Checker from https://tools.amazonworkspaces.com/ ImageChecker.zip and extract the ImageChecker.exe file. Copy this file to C:\Program Files\Amazon\. To run the Image Checker 1. Open the C:\Program Files\Amazon\ImageChecker.exe file. 2. In the Amazon WorkSpaces Image Checker dialog box, choose Run. 3. After each test is completed, you can view the status of the test. For any test with a status of FAILED, choose Info to display information about how to resolve the issue that caused the failure. For more information about how to resolve these issues, see Tips for resolving issues detected by the Image Checker. If any tests display a status of WARNING, choose the Fix All Warnings button. The tool generates an output log file in the same directory where the Image Checker is located. By default, this file is located at C:\Program Files\Amazon \ImageChecker_yyyyMMddhhmmss.log. Tip Do not delete this log file. If an issue occurs, this log file might be helpful in troubleshooting. 4. If applicable, resolve any issues that cause test failures and warnings, and repeat the process of running the Image Checker until the WorkSpace passes all tests. All failures and warnings must be resolved before you can create an image. 5. After your WorkSpace passes all tests, you see a Validation Successful message. You are now ready to create a custom bundle. Create a custom image and bundle 458 Amazon WorkSpaces Administration Guide Tips for resolving issues detected by the Image Checker In addition to consulting the following tips for resolving issues that are detected by the Image Checker, be sure to review the Image Checker log file at C:\Program Files\Amazon \ImageChecker_yyyyMMddhhmmss.log. PowerShell version 3.0 or later must be installed Install the latest version of Microsoft Windows PowerShell. Important The PowerShell execution policy for a WorkSpace must be set to allow RemoteSigned scripts. To check the execution policy, run the Get-ExecutionPolicy PowerShell command. If the execution policy is not set to Unrestricted or RemoteSigned, run the Set- ExecutionPolicy –ExecutionPolicy RemoteSigned command to change the value of the execution policy. The RemoteSigned setting allows the execution of scripts on Amazon WorkSpaces, which is required to create an image. Only the C and D drives can be present Only the C and D drives can be present on a WorkSpace that's used for imaging. Remove all other drives, including virtual drives. No pending reboot due to Windows Updates can be detected • The Create Image process can't run until Windows is rebooted to finish installing security or cumulative updates. Reboot Windows to apply these updates, and make sure that no other pending Windows security or cumulative updates need to be installed. • Image creation is not supported on Windows 10 systems that have been upgraded from one version of Windows 10 to a newer version of Windows 10 (a Windows feature/version upgrade). However, Windows cumulative or security updates are supported by the WorkSpaces image- creation process. The Sysprep file must exist and can't be blank If there are problems with your Sysprep file, contact the AWS Support Center to get your EC2Config or EC2Launch repaired. Create a custom image and bundle 459 Amazon WorkSpaces Administration Guide The user profile size must be less than 10 GB For Windows 7 WorkSpaces, the user profile (D:\Users\username) must be less than 10 GB total. Remove files as needed to reduce the size of the user profile. Drive C must have enough free space For Windows 7 WorkSpaces, you must have at least 12 GB of free space on drive C. Remove files as needed to free up space on drive C. For Windows 10 WorkSpaces, ignore if you receive a FAILED message and the disk space is above 2GB. No services can be running under a domain account To run the Create Image process, no services on the WorkSpace can be running under a domain account. All services must be running under a local account. To run services under a local account 1. Open C:\Program Files\Amazon\ImageChecker_yyyyMMddhhmmss.log and find the list of services that are running under a domain account. 2. In the Windows search box, enter services.msc to open the Windows Services Manager. 3. Under Log On As, look for the services that are running under domain accounts. (Services running as Local System, Local Service, or Network Service do not interfere with image creation.) 4. Select a service that is running under a domain account, and then choose Action, Properties. 5. Open the Log On tab. Under Log on as, choose Local System account. 6. Choose OK. The WorkSpace must be configured to use DHCP You must configure all network adapters on the WorkSpace to use DHCP instead of static IP addresses. To set all network adapters to use DHCP |
workspaces-ag-151 | workspaces-ag.pdf | 151 | Windows Services Manager. 3. Under Log On As, look for the services that are running under domain accounts. (Services running as Local System, Local Service, or Network Service do not interfere with image creation.) 4. Select a service that is running under a domain account, and then choose Action, Properties. 5. Open the Log On tab. Under Log on as, choose Local System account. 6. Choose OK. The WorkSpace must be configured to use DHCP You must configure all network adapters on the WorkSpace to use DHCP instead of static IP addresses. To set all network adapters to use DHCP 1. In the Windows search box, enter control panel to open the Control Panel. 2. Choose Network and Internet. 3. Choose Network and Sharing Center. Create a custom image and bundle 460 Amazon WorkSpaces Administration Guide 4. Choose Change adapter settings, and select an adapter. 5. Choose Change settings of this connection. 6. On the Networking tab, select Internet Protocol Version 4 (TCP/IPv4), and then choose Properties. 7. In the Internet Protocol Version 4 (TCP/IPv4) Properties dialog box, select Obtain an IP address automatically. 8. Choose OK. 9. Repeat this process for all network adapters on the WorkSpace. Remote Desktop Services must be enabled The Create Image process requires Remote Desktop Services to be enabled. To enable Remote Desktop Services 1. 2. 3. In the Windows search box, enter services.msc to open the Windows Services Manager. In the Name column, find Remote Desktop Services. Select Remote Desktop Services, and then choose Action, Properties. 4. On the General tab, for Startup type, choose Manual or Automatic. 5. Choose OK. A user profile must exist The WorkSpace that you're using to create images must have a user profile (D:\Users \username). If this test fails, contact the AWS Support Center for assistance. The environment variable path must be properly configured The environment variable path for the local machine is missing entries for System32 and for Windows PowerShell. These entries are required for Create Image to run. To configure your environment variable path 1. In the Windows search box, enter environment variables and then choose Edit the system environment variables. Create a custom image and bundle 461 Amazon WorkSpaces Administration Guide 2. 3. In the System Properties dialog box, open the Advanced tab, and choose Environment Variables. In the Environment Variables dialog box, under System variables, select the Path entry and then choose Edit. 4. Choose New, and add the following path: C:\Windows\System32 5. Choose New again, and add the following path: C:\Windows\System32\WindowsPowerShell\v1.0\ 6. Choose OK. 7. Restart the WorkSpace. Tip The order in which items appear in the environment variable path matters. To determine the correct order, you might want to compare the environment variable path of your WorkSpace with one from a newly created WorkSpace or a new Windows instance. Windows Modules Installer must be enabled The Create Image process requires the Windows Modules Installer service to be enabled. To enable the Windows Modules Installer service 1. 2. 3. In the Windows search box, enter services.msc to open the Windows Services Manager. In the Name column, find Windows Modules Installer. Select Windows Modules Installer, and then choose Action, Properties. 4. On the General tab, for Startup type, choose Manual or Automatic. 5. Choose OK. Amazon SSM Agent must be disabled The Create Image process requires the Amazon SSM Agent service to be disabled. Create a custom image and bundle 462 Amazon WorkSpaces Administration Guide To disable the Amazon SSM Agent service 1. 2. 3. In the Windows search box, enter services.msc to open the Windows Services Manager. In the Name column, find Amazon SSM Agent. Select Amazon SSM Agent, and then choose Action, Properties. 4. On the General tab, for Startup type, choose Disabled. 5. Choose OK. SSL3 and TLS version 1.2 must be enabled To configure SSL/TLS for Windows, see How to Enable TLS 1.2 in the Microsoft Windows documentation. Only one user profile can exist on the WorkSpace There can be only one WorkSpaces user profile (D:\Users\username) on the WorkSpace that you're using to create images. Delete any user profiles that don't belong to the intended user of the WorkSpace. For image creation to work, your WorkSpace can have only three user profiles on it: • The user profile of the intended user of the WorkSpace (D:\Users\username) • The default user profile (also known as Default Profile) • The Administrator user profile If there are additional user profiles, you can delete them through the advanced system properties in the Windows Control Panel. To delete a user profile 1. To access the advanced system properties, do one of the following: • Press the Windows key+Pause Break, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box. • In the |
workspaces-ag-152 | workspaces-ag.pdf | 152 | three user profiles on it: • The user profile of the intended user of the WorkSpace (D:\Users\username) • The default user profile (also known as Default Profile) • The Administrator user profile If there are additional user profiles, you can delete them through the advanced system properties in the Windows Control Panel. To delete a user profile 1. To access the advanced system properties, do one of the following: • Press the Windows key+Pause Break, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box. • In the Windows search box, enter control panel. In the Control Panel, choose System and Security, then choose System, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box. Create a custom image and bundle 463 Amazon WorkSpaces Administration Guide 2. 3. In the System Properties dialog box, on the Advanced tab, choose Settings under User Profiles. If any profile is listed other than the Administrator profile, the Default Profile, and the profile of the intended WorkSpaces user, select that additional profile and choose Delete. 4. When asked if you want to delete the profile, choose Yes. 5. If necessary, repeat Steps 3 and 4 to remove any other profiles that don't belong on the WorkSpace. 6. Choose OK twice and close the Control Panel. 7. Restart the WorkSpace. No AppX packages can be in a staged state One or more AppX packages are in a staged state. This might cause a Sysprep error during image creation. To remove all staged AppX packages 1. In the Windows search box, enter powershell. Choose Run as Administrator. 2. When asked "Do you want to allow this app to make changes to your device?", choose Yes. 3. In the Windows PowerShell window, enter the following commands to list all staged AppX packages, and press Enter after each one. $workSpaceUserName = $env:username $allAppxPackages = Get-AppxPackage -AllUsers $packages = $allAppxPackages | Where-Object { ` (($_.PackageUserInformation -like "*S-1-5-18*" - and !($_.PackageUserInformation -like "*$workSpaceUserName*")) -and ` ($_.PackageUserInformation -like "*Staged*" -or $_.PackageUserInformation -like "*Installed*")) -or ` ((!($_.PackageUserInformation -like "*S-1-5-18*") - and $_.PackageUserInformation -like "*$workSpaceUserName*") -and ` $_.PackageUserInformation -like "*Staged*") } Create a custom image and bundle 464 Amazon WorkSpaces Administration Guide 4. Enter the following command to remove all staged AppX packages, and press Enter. $packages | Remove-AppxPackage -ErrorAction SilentlyContinue 5. Run the Image Checker again. If this test still fails, enter the following commands to remove all AppX packages, and press Enter after each one. Get-AppxProvisionedPackage -Online | Remove-AppxProvisionedPackage -Online - ErrorAction SilentlyContinue Get-AppxPackage -AllUsers | Remove-AppxPackage -ErrorAction SilentlyContinue Windows must not have been upgraded from a previous version Image creation is not supported on Windows systems that have been upgraded from one version of Windows 10 to a newer version of Windows 10 (a Windows feature/version upgrade). To create images, use a WorkSpace that has not undergone a Windows feature/version upgrade. The Windows rearm count must not be 0 The rearm feature allows you to extend the activation period for the trial version of Windows. The Create Image process requires that the rearm count be a value other than 0. To check the Windows rearm count 1. On the Windows Start menu, choose Windows System, then choose Command Prompt. 2. In the Command Prompt window, enter the following command, and then press Enter. cscript C:\Windows\System32\slmgr.vbs /dlv To reset the rearm count to a value other than 0, see Sysprep (Generalize) a Windows installation in the Microsoft Windows documentation. Other troubleshooting tips If your WorkSpace passes all of the tests run by the Image Checker, but you are still unable to create an image from the WorkSpace, check for the following issues: Create a custom image and bundle 465 Amazon WorkSpaces Administration Guide • Make sure that the WorkSpace isn't assigned to a user within a Domain Guests group. To check if there are any domain accounts, run the following PowerShell command. Get-WmiObject -Class Win32_Service | Where-Object { $_.StartName -like "* $env:USERDOMAIN*" } • For Windows 7 WorkSpaces only: If problems occur while the user profile is being copied during image creation, check for the following issues: • Long profile paths can cause image creation errors. Make sure that the paths of all folders within the user profile are less than 261 characters. • Make sure to grant full permissions on the profile folder to the system and all application packages. • If any files in the user profile are locked by a process or are in use during image creation, copying the profile might fail. • Some Group Policy Objects (GPOs) restrict access to the RDP certificate thumbprint when it is requested by the EC2Config service or the EC2Launch scripts during Windows instance configuration. Before you |
workspaces-ag-153 | workspaces-ag.pdf | 153 | • Long profile paths can cause image creation errors. Make sure that the paths of all folders within the user profile are less than 261 characters. • Make sure to grant full permissions on the profile folder to the system and all application packages. • If any files in the user profile are locked by a process or are in use during image creation, copying the profile might fail. • Some Group Policy Objects (GPOs) restrict access to the RDP certificate thumbprint when it is requested by the EC2Config service or the EC2Launch scripts during Windows instance configuration. Before you try to create an image, move the WorkSpace to a new organizational unit (OU) with blocked inheritance and no GPOs applied. • Make sure that the Windows Remote Management (WinRM) service is configured to start automatically. Do the following: 1. In the Windows search box, enter services.msc to open the Windows Services Manager. 2. In the Name column, find Windows Remote Management (WS-Management). 3. Select Windows Remote Management (WS-Management), and then choose Action, Properties. 4. On the General tab, for Startup type, choose Automatic. 5. Choose OK. Step 3: Create a custom image and custom bundle After you have validated your WorkSpace image, you can proceed with creating your custom image and custom bundle. To create a custom image and custom bundle 1. If you are still connected to the WorkSpace, disconnect by choosing Amazon WorkSpaces and Disconnect in the WorkSpaces client application. Create a custom image and bundle 466 Amazon WorkSpaces Administration Guide 2. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 3. 4. In the navigation pane, choose WorkSpaces. Select the WorkSpace to open its details page and choose Create image. If the status of the WorkSpace is Stopped, you must start it first (choose Actions, Start WorkSpaces) before you can choose Actions, Create Image. Note To create an image programmatically, use the CreateWorkspaceImage API action. For more information, see CreateWorkspaceImage in the Amazon WorkSpaces API Reference. 5. A message displays, prompting you to reboot (restart) your WorkSpace before continuing. Rebooting your WorkSpace updates your Amazon WorkSpaces software to the latest version. Reboot your WorkSpace by closing the message and following the steps in Reboot a WorkSpace in WorkSpaces Personal. When you're done, repeat Step 4 of this procedure, but this time choose Next when the reboot message appears. To create an image, the status of the WorkSpace must be Available and its modification state must be None. 6. Enter an image name and a description that will help you identify the image, and then choose Create Image. While the image is being created, the status of the WorkSpace is Suspended and the WorkSpace is unavailable. Note When entering an image description, make sure you don't use the special character "-" or you will get an error. 7. In the navigation pane, choose Images. The image is complete when the status of the WorkSpace changes to Available (this can take up to 45 minutes). 8. Select the image and choose Actions, Create bundle. Note To create a bundle programmatically, use the CreateWorkspaceBundle API action. For more information, see CreateWorkspaceBundle in the Amazon WorkSpaces API Reference. Create a custom image and bundle 467 Amazon WorkSpaces Administration Guide 9. Enter a bundle name and a description, and then do the following: • For Bundle hardware type, choose the hardware to use when launching WorkSpaces from this custom bundle. • For Storage settings, select one of the default combinations for the root volume and user volume size, or select Custom, and then enter values (up to 2000 GB) for Root volume size and User volume size. The default available size combinations for the root volume (for Microsoft Windows, the C drive, for Linux, /) and the user volume (for Windows, the D drive; for Linux, /home) are as follows: • Root: 80 GB, User: 10 GB, 50 GB, or 100 GB • Root: 175 GB, User: 100 GB • For Graphics.g4dn, GraphicsPro.g4dn, Graphics, and GraphicsPro WorkSpaces only: Root: 100 GB, User: 100 GB Alternatively, you can expand the root and user volumes up to 2000 GB each. Note To ensure that your data is preserved, you cannot decrease the size of the root or user volumes after you launch a WorkSpace. Instead, make sure that you specify the minimum sizes for these volumes when launching a WorkSpace. • You can launch a Value, Standard, Performance, Power, or PowerPro WorkSpace with a minimum of 80 GB for the root volume and 10 GB for the user volume. • You can launch a GeneralPurpose.4xlarge or GeneralPurpose.8xlarge WorkSpace with a minimum of 175GB for the root volume and 100 GB for the user volume. • You can launch a Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro WorkSpace with a minimum of 100 GB for the root volume and |
workspaces-ag-154 | workspaces-ag.pdf | 154 | or user volumes after you launch a WorkSpace. Instead, make sure that you specify the minimum sizes for these volumes when launching a WorkSpace. • You can launch a Value, Standard, Performance, Power, or PowerPro WorkSpace with a minimum of 80 GB for the root volume and 10 GB for the user volume. • You can launch a GeneralPurpose.4xlarge or GeneralPurpose.8xlarge WorkSpace with a minimum of 175GB for the root volume and 100 GB for the user volume. • You can launch a Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro WorkSpace with a minimum of 100 GB for the root volume and 100 GB for the user volume. 10. Choose Create bundle. 11. To confirm that your bundle has been created, choose Bundles and verify that the bundle is listed. Create a custom image and bundle 468 Amazon WorkSpaces Administration Guide What's included with Windows WorkSpaces custom images When you create an image from a Windows 7, Windows 10, or Windows 11 WorkSpace, the entire contents of the C drive are included. For Windows 10 or 11 WorkSpaces, the user profile in D:\Users\username is not included in the custom image. For Windows 7 WorkSpaces, the entire contents of the user profile in D:\Users\username are included, except for the following: • Contacts • Downloads • Music • Pictures • Saved games • Videos • Podcasts • Virtual machines • .virtualbox • Tracing • appdata\local\temp • appdata\roaming\apple computer\mobilesync\ • appdata\roaming\apple computer\logs\ • appdata\roaming\apple computer\itunes\iphone software updates\ • appdata\roaming\macromedia\flash player\macromedia.com\support\flashplayer\sys\ • appdata\roaming\macromedia\flash player\#sharedobjects\ • appdata\roaming\adobe\flash player\assetcache\ • appdata\roaming\microsoft\windows\recent\ • appdata\roaming\microsoft\office\recent\ • appdata\roaming\microsoft office\live meeting • appdata\roaming\microsoft shared\livemeeting shared\ • appdata\roaming\mozilla\firefox\crash reports\ Create a custom image and bundle 469 Amazon WorkSpaces Administration Guide • appdata\roaming\mcafee\common framework\ • appdata\local\microsoft\feeds cache • appdata\local\microsoft\windows\temporary internet files\ • appdata\local\microsoft\windows\history\ • appdata\local\microsoft\internet explorer\domstore\ • appdata\local\microsoft\internet explorer\imagestore\ • appdata\locallow\microsoft\internet explorer\iconcache\ • appdata\locallow\microsoft\internet explorer\domstore\ • appdata\locallow\microsoft\internet explorer\imagestore\ • appdata\local\microsoft\internet explorer\recovery\ • appdata\local\mozilla\firefox\profiles\ What's included with Linux WorkSpace custom images When you create an image from an Amazon Linux WorkSpace, the entire contents of the user volume (/home) are removed. The contents of the root volume (/) are included, except the following applicable folders and keys, which are removed: • /tmp • /var/spool/mail • /var/tmp • /var/lib/dhcp • /var/lib/cloud • /var/cache • /var/backups • /etc/sudoers.d • /etc/udev/rules.d/70-persistent-net.rules • /etc/network/interfaces.d/50-cloud-init.cfg • /var/log/amazon/ssm • /var/log/pcoip-agent • /var/log/skylight • /var/lock/.skylight.domain-join.lock Create a custom image and bundle 470 Amazon WorkSpaces Administration Guide • /var/lib/skylight/domain-join-status • /var/lib/skylight/configuration-data • /var/lib/skylight/config-data.json • /home • /etc/default/grub.d/zz-hibernation.cfg • /etc/netplan/zz-workspaces-domain.yaml • /etc/netplan/yy-workspaces-base.yaml • /var/lib/AccountsService/users The following keys are shredded during custom image creation: • /etc/ssh/ssh_host_*_key • /etc/ssh/ssh_host_*_key.pub • /var/lib/skylight/tls.* • /var/lib/skylight/private.key • /var/lib/skylight/public.key Update a custom bundle for WorkSpaces Personal You can update an existing custom WorkSpaces bundle by modifying a WorkSpace that is based on the bundle, creating an image from the WorkSpace, and updating the bundle with the new image. You can then launch new WorkSpaces using the updated bundle. Important Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them. To update a bundle using the console 1. Connect to a WorkSpace that is based on the bundle and make the changes that you want. For example, you can apply the latest operating system and application patches and install additional applications. Update a custom bundle 471 Amazon WorkSpaces Administration Guide Alternatively, you can create a new WorkSpace with the same base software package (Plus or Standard) as the image used to create the bundle, and make changes. 2. If you are still connected to the WorkSpace, disconnect by choosing Amazon WorkSpaces and Disconnect in the WorkSpaces client application. 3. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 4. 5. 6. In the navigation pane, choose WorkSpaces. Select the WorkSpace and choose Actions, Create Image. If the status of the WorkSpace is STOPPED, you must start it first (choose Actions, Start WorkSpaces) before you can choose Actions, Create Image. Enter an image name and a description, and then choose Create Image. The WorkSpace is unavailable while the image is being created. For detailed information about the image creation process, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. 7. In the navigation pane, choose Bundles. 8. Choose the bundle to open its details page, and then under Source image, choose Edit. 9. On the Update source image page, select the image that you created and choose Update bundle. 10. As needed, update any existing WorkSpaces that are based on the bundle by rebuilding the WorkSpaces or deleting and recreating them. For more information, see Rebuild a WorkSpace in WorkSpaces Personal. To update a bundle programmatically To update a bundle programmatically, use the UpdateWorkspaceBundle API action. For more information, see UpdateWorkspaceBundle in the Amazon WorkSpaces |
workspaces-ag-155 | workspaces-ag.pdf | 155 | bundle for WorkSpaces Personal. 7. In the navigation pane, choose Bundles. 8. Choose the bundle to open its details page, and then under Source image, choose Edit. 9. On the Update source image page, select the image that you created and choose Update bundle. 10. As needed, update any existing WorkSpaces that are based on the bundle by rebuilding the WorkSpaces or deleting and recreating them. For more information, see Rebuild a WorkSpace in WorkSpaces Personal. To update a bundle programmatically To update a bundle programmatically, use the UpdateWorkspaceBundle API action. For more information, see UpdateWorkspaceBundle in the Amazon WorkSpaces API Reference. Copy a custom image in WorkSpaces Personal You can copy a custom WorkSpaces image within or across AWS Regions. Copying an image results in the creation of an identical image with its own unique identifier. You can copy a Bring Your Own License (BYOL) image to another Region as long as the destination Region is enabled for BYOL. Ensure that BYOL is enabled for all accounts and Regions involved. Note In the China (Ningxia) Region, you can copy images only within the same Region. Copy a custom image 472 Amazon WorkSpaces Administration Guide In the AWS GovCloud (US) Regions, to copy images to and from other AWS Regions, contact AWS Support. In Opt-in Regions, to copy images to other Regions, contact AWS Support. For more information about Opt-in Regions, see Available Regions. You can also copy an image that has been shared with you by another AWS account. For more information about shared images, see Share or unshare a custom image in WorkSpaces Personal. There are no additional charges for copying an image within or across Regions. However, the quota for the number of images in the destination Region applies. For more information about Amazon WorkSpaces quotas, see Amazon WorkSpaces quotas. IAM Permissions to copy an image If you use an IAM user to copy an image, the user must have permissions for workspaces:DescribeWorkspaceImages and workspaces:CopyWorkspaceImage. The following example policy allows the user to copy the specified image to the specified account in the specified Region. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workspaces:DescribeWorkspaceImages", "workspaces:CopyWorkspaceImage" ], "Resource": [ "arn:aws:workspaces:us-east-1:123456789012:workspaceimage/wsi-a1bcd2efg" ] } ] } Copy a custom image 473 Amazon WorkSpaces Important Administration Guide If you are creating an IAM policy for copying shared images for accounts that don't own the images, you cannot specify an account ID in the ARN. Instead, you must use * for the account ID, as shown in the following example policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workspaces:DescribeWorkspaceImages", "workspaces:CopyWorkspaceImage" ], "Resource": [ "arn:aws:workspaces:us-east-1:*:workspaceimage/wsi-a1bcd2efg" ] } ] } You can specify an account ID in the ARN only when that account owns the images to be copied. For more information about working with IAM, see Identity and access management for WorkSpaces. Bulk copy images You can copy images one by one using the console. To bulk copy images, use the CopyWorkspaceImage API operation or the copy-workspace-image command in the AWS Command Line Interface (AWS CLI). For more information, see CopyWorkspaceImage in the Amazon WorkSpaces API Reference or see copy-workspace-image in the AWS CLI Command Reference. Important Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see Copy a custom image 474 Amazon WorkSpaces Administration Guide the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations or the describe-workspace-images and describe-workspace-image-permissions commands in the AWS CLI. To copy an image using the console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. 5. 6. In the navigation pane, choose Images. Select the image and choose Actions, Copy image. For Select destination, select the AWS Region that you want to copy the image to. For Name of the copy, enter the new name for the copied image, and for Description, enter a description for the copied image. (Optional) Under Tags, enter tags for the copied image. For more information, see Tag resources in WorkSpaces Personal. 7. Choose Copy image. Share or unshare a custom image in WorkSpaces Personal You can share custom WorkSpaces images across AWS accounts within the same AWS Region. After an image has been shared, the recipient account can copy the image to other AWS Regions as needed. For more information about copying images, see Copy a custom image in WorkSpaces Personal. Note In the China (Ningxia) Region, you can copy images only within the same Region. In the AWS GovCloud (US) Regions, to copy images to and from other AWS Regions, contact AWS Support. There are no additional charges for sharing an image. However, the quota for the number of images in the AWS Region applies. A shared image |
workspaces-ag-156 | workspaces-ag.pdf | 156 | images across AWS accounts within the same AWS Region. After an image has been shared, the recipient account can copy the image to other AWS Regions as needed. For more information about copying images, see Copy a custom image in WorkSpaces Personal. Note In the China (Ningxia) Region, you can copy images only within the same Region. In the AWS GovCloud (US) Regions, to copy images to and from other AWS Regions, contact AWS Support. There are no additional charges for sharing an image. However, the quota for the number of images in the AWS Region applies. A shared image doesn't count against the recipient account's quota until the recipient copies the image. For more information about Amazon WorkSpaces quotas, see Amazon WorkSpaces quotas. Share or unshare a custom image 475 Amazon WorkSpaces Administration Guide To delete a shared image, you must unshare the image before you can delete it. Share Bring Your Own License images You can share Bring Your Own License (BYOL) images only with AWS accounts that are enabled for BYOL. The AWS account that you want to share BYOL images with must also be part of your organization (under the same payer account). Note Sharing BYOL images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) and AWS GovCloud (US-East) Regions. To share BYOL images across accounts in the AWS GovCloud (US-West) and AWS GovCloud (US-East) Regions, contact AWS Support. Images shared with you If images are shared with you, you can copy them. You can then use your copies of the shared images to create bundles for launching new WorkSpaces. Important Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To programmatically determine if an image has been shared, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations or the describe-workspace-images and describe-workspace-image-permissions commands in the AWS command line interface (CLI). The creation date shown for an image that has been shared with you is the date that the image was originally created, not the date that the image was shared with you. If an image has been shared with you, you can't further share that image with other accounts. To share an image 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Images. 3. Choose the image to open its details page. Share or unshare a custom image 476 Amazon WorkSpaces Administration Guide 4. On the image detail page, in the Shared accounts section, choose Add account. 5. On the Add account page, under Add account to share with, enter the account ID of the account that you want to share the image with. Important Before sharing the image, confirm that you are sharing to the correct AWS account ID. 6. Choose Share image. Note To use the shared image, the recipient account must first copy the image. The recipient account can then use its copy of the shared image to create bundles for launching new WorkSpaces. To stop sharing an image 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Images. 3. Choose the image to open its details page. 4. On the image detail page, in the Shared accounts section, select the AWS account that you want to stop sharing with, and then choose Unshare. 5. When prompted to confirm unsharing the image, choose Unshare. Note If you want to delete the image after unsharing it, you must first unshare it from all of the accounts that it has been shared with. After you stop sharing an image, the recipient account can no longer make copies of the image. However, any copies of shared images that are already in the recipient account remain in that account, and new WorkSpaces can be launched from those copies. To share or unshare images programmatically Share or unshare a custom image 477 Amazon WorkSpaces Administration Guide To share or unshare images programmatically, use the UpdateWorkspaceImagePermission API operation or the update-workspace-image-permission AWS Command Line Interface (AWS CLI) command. To determine if an image has been shared, use the DescribeWorkspaceImagePermissions API operation or the describe-workspace-image-permissions CLI command. Delete a custom bundle or image in WorkSpaces Personal You can delete unused custom bundles or custom images as needed. Delete a bundle To delete a bundle, you must first delete all of the WorkSpaces that are based on the bundle. To delete a bundle using the console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Bundles. Select the bundle and choose Delete. 4. When prompted for confirmation, choose Delete. To delete a bundle programmatically To delete a bundle programmatically, use the DeleteWorkspaceBundle API action. For more information, see DeleteWorkspaceBundle in the Amazon WorkSpaces API Reference. Note Ensure you wait at least 2 hours after |
workspaces-ag-157 | workspaces-ag.pdf | 157 | delete unused custom bundles or custom images as needed. Delete a bundle To delete a bundle, you must first delete all of the WorkSpaces that are based on the bundle. To delete a bundle using the console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Bundles. Select the bundle and choose Delete. 4. When prompted for confirmation, choose Delete. To delete a bundle programmatically To delete a bundle programmatically, use the DeleteWorkspaceBundle API action. For more information, see DeleteWorkspaceBundle in the Amazon WorkSpaces API Reference. Note Ensure you wait at least 2 hours after deleting a bundle before creating a new bundle with the same name. Delete an image After you delete a custom bundle, you can delete the image that you used to create or update the bundle. To delete an image, you must first either delete any bundles that are associated with the image, or you must update those bundles to use another source image. You must also unshare the image if it is shared with other accounts. The image also can't be in the Pending or Validating state. Delete a custom bundle or image 478 Amazon WorkSpaces Administration Guide To delete an image using the console 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Images. Select the image and choose Delete. 4. When prompted for confirmation, choose Delete. To delete an image programmatically To delete an image programmatically, use the DeleteWorkspaceImage API action. For more information, see DeleteWorkspaceImage in the Amazon WorkSpaces API Reference. Monitor WorkSpaces Personal You can use the following features to monitor your WorkSpaces. CloudWatch metrics Amazon WorkSpaces publishes data points to Amazon CloudWatch about your WorkSpaces. CloudWatch enables you to retrieve statistics about those data points as an ordered set of time- series data, known as metrics. You can use these metrics to verify that your WorkSpaces are performing as expected. For more information, see Monitor your WorkSpaces using CloudWatch metrics. CloudWatch Events Amazon WorkSpaces can submit events to Amazon CloudWatch Events when users log in to your WorkSpace. This enables you to respond when the event occurs. For more information, see Monitor your WorkSpaces using Amazon EventBridge. CloudTrail logs AWS CloudTrail provides a record of actions taken by a user, role, or an AWS service in WorkSpaces. Using the information collected by CloudTrail, you can determine the request that was made to WorkSpaces, the IP address from which the request was made, who made the request, when it was made, and additional details. For more information, see Logging WorkSpaces API Calls by Using CloudTrail. AWS CloudTrail logs successful and unsuccessful sign-in events for smart card users. For more information, see Understanding AWS sign-in events for smart card users. Monitor WorkSpaces Personal 479 Amazon WorkSpaces CloudWatch Internet Monitor Administration Guide Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on AWS and your end users. You can also use CloudWatch Internet Monitor to: • Create monitors for one or more WorkSpace directories. • Monitor internet performance. • Get alarms for issues between your end users’ city-network, including its location and ASN, which is typically the Internet Service Provider (ISP), and their WorkSpace Regions. Internet Monitor uses the connectivity data that AWS captures from its global networking footprint to calculate a baseline of performance and availability for internet-facing traffic. Internet Monitor currently can't provide internet performance for individual end user but it can at city and ISP level. Amazon S3 Access Logs If your users have application settings data or home folders data stored in Amazon S3 buckets, consider viewing Amazon S3 server access logs to monitor access. These logs provide detailed records about requests that are made to a bucket. Server access logs are useful for many applications. For example, access log information can be useful in security and access audits. For more information, see Amazon S3 Server Access Logging in the Amazon Simple Storage Service User Guide. Monitor your WorkSpaces health using the CloudWatch automatic dashboard You can monitor WorkSpaces using CloudWatch automatic dashboard, which collects raw data and processes it into readable, near real-time metrics. The metrics are kept for 15 months to access historical information and to monitor the performance of your web application or service. You can also set alarms that watch for certain thresholds, and send notifications or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. The CloudWatch dashboard is automatically created when you use your AWS account to configure your WorkSpaces. The dashboard allows you to monitor your WorkSpaces metrics, such as their health and performance, across Regions. You can also use the dashboard for the following purposes: Monitor with CloudWatch automatic dashboard 480 Amazon WorkSpaces Administration |
workspaces-ag-158 | workspaces-ag.pdf | 158 | for 15 months to access historical information and to monitor the performance of your web application or service. You can also set alarms that watch for certain thresholds, and send notifications or take actions when those thresholds are met. For more information, see the Amazon CloudWatch User Guide. The CloudWatch dashboard is automatically created when you use your AWS account to configure your WorkSpaces. The dashboard allows you to monitor your WorkSpaces metrics, such as their health and performance, across Regions. You can also use the dashboard for the following purposes: Monitor with CloudWatch automatic dashboard 480 Amazon WorkSpaces Administration Guide • Identify unhealthy WorkSpace instances. • Identify running modes, protocols, and operating systems that have unhealthy WorkSpace instances. • View critical resource utilization over time. • Identify anomalies to help with troubleshooting. WorkSpaces CloudWatch automatic dashboards are available in all AWS commercial Regions. To use the WorkSpaces CloudWatch automatic dashboard 1. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 2. In the navigation pane, choose Dashboards. 3. Choose the Automatic dashboards tab. 4. Choose WorkSpaces. Understanding your WorkSpaces CloudWatch automatic dashboard The CloudWatch automatic dashboard allows you to gain insight into the performance of your WorkSpaces resources and helps you identify performance issues. Monitor with CloudWatch automatic dashboard 481 Amazon WorkSpaces Administration Guide Monitor with CloudWatch automatic dashboard 482 Amazon WorkSpaces Administration Guide The dashboard consists of the following features: 1. View historical data using time and date range controls. 2. Add customized dashboard view to the CloudWatch custom dashboards. 3. Monitor the overall health and utilization status of your WorkSpaces by doing the following: a. View the total number of provisioned WorkSpaces, number of users connected, number of unhealthy and healthy WorkSpace instances. b. View unhealthy WorkSpaces and their different variables, such as protocol and compute mode. c. Hover over the line chart to view the number of healthy or unhealthy WorkSpace instances for a specific protocol and running mode over a period of time. d. Choose the ellipsis menu, then choose View in metrics to view the metrics on a time scale chart. 4. View your connection metrics and their different variables, such as number of connection attempts, successful connections, and failed connections in your WorkSpaces environment at any given time. 5. View InSession latencies that impact your user's experience, such as round trip time (RTT), to determine connection health and packet loss to monitor network health. 6. View host performance and resource utilization to identify and troubleshoot potential performance issues. Monitor your WorkSpaces using CloudWatch metrics WorkSpaces and Amazon CloudWatch are integrated, so you can gather and analyze performance metrics. You can monitor these metrics using the CloudWatch console, the CloudWatch command line interface, or programmatically using the CloudWatch API. CloudWatch also allows you to set alarms when you reach a specified threshold for a metric. For more information about using CloudWatch and alarms, see the Amazon CloudWatch User Guide. Prerequisites To get CloudWatch metrics, enable access on port 443 on the AMAZON subset in the us-east-1 Region. For more information, see IP address and port requirements for WorkSpaces Personal. Monitor using CloudWatch metrics 483 Amazon WorkSpaces Contents • WorkSpaces metrics • Dimensions for WorkSpaces metrics • Monitoring example WorkSpaces metrics Administration Guide The AWS/WorkSpaces namespace includes the following metrics. Metric Description Dimensions Statistics Units Available 1 The number of WorkSpaces that returned a healthy status. Unhealthy 1 The number of WorkSpace s that returned an unhealthy status. Count Average, Sum, Maximum, Minimum, Data Samples Count Average, Sum, Maximum, Minimum, Data Samples DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Monitor using CloudWatch metrics 484 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units ConnectionAttempt 2 The number of connection attempts. ConnectionSuccess 2 The number of successful connections. Count Average, Sum, Maximum, Minimum, Data Samples Count Average, Sum, Maximum, Minimum, Data Samples DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Monitor using CloudWatch metrics 485 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units ConnectionFailure 2 The number of failed connectio ns. SessionLa unchTime 2,6 The amount of time it takes to initiate a WorkSpaces session. Count Average, Sum, Maximum, Minimum, Data Samples Average, Sum, Maximum, Second (time) Minimum, Data Samples DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Monitor using CloudWatch metrics 486 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units InSessionLatency 2,6 The round trip time between the WorkSpace s client and the WorkSpace. SessionDi sconnect 2,6 The number of connectio ns that were closed, including user- DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Average, Sum, Maximum, Millisecond (time) Minimum, Data Samples Count Average, Sum, Maximum, Minimum, Data Samples initiated and Protocol failed connectio ns. ComputeType BundleId UserName Monitor using CloudWatch metrics 487 Amazon |
workspaces-ag-159 | workspaces-ag.pdf | 159 | Second (time) Minimum, Data Samples DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Monitor using CloudWatch metrics 486 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units InSessionLatency 2,6 The round trip time between the WorkSpace s client and the WorkSpace. SessionDi sconnect 2,6 The number of connectio ns that were closed, including user- DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Average, Sum, Maximum, Millisecond (time) Minimum, Data Samples Count Average, Sum, Maximum, Minimum, Data Samples initiated and Protocol failed connectio ns. ComputeType BundleId UserName Monitor using CloudWatch metrics 487 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units UserConnected 3 The number of WorkSpaces that have a user connected. DirectoryId WorkspaceId RunningMode Average, Sum, Maximum, Minimum, Data Samples Count Stopped The number of WorkSpace s that are stopped. Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Count Average, Sum, Maximum, Minimum, Data Samples Monitor using CloudWatch metrics 488 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units Count Average, Sum, Maximum, Minimum, Data Samples Count Average, Sum, Maximum, Minimum, Data Samples Count Average, Sum, Maximum, Minimum, Data Samples Maintenance 4 The number of WorkSpaces that are under maintenance. TrustedDeviceValid ationAttempt 5,6 The number of device authentic ation signature validation attempts. DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId TrustedDeviceValid ationSuccess 5,6 The number of successfu DirectoryId TrustedDeviceValid ationFailure 5,6 l device authentic ation signature validations. The number of failed device authentic ation signature validations. DirectoryId Count Average, Sum, Maximum, Minimum, Data Samples Monitor using CloudWatch metrics 489 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units TrustedDeviceCerti ficateDay sBeforeEx piration 6 CPUUsage Days left before the root certificate associated with the directory is expired. The percentag e of the CPU resource used. MemoryUsage The percentage of the machine memory used. Certifica teId Count Average, Sum, Maximum, Minimum, Data Samples Percentage Average, Maximum, Minimum Percentage Average, Maximum, Minimum DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Monitor using CloudWatch metrics 490 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units RootVolumeDiskUsag e The percentage of the root disk volume used. UserVolumeDiskUsag e The percentage of the user disk volume used. Percentage Average, Maximum, Minimum Percentage Average, Maximum, Minimum DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName Monitor using CloudWatch metrics 491 Amazon WorkSpaces Administration Guide Metric Description Dimensions Statistics Units UDPPacketLossRate 7 The percentag e of packets dropped between the client and the DirectoryId WorkspaceId RunningMode Average, Maximum, Minimum, Data Samples gateway. Protocol Percentage UpTime The time since the last reboot of a WorkSpace . Seconds Average, Maximum, Minimum, Data Samples ComputeType BundleId UserName DirectoryId WorkspaceId RunningMode Protocol ComputeType BundleId UserName 1 WorkSpaces periodically sends status requests to a WorkSpace. A WorkSpace is marked Available when it responds to these requests, and Unhealthy when it fails to respond to these requests. These metrics are available at a per-WorkSpace level of granularity, and also aggregated for all WorkSpaces in an organization. 2 WorkSpaces records metrics on connections made to each WorkSpace. These metrics are emitted after a user has successfully authenticated via the WorkSpaces client and the client then initiates a session. The metrics are available at a per-WorkSpace level of granularity, and also aggregated for all WorkSpaces in a directory. Monitor using CloudWatch metrics 492 Amazon WorkSpaces Administration Guide 3 WorkSpaces periodically sends connection status requests to a WorkSpace. Users are reported as connected when they are actively using their sessions. This metric is available at a per-WorkSpace level of granularity, and is also aggregated for all WorkSpaces in an organization. 4 This metric applies to WorkSpaces that are configured with an AutoStop running mode. If you have maintenance enabled for your WorkSpaces, this metric captures the number of WorkSpaces that are currently under maintenance. This metric is available at a per-WorkSpace level of granularity, which describes when a WorkSpace went into maintenance and when it was removed. 5 If the trusted devices feature is enabled for the directory, Amazon WorkSpaces uses certificate- based authentication to determine whether a device is trusted. When users attempt to access their WorkSpaces, these metrics are emitted to indicate successful or failed trusted device authentication. These metrics are available at a per-directory level of granularity, and only for the Amazon WorkSpaces Windows and macOS client applications. 6 Not available on WorkSpaces Web Access. 7 This metric measures average packet loss. • On PCoIP: Measures average UDP packet loss from client to gateway. Note This is measured at the gateway. • On DCV: Measures UDP packet loss from gateway to client. Note This is measured at the gateway. Dimensions for WorkSpaces metrics To filter the metric data, use the following dimensions. Monitor using CloudWatch metrics 493 Amazon WorkSpaces Dimension DirectoryId WorkspaceId |
workspaces-ag-160 | workspaces-ag.pdf | 160 | or failed trusted device authentication. These metrics are available at a per-directory level of granularity, and only for the Amazon WorkSpaces Windows and macOS client applications. 6 Not available on WorkSpaces Web Access. 7 This metric measures average packet loss. • On PCoIP: Measures average UDP packet loss from client to gateway. Note This is measured at the gateway. • On DCV: Measures UDP packet loss from gateway to client. Note This is measured at the gateway. Dimensions for WorkSpaces metrics To filter the metric data, use the following dimensions. Monitor using CloudWatch metrics 493 Amazon WorkSpaces Dimension DirectoryId WorkspaceId CertificateId RunningMode BundleId ComputeType Protocol UserName Administration Guide Description Filters the metric data to the WorkSpaces in the specified directory. The form of the directory ID is d-XXXXXXXXXX . Filters the metric data to the specified WorkSpace. The form of the WorkSpace ID is ws-XXXXXXXXXX . Filters the metric data to the specified root certificate associated with the directory. The form of the certificate ID is wsc-XXXXXXXXX . Filters the metric data to the WorkSpaces by their running mode. The form of the running mode is AutoStop or AlwaysOn. Filters the metric data to the WorkSpaces by the protocol. The form of the bundle is wsb- XXXXXXXXXX . Filters the metric data to the WorkSpaces by the compute type. Filters the metric data to the WorkSpaces by the protocol type. Filters the metric data to the WorkSpaces by the user's name. Note The UserName cannot consist of non- ASCII characters, such as the following: • Accented letters: é, à, ö, ñ, etc. • Non-Latin alphabets Monitor using CloudWatch metrics 494 Amazon WorkSpaces Dimension Monitoring example Administration Guide Description • Symbols: ©#, ®#, €, £, µ, ¥, etc. The following example demonstrates how you can use the AWS CLI to respond to a CloudWatch alarm and determine which WorkSpaces in a directory have experienced connection failures. To respond to a CloudWatch alarm 1. Determine which directory the alarm applies to using the describe-alarms command. aws cloudwatch describe-alarms --state-value "ALARM" { "MetricAlarms": [ { ... "Dimensions": [ { "Name": "DirectoryId", "Value": "directory_id" } ], ... } ] } 2. Get the list of WorkSpaces in the specified directory using the describe-workspaces command. aws workspaces describe-workspaces --directory-id directory_id { "Workspaces": [ { ... "WorkspaceId": "workspace1_id", ... }, Monitor using CloudWatch metrics 495 Administration Guide Amazon WorkSpaces { ... "WorkspaceId": "workspace2_id", ... }, { ... "WorkspaceId": "workspace3_id", ... } ] } 3. Get the CloudWatch metrics for each WorkSpace in the directory using the get-metric- statistics command. aws cloudwatch get-metric-statistics \ --namespace AWS/WorkSpaces \ --metric-name ConnectionFailure \ --start-time 2015-04-27T00:00:00Z \ --end-time 2015-04-28T00:00:00Z \ --period 3600 \ --statistics Sum \ --dimensions "Name=WorkspaceId,Value=workspace_id" { "Datapoints" : [ { "Timestamp": "2015-04-27T00:18:00Z", "Sum": 1.0, "Unit": "Count" }, { "Timestamp": "2014-04-27T01:18:00Z", "Sum": 0.0, "Unit": "Count" } ], "Label" : "ConnectionFailure" } Monitor using CloudWatch metrics 496 Amazon WorkSpaces Administration Guide Monitor your WorkSpaces using Amazon EventBridge You can use events from Amazon WorkSpaces to view, search, download, archive, analyze, and respond to successful logins to your WorkSpaces. For example, you can use events for the following purposes: • Store or archive WorkSpaces login events as logs for future reference, analyze the logs to look for patterns, and take action based on those patterns. • Use the WAN IP address to determine where users are logged in from, and then use policies to allow users access only to files or data from WorkSpaces that meet the access criteria found in the event type of WorkSpaces Access. • Analyze login data and perform automated actions using AWS Lambda. • Use policy controls to block access to files and applications from unauthorized IP addresses. • Find out the WorkSpaces client version used to connect to WorkSpaces. Amazon WorkSpaces emits these events on a best-effort basis. Events are delivered to EventBridge in near real time. With EventBridge, you can create rules that trigger programmatic actions in response to an event. For example, you can configure a rule that invokes an SNS topic to send an email notification or invokes a Lambda function to take some action. For more information, see the Amazon EventBridge User Guide. WorkSpaces Access events WorkSpaces client applications send WorkSpaces Access events when a user successfully logs in to a WorkSpace. All WorkSpaces clients send these events. Events emitted for WorkSpaces using DCV require the WorkSpaces client application version 4.0.1 or later. Events are represented as JSON objects. The following is example data for a WorkSpaces Access event. { "version": "0", "id": "64ca0eda-9751-dc55-c41a-1bd50b4fc9b7", "detail-type": "WorkSpaces Access", "source": "aws.workspaces", "account": "123456789012", Monitor using Amazon EventBridge 497 Amazon WorkSpaces Administration Guide "time": "2023-04-05T16:13:59Z", "region": "us-east-1", "resources": [], "detail": { "clientIpAddress": "192.0.2.3", "actionType": "successfulLogin", "workspacesClientProductName": "WorkSpacesWebClient", "loginTime": "2023-04-05T16:13:37.603Z", "clientPlatform": "Windows", "directoryId": "domain/d-123456789", "clientVersion": "5.7.0.3472", "workspaceId": "ws-xyskdga" } } Event-specific fields clientIpAddress The WAN |
workspaces-ag-161 | workspaces-ag.pdf | 161 | Access events when a user successfully logs in to a WorkSpace. All WorkSpaces clients send these events. Events emitted for WorkSpaces using DCV require the WorkSpaces client application version 4.0.1 or later. Events are represented as JSON objects. The following is example data for a WorkSpaces Access event. { "version": "0", "id": "64ca0eda-9751-dc55-c41a-1bd50b4fc9b7", "detail-type": "WorkSpaces Access", "source": "aws.workspaces", "account": "123456789012", Monitor using Amazon EventBridge 497 Amazon WorkSpaces Administration Guide "time": "2023-04-05T16:13:59Z", "region": "us-east-1", "resources": [], "detail": { "clientIpAddress": "192.0.2.3", "actionType": "successfulLogin", "workspacesClientProductName": "WorkSpacesWebClient", "loginTime": "2023-04-05T16:13:37.603Z", "clientPlatform": "Windows", "directoryId": "domain/d-123456789", "clientVersion": "5.7.0.3472", "workspaceId": "ws-xyskdga" } } Event-specific fields clientIpAddress The WAN IP address of the client application. For PCoIP zero clients, this is the IP address of the Teradici auth client. actionType This value is always successfulLogin. workspacesClientProductName The following values are case-sensitive. • WorkSpaces Desktop client — Windows, macOS, and Linux clients • Amazon WorkSpaces Mobile client — iOS client • WorkSpaces Mobile Client — Android clients • WorkSpaces Chrome Client — Chromebook client • WorkSpacesWebClient — Web Access client • AmazonWorkSpacesThinClient — Amazon WorkSpaces Thin Client device • Teradici PCoIP Zero Client, Teradici PCoIP Desktop Client, or Dell Wyse PCoIP Client — Zero Client loginTime The time at which the user logged in to the WorkSpace. Monitor using Amazon EventBridge 498 Administration Guide Amazon WorkSpaces clientPlatform • Android • Chrome • iOS • Linux • OSX • Windows • Teradici PCoIP Zero Client and Tera2 • Web directoryId The identifier of the directory for the WorkSpace. You must prepend the directory identifier with domain/. For example, "domain/d-123456789". clientVersion The client version used to connect to WorkSpaces. workspaceId The identifier of the WorkSpace. Create a rule to handle WorkSpaces events Use the following procedure to create a rule to handle the WorkSpaces events. Prerequisite To receive email notifications, create an Amazon Simple Notification Service topic. 1. Open the Amazon SNS console at https://console.aws.amazon.com/sns/v3/home. 2. In the navigation pane, choose Topics. 3. Choose Create topic. 4. 5. For Type, choose Standard. For Name, enter a name for your topic. Monitor using Amazon EventBridge 499 Amazon WorkSpaces 6. Choose Create topic. 7. Choose Create subscription. Administration Guide 8. 9. For Protocol, choose Email. For Endpoint, enter the email address that receives the notifications. 10. Choose Create subscription. 11. You'll receive an email message with the following subject line: AWS Notification - Subscription Confirmation. Follow the directions to confirm your subscription. To create a rule to handle WorkSpaces events 1. Open the Amazon EventBridge console at https://console.aws.amazon.com/events/. 2. Choose Create rule. 3. 4. For Name, enter a name for your rule. For Rule type, choose Rule with an event pattern. 5. Choose Next. 6. For Event pattern, do the following: a. b. c. For Event source, choose AWS services. For AWS service, choose WorkSpaces. For Event type, choose WorkSpaces Access. d. By default, we send notifications for every event. If you prefer, you can create an event pattern that filters events for specific clients or workspaces. 7. Choose Next. 8. Specify a target as follows: a. b. c. For Target types, choose AWS service. For Select a target, choose SNS topic. For Topic, choose the SNS topic that you created for notifications. 9. Choose Next. 10. (Optional) Add tags to your rule. 11. Choose Next. 12. Choose Create rule. Monitor using Amazon EventBridge 500 Amazon WorkSpaces Administration Guide Understanding AWS sign-in events for smart card users AWS CloudTrail logs successful and unsuccessful sign-in events for smart card users. This includes sign-in events that are captured each time a user is prompted to solve a specific credential challenge or factor, as well as the status of that particular credential verification request. A user is signed in only after completing all required credential challenges, which results in a UserAuthentication event being logged. The following table captures each of the sign-in CloudTrail event names and their purposes. Event name Event purpose Credentia lChallenge Notifies that AWS sign-in has requested that the user solve a specific credential challenge and specifies the CredentialType that is required (for example, SMARTCARD). Credentia Notifies that the user has attempted to solve a specific Credentia lVerification lChallenge succeeded or failed. request, and specifies whether that credential has UserAuthe ntication Notifies that all authentication requirements that the user was challenged with have been successfully completed and that the user was successfully signed in. When users fail to successfully complete the required credential challenges, no UserAuthentication logged. event is The following table captures additional useful event data fields contained within specific sign-in CloudTrail events. Event name AuthWorkf lowID Event purpose Sign-in event applicabi lity Example values Correlates all events emitted across an entire sign-in sequence. For each user sign-in, CredentialChalleng e , Credentia lVerification , UserAuthentication "AuthWorkflowID": "9de74b32-8362-4a01- a524-de21df59fd83" Understanding AWS sign-in events for smart card users 501 Amazon WorkSpaces Event name Event purpose |
workspaces-ag-162 | workspaces-ag.pdf | 162 | authentication requirements that the user was challenged with have been successfully completed and that the user was successfully signed in. When users fail to successfully complete the required credential challenges, no UserAuthentication logged. event is The following table captures additional useful event data fields contained within specific sign-in CloudTrail events. Event name AuthWorkf lowID Event purpose Sign-in event applicabi lity Example values Correlates all events emitted across an entire sign-in sequence. For each user sign-in, CredentialChalleng e , Credentia lVerification , UserAuthentication "AuthWorkflowID": "9de74b32-8362-4a01- a524-de21df59fd83" Understanding AWS sign-in events for smart card users 501 Amazon WorkSpaces Event name Event purpose Sign-in event applicabi lity Example values multiple events can be emitted by AWS sign-in. Administration Guide Credentia lType Notifies that the user has attempted to solve CredentialChalleng e , Credentia CredentialType": "SMARTCARD" (possible a specific Credentia lVerification , UserAuthentication lChallenge and specifies whether request that credential has succeeded or failed. values today: SMARTCARD) LoginTo Notifies that all authentication requireme UserAuthentication "LoginTo": "https:// skylight.local“ nts that the user was challenged with have been successfully completed and that the user was successfu lly signed in. When users fail to successfully complete the required credential challenges, no UserAuthentication event is logged. Example events for AWS sign-in scenarios The following examples show the expected sequence of CloudTrail events for different sign-in scenarios. Contents • Successful sign-in when authenticating with smart card • Failed sign-in when authenticating with only a smart card Understanding AWS sign-in events for smart card users 502 Amazon WorkSpaces Administration Guide Successful sign-in when authenticating with smart card The following sequence of events captures an example of a successful smart card sign-in. CredentialChallenge { "eventVersion": "1.08", "userIdentity": { "type": "Unknown", "principalId": "509318101470", "arn": "", "accountId": "509318101470", "accessKeyId": "" }, "eventTime": "2021-07-30T17:23:29Z", "eventSource": "signin.amazonaws.com", "eventName": "CredentialChallenge", "awsRegion": "us-east-1", "sourceIPAddress": "AWS Internal", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.164 Safari/537.36", "requestParameters": null, "responseElements": null, "additionalEventData": { "AuthWorkflowID": "6602f256-3b76-4977-96dc-306a7283269e", "CredentialType": "SMARTCARD" }, "requestID": "65551a6d-654a-4be8-90b5-bbfef7187d3a", "eventID": "fb603838-f119-4304-9fdc-c0f947a82116", "readOnly": false, "eventType": "AwsServiceEvent", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "509318101470", "serviceEventDetails": { CredentialChallenge": "Success" } } Understanding AWS sign-in events for smart card users 503 Amazon WorkSpaces Administration Guide Successful CredentialVerification { "eventVersion": "1.08", "userIdentity": { "type": "Unknown", "principalId": "509318101470", "arn": "", "accountId": "509318101470", "accessKeyId": "" }, "eventTime": "2021-07-30T17:23:39Z", "eventSource": "signin.amazonaws.com", "eventName": "CredentialVerification", "awsRegion": "us-east-1", "sourceIPAddress": "AWS Internal", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.164 Safari/537.36", "requestParameters": null, "responseElements": null, "additionalEventData": { "AuthWorkflowID": "6602f256-3b76-4977-96dc-306a7283269e", "CredentialType": "SMARTCARD" }, "requestID": "81869203-1404-4bf2-a1a4-3d30aa08d8d5", "eventID": "84c0a2ff-413f-4d0f-9108-f72c90a41b6c", "readOnly": false, "eventType": "AwsServiceEvent", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "509318101470", "serviceEventDetails": { CredentialVerification": "Success" } } Successful UserAuthentication { "eventVersion": "1.08", Understanding AWS sign-in events for smart card users 504 Amazon WorkSpaces Administration Guide "userIdentity": { "type": "Unknown", "principalId": "509318101470", "arn": "", "accountId": "509318101470", "accessKeyId": "" }, "eventTime": "2021-07-30T17:23:39Z", "eventSource": "signin.amazonaws.com", "eventName": "UserAuthentication", "awsRegion": "us-east-1", "sourceIPAddress": "AWS Internal", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.164 Safari/537.36", "requestParameters": null, "responseElements": null, "additionalEventData": { "AuthWorkflowID": "6602f256-3b76-4977-96dc-306a7283269e", "LoginTo": "https://skylight.local", "CredentialType": "SMARTCARD" }, "requestID": "81869203-1404-4bf2-a1a4-3d30aa08d8d5", "eventID": "acc0dba8-8e8b-414b-a52d-6b7cd51d38f6", "readOnly": false, "eventType": "AwsServiceEvent", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "509318101470", "serviceEventDetails": { UserAuthentication": "Success" } } Failed sign-in when authenticating with only a smart card The following sequence of events captures an example of failed smart card sign-in. CredentialChallenge { "eventVersion": "1.08", Understanding AWS sign-in events for smart card users 505 Amazon WorkSpaces Administration Guide "userIdentity": { "type": "Unknown", "principalId": "509318101470", "arn": "", "accountId": "509318101470", "accessKeyId": "" }, "eventTime": "2021-07-30T17:23:06Z", "eventSource": "signin.amazonaws.com", "eventName": "CredentialChallenge", "awaRegion": "us-east-1", "sourceIPAddress": "AWS Internal", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.164 Safari/537.36", "requestParameters": null, "responseElements": null, "additionalEventData": { "AuthWorkflowID": "73dfd26b-f812-4bd2-82e9-0b2abb358cdb", "CredentialType": "SMARTCARD" }, "requestID": "73eb499d-91a8-4c18-9c5d-281fd45ab50a", "eventID": "f30a50ec-71cf-415a-a5ab-e287edc800da", "readOnly": false, "eventType": "AwsServiceEvent", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "509318101470", "serviceEventDetails": { CredentialChallenge": "Success" } } Failed CredentialVerification { "eventVersion": "1.08", "userIdentity": { "type": "Unknown", "principalId": "509318101470", "arn": "", "accountId": "509318101470", Understanding AWS sign-in events for smart card users 506 Amazon WorkSpaces Administration Guide "accessKeyId": "" }, "eventTime": "2021-07-30T17:23:13Z", "eventSource": "signin.amazonaws.com", "eventName": "CredentialVerification", "awsRegion": "us-east-1", "sourceIPAddress": "AWS Internal", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.164 Safari/537.36", "requestParameters": null, "responseElements": null, "additionalEventData": { "AuthWorkflowID": "73dfd26b-f812-4bd2-82e9-0b2abb358cdb", "CredentialType": "SMARTCARD" }, "requestID": "051ca316-0b0d-4d38-940b-5fe5794fda03", "eventID": "4e6fbfc7-0479-48da-b7dc-e875155a8177", "readOnly": false, "eventType": "AwsServiceEvent", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "509318101470", "serviceEventDetails": { CredentialVerification": "Failure" } } Create custom CloudWatch dashboards using AWS CloudFormation templates AWS provides AWS CloudFormation templates that you can use to create custom CloudWatch dashboards for WorkSpaces. Choose from the following AWS CloudFormation template options to create custom dashboards for your WorkSpaces in the AWS CloudFormation console. Considerations before getting started Consider the following before you get started with custom CloudWatch dashboards: • Create your dashboards in the same AWS Region as the deployed WorkSpaces you want to monitor. Create custom CloudWatch dashboards 507 Amazon WorkSpaces Administration Guide |
workspaces-ag-163 | workspaces-ag.pdf | 163 | false, "eventType": "AwsServiceEvent", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "509318101470", "serviceEventDetails": { CredentialVerification": "Failure" } } Create custom CloudWatch dashboards using AWS CloudFormation templates AWS provides AWS CloudFormation templates that you can use to create custom CloudWatch dashboards for WorkSpaces. Choose from the following AWS CloudFormation template options to create custom dashboards for your WorkSpaces in the AWS CloudFormation console. Considerations before getting started Consider the following before you get started with custom CloudWatch dashboards: • Create your dashboards in the same AWS Region as the deployed WorkSpaces you want to monitor. Create custom CloudWatch dashboards 507 Amazon WorkSpaces Administration Guide • You can also create custom dashboards using the CloudWatch console. • A cost might be associated with custom CloudWatch dashboards. For information about pricing, see Amazon CloudWatch Pricing Help Desk dashboard The Help Desk dashboard displays the following metrics for a specific WorkSpace: • CPU usage • Memory usage • In-session latency • Root volume • User volume • Packet loss • Disk usage Following is an example of the Help Desk dashboard. Complete the following procedure to create a custom dashboard in CloudWatch using AWS CloudFormation. Create custom CloudWatch dashboards 508 Amazon WorkSpaces Administration Guide 1. Open the Create Stack page in the AWS CloudFormation console. This link opens the page with the Amazon S3 bucket location of the Help Desk custom CloudWatch dashboard template pre- populated. 2. Review the default selections on the Create Stack page. Note that the Amazon S3 URL field is pre-populated with the Amazon S3 bucket location of the AWS CloudFormation template. 3. Choose Next. 4. In the Stack name text box, enter the name of the stack. The stack name is an identifier that helps you find a particular stack from a list of stacks. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. 5. In the DashboardName text box, enter the name you want to give your dashboard. The dashboard name can contain only alphanumerics, dash (–), and underscore (_). 6. Choose Next. 7. Review the default selections on the Configure stack options page, and choose Next. 8. Scroll down to Transforms might require access capabilities and check the boxes for acknowledgement. Then choose Submit to create the stack and the custom CloudWatch dashboard. Important A cost might be associated with custom CloudWatch dashboards. For information about pricing, see Amazon CloudWatch Pricing 9. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 10. In the left navigation bar, choose Dashboards. 11. Under Custom Dashboards, choose the dashboard with the dashboard name you entered earlier in this procedure. 12. Using the Help Desk sample template, enter the UserName of the WorkSpace to monitor its data. Connection Insights dashboard The Connection Insights dashboard displays the client versions, platforms, and IP addresses that are connected to your WorkSpaces. This dashboard allows you to better understand how your users Create custom CloudWatch dashboards 509 Amazon WorkSpaces Administration Guide are connecting so that you can proactively notify your users using an outdated client. The dynamic variables allows you to monitor the details of IP addresses or specific directories. Following is an example of the Connection Insights dashboard. Complete the following procedure to create a custom dashboard in CloudWatch using AWS CloudFormation. 1. Open the Create Stack page in the AWS CloudFormation console. This link opens the page with the Amazon S3 bucket location of the Connection Insights custom CloudWatch dashboard template pre-populated. 2. Review the default selections on the Create Stack page. Note that the Amazon S3 URL field is pre-populated with the Amazon S3 bucket location of the AWS CloudFormation template. 3. Choose Next. 4. In the Stack name text box, enter the name of the stack. Create custom CloudWatch dashboards 510 Amazon WorkSpaces Administration Guide The stack name is an identifier that helps you find a particular stack from a list of stacks. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. 5. In the DashboardName text box, enter the name you want to give your dashboard. Enter other relevant CloudWatch access group setup information. The dashboard name can contain only alphanumerics, dash (–), and underscore (_). 6. Under LogRetention, enter the number of days you want to retain your LogGroup for. 7. Under SetupEventBridge, choose whether you want to deploy the EventBridge rule to get WorkSpaces access logs. 8. Under WorkSpaceAccessLogsName, enter the name of the CloudWatch LogGroup that has the WorkSpaces access logs. 9. Choose Next. 10. Review the default selections on the Configure stack options page, and choose Next. 11. Scroll down to Transforms might require access capabilities and check the boxes for acknowledgement. Then choose Submit to create the stack and |
workspaces-ag-164 | workspaces-ag.pdf | 164 | The dashboard name can contain only alphanumerics, dash (–), and underscore (_). 6. Under LogRetention, enter the number of days you want to retain your LogGroup for. 7. Under SetupEventBridge, choose whether you want to deploy the EventBridge rule to get WorkSpaces access logs. 8. Under WorkSpaceAccessLogsName, enter the name of the CloudWatch LogGroup that has the WorkSpaces access logs. 9. Choose Next. 10. Review the default selections on the Configure stack options page, and choose Next. 11. Scroll down to Transforms might require access capabilities and check the boxes for acknowledgement. Then choose Submit to create the stack and the custom CloudWatch dashboard. Important A cost might be associated with custom CloudWatch dashboards. For information about pricing, see Amazon CloudWatch Pricing 12. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 13. In the left navigation bar, choose Dashboards. 14. Under Custom Dashboards, choose the dashboard with the dashboard name you entered earlier in this procedure. 15. You can now monitor you WorkSpace's data using the Connection Insights dashboard. Internet Monitoring dashboard The Internet Monitoring dashboard displays details about the Internet Service Provider (ISP) that your users are using to join their WorkSpaces instances. It provides details on the city, state, ASN, network name, number of connected WorkSpaces, performance, and experience scores. You can Create custom CloudWatch dashboards 511 Amazon WorkSpaces Administration Guide also use specific IP addresses to get the details of your users connecting from a specific location. Deploy CloudWatch internet monitor to get ISP data information. For more information, see Using Amazon CloudWatch Internet Monitor. Following is an example of the Internet Monitoring dashboard. To create a custom dashboard in CloudWatch using AWS CloudFormation Note Before creating a custom dashboard, make sure you create an Internet Monitor with CloudWatch Internet Monitor. For more information, see Creating a monitor in Amazon CloudWatch Internet Monitor using the console 1. Open the Create Stack page in the AWS CloudFormation console. This link opens the page with the Amazon S3 bucket location of the Internet Monitoring custom CloudWatch dashboard template pre-populated. 2. Review the default selections on the Create Stack page. Note that the Amazon S3 URL field is pre-populated with the Amazon S3 bucket location of the AWS CloudFormation template. 3. Choose Next. 4. In the Stack name text box, enter the name of the stack. Create custom CloudWatch dashboards 512 Amazon WorkSpaces Administration Guide The stack name is an identifier that helps you find a particular stack from a list of stacks. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters. 5. In the DashboardName text box, enter the name you want to give your dashboard. Enter other relevant CloudWatch access group setup information. The dashboard name can contain only alphanumerics, dash (–), and underscore (_). 6. Under ResourcesToMonitor, enter the directory ID of the directory that you've enabled internet monitoring for. 7. Under MonitorName, enter the name of the internet monitor you want to use. 8. Choose Next. 9. Review the default selections on the Configure stack options page, and choose Next. 10. Scroll down to Transforms might require access capabilities and check the boxes for acknowledgement. Then choose Submit to create the stack and the custom CloudWatch dashboard. Important A cost might be associated with custom CloudWatch dashboards. For information about pricing, see Amazon CloudWatch Pricing 11. Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/. 12. In the left navigation bar, choose Dashboards. 13. Under Custom Dashboards, choose the dashboard with the dashboard name you entered earlier in this procedure. 14. You can now monitor you WorkSpace's data using the Internet Monitoring dashboard. Business continuity for WorkSpaces Personal Amazon WorkSpaces is built on the AWS global infrastructure, which is organized into AWS Regions and Availability Zones. These Regions and Availability Zones provide resiliency in terms of both physical isolation and data redundancy. For more information, see Resilience in Amazon WorkSpaces. Business continuity 513 Amazon WorkSpaces Administration Guide Amazon WorkSpaces also provides cross-Region redirection, a feature that works with your Domain Name System (DNS) routing policies to redirect your WorkSpaces users to alternative WorkSpaces when their primary WorkSpaces aren't available. For example, by using DNS failover routing policies, you can connect your users to WorkSpaces in your specified failover Region when they can't access their WorkSpaces in the primary Region. You can use cross-Region redirection to achieve regional resiliency and high availability. You can also use it for other purposes, such as traffic distribution or providing alternative WorkSpaces during maintenance periods. If you use Amazon Route 53 for your DNS configuration, you can take advantage of health checks that monitor Amazon CloudWatch alarms. Amazon WorkSpaces Multi-Region Resilience provides automated, redundant virtual desktop infrastructure in a secondary WorkSpace Region and streamlines the process of redirecting users to |
workspaces-ag-165 | workspaces-ag.pdf | 165 | routing policies, you can connect your users to WorkSpaces in your specified failover Region when they can't access their WorkSpaces in the primary Region. You can use cross-Region redirection to achieve regional resiliency and high availability. You can also use it for other purposes, such as traffic distribution or providing alternative WorkSpaces during maintenance periods. If you use Amazon Route 53 for your DNS configuration, you can take advantage of health checks that monitor Amazon CloudWatch alarms. Amazon WorkSpaces Multi-Region Resilience provides automated, redundant virtual desktop infrastructure in a secondary WorkSpace Region and streamlines the process of redirecting users to the secondary Region when the primary Region is unreachable due to outages. You can use WorkSpaces Multi-Region Resilience with cross-Region redirection to deploy redundant virtual desktop infrastructure in a secondary WorkSpace Region and design a cross-Region failover strategy in preparation for disruptive events. You can also use this solution for other purposes, such as traffic distribution or providing alternative WorkSpaces during maintenance periods. If you use Route 53 for your DNS configuration, you can take advantage of health checks that monitor CloudWatch alarms. Contents • Cross-Region redirection for WorkSpaces Personal • Multi-Region Resilience for WorkSpaces Personal Cross-Region redirection for WorkSpaces Personal With the cross-Region redirection feature in Amazon WorkSpaces, you can use a fully qualified domain name (FQDN) as the registration code for your WorkSpaces. Cross-Region redirection works with your Domain Name System (DNS) routing policies to redirect your WorkSpaces users to alternative WorkSpaces when their primary WorkSpaces aren't available. For example, by using DNS failover routing policies, you can connect your users to WorkSpaces in your specified failover AWS Region when they can't access their WorkSpaces in the primary Region. You can use cross-Region redirection along with your DNS failover routing policies to achieve regional resiliency and high availability. You can also use this feature for other purposes, such as traffic distribution or providing alternative WorkSpaces during maintenance periods. If you Cross-Region redirection 514 Amazon WorkSpaces Administration Guide use Amazon Route 53 for your DNS configuration, you can take advantage of health checks that monitor Amazon CloudWatch alarms. To use this feature, you must set up WorkSpaces for your users in two (or more) AWS Regions. You must also create special FQDN-based registration codes called connection aliases. These connection aliases replace Region-specific registration codes for your WorkSpaces users. (The Region-specific registration codes remain valid; however, for cross-Region redirection to work, your users must use the FQDN instead as their registration code.) To create a connection alias, you specify a connection string, which is your FQDN, such as www.example.com or desktop.example.com. To use this domain for cross-Region redirection, you must register it with a domain registrar and configure the DNS service for your domain. After you've created your connection aliases, you associate them with your WorkSpaces directories in different Regions to create association pairs. Each association pair has a primary Region and one or more failover Regions. If an outage occurs in the primary Region, your DNS failover routing policies redirect your WorkSpaces users to the WorkSpaces that you've set up for them in the failover Region. To designate your primary and failover Regions, you define the Region priority (either primary or secondary) when configuring your DNS failover routing policies. Contents • Prerequisites • Limitations • Step 1: Create connection aliases • (Optional) Step 2: Share a connection alias with another account • Step 3: Associate connection aliases with directories in each Region • Step 4: Configure your DNS service and set up DNS routing policies • Step 5: Send the connection string to your WorkSpaces users • Cross-Region Redirection architecture diagram • Initiate cross-Region redirection • What happens during cross-Region redirection • Disassociate a connection alias from a directory • Unshare a connection alias • Delete a connection alias Cross-Region redirection 515 Amazon WorkSpaces Administration Guide • IAM permissions to associate and disassociate connection aliases • Security considerations if you stop using cross-Region redirection Prerequisites • You must own and register the domain that you want to use as the FQDN in your connection aliases. If you're not already using another domain registrar, you can use Amazon Route 53 to register your domain. For more information, see Registering domain names using Amazon Route 53 in the Amazon Route 53 Developer Guide. Important You must have all necessary rights to use any domain name that you use in conjunction with Amazon WorkSpaces. You agree that the domain name does not violate or infringe on the legal rights of any third party or otherwise violate applicable law. The total length of your domain name can't exceed 255 characters. For more information about domain names, see DNS domain name format in the Amazon Route 53 Developer Guide. Cross-Region redirection works with both public domain names and domain names in private DNS zones. |
workspaces-ag-166 | workspaces-ag.pdf | 166 | names using Amazon Route 53 in the Amazon Route 53 Developer Guide. Important You must have all necessary rights to use any domain name that you use in conjunction with Amazon WorkSpaces. You agree that the domain name does not violate or infringe on the legal rights of any third party or otherwise violate applicable law. The total length of your domain name can't exceed 255 characters. For more information about domain names, see DNS domain name format in the Amazon Route 53 Developer Guide. Cross-Region redirection works with both public domain names and domain names in private DNS zones. If you're using a private DNS zone, you must provide a virtual private network (VPN) connection to the virtual private cloud (VPC) that contains your WorkSpaces. If your WorkSpaces users attempt to use a private FQDN from the public internet, the WorkSpaces client applications return the following error message: "We're unable to register the WorkSpace because of a DNS server issue. Contact your administrator for help." • You must set up your DNS service and configure the necessary DNS routing policies. Cross- Region redirection works in conjunction with your DNS routing policies to redirect your WorkSpaces users as needed. • In each primary and failover Region where you want to set up cross-Region redirection, create WorkSpaces for your users. Make sure that you use the same usernames in each WorkSpaces directory in each Region. To keep your Active Directory user data in sync, we recommend using AD Connector to point to the same Active Directory in each Region where you've set up WorkSpaces for your users. For more information about creating WorkSpaces, see Launch WorkSpaces. Cross-Region redirection 516 Amazon WorkSpaces Administration Guide Important If you configure your AWS Managed Microsoft AD directory for multi-Region replication, only the directory in the primary Region can be registered for use with Amazon WorkSpaces. Attempts to register the directory in a replicated Region for use with Amazon WorkSpaces will fail. Multi-Region replication with AWS Managed Microsoft AD isn't supported for use with Amazon WorkSpaces within replicated Regions. When you've finished setting up cross-Region redirection, you must make sure your WorkSpaces users are using the FQDN-based registration code instead of the Region-based registration code (for example, WSpdx+ABC12D) for their primary Region. To do this, you must send them an email with the FQDN connection string by using the procedure in Step 5: Send the connection string to your WorkSpaces users. Note If you create your users in the WorkSpaces console instead of creating them in Active Directory, WorkSpaces automatically sends an invitation email to your users with a Region-based registration code whenever you launch a new WorkSpace. This means that when you set up WorkSpaces for your users in the failover Region, your users will also automatically receive emails for these failover WorkSpaces. You will need to instruct your users to ignore emails with Region-based registration codes. Limitations • Cross-Region redirection doesn't automatically check whether connections to the primary Region have failed and then fails your WorkSpaces over to another Region. In other words, automatic failover doesn't occur. To implement an automatic failover scenario, you must use some other mechanism in conjunction with cross-Region redirection. For example, you can use an Amazon Route 53 failover DNS routing policy paired with a Route 53 health check that monitors a CloudWatch alarm in the primary Region. If the CloudWatch alarm in the primary Region is triggered, your DNS failover routing policy then redirects your WorkSpaces users to the WorkSpaces that you've set up for them in the failover Region. Cross-Region redirection 517 Amazon WorkSpaces Administration Guide • Cross-Region redirection is supported only on version 3.0.9 or later of the Linux, macOS, and Windows WorkSpaces client applications. You can also use cross-Region redirection with Web Access. • Cross-Region redirection is available in all AWS Regions where Amazon WorkSpaces is available, except for the AWS GovCloud (US) Regions and the China (Ningxia) Region. Step 1: Create connection aliases Using the same AWS account, create connection aliases in each primary and failover Region where you want to set up cross-Region redirection. To create a connection alias 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the upper-right corner of the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection, choose Create connection alias. 5. For Connection string, enter an FQDN, such as www.example.com or desktop.example.com. A connection string can be a maximum of 255 characters. It can include only letters (A-Z and a-z), numbers (0-9), and the following characters: .- Important After you create a connection string, it is always associated with your AWS account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. |
workspaces-ag-167 | workspaces-ag.pdf | 167 | the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection, choose Create connection alias. 5. For Connection string, enter an FQDN, such as www.example.com or desktop.example.com. A connection string can be a maximum of 255 characters. It can include only letters (A-Z and a-z), numbers (0-9), and the following characters: .- Important After you create a connection string, it is always associated with your AWS account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account. 6. (Optional) Under Tags, specify any tags that you want to associate with your connection alias. 7. Choose Create connection alias. 8. Repeat these steps, but in Step 2, be sure to select the failover Region for your WorkSpaces. If you have more than one failover Region, repeat these steps for each failover Region. Be sure to use the same AWS account to create the connection alias in each failover Region. Cross-Region redirection 518 Amazon WorkSpaces Administration Guide (Optional) Step 2: Share a connection alias with another account You can share a connection alias with one other AWS account in the same AWS Region. Sharing a connection alias with another account gives that account permission to associate or disassociate that alias with a directory owned by that account in the same Region only. Only the account that owns a connection alias can delete the alias. Note A connection alias can be associated with only one directory per AWS Region. If you share a connection alias with another AWS account, only one account (your account or the shared account) can associate the alias with a directory in that Region. To share a connection alias with another AWS account 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the upper-right corner of the console, select the AWS Region where you want to share the connection alias with another AWS account. 3. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string, and then choose Actions, Share/unshare connection alias. You can also share an alias from the details page for your connection alias. To do so, under Shared account, choose Share connection alias. 5. On the Share/unshare connection alias page, under Share with an account, enter the AWS account ID that you want to share your connection alias with in this AWS Region. 6. Choose Share. Step 3: Associate connection aliases with directories in each Region Associating the same connection alias with a WorkSpaces directory in two or more Regions creates an association pair between the directories. Each association pair has a primary Region and one or more failover Regions. For example, if your primary Region is the US West (Oregon) Region, you can pair your WorkSpaces directory in the US West (Oregon) Region with a WorkSpaces directory in the US East (N. Virginia) Cross-Region redirection 519 Amazon WorkSpaces Administration Guide Region. If an outage occurs in the primary Region, cross-Region redirection works in conjunction with your DNS failover routing policies and any health checks that you've put in place on the US West (Oregon) Region to redirect your users to the WorkSpaces you've set up for them in the US East (N. Virginia) Region. For more information about the cross-Region redirection experience, see What happens during cross-Region redirection. Note If your WorkSpaces users are located a significant distance from the failover Region (for example, thousands of miles away), their WorkSpaces experience might be less responsive than usual. To check the round-trip time (RTT) to the various AWS Regions from your location, use the Amazon WorkSpaces Connection Health Check. To associate a connection alias with a directory You can associate a connection alias with only one directory per AWS Region. If you have shared a connection alias with another AWS account, only one account (your account or the shared account) can associate the alias with a directory in that Region. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the upper-right corner of the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string, and then choose Actions, Associate/disassociate. You can also associate a connection alias with a directory from the details page for your connection alias. To do so, under Associated directory, choose Associate directory. 5. On the Associate/disassociate page, Under Associate to a directory, select the directory that you want to associate your connection alias with in this AWS Region. Note If you configure your AWS Managed Microsoft AD directory for multi-Region replication, only the directory in the primary Region can be used with Amazon WorkSpaces. Attempts to use the |
workspaces-ag-168 | workspaces-ag.pdf | 168 | choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string, and then choose Actions, Associate/disassociate. You can also associate a connection alias with a directory from the details page for your connection alias. To do so, under Associated directory, choose Associate directory. 5. On the Associate/disassociate page, Under Associate to a directory, select the directory that you want to associate your connection alias with in this AWS Region. Note If you configure your AWS Managed Microsoft AD directory for multi-Region replication, only the directory in the primary Region can be used with Amazon WorkSpaces. Attempts to use the directory in a replicated Region with Amazon Cross-Region redirection 520 Amazon WorkSpaces Administration Guide WorkSpaces will fail. Multi-Region replication with AWS Managed Microsoft AD isn't supported for use with Amazon WorkSpaces within replicated Regions. 6. Choose Associate. 7. Repeat these steps, but in Step 2, be sure to select the failover Region for your WorkSpaces. If you have more than one failover Region, repeat these steps for each failover Region. Be sure to associate the same connection alias with a directory in each failover Region. Step 4: Configure your DNS service and set up DNS routing policies After you've created your connection aliases and your connection alias association pairs, you can then configure the DNS service for the domain that you've used in your connection strings. You can use any DNS service provider for this purpose. If you don't already have a preferred DNS service provider, you can use Amazon Route 53. For more information, see Configuring Amazon Route 53 as your DNS service in the Amazon Route 53 Developer Guide. After you've configured the DNS service for your domain, you must set up the DNS routing policies that you want to use for cross-Region redirection. For example, you can use Amazon Route 53 health checks to determine whether your users can connect to their WorkSpaces in a particular Region. If your users can't connect, you can use a DNS failover policy to route your DNS traffic from one Region to another. For more information about choosing your DNS routing policy, see Choosing a routing policy in the Amazon Route 53 Developer Guide. For more information about Amazon Route 53 health checks, see How Amazon Route 53 checks the health of your resources in the Amazon Route 53 Developer Guide. When you're setting up your DNS routing policies, you will need the connection identifier for the association between the connection alias and the WorkSpaces directory in the primary Region. You will also need the connection identifier for the association between the connection alias and the WorkSpaces directory in your failover Region or Regions. Note The connection identifier is not the same as the connection alias ID. The connection alias ID starts with wsca-. Cross-Region redirection 521 Amazon WorkSpaces Administration Guide To find the connection identifier for a connection alias association 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the upper-right corner of the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string text (the FQDN) to view the connection alias details page. 5. On the details page for your connection alias, under Associated directory, make note of the value that's displayed for Connection identifier. 6. Repeat these steps, but in Step 2, be sure to select the failover Region for your WorkSpaces. If you have more than one failover Region, repeat these steps to find the connection identifier for each failover Region. Example: To set up a DNS failover routing policy using Route 53 The following example sets up a public hosted zone for your domain. However, you can set up a public or a private hosted zone. For more information about setting up a hosted zone, see Working with hosted zones in the Amazon Route 53 Developer Guide. This example also uses a failover routing policy. You can use other routing policy types for your cross-Region redirection strategy. For more information about choosing your DNS routing policy, see Choosing a routing policy in the Amazon Route 53 Developer Guide. When you're setting up a failover routing policy in Route 53, a health check is required for the primary Region. For more information about creating a health check in Route 53, see Creating Amazon Route 53 health checks and configuring DNS failover and Creating, updating, and deleting health checks in the Amazon Route 53 Developer Guide. If you want to use an Amazon CloudWatch alarm with your Route 53 health check, you'll also need to set up a CloudWatch alarm to monitor the resources in your primary Region. For more information about CloudWatch, see What Is Amazon CloudWatch? in the Amazon CloudWatch User Guide. For more information about how Route 53 uses |
workspaces-ag-169 | workspaces-ag.pdf | 169 | health check is required for the primary Region. For more information about creating a health check in Route 53, see Creating Amazon Route 53 health checks and configuring DNS failover and Creating, updating, and deleting health checks in the Amazon Route 53 Developer Guide. If you want to use an Amazon CloudWatch alarm with your Route 53 health check, you'll also need to set up a CloudWatch alarm to monitor the resources in your primary Region. For more information about CloudWatch, see What Is Amazon CloudWatch? in the Amazon CloudWatch User Guide. For more information about how Route 53 uses CloudWatch alarms in its health checks, see How Route 53 determines the status of health checks that monitor CloudWatch alarms and Monitoring a CloudWatch alarm in the Amazon Route 53 Developer Guide. To set up a DNS failover routing policy in Route 53, you first need to create a hosted zone for your domain. Cross-Region redirection 522 Amazon WorkSpaces Administration Guide 1. Open the Route 53 console at https://console.aws.amazon.com/route53/. 2. In the navigation pane, choose Hosted zones, and then choose Create hosted zone. 3. On the Created hosted zone page, enter your domain name (such as example.com) under Domain name. 4. Under Type, choose Public hosted zone. 5. Choose Create hosted zone. Then create a health check for your primary Region. 1. Open the Route 53 console at https://console.aws.amazon.com/route53/. 2. In the navigation pane, choose Health checks, and then choose Create health check. 3. On the Configure health check page, enter a name for your health check. 4. For What to monitor, select either Endpoint, Status of other health checks (calculated health check), or State of CloudWatch alarm. 5. Depending on what you've selected in the prior step, configure your health check, and then choose Next. 6. On the Get notified when health check fails page, for Create alarm, choose Yes or No. 7. Choose Create health check. After you've created your health check, you can create the DNS failover records. 1. Open the Route 53 console at https://console.aws.amazon.com/route53/. 2. In the navigation pane, choose Hosted zones. 3. On the Hosted zones page, select your domain name. 4. On the details page for your domain name, choose Create record. 5. On the Choose routing policy page, select Failover, and then choose Next. 6. On the Configure records page, under Basic configuration, for Record name, enter your subdomain name. For example, if your FQDN is desktop.example.com, enter desktop. Cross-Region redirection 523 Amazon WorkSpaces Note Administration Guide If you want to use the root domain, leave Record name blank. However, we recommend using a subdomain, such as desktop or workspaces, unless you've set up the domain solely for use with your WorkSpaces. 7. For Record type, select TXT – Used to verify email senders and for application-specific values. 8. Leave the TTL seconds settings at the default. 9. Under Failover records to add to your_domain_name, choose Define failover record. Now you need to set up the failover records for your primary and failover Regions. Example: To set up the failover record for your primary Region 1. In the Define failover record dialog box, for Value/route traffic to, select IP address or another value depending on the record type. 2. A box opens for you to enter your sample text entries. Enter the connection identifier for the connection alias association for your primary Region. For Failover record type, choose Primary. For Health check, select a health check that you've created for your primary Region. For Record ID, enter a description to identify this record. 3. 4. 5. 6. Choose Define failover record. Your new failover record appears under Failover records to add to your_domain_name. Example: To set up the failover record for your failover Region 1. Under Failover records to add to your_domain_name, choose Define failover record. 2. In the Define failover record dialog box, for Value/route traffic to, select IP address or another value depending on the record type. 3. A box opens for you to enter your sample text entries. Enter the connection identifier for the connection alias association for your failover Region. For Failover record type, choose Secondary. (Optional) For Health check, enter a health check that you've created for your failover Region. 4. 5. Cross-Region redirection 524 Amazon WorkSpaces Administration Guide 6. For Record ID, enter a description to identify this record. 7. Choose Define failover record. Your new failover record appears under Failover records to add to your_domain_name. If the health check that you've set up for your primary Region fails, your DNS failover routing policy redirects your WorkSpaces users to your failover Region. Route 53 continues to monitor the health check for your primary Region, and when the health check for your primary Region no longer fails, Route 53 automatically redirects your WorkSpaces users back to their |
workspaces-ag-170 | workspaces-ag.pdf | 170 | your failover Region. 4. 5. Cross-Region redirection 524 Amazon WorkSpaces Administration Guide 6. For Record ID, enter a description to identify this record. 7. Choose Define failover record. Your new failover record appears under Failover records to add to your_domain_name. If the health check that you've set up for your primary Region fails, your DNS failover routing policy redirects your WorkSpaces users to your failover Region. Route 53 continues to monitor the health check for your primary Region, and when the health check for your primary Region no longer fails, Route 53 automatically redirects your WorkSpaces users back to their WorkSpaces in the primary Region. For more information about creating DNS records, see Creating records by using the Amazon Route 53 console in the Amazon Route 53 Developer Guide. For more information about configuring DNS TXT records, see TXT record type in the Amazon Route 53 Developer Guide. Step 5: Send the connection string to your WorkSpaces users To make sure your users' WorkSpaces will be redirected as needed during an outage, you must send the connection string (FQDN) to your users. If you've already issued Region-based registration codes (for example, WSpdx+ABC12D) to your WorkSpaces users, those codes remain valid. However, for cross-Region redirection to work, your WorkSpaces users must use the connection string as their registration code when registering their WorkSpaces in the WorkSpaces client application. Important If you create your users in the WorkSpaces console instead of creating them in Active Directory, WorkSpaces automatically sends an invitation email to your users with a Region- based registration code (for example, WSpdx+ABC12D) whenever you launch a new WorkSpace. Even if you've already set up cross-Region redirection, the invitation email that's automatically sent for new WorkSpaces contains this Region-based registration code instead of your connection string. To make sure your WorkSpaces users are using the connection string instead of the Region- based registration code, you must send them another email with the connection string by using the procedure below. To send the connection string to your WorkSpaces users 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. Cross-Region redirection 525 Amazon WorkSpaces Administration Guide 2. 3. In the upper-right corner of the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose WorkSpaces. 4. On the WorkSpaces page, use the search box to search for a user that you want to send an invitation to, and then select the corresponding WorkSpace from the search results. You can select only one WorkSpace at a time. 5. Choose Actions, Invite User. 6. On the Invite Users to Their WorkSpaces page, you will see an email template to send to your users. 7. (Optional) If there is more than one connection alias associated with your WorkSpaces directory, select the connection string that you want your users to use from the Connection alias string list. The email template updates to display the string that you've chosen. 8. Copy the email template text and paste it into an email to the users using your own email application. In your email application, you can modify the text as needed. When the invitation email is ready, send it to your users. Cross-Region Redirection architecture diagram The following diagram describes the deployment process of cross-Region redirection. Note Cross-Region redirection only facilitates cross-Region failover and fallback. It doesn't facilitate creating and maintaining WorkSpaces in the secondary Region and doesn't allow cross-Region data replication. WorkSpaces in both the primary and secondary Regions should be managed separately. Initiate cross-Region redirection In the event of an outage, you can either update the DNS records manually or use automated routing policies based on health checks, which determine the failover Region. We recommend following the disaster recovery mechanisms outlined in Creating Disaster Recovery Mechanisms Using Amazon Route 53. Cross-Region redirection 526 Amazon WorkSpaces Administration Guide What happens during cross-Region redirection During Region failover, your WorkSpaces users are disconnected from their WorkSpaces in the primary Region. When they attempt to reconnect, they receive the following error message: We can't connect to your WorkSpace. Check your network connection, and then try again. Your users are then prompted to log in again. If they're using the FQDN as their registration code, when they log in again, your DNS failover routing policies redirect them to the WorkSpaces that you've set up for them in the failover Region. Note In some cases, users might be unable to reconnect when they log in again. If this behavior occurs, they must close and restart the WorkSpaces client application, and then try to log in again. Disassociate a connection alias from a directory Only the account that owns a directory can disassociate a connection alias from the directory. If you've shared a connection alias with another account and that account has associated the connection alias with a directory owned by that |
workspaces-ag-171 | workspaces-ag.pdf | 171 | your DNS failover routing policies redirect them to the WorkSpaces that you've set up for them in the failover Region. Note In some cases, users might be unable to reconnect when they log in again. If this behavior occurs, they must close and restart the WorkSpaces client application, and then try to log in again. Disassociate a connection alias from a directory Only the account that owns a directory can disassociate a connection alias from the directory. If you've shared a connection alias with another account and that account has associated the connection alias with a directory owned by that account, that account must be used to disassociate the connection alias from the directory. To disassociate a connection alias from a directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the upper-right corner of the console, select the AWS Region that contains the connection alias that you want to disassociate. 3. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string, and then choose Actions, Associate/disassociate. You can also dissociate a connection alias from the connection alias details page. To do so, under Associated directory, choose Disassociate. 5. On the Associate/disassociate page, choose Disassociate. Cross-Region redirection 527 Amazon WorkSpaces Administration Guide 6. In the dialog box that asks you to confirm the disassociation, choose Disassociate. Unshare a connection alias Only the owner of a connection alias can unshare the alias. If you unshare a connection alias with an account, that account can no longer associate the connection alias with a directory. To unshare a connection alias 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the upper-right corner of the console, select the AWS Region that contains the connection alias that you want to unshare. 3. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string, and then choose Actions, Share/unshare connection alias. You can also unshare a connection alias from the connection alias details page. To do so, under Shared account, choose Unshare. 5. On the Share/unshare connection alias page, choose Unshare. 6. In the dialog box that asks you to confirm unsharing the connection alias, choose Unshare. Delete a connection alias You can delete a connection alias only if it is owned by your account and if it isn't associated with a directory. If you've shared a connection alias with another account and that account has associated the connection alias with a directory owned by that account, that account must first disassociate the connection alias from the directory before you can delete the connection alias. Important After you create a connection string, it is always associated to your AWS account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account. Cross-Region redirection 528 Amazon WorkSpaces Warning Administration Guide If you will no longer be using an FQDN as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security considerations if you stop using cross-Region redirection. To delete a connection alias 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the upper-right corner of the console, select the AWS Region that contains the connection alias that you want to delete. 3. In the navigation pane, choose Account Settings. 4. Under Cross-Region redirection associations, select the connection string, and then choose Delete. You can also delete a connection alias from the connection alias details page. To do so, choose Delete in the upper-right corner of the page. Note If the Delete button is disabled, make sure that you are the owner of the alias, and make sure that the alias isn't associated with a directory. 5. In the dialog box that asks you to confirm deletion, choose Delete. IAM permissions to associate and disassociate connection aliases If you use an IAM user to associate or disassociate connection aliases, the user must have permissions for workspaces:AssociateConnectionAlias and workspaces:DisassociateConnectionAlias. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ Cross-Region redirection 529 Amazon WorkSpaces Administration Guide "workspaces:AssociateConnectionAlias", "workspaces:DisassociateConnectionAlias" ], "Resource": [ "arn:aws:workspaces:us-east-1:123456789012:connectionalias/wsca-a1bcd2efg" ] } ] } Important If you are creating an IAM policy for associating or disassociating connection aliases for accounts that don't own the connection aliases, you cannot specify an account ID in the ARN. Instead, you must use * for the account ID, as shown in the following example policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workspaces:AssociateConnectionAlias", "workspaces:DisassociateConnectionAlias" ], "Resource": [ "arn:aws:workspaces:us-east-1:*:connectionalias/wsca-a1bcd2efg" ] } ] } You can specify an account ID in the ARN only when that account owns the connection alias to be associated or disassociated. For more information about working with IAM, see Identity and |
workspaces-ag-172 | workspaces-ag.pdf | 172 | } Important If you are creating an IAM policy for associating or disassociating connection aliases for accounts that don't own the connection aliases, you cannot specify an account ID in the ARN. Instead, you must use * for the account ID, as shown in the following example policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workspaces:AssociateConnectionAlias", "workspaces:DisassociateConnectionAlias" ], "Resource": [ "arn:aws:workspaces:us-east-1:*:connectionalias/wsca-a1bcd2efg" ] } ] } You can specify an account ID in the ARN only when that account owns the connection alias to be associated or disassociated. For more information about working with IAM, see Identity and access management for WorkSpaces. Cross-Region redirection 530 Amazon WorkSpaces Administration Guide Security considerations if you stop using cross-Region redirection If you will no longer be using an FQDN as the registration code for your WorkSpaces users, you must take the following precautions to prevent potential security issues: • Be sure to issue your WorkSpaces users the Region-specific registration code (for example, WSpdx +ABC12D) for their WorkSpaces directory and instruct them to stop using the FQDN as their registration code. • If you still own this domain, be sure to update your DNS TXT record to remove this domain so that it cannot be exploited in a phishing attack. If you remove this domain from your DNS TXT record and your WorkSpaces users attempt to use the FQDN as their registration code, their connection attempts will fail harmlessly. • If you no longer own this domain, your WorkSpaces users must use their Region-specific registration code. If they continue trying to use the FQDN as their registration code, their connection attempts could be redirected to a malicious site. Multi-Region Resilience for WorkSpaces Personal Amazon WorkSpaces Multi-Region Resilience (MRR) enables you to redirect users to a secondary Region when your primary WorkSpaces Region is unreachable due to disruptive events, without requiring your users to switch registration codes when logging to their standby WorkSpaces. Standby WorkSpaces is a feature of Amazon WorkSpaces Multi-Region Resilience that streamlines the standby deployment creation and management. After setting up a user directory in your secondary Region, select the WorkSpace in your primary Region that you want to create a standby WorkSpace for. The system automatically mirrors the primary WorkSpace bundle images to the secondary Region. It then automatically provisions a new standby WorkSpace in your secondary Region Amazon WorkSpaces Multi-Region Resilience is built upon cross-Region redirection that leverages DNS health check and failover capabilities. It allows you to use a fully qualified domain name (FQDN) as your WorkSpaces registration code. When your users log in to WorkSpaces, you can redirect them across supported WorkSpaces Regions based on your Domain Name System (DNS) policies for the FQDN. If you use Amazon Route 53, we recommend using health checks that monitor Amazon CloudWatch alarms when devising a cross-Region redirection strategy for WorkSpaces. For more information, see Creating Amazon Route 53 health checks and configuring DNS failover in the Amazon Route 53 Developer Guide. Multi-Region Resilience 531 Amazon WorkSpaces Administration Guide Data replication is an add-on feature of standby WorkSpaces that replicates data one-way from the primary Region to the secondary Region. After enabling data replication, EBS snapshots of the system and user volumes are taken every 12 hours. Multi-Region Resilience regularly checks for fresh snapshots. When the snapshots are found, it initiates a copy to the secondary Region. As copies arrive in the secondary Region, they are used to update the secondary WorkSpace. Contents • Prerequisites • Limitations • Configure your Multi-Region Resilience standby WorkSpace • Create a standby WorkSpace • Manage a standby WorkSpace • Delete a standby WorkSpace • One-way data replication for standby WorkSpaces • Plan to reserve Amazon EC2 capacity for recovery Prerequisites • You must create WorkSpaces for your users in the primary Region before creating standby WorkSpaces. For more information about creating WorkSpaces, see Create a directory for WorkSpaces Personal. • To enable data replication on standby WorkSpaces, you should have either a self- managed Active Directory or an AWS Managed Microsoft AD configured to replicate to your standby Regions. For more information, see Create your AWS Managed Microsoft AD directory and Add a replicated Region. • Ensure you update networking dependency drivers like ENA, NVMe, and PV drivers on your primary WorkSpaces. You should do this at least once every 6 months. For more information, see Install or upgrade Elastic Network Adapter (ENA) driver , AWS NVMe drivers for Windows instances, and Upgrade PV drivers on Windows instances. • Ensure you update the EC2Config, EC2Launch, and EC2Launch V2 agents to the latest versions periodically. You should do this at least once every 6 months. For more information, see Update EC2Config and EC2Launch. • To ensure proper data replication, ensure the Active Directories in the primary and secondary regions are in sync for FQDN, |
workspaces-ag-173 | workspaces-ag.pdf | 173 | ENA, NVMe, and PV drivers on your primary WorkSpaces. You should do this at least once every 6 months. For more information, see Install or upgrade Elastic Network Adapter (ENA) driver , AWS NVMe drivers for Windows instances, and Upgrade PV drivers on Windows instances. • Ensure you update the EC2Config, EC2Launch, and EC2Launch V2 agents to the latest versions periodically. You should do this at least once every 6 months. For more information, see Update EC2Config and EC2Launch. • To ensure proper data replication, ensure the Active Directories in the primary and secondary regions are in sync for FQDN, OU, and user SID. Multi-Region Resilience 532 Amazon WorkSpaces Administration Guide • The default quota (limit) for standby WorkSpaces is 0. You need to request a service quota increase before creating a standby WorkSpace. For more information, see Amazon WorkSpaces quotas. • Ensure you are using customer managed keys to encrypt both your primary and standby WorkSpaces. You can either use single Region keys or multi-Region keys to encrypt your primary and standby WorkSpaces. Limitations • Standby WorkSpaces only copies the bundle image of your primary WorkSpaces but it doesn't copy the system volume (drive C) or user volume (drive D) from your primary WorkSpaces. To copy the system volume (drive C) or user volume (drive D) from your primary WorkSpaces to standby WorkSpaces, you have to enable data replication. • You cannot directly modify, rebuild, restore, or migrate a standby WorkSpace. • Failover for cross-Region redirection is controlled by your DNS settings. To implement an automatic failover scenario, you must use a different mechanism in conjunction with cross- Region redirection. For example, you can use an Amazon Route 53 failover DNS routing policy paired with a Route 53 health check that monitors a CloudWatch alarm in the primary Region. If the CloudWatch alarm in the primary Region is invoked, your DNS failover routing policy then redirects your WorkSpaces users to the WorkSpaces that you've set up for them in the failover Region. • Data replication only goes one way, copying data from primary Region to secondary Region. During standby WorkSpaces failover, you can access the data and application between 12 and 24 hours. After an outage, manually back up any data that you created on the secondary WorkSpace and log out. We recommend saving your work to external drives, such as your network drive, so that you can access your data from the primary WorkSpace. • Data replication does not support AWS Simple AD. • When you enable data replication on standby WorkSpaces, EBS snapshots of the primary WorkSpaces (both root and system volumes) are taken every 12 hours. The initial snapshot for a particular data volume is full and subsequent snapshots are incremental. As a result, the first replication for a given WorkSpace will take longer than subsequent ones. Snapshots are initiated on a schedule that is internal to WorkSpaces and you cannot control the timing. • If the primary WorkSpace and standby WorkSpace join using the same domain, we recommend that you only connect to either the primary WorkSpace or standby WorkSpace at a given point in time to avoid losing connection with the domain controller. Multi-Region Resilience 533 Amazon WorkSpaces Administration Guide • If you configure your AWS Managed Microsoft AD for Multi-Region replication, only the directory in the primary Region can be registered for use with WorkSpaces. If you try to register the directory in a replicated Region for use with WorkSpaces, it will fail. Multi-Region replication with AWS Managed Microsoft AD isn't supported for use with WorkSpaces within replicated Regions. • If you’ve already set up your cross-Region redirection and created WorkSpaces in both your primary and secondary Regions without using standby WorkSpaces, you cannot convert the existing WorkSpace in the secondary Region to a standby WorkSpace directly. Instead, you need to shut down the WorkSpace in your secondary Region, select the WorkSpace in your primary Region that you want to create a standby WorkSpace for, and use standby WorkSpaces to create the standby WorkSpace. • After an outage, manually back up any data that you created on the secondary WorkSpace and log out. We recommend saving your work to external drives, such as your network drive, so that you can access your data from the primary WorkSpace. • WorkSpaces Multi-Region Resilience is currently available in the following Regions: • US East (N. Virginia) Region • US West (Oregon) Region • Europe (Frankfurt) Region • Europe (Ireland) Region • WorkSpaces Multi-Region Resilience is only supported on version 3.0.9 or later of the Linux, macOS, and Windows WorkSpaces client applications. You can also use Multi-Region Resilience with Web Access. • WorkSpaces Multi-Region Resilience supports Windows and Bring Your Own License (BYOL) WorkSpaces. It doesn't support Amazon Linux 2, Ubuntu WorkSpaces, Red Hat Enterprise Linux, GeneralPurpose.4xlarge, |
workspaces-ag-174 | workspaces-ag.pdf | 174 | your network drive, so that you can access your data from the primary WorkSpace. • WorkSpaces Multi-Region Resilience is currently available in the following Regions: • US East (N. Virginia) Region • US West (Oregon) Region • Europe (Frankfurt) Region • Europe (Ireland) Region • WorkSpaces Multi-Region Resilience is only supported on version 3.0.9 or later of the Linux, macOS, and Windows WorkSpaces client applications. You can also use Multi-Region Resilience with Web Access. • WorkSpaces Multi-Region Resilience supports Windows and Bring Your Own License (BYOL) WorkSpaces. It doesn't support Amazon Linux 2, Ubuntu WorkSpaces, Red Hat Enterprise Linux, GeneralPurpose.4xlarge, GeneralPurpose.8xlarge, or GPU-enabled WorkSpaces (e.g. Graphics, GraphicsPro, Graphics.g4dn, or GraphicsPro.g4dn). • After failover or failback completes, wait 15 to 30 minutes before connecting to your WorkSpace. Configure your Multi-Region Resilience standby WorkSpace To configure your Multi-Region Resilience standby WorkSpace 1. Set up user directories in both your primary and secondary Regions. Ensure that you use the same user names in each WorkSpaces directory in each Region. Multi-Region Resilience 534 Amazon WorkSpaces Administration Guide To keep your Active Directory user data in sync, we recommend using AD Connector to point to the same Active Directory in each Region where you've set up WorkSpaces for your users. For more information about creating a directory, see Register a directory with WorkSpaces. Important If you configure your AWS Managed Microsoft AD directory for multi-Region replication, only the directory in the primary Region can be registered for use with WorkSpaces. Attempts to register the directory in a replicated Region for use with WorkSpaces will fail. Multi-Region replication with AWS Managed Microsoft AD isn't supported for use with WorkSpaces within replicated Regions. 2. Create WorkSpaces for your users in the primary Region. For more information about creating WorkSpaces, see Launch WorkSpaces. 3. Create a standby WorkSpace in the secondary Region. For more information about creating a standby WorkSpace, see Create a standby WorkSpace. 4. Create and associate connection strings (FQDN) with user directories in primary and secondary Regions. You must enable cross-Region redirection in your account because standby WorkSpaces is built upon cross-Region redirection. Follow step 1 - 3 of the instructions for Cross-Region redirection for Amazon WorkSpaces. 5. Configure DNS service and set up DNS routing policies. You must set up your DNS service and configure the necessary DNS routing policies. Cross- Region redirection works in conjunction with your DNS routing policies to redirect your WorkSpaces users as needed. 6. When you've finished setting up cross-Region redirection, you must send your users an email with a FQDN connection string. For more information see Step 5: Send the connection string to your WorkSpaces users. Ensure your WorkSpaces users are using the FQDN-based registration code instead of the Region-based registration code (for example, WSpdx+ABC12D) for their primary Region. Multi-Region Resilience 535 Amazon WorkSpaces Administration Guide Important • If you create your users in the WorkSpaces console instead of creating them in Active Directory, WorkSpaces automatically sends an invitation email to your users with a Region-based registration code whenever you launch a new WorkSpace. This means that when you set up WorkSpaces for your users in the secondary Region, your users will also automatically receive emails for these secondary WorkSpaces. You will need to instruct your users to ignore emails with Region-based registration codes. • The Region-specific registration codes remain valid; however, for cross- Region redirection to work, your users must use the FQDN instead as their registration code. Create a standby WorkSpace Before you create a standby WorkSpace, ensure you have completed the prerequisites, including creating a user directory in both primary and secondary Regions, provisioning WorkSpaces for your users in your primary Region, configuring cross-Region redirection in your account, and requesting standby WorkSpaces limit increase through the service quota. To create a standby WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the upper-right corner of the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose WorkSpaces. Select a WorkSpace you want to create a standby WorkSpace for. 5. Choose Actions and then choose Create standby WorkSpace. 6. 7. 8. Select the secondary Region, where you will create your standby WorkSpace, and then choose Next. Select the user directory in your secondary Region and then choose Next. (Optional) Add encryption key, enable data encryption, and manage tags. • To add an encryption key, enter it under Input encryption key. • To enable data replication, choose Enable data replication. Then, check the checkbox to confirm that you authorize additional monthly charge. • To add a new tag, choose Add new tag. Multi-Region Resilience 536 Amazon WorkSpaces Then, choose Next. Note Administration Guide • If the original WorkSpace is encrypted, this field is prepopulated. However, you can choose to replace it with your own encryption key. • It takes a |
workspaces-ag-175 | workspaces-ag.pdf | 175 | directory in your secondary Region and then choose Next. (Optional) Add encryption key, enable data encryption, and manage tags. • To add an encryption key, enter it under Input encryption key. • To enable data replication, choose Enable data replication. Then, check the checkbox to confirm that you authorize additional monthly charge. • To add a new tag, choose Add new tag. Multi-Region Resilience 536 Amazon WorkSpaces Then, choose Next. Note Administration Guide • If the original WorkSpace is encrypted, this field is prepopulated. However, you can choose to replace it with your own encryption key. • It takes a few minutes to update the data replication status. • After the standby WorkSpace is successfully updated with the snapshots from the primary WorkSpace, you can find the times stamps of the snapshots under Recovery Snapshot. 9. Review the settings of your standby WorkSpaces and then choose Create. Note • To view information about your standby WorkSpaces, go to the primary WorkSpace detail page. • The standby WorkSpace only copies the bundle image of your primary WorkSpace but it does not copy the system volume (drive C) or user volume (drive D) from your primary WorkSpaces. By default, data replication is off. To copy the system volume (drive C) or user volume (drive D) from your primary WorkSpaces to standby WorkSpaces, you have to enable data replication. Manage a standby WorkSpace You cannot directly modify, rebuild, restore, or migrate a standby WorkSpace. To enable data replication for your standby WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Go to your primary Region, select the primary WorkSpace ID. 3. Scroll down to the Standby WorkSpace section and choose Edit Standby WorkSpace. 4. Choose Enable data replication. Then, check the checkbox to confirm that you authorize additional monthly charge. Then, choose Save. Multi-Region Resilience 537 Amazon WorkSpaces Note Administration Guide • Standby WorkSpaces cannot hibernate. If you stop the standby WorkSpace, it does not preserve your unsaved work. We recommend users to always save their work before exiting their standby WorkSpaces. • To enable data replication on standby WorkSpaces, you should have either a self- managed Active Directory or an AWS Managed Microsoft AD configured to replicate to your standby Regions. To set up your directories, follow steps 1 to 3 in the Walkthrough section of Building for business continuity with Amazon WorkSpaces and AWS Directory Services or see Using multi-Region AWS Managed Active Directory with Amazon WorkSpaces . Multi-Region replication is only supported for the Enterprise Edition of AWS Managed Microsoft AD. • It takes a few minutes to update the data replication status. • After the standby WorkSpace is successfully updated with the snapshots from the primary WorkSpace, you can find the times stamps of the snapshots under Recovery Snapshot. Delete a standby WorkSpace You can terminate a standby WorkSpace the same way you terminate a regular WorkSpace. To delete a standby WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the upper-right corner of the console, select the primary AWS Region for your WorkSpaces. In the navigation pane, choose WorkSpaces. Select the standby WorkSpace and choose Delete. It takes approximately 5 minutes to delete a standby WorkSpace. During deletion, the status of the standby WorkSpace will be set to Terminating. When the deletion is complete, the standby WorkSpace disappears from the console. Multi-Region Resilience 538 Amazon WorkSpaces Note Administration Guide Deleting a standby WorkSpace is a permanent action and cannot be undone. The standby WorkSpace user's data does not persist and is destroyed. For help with backing up user data, contact AWS Support. One-way data replication for standby WorkSpaces Enabling data replication in Multi-Region Resilience allows you to replicate data from a primary Region to a secondary Region. During steady state, Multi-Region Resilience captures snapshots of the system (C drive) and data (D drive) of primary WorkSpaces every 12 hours. These snapshots are transferred to the secondary Region and used to update the standby WorkSpaces. By default, data replication is disabled for standby WorkSpaces. After data replication is enabled for the standby WorkSpaces, the initial snapshot for a particular data volume is complete, while subsequent snapshots are incremental. As a consequence, the first replication for a given WorkSpace will take longer than subsequent ones. Snapshots are triggered at predetermined intervals within WorkSpaces and the timing cannot be controlled by users. During failover, when users are redirected to the secondary Region, they can access their standby WorkSpaces with data and applications that are between 12 and 24 hours old. While users are using standby WorkSpaces, Multi-Region Resilience will not force them to log out of their standby WorkSpaces or update the standby WorkSpaces with the snapshots from the primary Region. After an outage, users should manually back up any data they have created on their secondary WorkSpaces |
workspaces-ag-176 | workspaces-ag.pdf | 176 | given WorkSpace will take longer than subsequent ones. Snapshots are triggered at predetermined intervals within WorkSpaces and the timing cannot be controlled by users. During failover, when users are redirected to the secondary Region, they can access their standby WorkSpaces with data and applications that are between 12 and 24 hours old. While users are using standby WorkSpaces, Multi-Region Resilience will not force them to log out of their standby WorkSpaces or update the standby WorkSpaces with the snapshots from the primary Region. After an outage, users should manually back up any data they have created on their secondary WorkSpaces before logging out of their standby WorkSpaces. When they log in again, they will be directed to the primary Region and their primary WorkSpaces. Plan to reserve Amazon EC2 capacity for recovery Amazon Multi-Region Resilience(MRR) relies on Amazon EC2 On-Demand pools by default. If a specific Amazon EC2 instance type is unavailable to support your recovery, MRR will automatically attempt to scale up the instance repeatedly until an available instance type is found, but in extreme circumstances, instances may not always be available. To improve the availability of the required instance types you need for your most critical WorkSpaces, contact AWS Support and we will assist you on capacity planning. Multi-Region Resilience 539 Amazon WorkSpaces Administration Guide Troubleshoot issues for WorkSpaces Personal The following information can help you troubleshoot issues with your WorkSpaces. Enabling advanced logging To help troubleshoot issues that your users might experience, you can enable advanced logging on any Amazon WorkSpaces client. Advanced logging generates log files that contain diagnostic information and debugging-level details, including verbose performance data. For the 1.0+ and 2.0+ clients, these advanced logging files are automatically uploaded to a database in AWS. Note To get AWS review of advanced logging files, and to receive technical support for issues with your WorkSpaces clients, contact AWS Support. For more information, see AWS Support Center. To enable advanced logging for Web Access To enable advanced logging for Web Access 1. Open your Amazon WorkSpaces Web Access client. 2. At the top of the WorkSpaces sign in page, choose Diagnostic logging. 3. 4. In the pop-up dialog box, ensure that Diagnostic logging is enabled. For Log level, choose Advanced logging. To access log files in Google Chrome, Microsoft Edge, and Firefox 1. Open the context (right-click) menu on the browsers or press Ctrl+Shift+I (or for Mac, command+option+I) on your keyboard to open the developer tools panel. 2. In the developer tools panel, choose the Console tab to find the log files. To access log files in Safari 1. Choose Safari, Settings. Troubleshooting 540 Amazon WorkSpaces Administration Guide 2. In the Settings window, choose the Advanced tab. 3. Choose Show Develop menu in menu bar. 4. 5. From the Develop tab in the menu bar, choose Develop > Show Web Inspector. In the Safari Web Inspector panel, choose the Console tab to find the log files. To enable advanced logging for 4.0+ clients The Windows client logs are stored in the following location: %LOCALAPPDATA%\Amazon Web Services\Amazon WorkSpaces\logs To enable advanced logging for Windows clients 1. Close the Amazon WorkSpaces client. 2. Open the Command Prompt app. 3. Launch the WorkSpaces client with the -l3 flag. c: cd "C:\Program Files\Amazon Web Services, Inc\Amazon WorkSpaces" workspaces.exe -l3 Note If WorkSpaces is installed for one user and not all users, use the following commands: c: cd "%LocalAppData%\Programs\Amazon Web Services, Inc\Amazon WorkSpaces" workspaces.exe -l3 The macOS client logs are stored in the following location: ~/Library/"Application Support"/"Amazon Web Services"/"Amazon WorkSpaces"/ logs Enabling advanced logging 541 Amazon WorkSpaces Administration Guide To enable advanced logging for macOS clients 1. Close the Amazon WorkSpaces client. 2. Open Terminal. 3. Run the following command. open -a workspaces --args -l3 To enable advanced logging for Android clients 1. Close the Amazon WorkSpaces client. 2. Open the Android client menu. 3. 4. 5. Select Support. Select Logging settings. Select Enable advanced logging. To retrieve logs for Android clients after enabling advanced logging: • Select Extract log to save zipped logs locally. The Linux client logs are stored in the following location: ~/.local/share/Amazon Web Services/Amazon WorkSpaces/logs To enable advanced logging for Linux clients 1. Close the Amazon WorkSpaces client. 2. Open Terminal. 3. Run the following command. /opt/workspacesclient/workspacesclient -l3 To enable advanced logging for 3.0 clients The Windows client logs are stored in the following location: %LOCALAPPDATA%\Amazon Web Services\Amazon WorkSpaces\logs Enabling advanced logging 542 Amazon WorkSpaces Administration Guide To enable advanced logging for Windows clients 1. Close the Amazon WorkSpaces client. 2. Open the Command Prompt app. 3. Launch the WorkSpaces client with the -l3 flag. c: cd "C:\Program Files (x86)\Amazon Web Services, Inc\Amazon WorkSpaces" workspaces.exe -l3 Note If WorkSpaces is installed for one user and not all users, use the following commands: c: cd "%LocalAppData%\Programs\Amazon Web Services, Inc\Amazon WorkSpaces" |
workspaces-ag-177 | workspaces-ag.pdf | 177 | Open Terminal. 3. Run the following command. /opt/workspacesclient/workspacesclient -l3 To enable advanced logging for 3.0 clients The Windows client logs are stored in the following location: %LOCALAPPDATA%\Amazon Web Services\Amazon WorkSpaces\logs Enabling advanced logging 542 Amazon WorkSpaces Administration Guide To enable advanced logging for Windows clients 1. Close the Amazon WorkSpaces client. 2. Open the Command Prompt app. 3. Launch the WorkSpaces client with the -l3 flag. c: cd "C:\Program Files (x86)\Amazon Web Services, Inc\Amazon WorkSpaces" workspaces.exe -l3 Note If WorkSpaces is installed for one user and not all users, use the following commands: c: cd "%LocalAppData%\Programs\Amazon Web Services, Inc\Amazon WorkSpaces" workspaces.exe -l3 The macOS client logs are stored in the following location: ~/Library/"Application Support"/"Amazon Web Services"/"Amazon WorkSpaces"/ logs To enable advanced logging for macOS clients 1. Close the Amazon WorkSpaces client. 2. Open Terminal. 3. Run the following command. open -a workspaces --args -l3 To enable advanced logging for Android clients 1. Close the Amazon WorkSpaces client. 2. Open the Android client menu. Enabling advanced logging 543 Amazon WorkSpaces Administration Guide 3. 4. 5. Select Support. Select Logging settings. Select Enable advanced logging. To retrieve logs for Android clients after enabling advanced logging: • Select Extract log to save zipped logs locally. The Linux client logs are stored in the following location: ~/.local/share/Amazon Web Services/Amazon WorkSpaces/logs To enable advanced logging for Linux clients 1. Close the Amazon WorkSpaces client. 2. Open Terminal. 3. Run the following command. /opt/workspacesclient/workspacesclient -l3 To enable advanced logging for 1.0+ and 2.0+ clients 1. Open the WorkSpaces client. 2. Choose the gear icon in the upper-right corner of the client application. 3. Choose Advanced Settings. 4. Select the Enable Advanced Logging check box. 5. Choose Save. The Windows client logs are stored in the following location: %LOCALAPPDATA%\Amazon Web Services\Amazon WorkSpaces\1.0\Logs The macOS client logs are stored in the following location: ~/Library/Logs/Amazon Web Services/Amazon WorkSpaces/1.0 Enabling advanced logging 544 Amazon WorkSpaces Administration Guide Troubleshoot specific issues The following information can help you troubleshoot specific issues with your WorkSpaces. Issues • I can't create an Amazon Linux WorkSpace because there are non-valid characters in the user name • I changed the shell for my Amazon Linux WorkSpace and now I can't provision a PCoIP session • My Amazon Linux WorkSpaces won't start • Launching WorkSpaces in my connected directory often fails • Launching WorkSpaces fails with an internal error • When I try to register a directory, the registration fails and leaves the directory in an ERROR state • My users can't connect to a Windows WorkSpace with an interactive logon banner • My users can't connect to a Windows WorkSpace • My users are having issues when they try to log on to WorkSpaces from WorkSpaces Web Access • The Amazon WorkSpaces client displays a gray "Loading..." screen for a while before returning to the login screen. No other error message appears. • My users receive the message "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes." • My users receive the message "This device is not authorized to access the WorkSpace. Please contact your administrator for assistance." • My users receive the message "No network. Network connection lost. Check your network connection or contact your administrator for help." when trying to connect to a DCV WorkSpace • The WorkSpaces client gives my users a network error, but they are able to use other network- enabled apps on their devices • My WorkSpace users see the following error message: "Device can't connect to the registration service. Check your network settings." • My PCoIP zero client users are receiving the error "The supplied certificate is invalid due to timestamp" • USB printers and other USB peripherals aren't working for PCoIP zero clients • My users skipped updating their Windows or macOS client applications and aren't getting prompted to install the latest version • My users are unable to install the Android client application on their Chromebooks Troubleshoot specific issues 545 Amazon WorkSpaces Administration Guide • My users aren't receiving invitation emails or password reset emails • My users don't see the Forgot password? option on the client login screen • I receive the message "The system administrator has set policies to prevent this installation" when I try to install applications on a Windows WorkSpace • No WorkSpaces in my directory can connect to the internet • My WorkSpace has lost its internet access • I receive a "DNS unavailable" error when I try to connect to my on-premises directory • I receive a "Connectivity issues detected" error when I try to connect to my on-premises directory • I receive an "SRV record" error when I try to connect to my on-premises directory • My Windows WorkSpace goes to sleep when it's left idle • One of my |
workspaces-ag-178 | workspaces-ag.pdf | 178 | has set policies to prevent this installation" when I try to install applications on a Windows WorkSpace • No WorkSpaces in my directory can connect to the internet • My WorkSpace has lost its internet access • I receive a "DNS unavailable" error when I try to connect to my on-premises directory • I receive a "Connectivity issues detected" error when I try to connect to my on-premises directory • I receive an "SRV record" error when I try to connect to my on-premises directory • My Windows WorkSpace goes to sleep when it's left idle • One of my WorkSpaces has a state of UNHEALTHY • My WorkSpace is unexpectedly crashing or rebooting • The same username has more than one WorkSpace, but the user can log in to only one of the WorkSpaces • I'm having trouble using Docker with Amazon WorkSpaces • I receive ThrottlingException errors to some of my API calls • My WorkSpace keeps disconnecting when I let it run in the background • SAML 2.0 federation isn't working. My users are not authorized to stream their WorkSpaces desktop. • My users are getting disconnected from their WorkSpaces session every 60 minutes. • My users get a redirect URI error when they federate using the SAML 2.0 identity provider (IdP)- initiated flow, or an additional instance of the WorkSpaces client application starts every time my users attempt to sign in from the client after federating to the IdP. • My users receive the message, "Something went wrong: An error occurred while launching your WorkSpace" when they attempt to sign in to the WorkSpaces client application after federating to the IdP. • My users receive the message, "Unable to validate tags” when they attempt to sign in to the WorkSpaces client application after federating to the IdP. • My users receive the message, "The client and the server cannot communicate, because they do not possess a common algorithm". • My microphone or web cam is not working on Windows WorkSpaces. Troubleshoot specific issues 546 Amazon WorkSpaces Administration Guide • My users cannot log in using certificate-based authentication and are prompted for the password either at the WorkSpaces client or the Windows sign-on screen when they connect to their desktop session. • I am trying to do something that requires Windows installation media but WorkSpaces does not provide it. • I want to launch WorkSpaces with an existing AWS Managed Directory created in an unsupported WorkSpaces Region. • I want to update Firefox on Amazon Linux 2. • My user is able to reset their password using the WorkSpaces client, ignoring the Fine Grained Password Policy (FFGP) setting that is configured on AWS Managed Microsoft AD. • My users receive the error message "This OS/platform is not authorized to access your WorkSpace" when trying to access the Windows/Linux WorkSpace using Web Access • My user's WorkSpace is showing as unhealthy after they connect to an AutoStop WorkSpace that is in the stopped state • Gnome crashes on WorkSpaces Ubuntu bundles after login I can't create an Amazon Linux WorkSpace because there are non-valid characters in the user name For Amazon Linux WorkSpaces, user names: • Can contain a maximum of 20 characters • Can contain letters, spaces, and numbers that are representable in UTF-8 • Can include the following special characters: _.-# • Cannot begin with a dash symbol (-) as the first character of the user name Note These limitations do not apply to Windows WorkSpaces. Windows WorkSpaces support the @ and - symbols for all characters in the user name. Troubleshoot specific issues 547 Amazon WorkSpaces Administration Guide I changed the shell for my Amazon Linux WorkSpace and now I can't provision a PCoIP session To override the default shell for Linux WorkSpaces, see Override the default shell for Amazon Linux WorkSpaces. My Amazon Linux WorkSpaces won't start Starting July 20, 2020, Amazon Linux WorkSpaces will be using new license certificates. These new certificates are compatible only with versions 2.14.1.1, 2.14.7, 2.14.9, and 20.10.6 or later of the PCoIP agent. If you're using an unsupported version of the PCoIP agent, you must upgrade it to the latest version (20.10.6), which has the latest fixes and performance improvements that are compatible with the new certificates. If you don't make these upgrades by July 20, session provisioning for your Linux WorkSpaces will fail and your end users won't be able to connect to their WorkSpaces. To upgrade your PCoIP agent to the latest version 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select your Linux WorkSpace, and reboot it by choosing Actions, Reboot WorkSpaces. If the WorkSpace status is STOPPED, you must choose Actions, Start WorkSpaces first and wait until its status is AVAILABLE before you can reboot it. 4. |
workspaces-ag-179 | workspaces-ag.pdf | 179 | performance improvements that are compatible with the new certificates. If you don't make these upgrades by July 20, session provisioning for your Linux WorkSpaces will fail and your end users won't be able to connect to their WorkSpaces. To upgrade your PCoIP agent to the latest version 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Select your Linux WorkSpace, and reboot it by choosing Actions, Reboot WorkSpaces. If the WorkSpace status is STOPPED, you must choose Actions, Start WorkSpaces first and wait until its status is AVAILABLE before you can reboot it. 4. After your WorkSpace has rebooted and its status is AVAILABLE, we recommend that you change the status of the WorkSpace to ADMIN_MAINTENANCE while you are performing this upgrade. When you are finished, change the status of the WorkSpace to AVAILABLE. For more information about ADMIN_MAINTENANCE mode, see Manual Maintenance. To change the status of a WorkSpace to ADMIN_MAINTENANCE, do the following: a. Select the WorkSpace and choose Actions, Modify WorkSpace. b. Choose Modify State. c. For Intended State, select ADMIN_MAINTENANCE. d. Choose Modify. 5. Connect to your Linux WorkSpace through SSH. For more information, see Enable SSH connections for your Linux WorkSpaces in WorkSpaces Personal. Troubleshoot specific issues 548 Amazon WorkSpaces Administration Guide 6. To update the PCoIP agent, run the following command: sudo yum --enablerepo=pcoip-stable install pcoip-agent-standard-20.10.6 7. To verify the agent version and to confirm that the update succeeded, run the following command: rpm -q pcoip-agent-standard The verification command should produce following result: pcoip-agent-standard-20.10.6-1.el7.x86_64 8. Disconnect from the WorkSpace and reboot it again. 9. If you set the status of the WorkSpace to ADMIN_MAINTENANCE in Step 4, repeat Step 4 and set Intended State to AVAILABLE. If your Linux WorkSpace still fails to start after you upgrade the PCoIP agent, contact AWS Support. Launching WorkSpaces in my connected directory often fails Verify that the two DNS servers or domain controllers in your on-premises directory are accessible from each of the subnets that you specified when you connected to your directory. You can verify this connectivity by launching an Amazon EC2 instance in each subnet and joining the instance to your directory using the IP addresses of the two DNS servers. Launching WorkSpaces fails with an internal error Check whether your subnets are configured to automatically assign IPv6 addresses to instances launched in the subnet. To check this setting, open the Amazon VPC console, select your subnet, and choose Subnet Actions, Modify auto-assign IP settings. If this setting is enabled, you cannot launch WorkSpaces using the Performance or Graphics bundles. Instead, disable this setting and specify IPv6 addresses manually when you launch your instances. When I try to register a directory, the registration fails and leaves the directory in an ERROR state This problem can occur if you're trying to register an AWS Managed Microsoft AD directory that has been configured for multi-Region replication. Although the directory in the primary Region can be Troubleshoot specific issues 549 Amazon WorkSpaces Administration Guide successfully registered for use with Amazon WorkSpaces, attempting to register the directory in a replicated Region fails. Multi-Region replication with AWS Managed Microsoft AD isn't supported for use with Amazon WorkSpaces within replicated Regions. My users can't connect to a Windows WorkSpace with an interactive logon banner If an interactive logon message has been implemented to display a logon banner, this prevents users from being able to access their Windows WorkSpaces. The interactive logon message Group Policy setting is not currently supported by PCoIP WorkSpaces. Move the WorkSpaces to an organizational unit (OU) where the Interactive logon: Message text for users attempting to log on Group Policy isn’t applied. The logon message is supported on DCV WorkSpaces, and users have to login again after accepting the logon banner. My users can't connect to a Windows WorkSpace My users receive the following error when they try to connect to their Windows WorkSpaces: "An error occurred while launching your WorkSpace. Please try again." This error often occurs when the WorkSpace can't load the Windows desktop using PCoIP. Check the following: • This message appears if the PCoIP Standard Agent for Windows service is not running. Connect using RDP to verify that the service is running, that it's set to start automatically, and that it can communicate over the management interface (eth0). • If the PCoIP agent was uninstalled, reboot the WorkSpace through the Amazon WorkSpaces console to reinstall it automatically. • You might also receive this error on the Amazon WorkSpaces client after a long delay if the WorkSpaces security group was modified to restrict outbound traffic. Restricting outbound traffic prevents Windows from communicating with your directory controllers for login. Verify that your security groups allow your WorkSpaces to communicate with your directory controllers on all required ports over the |
workspaces-ag-180 | workspaces-ag.pdf | 180 | that the service is running, that it's set to start automatically, and that it can communicate over the management interface (eth0). • If the PCoIP agent was uninstalled, reboot the WorkSpace through the Amazon WorkSpaces console to reinstall it automatically. • You might also receive this error on the Amazon WorkSpaces client after a long delay if the WorkSpaces security group was modified to restrict outbound traffic. Restricting outbound traffic prevents Windows from communicating with your directory controllers for login. Verify that your security groups allow your WorkSpaces to communicate with your directory controllers on all required ports over the primary network interface. Another cause of this error is related to the User Rights Assignment Group Policy. If the following group policy is incorrectly configured, it prevents users from being able to access their Windows WorkSpaces: Troubleshoot specific issues 550 Amazon WorkSpaces Administration Guide Computer Configuration\Windows Settings\Security Settings\Local Policies\User Rights Assignment • Incorrect policy: Policy: Access this computer from the network Setting: Domain name\Domain Computers Winning GPO: Allow File Access • Correct policy: Policy: Access this computer from the network Setting: Domain name\Domain Users Winning GPO: Allow File Access Note This policy setting should be applied to Domain Users instead of Domain Computers. For more information, see Access this computer from the network - security policy setting and Configure security policy settings in the Microsoft Windows documentation. My users are having issues when they try to log on to WorkSpaces from WorkSpaces Web Access Amazon WorkSpaces relies on a specific logon screen configuration to enable users to successfully log on from their Web Access client. To enable Web Access users to log on to their WorkSpaces, you must configure a Group Policy setting and three Security Policy settings. If these settings are not correctly configured, users might experience long logon times or black screens when they try to log on to their WorkSpaces. To configure these settings, see Enable and configure WorkSpaces Web Access for WorkSpaces Personal. Troubleshoot specific issues 551 Amazon WorkSpaces Important Administration Guide Beginning October 1, 2020, customers will no longer be able to use the Amazon WorkSpaces Web Access client to connect to Windows 7 custom WorkSpaces or to Windows 7 Bring Your Own License (BYOL) WorkSpaces. The Amazon WorkSpaces client displays a gray "Loading..." screen for a while before returning to the login screen. No other error message appears. This behavior usually indicates that the WorkSpaces client can authenticate over port 443, but can't establish a streaming connection over port 4172 (PCoIP) or port 4195 (DCV). This situation can occur when network prerequisites aren't met. Issues on the client side often cause the network check in the client to fail. To see which health checks are failing, choose the network check icon (typically a red triangle with an exclamation point in the bottom-right corner of the login screen for 2.0+ clients or the network icon in the upper-right corner of the 3.0+ clients). Note The most common cause of this problem is a client-side firewall or proxy preventing access over port 4172 or 4195 (TCP and UDP). If this health check fails, check your local firewall settings. If the network check passes, there might be a problem with the network configuration of the WorkSpace. For example, a Windows Firewall rule might block port UDP 4172 or 4195 on the management interface. Connect to the WorkSpace using a Remote Desktop Protocol (RDP) client to verify that the WorkSpace meets the necessary port requirements. My users receive the message "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes." This error usually indicates the SkyLightWorkSpacesConfigService service isn't responding to health checks. If you just rebooted or started your WorkSpace, wait a few minutes, and then try again. Troubleshoot specific issues 552 Amazon WorkSpaces Administration Guide If the WorkSpace has been running for some time and you still see this error, connect using RDP to verify that the SkyLightWorkSpacesConfigService service: • Is running. • Is set to start automatically. • Can communicate over the management interface (eth0). • Isn't blocked by any third-party antivirus software. My users receive the message "This device is not authorized to access the WorkSpace. Please contact your administrator for assistance." This error indicates that one of the following might be occurring: • IP access control groups are configured on the WorkSpace directory, but the client IP address isn't allowlisted. Check the settings on your directory. Confirm that the public IP address the user is connecting from allows access to the WorkSpace. • Under access control, your device’s operating system isn’t allowed as a trusted device or your device doesn’t have the proper certificates installed when using the Trusted devices option. Add your device type as a trusted device by doing the following: 1. Open |
workspaces-ag-181 | workspaces-ag.pdf | 181 | Please contact your administrator for assistance." This error indicates that one of the following might be occurring: • IP access control groups are configured on the WorkSpace directory, but the client IP address isn't allowlisted. Check the settings on your directory. Confirm that the public IP address the user is connecting from allows access to the WorkSpace. • Under access control, your device’s operating system isn’t allowed as a trusted device or your device doesn’t have the proper certificates installed when using the Trusted devices option. Add your device type as a trusted device by doing the following: 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose the directory you're using. 4. Scroll down to Access control options and choose Edit. 5. Under Trusted devices, for the device types you want to allow access to, choose Allow all in the drop-down. If you want to restrict the devices to ones that have client certificates installed, choose Trusted devices. 6. If you chose Trusted devices in the previous step, ensure you have imported at least one root certificate and that the client certificate that has been issued by the root certification authority (CA) has been installed on the client. For more information about creating, Troubleshoot specific issues 553 Amazon WorkSpaces Administration Guide deploying, and importing root certificates, see Restrict access to trusted devices for WorkSpaces Personal. 7. Choose Save. • Your device types are not granted access to WorkSpaces. Grant access to your device type by doing the following: 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose the directory you're using. 4. Scroll down to Other platforms and choose Edit. 5. Check from one of the following device types you want to grant WorkSpaces access. • ChromeOS • iOS • Linux • Web Access • Zero Clients 6. Choose Save. My users receive the message "No network. Network connection lost. Check your network connection or contact your administrator for help." when trying to connect to a DCV WorkSpace If this error occurs and your users don't have connectivity issues, make sure that port 4195 is open on your network's firewalls. For WorkSpaces using DCV, the port used to stream the client session was changed from 4172 to 4195. The WorkSpaces client gives my users a network error, but they are able to use other network-enabled apps on their devices The WorkSpaces client applications rely on access to resources in the AWS Cloud, and require a connection that provides at least 1 Mbps download bandwidth. If a device has an intermittent connection to the network, the WorkSpaces client application might report an issue with the network. Troubleshoot specific issues 554 Amazon WorkSpaces Administration Guide WorkSpaces enforces the use of digital certificates issued by Amazon Trust Services, as of May 2018. Amazon Trust Services is already a trusted Root CA on the operating systems that are supported by WorkSpaces. If the Root CA list for the operating system is not up to date, the device cannot connect to WorkSpaces and the client gives a network error. To recognize connection issues due to certificate failures • PCoIP zero clients — The following error message is displayed. Failed to connect. The server provided a certificate that is invalid. See below for details: - The supplied certificate is invalid due to timestamp - The supplied certificate is not rooted in the devices local certificate store • Other clients — The health checks fail with a red warning triangle for Internet. To resolve certificate failures • Windows client application • PCoIP zero clients • Other client applications Windows client application Use one of the following solutions for certificate failures. Solution 1: Update the client application Download and install the latest Windows client application from https:// clients.amazonworkspaces.com/ . During installation, the client application ensures that your operating system trusts certificates issued by Amazon Trust Services. Solution 2: Add Amazon Trust Services to the local Root CA list 1. Open https://www.amazontrust.com/repository/. 2. Download the Starfield certificate in DER format (2b071c59a0a0ae76b0eadb2bad23bad4580b69c3601b630c2eaf0613afa83f92). 3. Open the Microsoft Management Console. (From the Command Prompt, run mmc.) 4. Choose File, Add/Remove Snap-in, Certificates, Add. Troubleshoot specific issues 555 Amazon WorkSpaces Administration Guide 5. On the Certificates snap-in page, select Computer account and choose Next. Keep the default, Local computer. Choose Finish. Choose OK. 6. 7. 8. Expand Certificates (Local Computer) and select Trusted Root Certification Authorities. Choose Action, All Tasks, Import. Follow the wizard to import the certificate that you downloaded. Exit and restart the WorkSpaces client application. Solution 3: Deploy Amazon Trust Services as a trusted CA using Group Policy Add the Starfield certificate to the trusted Root CAs for the domain using Group Policy. For more information, see Use Policy to Distribute Certificates. PCoIP zero clients To |
workspaces-ag-182 | workspaces-ag.pdf | 182 | WorkSpaces Administration Guide 5. On the Certificates snap-in page, select Computer account and choose Next. Keep the default, Local computer. Choose Finish. Choose OK. 6. 7. 8. Expand Certificates (Local Computer) and select Trusted Root Certification Authorities. Choose Action, All Tasks, Import. Follow the wizard to import the certificate that you downloaded. Exit and restart the WorkSpaces client application. Solution 3: Deploy Amazon Trust Services as a trusted CA using Group Policy Add the Starfield certificate to the trusted Root CAs for the domain using Group Policy. For more information, see Use Policy to Distribute Certificates. PCoIP zero clients To connect directly to a WorkSpace using firmware version 6.0 or later, download and install the certificate issued by Amazon Trust Services. To add Amazon Trust Services as a trusted Root CA 1. Open https://certs.secureserver.net/repository/. 2. Download the certificate under Starfield Certificate Chain with the thumbprint 14 65 FA 20 53 97 B8 76 FA A6 F0 A9 95 8E 55 90 E4 0F CC 7F AA 4F B7 C2 C8 67 75 21 FB 5F B6 58. 3. Upload the certificate to the zero client. For more information, see Uploading Certificates in the Teradici documentation. Other client applications Add the Starfield certificate (2b071c59a0a0ae76b0eadb2bad23bad4580b69c3601b630c2eaf0613afa83f92) from Amazon Trust Services. For more information about how to add a Root CA, see the following documentation: • Android: Add & remove certificates • Chrome OS: Manage client certificates on Chrome devices • macOS and iOS: Installing a CA's Root Certificate on Your Test Device Troubleshoot specific issues 556 Amazon WorkSpaces Administration Guide My WorkSpace users see the following error message: "Device can't connect to the registration service. Check your network settings." When a registration service failure occurs, your WorkSpace users might see the following error message on the Connection Health Check page: "Your device is not able to connect to the WorkSpaces Registration service. You will not be able to register your device with WorkSpaces. Please check your network settings." This error occurs when the WorkSpaces client application can't reach the registration service. Typically, this happens when the WorkSpaces directory has been deleted. To resolve this error, make sure that the registration code is valid and corresponds to a running directory in the AWS Cloud. My PCoIP zero client users are receiving the error "The supplied certificate is invalid due to timestamp" If Network Time Protocol (NTP) isn't enabled in Teradici, your PCoIP zero client users might receive certificate failure errors. To set up NTP, see Set up PCoIP zero clients for WorkSpaces Personal. USB printers and other USB peripherals aren't working for PCoIP zero clients Starting with version 20.10.4 of the PCoIP agent, Amazon WorkSpaces disables USB redirection by default through the Windows registry. This registry setting affects the behavior of USB peripherals when your users are using PCoIP zero client devices to connect to their WorkSpaces. If your WorkSpaces are using version 20.10.4 or later of the PCoIP agent, USB peripheral devices won't work with PCoIP zero client devices until you've enabled USB redirection. Note If you're using 32-bit virtual printer drivers, you must also update those drivers to their 64- bit versions. To enable USB redirection for PCoIP zero client devices We recommend that you push out these registry changes to your WorkSpaces through Group Policy. For more information, see Configuring the agent and Configurable settings in the Teradici documentation. Troubleshoot specific issues 557 Amazon WorkSpaces Administration Guide 1. Set the following registry key value to 1 (enabled): KeyPath = HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Teradici\PCoIP\pcoip_admin KeyName = pcoip.enable_usb KeyType = DWORD KeyValue = 1 2. Set the following registry key value to 1 (enabled): KeyPath = HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Teradici\PCoIP \pcoip_admin_defaults KeyName = pcoip.enable_usb KeyType = DWORD KeyValue = 1 3. If you haven't already done so, log out of the WorkSpace, and then log back in. Your USB devices should now work. My users skipped updating their Windows or macOS client applications and aren't getting prompted to install the latest version When users skip updates to the Amazon WorkSpaces Windows client application, the SkipThisVersion registry key gets set, and they are no longer prompted to update their clients when a new version of the client is released. To update to the latest version, you can edit the registry as described in Update the WorkSpaces Windows Client Application to a Newer Version in the Amazon WorkSpaces User Guide. You can also run the following PowerShell command: Remove-ItemProperty -Path "HKCU:\Software\Amazon Web Services. LLC\Amazon WorkSpaces \WinSparkle" -Name "SkipThisVersion" When users skip updates to the Amazon WorkSpaces macOS client application, the SUSkippedVersion preference gets set, and they are no longer prompted to update their clients when a new version of the client is released. To update to the latest version, you can reset this preference as described in Update the WorkSpaces macOS Client Application to a Newer Version in the Amazon WorkSpaces |
workspaces-ag-183 | workspaces-ag.pdf | 183 | as described in Update the WorkSpaces Windows Client Application to a Newer Version in the Amazon WorkSpaces User Guide. You can also run the following PowerShell command: Remove-ItemProperty -Path "HKCU:\Software\Amazon Web Services. LLC\Amazon WorkSpaces \WinSparkle" -Name "SkipThisVersion" When users skip updates to the Amazon WorkSpaces macOS client application, the SUSkippedVersion preference gets set, and they are no longer prompted to update their clients when a new version of the client is released. To update to the latest version, you can reset this preference as described in Update the WorkSpaces macOS Client Application to a Newer Version in the Amazon WorkSpaces User Guide. Troubleshoot specific issues 558 Amazon WorkSpaces Administration Guide My users are unable to install the Android client application on their Chromebooks Version 2.4.13 is the final release of the Amazon WorkSpaces Chromebook client application. Because Google is phasing out support for Chrome Apps, there will be no further updates to the WorkSpaces Chromebook client application, and its use is unsupported. For Chromebooks that support installing Android applications, we recommend using the WorkSpaces Android client application instead. In some cases, you might need to enable your users' Chromebooks to install Android applications. For more information, see Set up Android for Chromebook for WorkSpaces Personal. My users aren't receiving invitation emails or password reset emails Users do not automatically receive welcome or password reset emails for WorkSpaces that were created using AD Connector or a trusted domain. Invitation emails also aren't sent automatically if the user already exists in Active Directory. To manually send welcome emails to these users, see Send an invitation email. To reset user passwords, see Set up Active Directory Administration Tools for WorkSpaces Personal. My users don't see the Forgot password? option on the client login screen If you're using AD Connector or a trusted domain, your users won't be able to reset their own passwords. (The Forgot password? option on the WorkSpaces client application login screen won't be available.) For information about how to reset user passwords, see Set up Active Directory Administration Tools for WorkSpaces Personal. I receive the message "The system administrator has set policies to prevent this installation" when I try to install applications on a Windows WorkSpace You can address this issue by modifying the Windows Installer Group Policy setting. To deploy this policy to multiple WorkSpaces in your directory, apply this setting to a Group Policy object that is linked to the WorkSpaces organizational unit (OU) from a domain-joined EC2 instance. If you are using AD Connector, you can make these changes from a domain controller. For more information about using the Active Directory administration tools to work with Group Policy objects, see Installing the Active Directory Administration Tools in the AWS Directory Service Administration Guide. Troubleshoot specific issues 559 Amazon WorkSpaces Administration Guide The following procedure shows how to configure the Windows Installer setting for the WorkSpaces Group Policy object. 1. Make sure that the most recent WorkSpaces Group Policy administrative template is installed in your domain. 2. Open the Group Policy Management tool on your Windows WorkSpace client and navigate to and select the WorkSpaces Group Policy object for your WorkSpaces machine accounts. From the main menu, choose Action, Edit. 3. In the Group Policy Management Editor, choose Computer Configuration, Policies, Administrative Templates, Classic Administrative Templates, Windows Components, Windows Installer. 4. Open the Turn Off Windows Installer setting. 5. In the Turn Off Windows Installer dialog box, change Not Configured to Enabled, and then set Disable Windows Installer to Never. 6. Choose OK. 7. To apply the group policy changes, do one of the following: • • Reboot the WorkSpace (in the WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). From an administrative command prompt, enter gpupdate /force. No WorkSpaces in my directory can connect to the internet WorkSpaces cannot communicate with the internet by default. You must explicitly provide internet access. For more information, see Provide internet access for WorkSpaces Personal. My WorkSpace has lost its internet access If your WorkSpace has lost access to the internet and you can't connect to the WorkSpace by using RDP, this issue is probably caused by the loss of the public IP address for the WorkSpace. If you have enabled automatic assignment of Elastic IP addresses at the directory level, an Elastic IP address (from the Amazon-provided pool) is assigned to your WorkSpace when it is launched. However, if you associate an Elastic IP address that you own to a WorkSpace, and then you later disassociate that Elastic IP address from the WorkSpace, the WorkSpace loses its public IP address, and it doesn't automatically get a new one from the Amazon-provided pool. Troubleshoot specific issues 560 Amazon WorkSpaces Administration Guide To associate a new public IP address from the Amazon-provided pool with the WorkSpace, you must rebuild the |
workspaces-ag-184 | workspaces-ag.pdf | 184 | have enabled automatic assignment of Elastic IP addresses at the directory level, an Elastic IP address (from the Amazon-provided pool) is assigned to your WorkSpace when it is launched. However, if you associate an Elastic IP address that you own to a WorkSpace, and then you later disassociate that Elastic IP address from the WorkSpace, the WorkSpace loses its public IP address, and it doesn't automatically get a new one from the Amazon-provided pool. Troubleshoot specific issues 560 Amazon WorkSpaces Administration Guide To associate a new public IP address from the Amazon-provided pool with the WorkSpace, you must rebuild the WorkSpace. If you don't want to rebuild the WorkSpace, you must associate another Elastic IP address that you own to the WorkSpace. We recommend that you not modify the elastic network interface of a WorkSpace after the WorkSpace is launched. After an Elastic IP address has been assigned to a WorkSpace, the WorkSpace retains the same public IP address (unless the WorkSpace is rebuilt, in which case it gets a new public IP address). I receive a "DNS unavailable" error when I try to connect to my on-premises directory You receive an error message similar to the following when connecting to your on-premises directory. DNS unavailable (TCP port 53) for IP: dns-ip-address AD Connector must be able to communicate with your on-premises DNS servers via TCP and UDP over port 53. Verify that your security groups and on-premises firewalls allow TCP and UDP communication over this port. I receive a "Connectivity issues detected" error when I try to connect to my on- premises directory You receive an error message similar to the following when connecting to your on-premises directory. Connectivity issues detected: LDAP unavailable (TCP port 389) for IP: ip-address Kerberos/authentication unavailable (TCP port 88) for IP: ip-address Please ensure that the listed ports are available and retry the operation. AD Connector must be able to communicate with your on-premises domain controllers via TCP and UDP over the following ports. Verify that your security groups and on-premises firewalls allow TCP and UDP communication over these ports: • 88 (Kerberos) • 389 (LDAP) Troubleshoot specific issues 561 Amazon WorkSpaces Administration Guide I receive an "SRV record" error when I try to connect to my on-premises directory You receive an error message similar to one or more of the following when connecting to your on- premises directory. SRV record for LDAP does not exist for IP: dns-ip-address SRV record for Kerberos does not exist for IP: dns-ip-address AD Connector needs to obtain the _ldap._tcp.dns-domain-name and _kerberos._tcp.dns- domain-name SRV records when connecting to your directory. You get this error if the service cannot obtain these records from the DNS servers that you specified when connecting to your directory. Make sure that your DNS servers contain these SRV records. For more information, see SRV Resource Records on Microsoft TechNet. My Windows WorkSpace goes to sleep when it's left idle To resolve this issue, connect to the WorkSpace and change the power plan to High performance by using the following procedure: 1. From the WorkSpace, open Control Panel, then choose Hardware or choose Hardware and Sound (the name might differ, depending on your version of Windows). 2. Under Power Options, choose Choose a power plan. 3. In the Choose or customize a power plan pane, choose the High performance power plan, and then choose Change plan settings. • If the option to choose the High performance power plan is disabled, choose Change settings that are currently unavailable, and then choose the High performance power plan. • If the High performance plan isn't visible, choose the arrow to the right of Show additional plans to display it, or choose Create a power plan in the left navigation, choose High performance, give the power plan a name, and then choose Next. 4. On the Change settings for the plan: High performance page, make sure Turn off the display and (if available) Put the computer to sleep are set to Never. 5. If you made any changes to the high performance plan, choose Save changes (or choose Create if you're creating a new plan). If the preceding steps do not solve the issue, do the following: Troubleshoot specific issues 562 Amazon WorkSpaces Administration Guide 1. From the WorkSpace, open Control Panel, then choose Hardware or choose Hardware and Sound (the name might differ, depending on your version of Windows). 2. Under Power Options, choose Choose a power plan. 3. In the Choose or customize a power plan pane, choose the Change plan settings link to the right of the High performance power plan, then choose the Change advanced power settings link. 4. In the Power Options dialog box, in the list of settings, choose the plus sign to the left of Hard disk to display the relevant settings. |
workspaces-ag-185 | workspaces-ag.pdf | 185 | issues 562 Amazon WorkSpaces Administration Guide 1. From the WorkSpace, open Control Panel, then choose Hardware or choose Hardware and Sound (the name might differ, depending on your version of Windows). 2. Under Power Options, choose Choose a power plan. 3. In the Choose or customize a power plan pane, choose the Change plan settings link to the right of the High performance power plan, then choose the Change advanced power settings link. 4. In the Power Options dialog box, in the list of settings, choose the plus sign to the left of Hard disk to display the relevant settings. 5. Verify that the Turn off hard disk after value for Plugged in is greater than the value for On battery (the default value is 20 minutes). 6. Choose the plus sign to the left of PCI Express, and do the same for Link State Power Management. 7. Verify that the Link State Power Management settings are Off. 8. Choose OK (or Apply if you changed any settings) to close the dialog box. 9. In the Change settings for the plan pane, if you changed any settings, choose Save changes. One of my WorkSpaces has a state of UNHEALTHY The WorkSpaces service periodically sends status requests to a WorkSpace. A WorkSpace is marked UNHEALTHY when it fails to respond to these requests. Common causes for this problem are: • An application on the WorkSpace is blocking network ports, which prevents the WorkSpace from responding to the status request. • High CPU utilization is preventing the WorkSpace from responding to the status request in a timely manner. • The computer name of the WorkSpace has been changed. This prevents a secure channel from being established between WorkSpaces and the WorkSpace. You can attempt to correct the situation using the following methods: • Reboot the WorkSpace from the WorkSpaces console. • Connect to the unhealthy WorkSpace using the following procedure, which should be used only for troubleshooting purposes: 1. Connect to an operational WorkSpace in the same directory as the unhealthy WorkSpace. Troubleshoot specific issues 563 Amazon WorkSpaces Administration Guide 2. From the operational WorkSpace, use Remote Desktop Protocol (RDP) to connect to the unhealthy WorkSpace using the IP address of the unhealthy WorkSpace. Depending on the extent of the problem, you might not be able to connect to the unhealthy WorkSpace. 3. On the unhealthy WorkSpace, confirm that the minimum port requirements are met. • Make sure the SkyLightWorkSpacesConfigService service can respond to health checks. To troubleshoot this issue, see My users receive the message "WorkSpace Status: Unhealthy. We were unable to connect you to your WorkSpace. Please try again in a few minutes.". • Rebuild the WorkSpace from the WorkSpaces console. Because rebuilding a WorkSpace can potentially cause a loss of data, this option should be used only if all other attempts to correct the problem have been unsuccessful. My WorkSpace is unexpectedly crashing or rebooting If your WorkSpace configured for PCoIP is repeatedly crashing or rebooting and your error logs or crash dumps are pointing to problems with spacedeskHookKmode.sys or spacedeskHookUmode.dll, or if you're receiving the following error messages, you might need to disable Web Access to the WorkSpace: The kernel power manager has initiated a shutdown transition. Shutdown reason: Kernel API The computer has rebooted from a bugcheck. Note • These troubleshooting steps are not applicable to WorkSpaces that are configured for DCV. They are applicable only to WorkSpaces that are configured for PCoIP. • You should disable Web Access only if you aren't allowing your users to use Web Access. To disable Web Access to the WorkSpace, you must disable Web Access in the WorkSpaces directory and reboot the WorkSpace. Troubleshoot specific issues 564 Amazon WorkSpaces Administration Guide The same username has more than one WorkSpace, but the user can log in to only one of the WorkSpaces If you delete a user in Active Directory (AD) without first deleting their WorkSpace and then you add the user back to Active Directory and create a new WorkSpace for that user, the same username will now have two WorkSpaces in the same directory. However, if the user tries to connect to their original WorkSpace, they will receive the following error: "Unrecognized user. No WorkSpace found under your username. Contact your administrator to request one." Additionally, searches for the username in the Amazon WorkSpaces console return only the new WorkSpace, even though both WorkSpaces still exist. (You can find the original WorkSpace by searching for the WorkSpace ID instead of the username.) This behavior can also occur if you rename a user in Active Directory without first deleting their WorkSpace. If you then change their username back to the original username and create a new WorkSpace for the user, the same username will have two WorkSpaces in the directory. |
workspaces-ag-186 | workspaces-ag.pdf | 186 | following error: "Unrecognized user. No WorkSpace found under your username. Contact your administrator to request one." Additionally, searches for the username in the Amazon WorkSpaces console return only the new WorkSpace, even though both WorkSpaces still exist. (You can find the original WorkSpace by searching for the WorkSpace ID instead of the username.) This behavior can also occur if you rename a user in Active Directory without first deleting their WorkSpace. If you then change their username back to the original username and create a new WorkSpace for the user, the same username will have two WorkSpaces in the directory. This problem occurs because Active Directory uses the user's security identifier (SID), rather than the username, to uniquely identify the user. When a user is deleted and recreated in Active Directory, the user is assigned a new SID, even if their username remains the same. During searches for a username, the Amazon WorkSpaces console uses the SID to search Active Directory for matches. The Amazon WorkSpaces clients also use the SID to identify users when they are connecting to WorkSpaces. To resolve this problem, do one of the following: • If this problem occurred because the user was deleted and recreated in Active Directory, you might be able to restore the original deleted user object if you have enabled the Recycle Bin feature in Active Directory. If you're able to restore the original user object, make sure the user can connect to their original WorkSpace. If they can, you can delete the new WorkSpace after manually backing up and transferring any user data from the new WorkSpace to the original WorkSpace (if needed). • If you can't restore the original user object, delete the user's original WorkSpace. The user should be able to connect to and use their new WorkSpace instead. Be sure to manually back up and transfer any user data from the original WorkSpace to the new WorkSpace. Troubleshoot specific issues 565 Amazon WorkSpaces Warning Administration Guide Deleting a WorkSpace is a permanent action and cannot be undone. The WorkSpace user's data does not persist and is destroyed. For help with backing up user data, contact AWS Support. I'm having trouble using Docker with Amazon WorkSpaces Windows WorkSpaces Nested virtualization (including the use of Docker) is not supported on Windows WorkSpaces. For more information, see the Docker documentation. Linux WorkSpaces To use Docker on Linux WorkSpaces, make sure that the CIDR blocks used by Docker don't overlap with the CIDR blocks used in the two elastic network interfaces (ENIs) associated with the WorkSpace. If you encounter problems with using Docker on Linux WorkSpaces, contact Docker for assistance. I receive ThrottlingException errors to some of my API calls The default allowed rate for WorkSpaces API calls is a constant rate of two API calls per second, with a maximum allowed "burst" rate of five API calls per second. The following table shows how the burst rate limit works for API requests. Second Number of requests sent Net requests allowed Details 1 2 0 2 5 5 During the first second (second 1), five requests are allowed, up to the burst rate maximum of five calls per second. Because two or fewer calls were issued in second 1, the full burst capacity of five calls is still available. Troubleshoot specific issues 566 Amazon WorkSpaces Second Number of requests sent Net requests allowed Details Administration Guide 3 4 5 6 7 8 9 5 2 3 0 0 0 0 5 2 2 1 3 5 5 Because only two calls were issued in second 2, the full burst capacity of five calls is still available. Because the full burst capacity was used in second 3, only the constant rate of two calls per second is available. Because there is no remaining burst capacity, only two calls are allowed at this time. This means that one of the three API calls is throttled. The one throttled call will respond after a short delay. Because one of the calls from second 5 is being retried in second 6, there is capacity for only one additional call in second 6 because of the constant rate limit of two calls per second. Now that there are no longer any throttled API calls in the queue, the rate limit continues to increase, up to the burst rate limit of five calls. Because no calls were issued in second 7, the maximum number of requests is allowed. Even though no calls were issued in second 8, the rate limit does not increase above five. My WorkSpace keeps disconnecting when I let it run in the background For Mac users, check to see if the Power Nap feature is on. If it is on, turn it off. To turn Power Nap off, open your terminal and run |
workspaces-ag-187 | workspaces-ag.pdf | 187 | there are no longer any throttled API calls in the queue, the rate limit continues to increase, up to the burst rate limit of five calls. Because no calls were issued in second 7, the maximum number of requests is allowed. Even though no calls were issued in second 8, the rate limit does not increase above five. My WorkSpace keeps disconnecting when I let it run in the background For Mac users, check to see if the Power Nap feature is on. If it is on, turn it off. To turn Power Nap off, open your terminal and run the following command: defaults write com.amazon.workspaces NSAppSleepDisabled -bool YES Troubleshoot specific issues 567 Amazon WorkSpaces Administration Guide SAML 2.0 federation isn't working. My users are not authorized to stream their WorkSpaces desktop. This might happen because the inline policy that is embedded for the SAML 2.0 federation IAM role does not include permissions to stream from the directory Amazon Resource Name (ARN). The IAM role is assumed by the federated user who is accessing a WorkSpaces directory. Edit the role permissions to include the directory ARN and ensure that the user has a WorkSpace in the directory. For more information, see SAML 2.0 Authentication and Troubleshooting SAML 2.0 Federation with AWS. My users are getting disconnected from their WorkSpaces session every 60 minutes. If you have configured SAML 2.0 authentication to WorkSpaces, depending on your identity provider (IdP), you might need to configure the information that the IdP passes as SAML attributes to AWS as part of the authentication response. This includes configuring the Attribute element with the SessionDuration attribute set to https://aws.amazon.com/SAML/Attributes/ SessionDuration. SessionDuration specifies the maximum amount of time that a federated streaming session can remain active for a user before reauthentication is required. Although SessionDuration is an optional attribute, we recommend that you include it in the SAML authentication response. If you don't specify this attribute, the session duration defaults to 60 minutes. To resolve this issue, configure your IdP to include the SessionDuration value in the SAML authentication response and set the value as required. For more information, see Step 5: Create assertions for the SAML authentication response. My users get a redirect URI error when they federate using the SAML 2.0 identity provider (IdP)-initiated flow, or an additional instance of the WorkSpaces client application starts every time my users attempt to sign in from the client after federating to the IdP. This error occurs due to a relay state URL that's not valid. Make sure that the relay state in your IdP federation setup is correct, and that the user access URL and relay state parameter name are configured correctly for your IdP federation in the WorkSpaces directory properties. If they are valid and the problem still persists, contact AWS Support. For more information, see Setting Up SAML. Troubleshoot specific issues 568 Amazon WorkSpaces Administration Guide My users receive the message, "Something went wrong: An error occurred while launching your WorkSpace" when they attempt to sign in to the WorkSpaces client application after federating to the IdP. Review the SAML 2.0 assertions for your federation. The SAML Subject NameID value must match the WorkSpaces user name, and is typically the same as the sAMAccountName attribute for the Active Directory user. In addition, the Attribute element that has the PrincipalTag:Email attribute set to https://aws.amazon.com/SAML/Attributes/PrincipalTag:Email must match the WorkSpaces user's email address as defined in the WorkSpaces directory. For more information, see Setting Up SAML. My users receive the message, "Unable to validate tags” when they attempt to sign in to the WorkSpaces client application after federating to the IdP. Review the PrincipalTag attribute values in the SAML 2.0 assertions for your federation, such as https://aws.amazon.com/SAML/Attributes/PrincipalTag:Email. Tag values may include combinations of the characters _ . : / = + - @, letters, numbers, and spaces.. For more information, see Rules for tagging in IAM and AWS STS. My users receive the message, "The client and the server cannot communicate, because they do not possess a common algorithm". This problem can occur if you do not enable TLS 1.2. My microphone or web cam is not working on Windows WorkSpaces. Check your privacy setting by opening the Start menu • Start > Settings > Privacy > Camera • Start > Settings > Privacy > Microphone If they are turned off turn them on. Alternatively, WorkSpaces administrators can create a Group Policy Object (GPO) to enable microphone and or webcam as needed. Troubleshoot specific issues 569 Amazon WorkSpaces Administration Guide My users cannot log in using certificate-based authentication and are prompted for the password either at the WorkSpaces client or the Windows sign-on screen when they connect to their desktop session. Certificate-based authentication was unsuccessful for the session. If the problem continues, certificate-based authentication failure can be the |
workspaces-ag-188 | workspaces-ag.pdf | 188 | Start menu • Start > Settings > Privacy > Camera • Start > Settings > Privacy > Microphone If they are turned off turn them on. Alternatively, WorkSpaces administrators can create a Group Policy Object (GPO) to enable microphone and or webcam as needed. Troubleshoot specific issues 569 Amazon WorkSpaces Administration Guide My users cannot log in using certificate-based authentication and are prompted for the password either at the WorkSpaces client or the Windows sign-on screen when they connect to their desktop session. Certificate-based authentication was unsuccessful for the session. If the problem continues, certificate-based authentication failure can be the result of one of the following issues: • The WorkSpaces or the client is not supported. Certificate-based authentication is supported with Windows WorkSpaces on DCV bundles using the latest WorkSpaces Windows client application. • The WorkSpaces needs to be rebooted after enabling certificate-based authentication on the WorkSpaces Directory. • WorkSpaces could not communicate with AWS Private CA, or AWS Private CA did not issue the certificate. Check AWS CloudTrail to determine if a certificate was issued. For more information, see Manage certificate-based authentication. • The domain controller has no domain controller certificate for smart card logon, or it is expired. For more information, see step 7, “Configure domain controllers with a domain controller certificate to authenticate smart card users” in Prerequisites. • The certificate is not trusted. For more information, see step 7, “Publish the CA to Active Directory” in Prerequisites. Run certutil –viewstore –enterprise NTAuth on domain controllers to confirm that the CA is published. • There is a certificate in cache, but attributes have changed for the user that have invalidated the certificate. Contact Support to clear the cache before certificate expiry (24 hours). For more information, see Support Center. • The userPrincipalName format for the UserPrincipalName SAML attribute is not formatted properly or does not resolve to the actual domain for the user. For more information, see step 1 in in Prerequisites. • The (optional) ObjectSid attribute in your SAML assertion does not match the Active Directory security identifier (SID) for user specified in the SAML_Subject NameID. Confirm that attribute mapping is correct in your SAML federation and that your SAML identity provider is synchronizing the SID attribute for the Active Directory user. • There are Group Policy settings that are modifying the default Active Directory settings for smart card logon or taking action if a smart card is removed from a smart card reader. These settings may cause additional unexpected behavior than the errors listed above. Certificate- based authentication presents a virtual smart card to the instance operating system and removes Troubleshoot specific issues 570 Amazon WorkSpaces Administration Guide it after logon is complete. Check the Primary Group Policy settings for smart cards and the Additional smart card Group Policy settings and registry keys, including Smart card removal behavior. • The CRL distribution point for the private CA is not online nor accessible from either the WorkSpaces or the domain controller. For more information, see step 5 in Prerequisites. • To check if there are any stale CAs in the domain or forest, run PKIVIEW.msc on the CA to verify. If there are stale CAs, use the PKIVIEW.msc mmc to manually delete them. • To check if Active Directory replication is working and that there are no stale domain controllers in the domain, run repadmin /replsum. Additional troubleshooting steps involve reviewing the WorkSpaces instance Windows event logs. A common event to review for logon failure is Event 4625: An account failed to logon in the Windows Security log. If the problem persists, contact Support. For more information, see Support Center. I am trying to do something that requires Windows installation media but WorkSpaces does not provide it. If you are using an AWS-provided public bundle, you can use the Windows Server OS installation media EBS snapshots provided by Amazon EC2 when needed. Create an EBS volume from these snapshots, attach it to Amazon EC2, and transfer the files to the WorkSpace where the files as needed. If you are using Windows 10 on BYOL on WorkSpaces and need an installation media, you will need to prepare your own installation media. For more information, see Add Windows components using installation media. Since you can't directly attach an EBS volume to a WorkSpace, you'll need to attach it to an Amazon EC2 instance and copy the files. I want to launch WorkSpaces with an existing AWS Managed Directory created in an unsupported WorkSpaces Region. To launch Amazon WorkSpaces using a directory in a Region that is not currently supported by WorkSpaces, follow the steps below. Troubleshoot specific issues 571 Amazon WorkSpaces Note Administration Guide If you receive errors when running AWS Command Line Interface commands, ensure you’re using the most recent AWS CLI version. For more information, see |
workspaces-ag-189 | workspaces-ag.pdf | 189 | components using installation media. Since you can't directly attach an EBS volume to a WorkSpace, you'll need to attach it to an Amazon EC2 instance and copy the files. I want to launch WorkSpaces with an existing AWS Managed Directory created in an unsupported WorkSpaces Region. To launch Amazon WorkSpaces using a directory in a Region that is not currently supported by WorkSpaces, follow the steps below. Troubleshoot specific issues 571 Amazon WorkSpaces Note Administration Guide If you receive errors when running AWS Command Line Interface commands, ensure you’re using the most recent AWS CLI version. For more information, see Confirm that you're running a recent version of the AWS CLI. Step 1: Create virtual private cloud (VPC) peering with another VPC in your account 1. Create the VPC peering connection with a VPC in a different Region. For more information, see Create with VPCs in the same account and different Regions. 2. Accept the VPC peering connection. For more information, see Accept a VPC peering connection. 3. After you activate the VPC peering connection, you can view your VPC peering connections using the Amazon VPC console, the AWS CLI, or an API. Step 2: Update route tables for VPC peering in both Regions Update your route tables to turn on communication with the peer VPC over IPv4 or IPv6. For more information, see Update your route tables for a VPC peering connection. Step 3: Create an AD Connector and register Amazon WorkSpaces 1. To review the AD Connector prerequisites, see AD Connector prerequisites. 2. Connect your existing directory with AD Connector. For more information, see Create an AD Connector. 3. When the AD Connector status changes to Active, open the AWS Directory Service console, then choose the hyperlink for your Directory ID. 4. For AWS apps and services, choose Amazon WorkSpaces to turn on access for WorkSpaces on this directory. 5. Register the directory with WorkSpaces. For more information, see Register a directory with WorkSpaces. Troubleshoot specific issues 572 Amazon WorkSpaces Administration Guide I want to update Firefox on Amazon Linux 2. Step 1: Verify auto-update is enabled To verify that autoupdate is enabled, run the command systemctl status *os-update- mgmt.timer | grep enabled on your WorkSpace. In the output, there should be two lines with the word enabled on them. Step 2: Initiate an update Firefox usually updates automatically in Amazon Linux 2 WorkSpaces along with all other software packages in the system during the maintenance window. However, this depends on the type of WorkSpaces you are using. • For AlwaysOn WorkSpaces, the weekly maintenance window is on Sunday 00h00 to 04h00, in the time zone of the WorkSpace. • For AutoStop WorkSpaces. beginning on the third Monday of the month, and for up to two weeks, the maintenance window is open each day from about 00h00 to 05h00, in the time zone of the AWS Region for the WorkSpace. For more information about maintenance windows, see WorkSpace maintenance. You can also initiate an immediate update cycle by rebooting your WorkSpace and reconnecting after 15 minutes. You can also initiate updates by entering sudo yum update. To initiate an update for Firefox only, enter sudo yum install firefox. If you are not able to configure access for Amazon Linux 2 repositories and prefer to install Firefox using binaries built by Mozilla, see Install Firefox from Mozilla builds on Mozilla support. We recommend uninstalling the RPM-packaged version of Firefox altogether to make sure you don't run an outdated version by mistake. You can uninstall it by running command sudo yum remove firefox. You can also download the necessary RPM packages from Amazon Linux 2 repositories by running the command yumdownloader firefox on a different machine. Then, side-load the repositories onto WorkSpaces, where you can install them with a standard YUM command like sudo yum install firefox-102.11.0-2.amzn2.0.1.x86_64.rpm. Troubleshoot specific issues 573 Amazon WorkSpaces Note The exact file name will change based on the package version. Administration Guide Step 3: Verify Firefox repository is used Amazon Linux Extras automatically provides Firefox updates for Amazon Linux 2 WorkSpaces. Amazon Linux 2 WorkSpaces created after July 31, 2023 will already have the Firefox Extra repository activated. To verify that your WorkSpace is using the Firefox Extra repository, run the following command. yum repolist | grep amzn2extra-firefox The command output should look something like amzn2extra-firefox/2/x86_64 Amazon Extras repo for firefox 10 if Firefox Extra repository is used. It will be empty if the Firefox Extra repository is not used. If Firefox Extra repository is not used, you can attempt to enable it manually with the following command: sudo amazon-linux-extras install firefox If the Firefox Extra repository activation still fails, check your internet access and ensure that your VPC endpoints are unconfigured. To continue receiving Firefox updates for Amazon Linux 2 WorkSpaces via YUM repositories, |
workspaces-ag-190 | workspaces-ag.pdf | 190 | the Firefox Extra repository, run the following command. yum repolist | grep amzn2extra-firefox The command output should look something like amzn2extra-firefox/2/x86_64 Amazon Extras repo for firefox 10 if Firefox Extra repository is used. It will be empty if the Firefox Extra repository is not used. If Firefox Extra repository is not used, you can attempt to enable it manually with the following command: sudo amazon-linux-extras install firefox If the Firefox Extra repository activation still fails, check your internet access and ensure that your VPC endpoints are unconfigured. To continue receiving Firefox updates for Amazon Linux 2 WorkSpaces via YUM repositories, ensure that your WorkSpaces are able to reach Amazon Linux 2 repositories. For more information on accessing Amazon Linux 2 repositories without internet access, see this knowledge center article. My user is able to reset their password using the WorkSpaces client, ignoring the Fine Grained Password Policy (FFGP) setting that is configured on AWS Managed Microsoft AD. If your user's WorkSpaces client is associated with AWS Managed Microsoft AD, they will have to reset their password using the default complexity setting. The default complexity password is case-sensitive and must be between 8 and 64 characters in length, inclusive. It must contain at least one character from each of the following categories: • Lowercase characters (a-z) • Uppercase characters (A-Z) Troubleshoot specific issues 574 Amazon WorkSpaces • Numbers (0-9) • Non-alphanumeric characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/) Administration Guide Make sure the password doesn't include non-printable unicode characters, such as white spaces, carriage reture tabs, line breaks, and null characters. If your organization requires you to enforce FFGP for WorkSpaces, contact your Active Directory administrator to reset your user's password directly from the Active Directory instead of the WorkSpaces client. My users receive the error message "This OS/platform is not authorized to access your WorkSpace" when trying to access the Windows/Linux WorkSpace using Web Access The operating system version your user is trying to use isn't compatible with WorkSpaces Web Access. Make sure you enable Web Access under the WorkSpace directory's Other Platform setting. For more information on enabling your WorkSpace's Web Access, see Enable and configure WorkSpaces Web Access for WorkSpaces Personal. My user's WorkSpace is showing as unhealthy after they connect to an AutoStop WorkSpace that is in the stopped state Your user might be using software that is known to cause issues to the network interfaces when resuming from hibernation. For example, if the WorkSpace has the NPCAP 1.1 application installed, update to version 1.2 or above to resolve this issue. Gnome crashes on WorkSpaces Ubuntu bundles after login If a WorkSpace is launched using the ubuntu username, there will be conflicts with the ubuntu user that exists by default. This will cause crashes in Gnome and potentially other degraded performance. To avoid this issue, don't specify the ubuntu username when provisioning Ubuntu WorkSpaces. DCV host agent versions in WorkSpaces Personal DCV host agent is a host agent that runs inside your WorkSpace. It streams the pixels of your WorkSpace to a client application and includes in-session features, such as two-way audio and video, and printing. For more information about DCV, see Protocols for Amazon WorkSpaces. Release notes 575 Amazon WorkSpaces Administration Guide We recommend keeping your host agent software updated with the latest version. You can manually reboot your WorkSpaces to update the DCV host agent. The DCV host agent is also updated automatically during the regular WorkSpaces default maintenance window. For more information about maintenance windows, see WorkSpace maintenance. Some of these features require the latest WorkSpaces client version. For more information about the latest client versions, see WorkSpaces Clients. The following table describes the changes in each version of the DCV host agent for WorkSpaces Personal. Release Date Changes • Ubuntu WorkSpaces - 2.1.0.1923 May 1, 2025 • Bug fixes and performance improvements. • Rocky Linux WorkSpaces - April 10, 2025 • Bug fixes and performance 2.1.0.1843 • Red Hat Enterprise Linux WorkSpaces - 2.1.0.1843 improvements. • Windows WorkSpaces - 2.1.0.1840 March 19, 2025 • Fixed an issue where the list • Windows WorkSpaces - 2.1.0.1792 November 19, 2024 of printers was displayed even though the Printer Redirection GPO was disabled. • Bug fixes and performance improvements. Bug fixes and performance improvements. • Windows WorkSpaces - 2.1.0.1786 October 31, • Renamed the WorkSpaces 2024 Streaming Protocol (WSP) to Amazon DCV. • Fixed an audio ducking issue on the DCV agent for customers using the Avaya application. Release notes 576 Amazon WorkSpaces Release Date Changes Administration Guide • Windows WorkSpaces - 2.1.0.1757 August 19, 2024 • Fixed SmartCard login issues presented when user has been idle on the PIN prompt page. • Fixed a WebAuthn redirecti on issue during the first login attempt on the Chrome browser. • Bug fixes and performance improvements. • Added support for integration with IAM |
workspaces-ag-191 | workspaces-ag.pdf | 191 | and performance improvements. • Windows WorkSpaces - 2.1.0.1786 October 31, • Renamed the WorkSpaces 2024 Streaming Protocol (WSP) to Amazon DCV. • Fixed an audio ducking issue on the DCV agent for customers using the Avaya application. Release notes 576 Amazon WorkSpaces Release Date Changes Administration Guide • Windows WorkSpaces - 2.1.0.1757 August 19, 2024 • Fixed SmartCard login issues presented when user has been idle on the PIN prompt page. • Fixed a WebAuthn redirecti on issue during the first login attempt on the Chrome browser. • Bug fixes and performance improvements. • Added support for integration with IAM Identity Center (IdC). • Bug fixes and performance improvements. • Windows WorkSpaces - 2.1.0.1696 July 29, 2024 • Added support for Windows Graphics hosts. • Added WebRTC redirection support for Amazon Connect. • Fixed an issue that could prevent the service from running at system start. • Bug fixes and performance improvements. Release notes 577 Amazon WorkSpaces Release Date Changes Administration Guide • Windows WorkSpaces - 2.1.0.1554 May 15, 2024 • Added support for Idle Disconnect Timeout. • Added new Group Policy setting to configure Idle Disconnect Timeout. • Fixed an issue where WorkSpaces got disconnected and displayed a white screen when users modified the display settings. • Bug fixes and performance improvements. • Ubuntu WorkSpaces - 2.1.0.1342 February 29, 2024 • Changed preferred webcam resolution to between 480x360 and 640x480. • Bug fixes and performance improvements. Release notes 578 Amazon WorkSpaces Release Date Changes Administration Guide • Windows WorkSpaces - 2.0.0.1425 February 22, 2024 • Added support for in-session WebAuthn redirection requests from web applications running in remote Google Chrome or Microsoft Edge browsers. This feature adds a one-time browser prompt that asks the user to enable the DCV WebAuthn Redirection Extension. It is only supported on Windows WorkSpaces and WorkSpaces native clients. • Fixed an issue where a white or frozen screen sometimes appeared when logging in. • Bug fixes and performance improvements. • Windows WorkSpaces - 2.0.0.1304 January 11, 2024 • Fixed a bug related to potential streaming freezes during login. • Fixed a logging-related bug. Release notes 579 Amazon WorkSpaces Release Date Changes Administration Guide • Windows WorkSpaces - 2.0.0.1288 November 16, • Added support for Indirect Display 2023 Driver (IDD) on Windows 10+, which lowers CPU consumpti on and improves streaming performance. • Added new Group Policy setting to enable or disable IDD driver. • Fixed bugs related to clipboard image transparency. • Fixed bugs preserving Windows scale factors. • Bug fixes and performance improvements. • Windows WorkSpaces - 2.0.0.1164 October 13, • Added support for VSync in the 2023 virtual display driver. • Amazon Linux WorkSpaces - August 18, 2023 2.0.0.1086 • Ubuntu WorkSpaces - 2.1.0.1086 • Added new Group Policy setting to enable or disable VSync. • Improved reconnection and reliability issues. • Bug fixes and performance improvements. • Added new setting to enable or disable time zone redirection. • Extended logon timeout and added a configuration option. • Improved gateway to enable faster reconnections after disruption. • Bug fixes and performance improvements. Release notes 580 Amazon WorkSpaces Release Date Changes Administration Guide • Amazon Linux WorkSpaces - June 30, 2023 • Added support for the DCV 2.0.0.907 • Windows WorkSpaces - 2.0.0.829 June 8, 2023 • Ubuntu WorkSpaces - 2.1.0.829 May 16, 2023 Extension SDK to enable ISV-speci fic integrations. • Changed the disconnect behavior so that logging out terminates the user’s session. • Added support for time zone redirection. • Extended logon timeout and added a configuration option. • Fixed upgrade issues. • Bug fixes and performance improvements. • Changed disconnect behavior so that logging out terminates the user’s session. • Fixed bugs related to A/V sync and Japanese keyboards. • Improved DCV installer reliability. • Changed disconnect behavior so that logging out terminates the user’s session. • Added support for the DCV Extension SDK to enable ISV-speci fic integrations. • Added support for time zone redirection. • Fixed upgrade issues. Release notes 581 Amazon WorkSpaces Release Date Changes Administration Guide • Windows WorkSpaces - 2.0.0.799 May 8, 2023 • Enhanced UDP-based QUIC transport with several image quality and performance optimizations. • Added support for the DCV Extension SDK to enable ISV-speci fic integrations. • Added new Group Policy settings to enable or disable the Extension SDK. • Improved Korean, Japanese, and German keyboard layouts. • Fixed bugs related to session freeze issues, hardware accelerat ion, printer redirection, log verbosity, and target-fps Group Policy settings. Note • For information about how to check your host agent version, see What client and host operating systems are supported by the latest version of DCV?. • For information about how to update your host agent version, see If I already have a DCV WorkSpace, how do I update it?. • For DCV macOS client |
workspaces-ag-192 | workspaces-ag.pdf | 192 | ISV-speci fic integrations. • Added new Group Policy settings to enable or disable the Extension SDK. • Improved Korean, Japanese, and German keyboard layouts. • Fixed bugs related to session freeze issues, hardware accelerat ion, printer redirection, log verbosity, and target-fps Group Policy settings. Note • For information about how to check your host agent version, see What client and host operating systems are supported by the latest version of DCV?. • For information about how to update your host agent version, see If I already have a DCV WorkSpace, how do I update it?. • For DCV macOS client version release notes, see Release notes in the WorkSpaces macOS client application section of the WorkSpaces User Guide. • For DCV Windows client version release notes, see Release notes in the WorkSpaces Windows client application section of the WorkSpaces User Guide. Release notes 582 Amazon WorkSpaces Administration Guide Use and manage WorkSpaces Pools WorkSpaces Pools offers non-persistent virtual desktops, tailored for users who need access to highly-curated desktop environments hosted on ephemeral infrastructure. Topics • AWS Regions and Availability Zones for WorkSpaces Pools • Manage directories for WorkSpaces Pools • Networking and Access for WorkSpaces Pools • Create a WorkSpaces Pool • Administer WorkSpaces Pools • Using Active Directory with WorkSpaces Pools • Bundles and images for WorkSpaces Pools • Monitoring WorkSpaces Pools • Enable and Administer Persistent Storage for WorkSpaces Pools • Enable application settings persistence for your WorkSpaces Pools users • WorkSpaces Pools troubleshooting notification codes AWS Regions and Availability Zones for WorkSpaces Pools WorkSpaces Pools is available in the following AWS Regions. Note For the AWS Regions that apply to WorkSpaces Personal, see Amazon WorkSpaces endpoints and quotas in the AWS General Reference Reference guide. Region Name Region Endpoint Protocol Availabil US East (N. us- east-1 workspaces.us-east-1.amazonaws.com HTTPS Supported Regions and Availability Zones 583 ity Zones use1- az2, Amazon WorkSpaces Administration Guide Region Name Region Endpoint Protocol Availabil Virginia) workspaces-fips.us-east-1.amazonaws. HTTPS com US West (Oregon) us- west-2 workspaces.us-west-2.amazonaws.com HTTPS workspaces-fips.us-west-2.amazonaws. HTTPS com Asia Pacific ap- south-1 (Mumbai) Asia Pacific (Seoul) ap- northe ast-2 Asia Pacific (Singapor e) ap- southe ast-1 Asia Pacific (Sydney) ap- southe ast-2 workspaces.ap-south-1.amazonaws.com HTTPS workspaces.ap-northeast-2.amazonaws. com HTTPS workspaces.ap-southeast-1.amazonaws. com HTTPS workspaces.ap-southeast-2.amazonaws. com HTTPS ity Zones use1- az4, use1- az6 usw2- az1, usw2- az2, usw2- az3 aps1- az1, aps1- az3 apne2- az1, apne2- az3 apse1- az1, apse1- az2 apse2- az1, apse2- az3 Supported Regions and Availability Zones 584 Amazon WorkSpaces Administration Guide Region Name Region Endpoint Protocol Availabil Asia Pacific ap- northe workspaces.ap-northeast-1.amazonaws. com HTTPS (Tokyo) ast-1 Canada (Central) ca- centra l-1 workspaces.ca-central-1.amazonaws.com HTTPS Europe (Frankfur eu- centra workspaces.eu-central-1.amazonaws.co m HTTPS t) l-1 Europe (Ireland) eu- west-1 Europe (London) eu- west-2 Europe (Paris) eu- west-3 workspaces.eu-west-1.amazonaws.com HTTPS workspaces.eu-west-2.amazonaws.com HTTPS workspaces.eu-west-3.amazonaws.com HTTPS ity Zones apne1- az1, apne1- az4 cac1- az1, cac1- az2 euc1- az2, euc1- az3 euw1- az1, euw1- az2, euw1- az3 euw2- az2, euw2- az3 euw3- az1, euw3- az2, euw3- az3 Supported Regions and Availability Zones 585 Amazon WorkSpaces Administration Guide Region Name Region Endpoint Protocol Availabil workspaces.sa-east-1.amazonaws.com HTTPS South America sa- east-1 (São Paulo) AWS GovCloud us-gov- east-1 workspaces.us-gov-east-1.amazonaws.c om (US- East) workspaces-fips.us-gov-east-1.amazon aws.com AWS GovCloud us-gov- west-1 workspaces.us-gov-west-1.amazonaws.c om (US- West) workspaces-fips.us-gov-west-1.amazon aws.com HTTPS HTTPS HTTPS HTTPS ity Zones sae1- az1, sae1- az3 usgw1- az1, usgw1- az2, usgw1- az3 usge1- az1, usge1- az2, usge1- az3 Manage directories for WorkSpaces Pools WorkSpaces Pools uses a directory to store and manage information for your WorkSpaces and users. In this section, we show you how to create and manage directories for WorkSpaces Pools. Contents • Configure SAML 2.0 and create a WorkSpaces Pools directory • Update directory details for your WorkSpaces Pools • Deregister a WorkSpaces Pools directory Manage directories 586 Amazon WorkSpaces Administration Guide Configure SAML 2.0 and create a WorkSpaces Pools directory You can enable WorkSpaces client application registration and signing in to WorkSpaces in a WorkSpaces Pool by setting up identity federation using SAML 2.0. To do this, you use an AWS Identity and Access Management (IAM) role and a relay state URL to configure your SAML 2.0 identity provider (IdP) and enable it for AWS. This grants your federated users access to a WorkSpace Pool directory. The relay state is the WorkSpaces directory endpoint to which users are forwarded after successfully signing in to AWS. Important WorkSpaces Pools doesn't support IP-based SAML 2.0 configurations. Topics • Step 1: Consider the requirements • Step 2: Complete the prerequisites • Step 3: Create a SAML identity provider in IAM • Step 4: Create WorkSpace Pool directory • Step 5: Create a SAML 2.0 federation IAM role • Step 6: Configure your SAML 2.0 identity provider • Step 7: Create assertions for the SAML authentication response • Step 8: Configure the relay state of your federation • Step 9: Enable integration with SAML 2.0 |
workspaces-ag-193 | workspaces-ag.pdf | 193 | WorkSpaces directory endpoint to which users are forwarded after successfully signing in to AWS. Important WorkSpaces Pools doesn't support IP-based SAML 2.0 configurations. Topics • Step 1: Consider the requirements • Step 2: Complete the prerequisites • Step 3: Create a SAML identity provider in IAM • Step 4: Create WorkSpace Pool directory • Step 5: Create a SAML 2.0 federation IAM role • Step 6: Configure your SAML 2.0 identity provider • Step 7: Create assertions for the SAML authentication response • Step 8: Configure the relay state of your federation • Step 9: Enable integration with SAML 2.0 on your WorkSpace Pool directory • Troubleshooting • Specify Active Directory details for your WorkSpaces Pools directory Step 1: Consider the requirements The following requirements apply when setting up SAML for a WorkSpaces Pools directory. • The workspaces_DefaultRole IAM role must exist in your AWS account. This role is automatically created when you use the WorkSpaces Quick Setup or if you previously launched a WorkSpace using the AWS Management Console. It grants Amazon WorkSpaces permission to access specific AWS resources on your behalf. If the role already exists, you might need to attach Configure SAML 2.0 and create a pool directory 587 Amazon WorkSpaces Administration Guide the AmazonWorkSpacesPoolServiceAccess managed policy to it, which Amazon WorkSpaces uses to access required resources in the AWS account for WorkSpaces Pools. For more information, see Create the workspaces_DefaultRole Role and AWS managed policy: AmazonWorkSpacesPoolServiceAccess. • You can configure SAML 2.0 authentication for WorkSpaces Pools in the AWS Regions that support the feature. For more information, see AWS Regions and Availability Zones for WorkSpaces Pools. • To use SAML 2.0 authentication with WorkSpaces, the IdP must support unsolicited IdP-initiated SSO with a deep link target resource or relay state endpoint URL. Examples of IdPs that support this include ADFS, Azure AD, Duo Single Sign-On, Okta, PingFederate, and PingOne. Consult your IdP documentation for more information. • SAML 2.0 authentication is supported only on the following WorkSpaces clients. For the latest WorkSpaces clients, see the Amazon WorkSpaces Client Download page. • Windows client application version 5.20.0 or later • macOS client version 5.20.0 or later • Web Access Step 2: Complete the prerequisites Complete the following prerequisites before configuring your SAML 2.0 IdP connection to a WorkSpaces Pool directory. • Configure your IdP to establish a trust relationship with AWS. • See Integrating third-party SAML solution providers with AWS for more information on configuring AWS federation. Relevant examples include IdP integration with IAM to access the AWS Management Console. • Use your IdP to generate and download a federation metadata document that describes your organization as an IdP. This signed XML document is used to establish the relying party trust. Save this file to a location that you can access from the IAM console later. • Create a WorkSpaces Pool directory by using the WorkSpaces console. For more information, see Using Active Directory with WorkSpaces Pools. • Create a WorkSpaces Pool for users who can sign in to the IdP using a supported directory type. For more information, see Create a WorkSpaces Pool. Configure SAML 2.0 and create a pool directory 588 Amazon WorkSpaces Administration Guide Step 3: Create a SAML identity provider in IAM To get started, you must create a SAML IdP in IAM. This IdP defines your organization's IdP-to- AWS trust relationship using the metadata document generated by the IdP software in your organization. For more information, see Creating and managing a SAML identity provider in the AWS Identity and Access Management User Guide. For information about working with SAML IdPs in AWS GovCloud (US) Regions, see AWS Identity and Access Management in the AWS GovCloud (US) User Guide. Step 4: Create WorkSpace Pool directory Complete the following procedure to create a WorkSpaces Pool directory. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose Create directory. 4. 5. For WorkSpace type, choose Pool. In the User identity source section of the page: a. Enter a placeholder value into the User access URL text box. For example, enter placeholder into the text box. You will edit this later after setting up the application entitlement in your IdP. b. Leave the Relay state parameter name text box blank. You will edit this later after setting up the application entitlement in your IdP. 6. In the Directory information section of the page, enter a name and a description for the directory. The directory name and description must be less than 128 characters, can contain alphanumeric characters and the following special characters: _ @ # % * + = : ? . / ! \ -. The directory name and description cannot start with a special character. 7. In the Networking and security section of the page: a. Choose a |
workspaces-ag-194 | workspaces-ag.pdf | 194 | b. Leave the Relay state parameter name text box blank. You will edit this later after setting up the application entitlement in your IdP. 6. In the Directory information section of the page, enter a name and a description for the directory. The directory name and description must be less than 128 characters, can contain alphanumeric characters and the following special characters: _ @ # % * + = : ? . / ! \ -. The directory name and description cannot start with a special character. 7. In the Networking and security section of the page: a. Choose a VPC and 2 subnets that have access to the network resources that your application needs. For increased fault tolerance, you should choose two subnets in different Availability Zones. b. Choose a security group that allows WorkSpaces to create network links in your VPC. Security groups control what network traffic is allowed to flow from WorkSpaces to your VPC. For example, if your security group restricts all inbound HTTPS connections, users accessing your web portal won't be able to load HTTPS websites from the WorkSpaces. Configure SAML 2.0 and create a pool directory 589 Amazon WorkSpaces Administration Guide 8. The Active Directory Config section is optional. However, you should specify your Active Directory (AD) details during the creation of your WorkSpaces Pools directory if you plan to use an AD with your WorkSpaces Pools. You can't edit the Active Directory Config for your WorkSpaces Pools directory after you create it. For more information about specifying your AD details for your WorkSpaces Pool directory, see Specify Active Directory details for your WorkSpaces Pools directory. After you complete the process outlined in that topic, you should return to this topic to finish creating your WorkSpaces Pools directory. You can skip the Active Directory Config section if you don't plan on using an AD with your WorkSpaces Pools. 9. In the Streaming properties section of the page: • Choose the clipboard permissions behavior, and enter a copy to local character limit (optional), and paste to remote session character limit (optional). • Choose to allow or not allow print to local device. • Choose to allow or not allow diagnostic logging. • Choose to allow or not allow smart card sign in. This feature applies only if you enabled AD configuration earlier in this procedure. 10. In the Storage section of the page, you can choose to enable home folders. 11. In the IAM role section of the page, choose an IAM role to be available to all desktop streaming instances. To create a new one, choose Create new IAM role. When you apply an IAM role from your account to a WorkSpace Pool directory, you can make AWS API requests from a WorkSpace in the WorkSpace Pool without manually managing AWS credentials. For more information, see Creating a role to delegate permissions to an IAM user in AWS Identity and Access Management User Guide. 12. Choose Create directory. Step 5: Create a SAML 2.0 federation IAM role Complete the following procedure to create a SAML 2.0 federation IAM role in the IAM console. 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. Choose Roles in the navigation pane. 3. Choose Create role. 4. Choose SAML 2.0 federation for the trusted entity type. Configure SAML 2.0 and create a pool directory 590 Amazon WorkSpaces Administration Guide 5. For SAML 2.0-based provider, choose the identity provider you created in IAM. For more information, see Create a SAML identity provider in IAM. 6. Choose Allow programmatic access only for the access to be allowed. 7. Choose SAML:sub_type for the attribute. 8. For Value, enter https://signin.aws.amazon.com/saml. This value restricts role access to SAML user streaming requests that include a SAML subject type assertion with a value of persistent. If the SAML:sub_type is persistent, your IdP sends the same unique value for the NameID element in all SAML requests from a particular user. For more information, see Uniquely identifying users in SAML-based federation in AWS Identity and Access Management User Guide. 9. Choose Next to continue. 10. Don't make changes or selections in the Add permissions page. Choose Next to continue. 11. Enter a name and a description for the role. 12. Choose Create role. 13. In the Roles page, choose the role you must created. 14. Choose the Trust relationships tab. 15. Choose Edit trust policy. 16. In the Edit trust policy JSON text box, add the sts:TagSession action to the trust policy. For more information, see Passing session tags in AWS STS in AWS Identity and Access Management User Guide. The result should look like the following example. Configure SAML 2.0 and create a pool directory 591 Amazon WorkSpaces Administration Guide 17. Choose Update policy. 18. Choose the Permissions tab. 19. In the Permissions policies section of the |
workspaces-ag-195 | workspaces-ag.pdf | 195 | role. 12. Choose Create role. 13. In the Roles page, choose the role you must created. 14. Choose the Trust relationships tab. 15. Choose Edit trust policy. 16. In the Edit trust policy JSON text box, add the sts:TagSession action to the trust policy. For more information, see Passing session tags in AWS STS in AWS Identity and Access Management User Guide. The result should look like the following example. Configure SAML 2.0 and create a pool directory 591 Amazon WorkSpaces Administration Guide 17. Choose Update policy. 18. Choose the Permissions tab. 19. In the Permissions policies section of the page choose Add permissions and then choose Create inline policy. 20. In the Policy editor section of the page, choose JSON. 21. In the Policy editor JSON text box, enter the following policy. Be sure to replace: • <region-code> with the code of the AWS Region in which you created your WorkSpace Pool directory. • <account-id> with the AWS account ID. • <directory-id> with the ID of the directory you created earlier. You can get this in the WorkSpaces console. For resources in AWS GovCloud (US) Regions, use the following format for the ARN: arn:aws- us-gov:workspaces:<region-code>:<account-id>:directory/<directory-id>. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "workspaces:Stream", "Resource": "arn:aws:workspaces:<region-code>:<account- id>:directory/<directory-id>", "Condition": { "StringEquals": {"workspaces:userId": "${saml:sub}"} } } ] } 22. Choose Next. 23. Enter a name for the policy, and then choose Create policy. Step 6: Configure your SAML 2.0 identity provider Depending on your SAML 2.0 IdP, you might need to manually update your IdP to trust AWS as a service provider. You do this by downloading the saml-metadata.xml file found at https:// Configure SAML 2.0 and create a pool directory 592 Amazon WorkSpaces Administration Guide signin.aws.amazon.com/static/saml-metadata.xml, and then uploading it to your IdP. This updates your IdP’s metadata. For some IdPs, the update might already be configured. You can skip this step if it's already configured. If the update isn't already configured in your IdP, review the documentation provided by your IdP for information about how to update the metadata. Some providers give you the option to type the URL of the XML file into their dashboard, and the IdP obtains and installs the file for you. Others require you to download the file from the URL and then upload it to their dashboard. Important At this time, you can also authorize users in your IdP to access the WorkSpaces application you have configured in your IdP. Users who are authorized to access the WorkSpaces application for your directory don't automatically have a WorkSpace created for them. Likewise, users that have a WorkSpace created for them are not automatically authorized to access the WorkSpaces application. To successfully connect to a WorkSpace using SAML 2.0 authentication, a user must be authorized by the IdP and must have a WorkSpace created. Step 7: Create assertions for the SAML authentication response Configure the information that your IdP sends to AWS as SAML attributes in its authentication response. Depending on your IdP, this is might already be configured. You can skip this step if it's already configured. If it's not already configured, provide the following: • SAML Subject NameID — The unique identifier for the user who is signing in. Don't change the format/value of this field. Otherwise, the home folder feature will not work as expected because the user will be treated as different user. Note For domain-joined WorkSpaces Pools, the NameID value for the user must be provided in the domain\username format using the sAMAccountName, or in the username@domain.com format using userPrincipalName, or just userName. If you are using the sAMAccountName format, you can specify the domain by using either the NetBIOS name or the fully qualified domain name (FQDN). The sAMAccountName format is required for Active Directory one-way trust scenarios. For more information, see Using Configure SAML 2.0 and create a pool directory 593 Amazon WorkSpaces Administration Guide Active Directory with WorkSpaces Pools. if just userName is provided, the user will be logged in to the primary-domain • SAML Subject Type (with a value set to persistent) — Setting the value to persistent ensures that your IdP sends the same unique value for the NameID element in all SAML requests from a particular user. Make sure that your IAM policy includes a condition to only allow SAML requests with a SAML sub_type set to persistent, as described in the Step 5: Create a SAML 2.0 federation IAM role section. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/Role — This element contains one or more AttributeValue elements that list the IAM role and SAML IdP to which the user is mapped by your IdP. The role and IdP are specified as a comma-delimited pair of ARNs. An example of the expected value is arn:aws:iam::<account-id>:role/<role-name>,arn:aws:iam::<account- id>:saml-provider/<provider-name>. • Attribute element |
workspaces-ag-196 | workspaces-ag.pdf | 196 | from a particular user. Make sure that your IAM policy includes a condition to only allow SAML requests with a SAML sub_type set to persistent, as described in the Step 5: Create a SAML 2.0 federation IAM role section. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/Role — This element contains one or more AttributeValue elements that list the IAM role and SAML IdP to which the user is mapped by your IdP. The role and IdP are specified as a comma-delimited pair of ARNs. An example of the expected value is arn:aws:iam::<account-id>:role/<role-name>,arn:aws:iam::<account- id>:saml-provider/<provider-name>. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/RoleSessionName — This element contains one AttributeValue element that provides an identifier for the AWS temporary credentials that are issued for SSO. The value in the AttributeValue element must be between 2 and 64 characters long, can contain alphanumeric characters and the following special characters: _ . : / = + - @. It can't contain spaces. The value is typically an email address or a user principal name (UPN). It shouldn't be a value that includes a space, such as a user's display name. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/PrincipalTag:Email — This element contains one AttributeValue element that provides the email address of the user. The value must match the WorkSpaces user email address as defined in the WorkSpaces directory. Tag values may include combinations of letters, numbers, spaces, and _ . : / = + - @ characters. For more information, see Rules for tagging in IAM and AWS STS in the AWS Identity and Access Management User Guide. • (Optional) Attribute element with the Name attribute set to https://aws.amazon.com/ SAML/Attributes/PrincipalTag:UserPrincipalName — This element contains one AttributeValue element that provides the Active Directory userPrincipalName for the user who is signing in. The value must be provided in the username@domain.com format. This parameter is used with certificate-based authentication as the Subject Alternative Name in the end user certificate. For more information, see Certificate-based authentication and WorkSpaces Personal. Configure SAML 2.0 and create a pool directory 594 Amazon WorkSpaces Administration Guide • (Optional) Attribute element with the Name attribute set to https://aws.amazon.com/ SAML/Attributes/PrincipalTag:ObjectSid (optional) — This element contains one AttributeValue element that provides the Active Directory security identifier (SID) for the user who is signing in. This parameter is used with certificate-based authentication to enable strong mapping to the Active Directory user. For more information, see Certificate-based authentication and WorkSpaces Personal. • (Optional) Attribute element with the Name attribute set to https://aws.amazon.com/ SAML/Attributes/PrincipalTag:Domain — This element contains one AttributeValue element that provides the Active Directory DNS fully qualified domain name (FQDN) for users signing in. This parameter is used with certificate-based authentication when the Active Directory userPrincipalName for the user contains an alternative suffix. The value must be provided in the domain.com format, and must include any subdomains. • (Optional) Attribute element with the Name attribute set to https://aws.amazon.com/ SAML/Attributes/SessionDuration — This element contains one AttributeValue element that specifies the maximum amount of time that a federated streaming session for a user can remain active before re-authentication is required. The default value is 3600 seconds (60 minutes). For more information, see the SAML SessionDurationAttribute in the AWS Identity and Access Management User Guide. Note Although SessionDuration is an optional attribute, we recommend that you include it in the SAML response. If you don't specify this attribute, the session duration is set to a default value of 3600 seconds (60 minutes). WorkSpaces desktop sessions are disconnected after their session duration expires. For more information about how to configure these elements, see Configuring SAML assertions for the authentication response in the AWS Identity and Access Management User Guide. For information about specific configuration requirements for your IdP, see your IdP's documentation. Step 8: Configure the relay state of your federation Use your IdP to configure the relay state of your federation to point to the WorkSpaces Pool directory relay state URL. After successful authentication by AWS, the user is directed to the WorkSpaces Pool directory endpoint, defined as the relay state in the SAML authentication response. Configure SAML 2.0 and create a pool directory 595 Amazon WorkSpaces Administration Guide The following is the relay state URL format: https://relay-state-region-endpoint/sso-idp?registrationCode=registration-code The following table lists the relay state endpoints for the AWS Regions where WorkSpaces SAML 2.0 authentication is available. AWS Regions in which the WorkSpaces Pools feature is not available have been removed. Region Relay state endpoint US East (N. Virginia) Region • workspaces.euc-sso.us-east-1.aws.ama zon.com • (FIPS) workspaces.euc-sso-fips.us-east-1.aw s.amazon.com US West (Oregon) Region • workspaces.euc-sso.us-west-2.aws.ama Asia Pacific (Mumbai) Region Asia Pacific (Seoul) Region Asia Pacific (Singapore) Region Asia Pacific (Sydney) Region Asia Pacific (Tokyo) Region Canada (Central) Region zon.com • (FIPS) workspaces.euc-sso-fips.us-west-2.aw s.amazon.com workspaces.euc-sso.ap-south-1.aws.am azon.com workspaces.euc-sso.ap-northeast-2.aw s.amazon.com workspaces.euc-sso.ap-southeast-1.aw s.amazon.com workspaces.euc-sso.ap-southeast-2.aw s.amazon.com workspaces.euc-sso.ap-northeast-1.aw |
workspaces-ag-197 | workspaces-ag.pdf | 197 | following is the relay state URL format: https://relay-state-region-endpoint/sso-idp?registrationCode=registration-code The following table lists the relay state endpoints for the AWS Regions where WorkSpaces SAML 2.0 authentication is available. AWS Regions in which the WorkSpaces Pools feature is not available have been removed. Region Relay state endpoint US East (N. Virginia) Region • workspaces.euc-sso.us-east-1.aws.ama zon.com • (FIPS) workspaces.euc-sso-fips.us-east-1.aw s.amazon.com US West (Oregon) Region • workspaces.euc-sso.us-west-2.aws.ama Asia Pacific (Mumbai) Region Asia Pacific (Seoul) Region Asia Pacific (Singapore) Region Asia Pacific (Sydney) Region Asia Pacific (Tokyo) Region Canada (Central) Region zon.com • (FIPS) workspaces.euc-sso-fips.us-west-2.aw s.amazon.com workspaces.euc-sso.ap-south-1.aws.am azon.com workspaces.euc-sso.ap-northeast-2.aw s.amazon.com workspaces.euc-sso.ap-southeast-1.aw s.amazon.com workspaces.euc-sso.ap-southeast-2.aw s.amazon.com workspaces.euc-sso.ap-northeast-1.aw s.amazon.com workspaces.euc-sso.ca-central-1.aws. amazon.com Configure SAML 2.0 and create a pool directory 596 Amazon WorkSpaces Region Europe (Frankfurt) Region Europe (Ireland) Region Europe (London) Region South America (São Paulo) Region Administration Guide Relay state endpoint workspaces.euc-sso.eu-central-1.aws. amazon.com workspaces.euc-sso.eu-west-1.aws.ama zon.com workspaces.euc-sso.eu-west-2.aws.ama zon.com workspaces.euc-sso.sa-east-1.aws.ama zon.com AWS GovCloud (US-West) • workspaces.euc-sso.us-gov-west-1.ama zonaws-us-gov.com • (FIPS) workspaces.euc-sso-fips.us-gov-west- 1.amazonaws-us-gov.com Note For information about working with SAML IdPs in AWS GovCloud (US) Regions, see Amazon WorkSpaces in the AWS GovCloud (US) User Guide. Configure SAML 2.0 and create a pool directory 597 Amazon WorkSpaces Region Relay state endpoint Administration Guide AWS GovCloud (US-East) • workspaces.euc-sso.us-gov-east-1.ama zonaws-us-gov.com • (FIPS) workspaces.euc-sso-fips.us-gov-east- 1.amazonaws-us-gov.com Note For information about working with SAML IdPs in AWS GovCloud (US) Regions, see Amazon WorkSpaces in the AWS GovCloud (US) User Guide. Step 9: Enable integration with SAML 2.0 on your WorkSpace Pool directory Complete the following procedure to enable SAML 2.0 authentication for the WorkSpaces Pool directory. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the Pools directories tab. 4. Choose the ID of the directory you want to edit. 5. Choose Edit in the Authentication section of the page. 6. Choose Edit SAML 2.0 Identity Provider. 7. For the User Access URL, which is sometimes know as the "SSO URL", replace the placeholder value with the SSO URL provided to you by your IdP. 8. For the IdP deep link parameter name, enter the parameter that is applicable to your IdP and the application you have configured. The default value is RelayState if you omit the parameter name. The following table lists the user access URLs and deep link parameter names that are unique to various identity providers for applications. Configure SAML 2.0 and create a pool directory 598 Amazon WorkSpaces Administration Guide Identity provider Parameter User access URL ADFS RelayState Azure AD RelayState Duo Single Sign-On RelayState Okta RelayState OneLogin RelayState JumpCloud RelayState https://<host>/ adfs/ls/idpinitia tedsignon.aspx? RelayState=R PID= <relaying- party-uri> https://myapps.mic rosoft.com/signin/ <app-id>?tenantId = <tenant-id> https://<sub-doma in> .sso.duos ecurity.com/saml2/ sp/ <app-id>/sso https://<sub-doma in> .okta.com/ app/<app-name> /<app- id>/sso/saml https://<sub-doma in> .onelogin.com/ trust/saml2/http- post/sso/ <app-id> https://sso.jumpcl oud.com/saml2/ <app- id> Configure SAML 2.0 and create a pool directory 599 Amazon WorkSpaces Administration Guide Identity provider Parameter User access URL Auth0 RelayState https://<default- tenant-na me> .us.auth0.com/ samlp/ <client-id> PingFederate TargetResource https://<host>/idp/ PingOne for Enterprise TargetResource startSSO.ping? PartnerSpId= <sp-id> https://sso.connec t.pingidentity.com /sso/sp/initsso? saasid= <app- id>&idpid=<idp-id> 9. Choose Save. Important Revoking SAML 2.0 from a user won't directly disconnect their session. They will be removed only after the timeout kicks in. They can also terminate it using the TerminateWorkspacesPoolSession API. Troubleshooting The following information can help you troubleshoot specific issues with your WorkSpaces Pools. I am receiving an "Unable to login" message in the WorkSpaces Pools client after completing SAML authentication The nameID and PrincipalTag:Email in the SAML claims need to match the username and email configured in Active Directory. Some IdP's may require an update, refresh, or redeploy after adjusting certain attributes. If you make an adjustment and it is not reflected in your SAML capture, refer to your IdP's documentation or support program regarding the specific steps required to make the change take effect. Configure SAML 2.0 and create a pool directory 600 Amazon WorkSpaces Administration Guide Specify Active Directory details for your WorkSpaces Pools directory In this topic, we show you how to specify your Active Directory (AD) details within the Create WorkSpaces Pool directory page of the WorkSpaces console. As you create your WorkSpaces Pool directory, you should specify your AD details if you plan to use an AD with your WorkSpaces Pools. You cannot edit the Active Directory Config for your WorkSpaces Pools directory after you create it. Following is an example of the Active Directory Config section of the Create WorkSpaces Pool directory page. Note The full process for creating a WorkSpaces Pool directory is outlined in the Configure SAML 2.0 and create a WorkSpaces Pools directory topic. The procedures outlined on this page represent only a subset of steps of the full process to create a WorkSpaces Pool directory. Topics • Specify the organization unit and directory domain name for your AD • Specify the service account for your AD Configure SAML 2.0 and create |
workspaces-ag-198 | workspaces-ag.pdf | 198 | Directory Config for your WorkSpaces Pools directory after you create it. Following is an example of the Active Directory Config section of the Create WorkSpaces Pool directory page. Note The full process for creating a WorkSpaces Pool directory is outlined in the Configure SAML 2.0 and create a WorkSpaces Pools directory topic. The procedures outlined on this page represent only a subset of steps of the full process to create a WorkSpaces Pool directory. Topics • Specify the organization unit and directory domain name for your AD • Specify the service account for your AD Configure SAML 2.0 and create a pool directory 601 Amazon WorkSpaces Administration Guide Specify the organization unit and directory domain name for your AD Complete the following procedure to specify an organizational unit (OU) and a directory domain name for your AD in the Create a WorkSpaces Pool directory page. 1. For Organization Unit, enter the OU that the pool belongs to. WorkSpace machine accounts are placed in the organizational unit (OU) that you specify for the WorkSpaces Pool directory. Note The OU name can't contain spaces. If you specify an OU name that contains spaces, when it attempts to rejoin the Active Directory domain, WorkSpaces cannot cycle the computer objects correctly and the domain rejoin doesn't work. 2. For Directory domain name, enter the fully qualified domain name (FQDN) of the Active Directory domain (for example, corp.example.com). Each AWS Region can have only one directory config value with a specific directory name. • You can join your WorkSpaces Pool directories to domains in Microsoft Active Directory. You can also use your existing Active Directory domains, either cloud-based or on-premises, to launch domain-joined WorkSpaces. • You can also use AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD, to create an Active Directory domain. Then, you can use that domain to support your WorkSpaces resources. • By joining WorkSpaces to your Active Directory domain, you can: • Allow your users and applications to access Active Directory resources, such as printers and file shares from streaming sessions. • Use Group Policy settings that are available in the Group Policy Management Console (GPMC) to define the end user experience. • Stream applications that require users to be authenticated using their Active Directory login credentials. • Apply your enterprise compliance and security policies to your WorkSpaces streaming instances. 3. For Service account, continue to the Specify the service account for your AD next section of this page. Configure SAML 2.0 and create a pool directory 602 Amazon WorkSpaces Administration Guide Specify the service account for your AD When you configure Active Directory (AD) for your WorkSpaces Pools as part of the directory creation process, you must specify the AD service account to be used for managing the AD. This requires that you provide the service account credentials, which must be stored in AWS Secrets Manager and encrypted using a AWS Key Management Service (AWS KMS) customer managed key. In this section, we show you how to create the AWS KMS customer managed key and the Secrets Manager secret to store your AD service account credentials. Step 1: Create an AWS KMS customer managed key Complete the following procedure to create an AWS KMS customer managed key 1. Open the AWS KMS console at https://console.aws.amazon.com/kms. 2. To change the AWS Region, use the Region selector in the upper-right corner of the page. 3. Choose Create a key, and then choose Next. 4. Choose Symetric for the key type, and Encrypt and decrypt for the key usage, and then choose Next. 5. Enter an alias for the key, such as WorkSpacesPoolDomainSecretKey, and then choose Next. 6. Don't choose a key administrator. Choose Next to continue. 7. Don't define key usage permissions. Choose Next to continue. 8. In the Key policy section of the page, add the following: { "Sid": "Allow access for Workspaces SP", "Effect": "Allow", "Principal": { "Service": "workspaces.amazonaws.com" }, "Action": "kms:Decrypt", "Resource": "*" } The result should appear like the following example. Configure SAML 2.0 and create a pool directory 603 Amazon WorkSpaces Administration Guide 9. Choose Finish. Your AWS KMS customer managed key is now ready to be used with Secrets Manager. Continue to the Step 2: Create Secrets Manager secret to store your AD service account credentials section of this page. Step 2: Create Secrets Manager secret to store your AD service account credentials Complete the following procedure to create a Secrets Manager secret to store your AD service account credentials. 1. Open the AWS Secrets Manager console at https://console.aws.amazon.com/secretsmanager/. 2. Choose Create a new secret. 3. Choose Other type of secret. 4. 5. 6. For the first key/value pair, enter Service Account Name for the key, and the name of the service account for the value, such as domain\username. For |
workspaces-ag-199 | workspaces-ag.pdf | 199 | Continue to the Step 2: Create Secrets Manager secret to store your AD service account credentials section of this page. Step 2: Create Secrets Manager secret to store your AD service account credentials Complete the following procedure to create a Secrets Manager secret to store your AD service account credentials. 1. Open the AWS Secrets Manager console at https://console.aws.amazon.com/secretsmanager/. 2. Choose Create a new secret. 3. Choose Other type of secret. 4. 5. 6. For the first key/value pair, enter Service Account Name for the key, and the name of the service account for the value, such as domain\username. For the second key/value pair, enter a Service Account Password for the key, and the password of the service account for the value. For the encryption key, choose the AWS KMS customer managed key that you created earlier, and then choose Next. 7. Enter a name for the secret, such as WorkSpacesPoolDomainSecretAD. Configure SAML 2.0 and create a pool directory 604 Amazon WorkSpaces Administration Guide 8. Choose Edit permissions in the Resource permissions section of the page. 9. Enter the following permission policy: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": [ "workspaces.amazonaws.com" ] }, "Action": "secretsmanager:GetSecretValue", "Resource": "*" } ] } 10. Choose Save to save the permission policy. 11. Choose Next to continue. 12. Don't configure automatic rotation. Choose Next to continue. 13. Choose Store to finish storing your secret. Your AD service account credentials are now stored in Secrets Manager. Continue to the Step 3: Select the Secrets Manager secret that contains your AD service account credentails section of this page. Step 3: Select the Secrets Manager secret that contains your AD service account credentails Complete the following procedure to select the Secrets Manager secret you created in the Active Directory config for your WorkSpaces Pool directory. • For Service account, choose the AWS Secrets Manager secret that contains your service account credentials. Complete the following steps to create the secret if you haven't already done so. The secret must be encrypted using a AWS Key Management Service customer managed key. Configure SAML 2.0 and create a pool directory 605 Amazon WorkSpaces Administration Guide Now that you've completed all of the fields within the Active Directory Config section of the Create WorkSpaces Pool directory page, you can continue to finish creating your WorkSpaces Pool directory. Go to Step 4: Create WorkSpace Pool directory and start on step 9 of the procedure. Update directory details for your WorkSpaces Pools You can complete the following directory management tasks using the WorkSpaces Pools console. Authentication You can configure additional authentication options for your WorkSpaces Pools. Pools requires SAML 2.0 authentication. To enable and configure SAML 2.0 Identity Provider authentiation 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to authentication and choose Edit. 5. Choose Edit SAML 2.0 Identity Provider. 6. Check the Enable SAML 2.0 authentication checkbox. 7. 8. Enter the User Access URL to direct the WorkSpaces Pools client during federated sign-in. Enter the IdP deep link parameter name (optional). 9. Choose Save. To enable and configure Certificate-Based Authentication 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to Authentication and choose Edit. 5. Choose Edit Certificate-Based Authentication. 6. Check the Enable Certificate-Based Authentication checkbox. 7. Choose from the dropdown the AWS Certificate Manager (ACM) Private Certificate Authority (CA). Update directory details 606 Amazon WorkSpaces 8. Choose Save. Security group Administration Guide Apply a security group to your WorkSpaces Pools in your directory. To configure security group for your WorkSpaces Pools 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to Security group and choose Edit. 5. From the dropdown, choose a security group. Active Directory Config Configure your directory Active Directory Config with an Organization Unit (OU), directory domain name, and AWS Secrets Manager secret. To configure your Active Directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to Active Directory Config and choose Edit. 5. To find an Organizational Unit (OU), you can start typing all or part of the OU name and choose the OU you want to use. Note (Optional) After choosing the OU, rebuild the existing WorkSpaces to update the OU. For more information, see Rebuild a WorkSpace in WorkSpaces Personal 6. Choose Save. Update directory details 607 Amazon WorkSpaces Note Administration Guide The directory domain name and AWS Secrets Manager secret can't be edited after you've created your pool. Streaming properties Configure how your users can transfer data between |
workspaces-ag-200 | workspaces-ag.pdf | 200 | to configure. 4. Go to Active Directory Config and choose Edit. 5. To find an Organizational Unit (OU), you can start typing all or part of the OU name and choose the OU you want to use. Note (Optional) After choosing the OU, rebuild the existing WorkSpaces to update the OU. For more information, see Rebuild a WorkSpace in WorkSpaces Personal 6. Choose Save. Update directory details 607 Amazon WorkSpaces Note Administration Guide The directory domain name and AWS Secrets Manager secret can't be edited after you've created your pool. Streaming properties Configure how your users can transfer data between their pooled WorkSpace and their local device. To configure streaming properties 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to Streaming properties and choose Edit. 5. Configure the following streaming properties: • Clipboard permissions • From the drop down list, choose one of the following: • Allow copy and paste - Allows copying to local device and pasting to remote session. • Allow paste to remote session - Allows pasting to remote session. • Allow copy to local device - Allows copying to a local device. • Disabled • Choose to allow or not allow print to local device. • Choose to allow or not allow diagnostic logging. • Choose to allow or not allow smart card sign in. • To enable Home Folders storage, choose Enable Home Folders. 6. Choose Save. IAM role Select an IAM role for you WorkSpaces Pools. Update directory details 608 Amazon WorkSpaces To select an IAM role Administration Guide 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to IAM role and choose Edit. 5. Choose an IAM role from the drop down. To create a new IAM role, choose Create new IAM role. 6. Choose Save. Tags Add new tags to your WorkSpaces Pools To add a new tag 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Choose the directory you want to configure. 4. Go to Tags and choose Manage tags. 5. Choose Add new tags and enter the key pair value that you want to use. A key can be a general category, such as "project," "owner," or "environment," with specific associated values. 6. Choose Save changes. Deregister a WorkSpaces Pools directory Complete the following procedures to deregister a WorkSpaces Pools directory. 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Directories in the navigation pane. 3. Select the directory. 4. Choose Actions, Deregister. 5. When prompted for confirmation, choose Deregister. After deregistration is complete, the value of Registered is No. Deregister a WorkSpaces Pools directory 609 Amazon WorkSpaces Administration Guide Networking and Access for WorkSpaces Pools The following topics provide information about enabling users to connect to WorkSpaces Pools and enabling your WorkSpaces Pools to access network resources and the internet. Contents • Internet Access for WorkSpaces Pools • Configure a VPC for WorkSpaces Pools • Configure FedRAMP authorization or DoD SRG compliance for WorkSpaces Pools • Using Amazon S3 VPC Endpoints for WorkSpaces Pools Features • Connections to Your VPC for WorkSpaces Pools • User connections to WorkSpaces Pools Internet Access for WorkSpaces Pools If your WorkSpaces in WorkSpaces Pools require internet access, you can enable it in several ways. When you choose a method for enabling internet access, consider the number of users your deployment must support and your deployment goals. For example: • If your deployment must support more than 100 concurrent users, configure a VPC with private subnets and a NAT gateway. • If your deployment supports fewer than 100 concurrent users, you can configure a new or existing VPC with a public subnet. • If your deployment supports fewer than 100 concurrent users and you are new to WorkSpaces Pools and want to get started using the service, you can use the default VPC, public subnet, and security group. The following sections provide more information about each of these deployment options. • Configure a VPC with Private Subnets and a NAT Gateway (recommended) — With this configuration, you launch your WorkSpaces Pools builders in a private subnet and configure a NAT gateway in a public subnet in your VPC. Your streaming instances are assigned a private IP address that is not directly accessible from the internet. Networking and Access 610 Amazon WorkSpaces Administration Guide In addition, unlike configurations that use the Default Internet Access option for enabling internet access, the NAT configuration is not limited to 100 WorkSpaces in WorkSpaces Pools. If your deployment must support more than 100 concurrent users, use this configuration. You can create and configure a new VPC to use with a NAT |
workspaces-ag-201 | workspaces-ag.pdf | 201 | you launch your WorkSpaces Pools builders in a private subnet and configure a NAT gateway in a public subnet in your VPC. Your streaming instances are assigned a private IP address that is not directly accessible from the internet. Networking and Access 610 Amazon WorkSpaces Administration Guide In addition, unlike configurations that use the Default Internet Access option for enabling internet access, the NAT configuration is not limited to 100 WorkSpaces in WorkSpaces Pools. If your deployment must support more than 100 concurrent users, use this configuration. You can create and configure a new VPC to use with a NAT gateway, or add a NAT gateway to an existing VPC. • Configure a New or Existing VPC with a Public Subnet — With this configuration, you launch your WorkSpaces Pools in a public subnet. When you enable this option, WorkSpaces Pools uses the internet gateway in your Amazon VPC public subnet to provide the internet connection. Your streaming instances are assigned a public IP address that is directly accessible from the internet. You can create a new VPC or configure an existing one for this purpose. Note When you configure a new or existing VPC with a public subnet, a maximum of 100 WorkSpaces are supported in WorkSpaces Pools. If your deployment must support more than 100 concurrent users, use the NAT gateway configuration instead. • Use the Default VPC, Public Subnet, and Security Group — If you are new to WorkSpaces Pools and want to get started using the service, you can launch your WorkSpaces Pools in a default public subnet. When you enable this option, WorkSpaces Pools uses the internet gateway in your Amazon VPC public subnet to provide the internet connection. Your streaming instances are assigned a public IP address that is directly accessible from the internet. Default VPCs are available in Amazon Web Services accounts created after 2013-12-04. The default VPC includes a default public subnet in each Availability Zone and an internet gateway that is attached to your VPC. The VPC also includes a default security group. Note When you use the default VPC, public subnet, and security group, a maximum of 100 WorkSpaces are supported in WorkSpaces Pools. If your deployment must support more than 100 concurrent users, use the NAT gateway configuration instead. Internet Access 611 Amazon WorkSpaces Administration Guide Configure a VPC for WorkSpaces Pools When you set up WorkSpaces Pools, you must specify the virtual private cloud (VPC) and at least one subnet in which to launch your WorkSpaces. A VPC is a virtual network in your own logically isolated area within the Amazon Web Services Cloud. A subnet is a range of IP addresses in your VPC. When you configure your VPC for WorkSpaces Pools, you can specify either public or private subnets, or a mix of both types of subnets. A public subnet has direct access to the internet through an internet gateway. A private subnet, which doesn't have a route to an internet gateway, requires a Network Address Translation (NAT) gateway or NAT instance to provide access to the internet. Contents • VPC Setup Recommendations for WorkSpaces Pools • Configure a VPC with Private Subnets and a NAT Gateway • Configure a New or Existing VPC with a Public Subnet • Use the Default VPC, Public Subnet, and Security Group VPC Setup Recommendations for WorkSpaces Pools When you create a WorkSpaces Pools, you specify the VPC and one or more subnets to use. You can provide additional access control to your VPC by specifying security groups. The following recommendations can help you configure your VPC more effectively and securely. In addition, they can help you configure an environment that supports effective WorkSpaces Pools scaling. With effective WorkSpaces Pools scaling, you can meet current and anticipated WorkSpaces user demand, while avoiding unnecessary resource usage and associated costs. Overall VPC Configuration • Make sure that your VPC configuration can support your WorkSpaces Pools scaling needs. As you develop your plan for WorkSpaces Pools scaling, keep in mind that one user requires one WorkSpaces. Therefore, the size of your WorkSpaces Pools determines the number of users who can stream concurrently. For this reason, for each instance type that you plan to use, make sure that the number of WorkSpaces that your VPC can support is greater than the number of anticipated concurrent users for the same instance type. VPC Requirements 612 Amazon WorkSpaces Administration Guide • Make sure that your WorkSpaces Pools account quotas (also referred to as limits) are sufficient to support your anticipated demand. To request a quota increase, you can use the Service Quotas console at https://console.aws.amazon.com/servicequotas/. For information about default WorkSpaces Pools quotas, see Amazon WorkSpaces quotas. • If you plan to provide your WorkSpaces in WorkSpaces Pools with access to the internet, we recommend that you |
workspaces-ag-202 | workspaces-ag.pdf | 202 | use, make sure that the number of WorkSpaces that your VPC can support is greater than the number of anticipated concurrent users for the same instance type. VPC Requirements 612 Amazon WorkSpaces Administration Guide • Make sure that your WorkSpaces Pools account quotas (also referred to as limits) are sufficient to support your anticipated demand. To request a quota increase, you can use the Service Quotas console at https://console.aws.amazon.com/servicequotas/. For information about default WorkSpaces Pools quotas, see Amazon WorkSpaces quotas. • If you plan to provide your WorkSpaces in WorkSpaces Pools with access to the internet, we recommend that you configure a VPC with two private subnets for your streaming instances and a NAT gateway in a public subnet. The NAT gateway lets the WorkSpaces in your private subnets connect to the internet or other AWS services. However, it prevents the internet from initiating a connection with those WorkSpaces. In addition, unlike configurations that use the Default Internet Access option for enabling internet access, the NAT configuration supports more than 100 WorkSpaces. For more information, see Configure a VPC with Private Subnets and a NAT Gateway. Elastic Network Interfaces • WorkSpaces Pools creates as many elastic network interfaces (network interfaces) as the maximum desired capacity of your WorkSpaces Pools. By default, the limit for network interfaces per Region is 5000. When planning capacity for very large deployments, for example, thousands of WorkSpaces, consider the number of Amazon EC2 instances that are also used in the same Region. Subnets • If you are configuring more than one private subnet for your VPC, configure each in a different Availability Zone. Doing so increases fault tolerance and can help prevent insufficient capacity errors. If you use two subnets in the same AZ, you might run out of IP addresses, because WorkSpaces Pools will not use the second subnet. • Make sure that the network resources required for your applications are accessible through both of your private subnets. • Configure each of your private subnets with a subnet mask that allows for enough client IP addresses to account for the maximum number of expected concurrent users. In addition, allow for additional IP addresses to account for anticipated growth. For more information, see VPC and Subnet Sizing for IPv4. VPC Requirements 613 Amazon WorkSpaces Administration Guide • If you are using a VPC with NAT, configure at least one public subnet with a NAT Gateway for internet access, preferably two. Configure the public subnets in the same Availability Zones where your private subnets reside. To enhance fault tolerance and reduce the chance of insufficient capacity errors for large WorkSpaces Pools deployments, consider extending your VPC configuration into a third Availability Zone. Include a private subnet, public subnet, and NAT gateway in this additional Availability Zone. Security Groups • Use security groups to provide additional access control to your VPC. Security groups that belong to your VPC let you control the network traffic between WorkSpaces Pools streaming instances and network resources required by applications. These resources may include other AWS services such as Amazon RDS or Amazon FSx, license servers, database servers, file servers, and application servers. • Make sure that the security groups provide access to the network resources that your applications require. For general information about security groups, see Control traffic to your AWS resources using security groups in the Amazon VPC User Guide. Configure a VPC with Private Subnets and a NAT Gateway If you plan to provide your WorkSpaces in WorkSpaces Pools with access to the internet, we recommend that you configure a VPC with two private subnets for your WorkSpaces and a NAT gateway in a public subnet. You can create and configure a new VPC to use with a NAT gateway, or add a NAT gateway to an existing VPC. For additional VPC configuration recommendations, see VPC Setup Recommendations for WorkSpaces Pools. The NAT gateway lets the WorkSpaces in your private subnets connect to the internet or other AWS services, but prevents the internet from initiating a connection with those WorkSpaces. In addition, unlike configurations that use the Default Internet Access option for enabling internet access for WorkSpaces, this configuration is not limited to 100 WorkSpaces. For information about using NAT Gateways and this configuration, see NAT Gateways and VPC with Public and Private Subnets (NAT) in the Amazon VPC User Guide. VPC Requirements 614 Amazon WorkSpaces Contents • Create and Configure a New VPC • Add a NAT Gateway to an Existing VPC • Enable Internet Access for WorkSpaces Pools Create and Configure a New VPC Administration Guide This topic describes how to use the VPC wizard to create a VPC with a public subnet and one private subnet. As part of this process, the wizard creates an internet gateway and a NAT gateway. It also creates a custom |
workspaces-ag-203 | workspaces-ag.pdf | 203 | NAT Gateways and this configuration, see NAT Gateways and VPC with Public and Private Subnets (NAT) in the Amazon VPC User Guide. VPC Requirements 614 Amazon WorkSpaces Contents • Create and Configure a New VPC • Add a NAT Gateway to an Existing VPC • Enable Internet Access for WorkSpaces Pools Create and Configure a New VPC Administration Guide This topic describes how to use the VPC wizard to create a VPC with a public subnet and one private subnet. As part of this process, the wizard creates an internet gateway and a NAT gateway. It also creates a custom route table associated with the public subnet and updates the main route table associated with the private subnet. The NAT gateway is automatically created in the public subnet of your VPC. After you use the wizard to create the initial VPC configuration, you'll add a second private subnet. For more information about this configuration, see VPC with Public and Private Subnets (NAT) in the Amazon VPC User Guide. Note If you already have a VPC, complete the steps in Add a NAT Gateway to an Existing VPC instead. Contents • Step 1: Allocate an Elastic IP Address • Step 2: Create a New VPC • Step 3: Add a Second Private Subnet • Step 4: Verify and Name Your Subnet Route Tables Step 1: Allocate an Elastic IP Address Before you create your VPC, you must allocate an Elastic IP address in your WorkSpaces Region. You must first allocate an Elastic IP address for use in your VPC, and then associate it with your NAT gateway. For more information, see Elastic IP Addresses in the Amazon VPC User Guide. VPC Requirements 615 Amazon WorkSpaces Note Administration Guide Charges may apply to Elastic IP addresses that you use. For more information, see Elastic IP Addresses on the Amazon EC2 pricing page. Complete the following steps if you don't already have an Elastic IP address. If you want to use an existing Elastic IP address, verify that it's not currently associated with another instance or network interface. To allocate an Elastic IP address 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. In the navigation pane, under Network & Security, choose Elastic IPs. 3. Choose Allocate New Address, and then choose Allocate. 4. Note the Elastic IP address. 5. In the upper right of the Elastic IPs pane, click the X icon to close the pane. Step 2: Create a New VPC Complete the following steps to create a new VPC with a public subnet and one private subnet. To create a new VPC 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. In the navigation pane, choose VPC Dashboard. 3. Choose Launch VPC Wizard. 4. In Step 1: Select a VPC Configuration, choose VPC with Public and Private Subnets, and then choose Select. 5. In Step 2: VPC with Public and Private Subnets, configure the VPC as follows: • For IPv4 CIDR block, specify an IPv4 CIDR block for the VPC. • For IPv6 CIDR block, keep the default value, No IPv6 CIDR Block. • For VPC name, type a unique name for the VPC. 6. Configure the public subnet as follows: VPC Requirements 616 Amazon WorkSpaces Administration Guide • For Public subnet's IPv4 CIDR, specify the CIDR block for the subnet. • For Availability Zone, keep the default value, No Preference. • For Public subnet name, type a name for the subnet; for example, WorkSpaces Public Subnet. 7. Configure the first private subnet as follows: • For Private subnet's IPv4 CIDR, specify the CIDR block for the subnet. Make a note of the value that you specify. • For Availability Zone, select a specific zone and make a note of the zone that you select. • For Private subnet name, type a name for the subnet; for example, WorkSpaces Private Subnet1. • For the remaining fields, where applicable, keep the default values. 8. For Elastic IP Allocation ID, click in the text box and select the value that corresponds to the Elastic IP address that you created. This address is assigned to the NAT gateway. If you don't have an Elastic IP address, create one by using the Amazon VPC console at https:// console.aws.amazon.com/vpc/. 9. For Service endpoints, if an Amazon S3 endpoint is required for your environment, specify one. An S3 endpoint is required to provide users with access to home folders or to enable application settings persistence for your users in a private network. To specify an Amazon S3 endpoint, do the following: a. b. c. d. Choose Add Endpoint. For Service, select the entry in the list that ends with "s3" (the com.amazonaws.region.s3 entry that corresponds to the Region in which the VPC is being created). For Subnet, choose Private subnet. For Policy, keep the default value, |
workspaces-ag-204 | workspaces-ag.pdf | 204 | console at https:// console.aws.amazon.com/vpc/. 9. For Service endpoints, if an Amazon S3 endpoint is required for your environment, specify one. An S3 endpoint is required to provide users with access to home folders or to enable application settings persistence for your users in a private network. To specify an Amazon S3 endpoint, do the following: a. b. c. d. Choose Add Endpoint. For Service, select the entry in the list that ends with "s3" (the com.amazonaws.region.s3 entry that corresponds to the Region in which the VPC is being created). For Subnet, choose Private subnet. For Policy, keep the default value, Full Access. 10. For Enable DNS hostnames, keep the default value, Yes. 11. For Hardware tenancy, keep the default value, Default. 12. Choose Create VPC. 13. Note that it takes several minutes to set up your VPC. After the VPC is created, choose OK. VPC Requirements 617 Amazon WorkSpaces Administration Guide Step 3: Add a Second Private Subnet In the previous step (Step 2: Create a New VPC), you created a VPC with one public subnet and one private subnet. Perform the following steps to add a second private subnet. We recommend that you add a second private subnet in a different Availability Zone than your first private subnet. 1. 2. In the navigation pane, choose Subnets. Select the first private subnet that you created in the previous step. On the Description tab, below the list of subnets, make a note of the Availability Zone for this subnet. 3. On the upper left of the subnets pane, choose Create Subnet. 4. 5. 6. For Name tag, type a name for the private subnet; for example, WorkSpaces Private Subnet2. For VPC, select the VPC that you created in the previous step. For Availability Zone, select an Availability Zone other than the one you are using for your first private subnet. Selecting a different Availability Zone increases fault tolerance and helps prevent insufficient capacity errors. 7. For IPv4 CIDR block, specify a unique CIDR block range for the new subnet. For example, if your first private subnet has an IPv4 CIDR block range of 10.0.1.0/24, you could specify a CIDR block range of 10.0.2.0/24 for the new private subnet. 8. Choose Create. 9. After your subnet is created, choose Close. Step 4: Verify and Name Your Subnet Route Tables After you've created and configured your VPC, complete the following steps to specify a name for your route tables, and to verify that: • The route table associated with the subnet in which your NAT gateway resides includes a route that points internet traffic to an internet gateway. This ensures that your NAT gateway can access the internet. • The route tables associated with your private subnets are configured to point internet traffic to the NAT gateway. This enables the streaming instances in your private subnets to communicate with the internet. VPC Requirements 618 Amazon WorkSpaces Administration Guide 1. In the navigation pane, choose Subnets, and select the public subnet that you created; for example, WorkSpaces Public Subnet. a. On the Route Table tab, choose the ID of the route table; for example, rtb-12345678. b. Select the route table. Under Name, choose the edit icon (the pencil), and type a name (for example, workspaces-public-routetable), and then select the check mark to save the name. c. With the public route table still selected, on the Routes tab, verify that there is one route for local traffic and another route that sends all other traffic to the internet gateway for the VPC. The following table describes these two routes: Destination Public subnet IPv4 CIDR Block (for example, 10.0.0/20) Target Local Traffic destined to all other IPv4 addresses (for example, 0.0.0.0/0 Outbound (igw-ID) Description All traffic from the resources destined for IPv4 addresses within the public subnet IPv4 CIDR block is routed locally within the VPC. Traffic destined for all other IPv4 addresses is routed to the internet gateway (identified by igw-ID) that was created by the VPC Wizard. 2. In the navigation pane, choose Subnets, and select the first private subnet that you created (for example, WorkSpaces Private Subnet1). a. On the Route Table tab, choose the ID of the route table. b. Select the route table. Under Name, choose the edit icon (the pencil), and enter a name (for example, workspaces-private-routetable), and then choose the check mark to save the name. c. On the Routes tab, verify that the route table includes the following routes: VPC Requirements 619 Amazon WorkSpaces Administration Guide Destination Public subnet IPv4 CIDR Block (for example, 10.0.0/20) Target Local Outbound (nat-ID) Storage (vpce-ID) Traffic destined to all other IPv4 addresses (for example, 0.0.0.0/0 Traffic destined for S3 buckets (applicable if you specified an S3 endpoint) [pl-ID (com.amazo naws. region.s3)] Description All traffic from the resources destined for IPv4 addresses within |
workspaces-ag-205 | workspaces-ag.pdf | 205 | route table. Under Name, choose the edit icon (the pencil), and enter a name (for example, workspaces-private-routetable), and then choose the check mark to save the name. c. On the Routes tab, verify that the route table includes the following routes: VPC Requirements 619 Amazon WorkSpaces Administration Guide Destination Public subnet IPv4 CIDR Block (for example, 10.0.0/20) Target Local Outbound (nat-ID) Storage (vpce-ID) Traffic destined to all other IPv4 addresses (for example, 0.0.0.0/0 Traffic destined for S3 buckets (applicable if you specified an S3 endpoint) [pl-ID (com.amazo naws. region.s3)] Description All traffic from the resources destined for IPv4 addresses within the public subnet IPv4 CIDR block is routed locally within the VPC. Traffic destined for all other IPv4 addresses is routed to the NAT gateway (identified by nat-ID). Traffic destined for S3 buckets is routed to the S3 endpoint (identifi ed by vpce-ID). 3. In the navigation pane, choose Subnets, and select the second private subnet that you created (for example, WorkSpaces Private Subnet2). 4. On the Route Table tab, verify that the route table is the private route table (for example, workspaces-private-routetable). If the route table is different, choose Edit and select this route table. Next Steps To enable your WorkSpaces in WorkSpaces Pools to access the internet, complete the steps in Enable Internet Access for WorkSpaces Pools. Add a NAT Gateway to an Existing VPC If you have already configured a VPC, complete the following steps to add a NAT gateway to your VPC. If you need to create a new VPC, see Create and Configure a New VPC. VPC Requirements 620 Amazon WorkSpaces Administration Guide To add a NAT gateway to an existing VPC 1. To create your NAT gateway, complete the steps in Creating a NAT Gateway in the Amazon VPC User Guide. 2. Verify that your VPC has at least one private subnet. We recommend that you specify two private subnets from different Availability Zones for high availability and fault tolerance. For information about how to create a second private subnet, see Step 3: Add a Second Private Subnet. 3. Update the route table associated with one or more of your private subnets to point internet- bound traffic to the NAT gateway. This enables the streaming instances in your private subnets to communicate with the internet. To do so, complete the steps in Updating Your Route Table in the Amazon VPC User Guide. Next Steps To enable your WorkSpaces in WorkSpaces Pools to access the internet, complete the steps in Enable Internet Access for WorkSpaces Pools. Enable Internet Access for WorkSpaces Pools After your NAT gateway is available on a VPC, you can enable internet access for your WorkSpaces Pools. You can enable internet access when you create the WorkSpaces Pool directory. Choose the VPC with a NAT gateway when you create the directory. Then select a private subnet for Subnet 1 and, optionally, another private subnet for Subnet 2. If you don't already have a private subnet in your VPC, you may need to create a second private subnet. You can test your internet connectivity by starting your WorkSpaces Pool, and then connecting to a WorkSpace in the pool and browsing to the internet. Configure a New or Existing VPC with a Public Subnet If you created your Amazon Web Services account after 2013-12-04, you have a default VPC in each AWS Region that includes default public subnets. However, you may want to create your own nondefault VPC or configure an existing VPC to use with your WorkSpaces Pool directory. This topic describes how to configure a nondefault VPC and public subnet to use with WorkSpaces Pools. After you configure your VPC and public subnet, you can provide your WorkSpaces in WorkSpaces Pools with access to the internet by enabling the Default Internet Access option. When you enable VPC Requirements 621 Amazon WorkSpaces Administration Guide this option, WorkSpaces Pools enables internet connectivity by associating an Elastic IP address to the network interface that is attached from the streaming instance to your public subnet. An Elastic IP address is a public IPv4 address that is reachable from the internet. For this reason, we recommend that you instead use a NAT gateway to provide internet access to your WorkSpaces in WorkSpaces Pools. In addition, when Default Internet Access is enabled, a maximum of 100 WorkSpaces are supported. If your deployment must support more than 100 concurrent users, use the NAT gateway configuration instead. For more information, see the steps in Configure a VPC with Private Subnets and a NAT Gateway. For additional VPC configuration recommendations, see VPC Setup Recommendations for WorkSpaces Pools. Contents • Step 1: Configure a VPC with a Public Subnet • Step 2: Enable Default Internet Access For Your WorkSpaces Pools Step 1: Configure a VPC with a Public Subnet You can configure |
workspaces-ag-206 | workspaces-ag.pdf | 206 | to your WorkSpaces in WorkSpaces Pools. In addition, when Default Internet Access is enabled, a maximum of 100 WorkSpaces are supported. If your deployment must support more than 100 concurrent users, use the NAT gateway configuration instead. For more information, see the steps in Configure a VPC with Private Subnets and a NAT Gateway. For additional VPC configuration recommendations, see VPC Setup Recommendations for WorkSpaces Pools. Contents • Step 1: Configure a VPC with a Public Subnet • Step 2: Enable Default Internet Access For Your WorkSpaces Pools Step 1: Configure a VPC with a Public Subnet You can configure your own non-default VPC with a public subnet by using either of the following methods: • Create a New VPC with a Single Public Subnet • Configure an Existing VPC Create a New VPC with a Single Public Subnet When you use the VPC wizard to create a new VPC, the wizard creates an internet gateway and a custom route table that is associated with the public subnet. The route table routes all traffic destined for an address outside the VPC to the internet gateway. For more information about this configuration, see VPC with a Single Public Subnet in the Amazon VPC User Guide. 1. Complete the steps in Step 1: Create the VPC in the Amazon VPC User Guide to create your VPC. 2. To enable your WorkSpaces to access the internet, complete the steps in Step 2: Enable Default Internet Access For Your WorkSpaces Pools. VPC Requirements 622 Amazon WorkSpaces Configure an Existing VPC Administration Guide If you want to use an existing VPC that does not have a public subnet, you can add a new public subnet. In addition to a public subnet, you must also have an internet gateway attached to your VPC and a route table that routes all traffic destined for an address outside the VPC to the internet gateway. To configure these components, complete the following steps. 1. To add a public subnet, complete the steps in Creating a Subnet in Your VPC. Use the existing VPC that you plan to use with WorkSpaces Pools. If your VPC is configured to support IPv6 addressing, the IPv6 CIDR block list displays. Select Don't assign Ipv6. 2. To create and attach an internet gateway to your VPC, complete the steps in Creating and Attaching an Internet Gateway. 3. To configure your subnet to route internet traffic through the internet gateway, complete the steps in Creating a Custom Route Table. In step 5, for Destination, use IPv4 format (0.0.0.0/0). 4. To enable your WorkSpaces and image builders to access the internet, complete the steps in Step 2: Enable Default Internet Access For Your WorkSpaces Pools. Step 2: Enable Default Internet Access For Your WorkSpaces Pools You can enable internet access when you create the WorkSpaces Pool directory. Choose the VPC with a public subnet when you create the directory. Then select a public subnet for Subnet 1 and, optionally, another public subnet for Subnet 2. You can test your internet connectivity by starting your WorkSpaces Pool, and then connecting to a WorkSpace in the pool and browsing to the internet. Use the Default VPC, Public Subnet, and Security Group Your Amazon Web Services account, if it was created after 2013-12-04, has a default VPC in each AWS Region. The default VPC includes a default public subnet in each Availability Zone and an internet gateway that is attached to your VPC. The VPC also includes a default security group. If you are new to WorkSpaces Pools and want to get started using the service, you can keep the default VPC and security group selected when you create a WorkSpaces Pool. Then, you can select at least one default subnet. VPC Requirements 623 Amazon WorkSpaces Note Administration Guide If your Amazon Web Services account was created before 2013-12-04, you must create a new VPC or configure an existing one to use with WorkSpaces Pools. We recommend that you manually configure a VPC with two private subnets for your WorkSpaces Pools and a NAT gateway in a public subnet. For more information, see Configure a VPC with Private Subnets and a NAT Gateway. Alternatively, you can configure a non-default VPC with a public subnet. For more information, see Configure a New or Existing VPC with a Public Subnet. You can enable internet access when you create the WorkSpaces Pool directory. Choose the default VPC when you create the directory. The default VPC name uses the following format: vpc-vpc-id (No_default_value_Name). Then select a default public subnet for Subnet 1 and, optionally, another default public subnet for Subnet 2. The default subnet names use the following format: subnet-subnet-id | (IPv4 CIDR block) | Default in availability-zone. You can test your internet connectivity by starting your WorkSpaces Pool, and then connecting to |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.