Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
workspaces-ag-007	workspaces-ag.pdf	7	to specify, contact your AWS account manager or sales representative, or contact the AWS Support Center before proceeding. 5. Choose the CIDR block that you want from the list of results, and then choose Enable BYOL. This process may take several hours. While WorkSpaces is enabling your account for BYOL, proceed to the next step. (Optional) Use Amazon EC2 Image Builder (Windows 11 only) The Amazon EC2 Image Builder is capable of creating an Amazon Machine Image (AMI) from a raw ISO ﬁle. This feature is only available for Windows 11 systems. If you are using Amazon EC2 Image Builder to create the image you need, you can skip: • the section called “Step 4: Conﬁrm that your VM meets BYOL requirements” • the section called “Step 5: Export a VM from your virtualization environment” Converting an ISO ﬁle to an AMI 1. Upload the ISO ﬁle to S3. See Uploading objects in the Amazon Simple Storage Service user guide. 2. Convert the ISO ﬁle into an AMI. See Import veriﬁed Windows ISO disk images with Image Builder in the EC2 Image Builder User Guide. 3. Proceed to the section called “Step 6: Import a VM as an image into Amazon EC2” Step 4: Conﬁrm that the Windows VM in Amazon WorkSpaces meets the requirements for Microsoft BYOL Note If you are using Amazon EC2 Image Builder, you can proceed to the section called “Step 6: Import a VM as an image into Amazon EC2”. (Optional) Use Amazon EC2 Image Builder (Windows 11 only) 11 Amazon WorkSpaces Administration Guide After you enable BYOL for your account by following the instructions in Step 3: Enable BYOL for your eligible WorkSpaces account using the Amazon WorkSpaces console, you must conﬁrm that your VM meets the requirements for BYOL. To do so, perform these steps to download and run the WorkSpaces BYOL Checker PowerShell script. The script performs a series of tests on the VM that you plan to use to create your image. Important The VM must pass all tests before you can use it for BYOL. To download the BYOL Checker script Before you download and run the BYOL Checker script, verify that the latest Windows security updates are installed on your VM. While this script runs, it disables the Windows Update service. 1. Download the BYOL Checker script .zip ﬁle from https://tools.amazonworkspaces.com/ BYOLChecker.zip to your Downloads folder. In your Downloads folder, create a BYOL folder. Extract the ﬁles from BYOLChecker.zip and copy them to the Downloads\BYOL folder. 2. 3. 4. Delete the Downloads\BYOLChecker.zip folder so that only the extracted ﬁles remain. Perform these steps to run the BYOL Checker script. To run the BYOL Checker script 1. From the Windows desktop, open Windows PowerShell. Choose the Windows Start button, right-click Windows PowerShell, and choose Run as administrator. If you are prompted by User Account Control to choose whether you want PowerShell to make changes to your device, choose Yes. 2. At the PowerShell command prompt, change to the directory where the BYOL Checker script is located. For example, if the script is located in the Downloads\BYOL directory, enter the following command and press Enter: cd C:\Users\username\Downloads\BYOL 3. Enter the following command to update the PowerShell execution policy on the computer. Doing so allows the BYOL Checker script to run: Step 4: Conﬁrm that your VM meets BYOL requirements 12 Amazon WorkSpaces Administration Guide Set-ExecutionPolicy AllSigned 4. When prompted to conﬁrm whether to change the PowerShell execution policy, enter A to specify Yes to All. 5. Enter the following command to run the BYOL Checker script: .\BYOLChecker.ps1 6. 7. If a security notiﬁcation appears, press the R key to Run Once. In the WorkSpaces Image Validation dialog box, choose Begin Tests. 8. 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. If any tests display a status of WARNING, choose the Fix All Warnings button. 9. If applicable, resolve any issues that cause test failures and warnings, and repeat Step 7 and Step 8 until the VM passes all tests. All failures and warnings must be resolved before you export the VM. 10. The BYOL script checker generates two log ﬁles, BYOLPrevalidationlogYYYY-MM- DD_HHmmss.txt and ImageInfo.text. These ﬁles are located in the directory that contains the BYOL Checker script ﬁles. Tip Do not delete these ﬁles. If an issue occurs, they might be helpful in troubleshooting. 11. After your VM passes all tests, you get a Validation Successful message. You will also see a prompt to run Sysprep. Close the prompt and don't run Sysprep yet. 12. Shut down the VM and export it. For more information, see Export your VM from its virtualization environment
workspaces-ag-008	workspaces-ag.pdf	8	must be resolved before you export the VM. 10. The BYOL script checker generates two log ﬁles, BYOLPrevalidationlogYYYY-MM- DD_HHmmss.txt and ImageInfo.text. These ﬁles are located in the directory that contains the BYOL Checker script ﬁles. Tip Do not delete these ﬁles. If an issue occurs, they might be helpful in troubleshooting. 11. After your VM passes all tests, you get a Validation Successful message. You will also see a prompt to run Sysprep. Close the prompt and don't run Sysprep yet. 12. Shut down the VM and export it. For more information, see Export your VM from its virtualization environment in the VM Import/Export User Guide. 13. (Optional) Start the VM and run the BYOL Checker script one more time. All validations should pass. A screen will pop up again with a button to run Sysprep. Choose Run Sysprep. If Sysprep is successful, your exported VM that you exported from step 12 can be imported into Amazon Elastic Compute Cloud (Amazon EC2). If Sysprep is unsuccessful, review the Sysprep logs in the %WINDIR%\System32\Sysprep \Panther path, roll back to the exported VM from step 12, resolve the reported issues, and Step 4: Conﬁrm that your VM meets BYOL requirements 13 Amazon WorkSpaces Administration Guide complete step 12 again by exporting the ﬁxed VM. You will then re-run the BYOL Checker script to ensure the issues have been resolved. The most common reason for a Sysprep failure is that the Modern AppX Packages have not been uninstalled for all users. Use the Remove-AppxPackage PowerShell cmdlet to remove the AppX Packages. 14. Import the VM that you exported in step 12 into Amazon EC2. Common error messages and their solutions BYOL import does not support systems with active Microsoft Oﬃce installed. Microsoft Oﬃce must be uninstalled before import. For more information, see Uninstall Oﬃce from a PC. BYOL import requires a system without a PCoIP Agent. Uninstall the PCoIP Agent. For information about uninstalling the PCoIP agent, see Uninstalling the Teradici PCoIP Software Client for Mac BYOL import requires that Windows updates are disabled. Disable Windows updates by following the following steps: 1. Press Windows key + R. Type services.msc, then press Enter. 2. Right-click on Windows Update, then choose Properties. 3. Under the General tab, set the Startup type to Disabled. 4. Choose Stop. 5. Click Apply, and then choose OK. 6. Restart your computer. BYOL import requires that Automount is enabled. You must enable Automount. Run the following command in powershell as an administrator. C:\> diskpart Common error messages and their solutions 14 Amazon WorkSpaces DISKPART> automount enable Administration Guide Automatic mounting of new volumes enabled. BYOL import requires the WorkSpaces_BYOL account to be enabled WorkSpaces_BYOL account must be enabled. For more information, see Enable BYOL for your account for BYOL using the Amazon WorkSpaces console. BYOL import requires the network interface to use DHCP to automatically assign an IP address. The network interface is currently using a static IP address. Network interface must be changed to use DHCP. For more information, see Change TCP/IP settings. BYOL import requires more than 20 GB of space on the local disk. Local disk must have enough space and requires you to free up 20 GB or more. BYOL import requires systems with 1 local drive. There are additional Local, Removable or Network drives. Only the C drive can be present on an Amazon Machine Image that is being used for importing BYOL WorkSpace Image. Remove all other drives, including virtual drives. BYOL import requires Windows 10 or Windows 11. Use a Windows 10 or Windows 11 operating system. BYOL import requires systems that are not AD domain joined. System must be unjoined from AD domain. For more information, see Azure Active Directory device management FAQ. BYOL import requires systems that are not Azure domain joined. System must be unjoined from Azure domain. For more information, see Azure Active Directory device management FAQ. BYOL import requires Windows Public Firewall disabled. Public ﬁrewall proﬁle must be disabled. For more information, see Turn Microsoft Defender Firewall on or oﬀ. Common error messages and their solutions 15 Amazon WorkSpaces Administration Guide BYOL import requires a system without VMware tools. VMWare tools must be uninstalled. For more information, see Uninstalling and manually installing VMware Tools in VMware Fusion (1014522). BYOL import requires the local disk to be less than 80 GB. The disk must be smaller than 80 GB. Reduce the disk size. BYOL import requires less than 2 partitions on the local drive. In addition, all Windows 10 partitions must be MBR partitioned and all Windows 11 partitions must be GPT partitioned. Volumes must be MBR partitioned for Windows 10 and GPT partitioned for Windows 11. For more information, see Manage disks. BYOL import requires all pending updates that require reboots are complete. Install all updates and
workspaces-ag-009	workspaces-ag.pdf	9	see Uninstalling and manually installing VMware Tools in VMware Fusion (1014522). BYOL import requires the local disk to be less than 80 GB. The disk must be smaller than 80 GB. Reduce the disk size. BYOL import requires less than 2 partitions on the local drive. In addition, all Windows 10 partitions must be MBR partitioned and all Windows 11 partitions must be GPT partitioned. Volumes must be MBR partitioned for Windows 10 and GPT partitioned for Windows 11. For more information, see Manage disks. BYOL import requires all pending updates that require reboots are complete. Install all updates and reboot the operating system. BYOL import requires that AutoLogon is disabled. To disable the AutoLogon registry: 1. Press Windows key + R and type Regedit.exe in the command prompt. 2. Scroll down to HKEY_LOCAL_Machine\SOFTWARE\Microsoft\WindowsNT \CurrentVersion\Winlogon 3. Add a value for DontDisplayLastUserName. 4. 5. For Type, enter REG_SZ. For Value, enter 0. Note • The value DontDisplayLastUserName determines whether the logon dialog box displays the username of the last user that logged onto the PC. • The value does not exist by default. If it exists, you must set it to 0 or the value of DefaultUser will be wiped and AutoLogon will fail. Common error messages and their solutions 16 Amazon WorkSpaces Administration Guide BYOL import requires RealTimeIsUniversal to be enabled. RealTimeUniversal Registry Key must be enabled. For more information, see Conﬁgure time settings for Windows Server 2008 and later. BYOL import requires a system with one bootable partition. Number of bootable partitions must not exceed one. To remove additional partitions 1. Press the Windows logo + R keys to open Run box. Enter msconfig and press the Enter key on the keyboard to open the System Conﬁguration window. 2. Choose the Boot tab from the window and check if the OS you want to use is set to Current OS; Default OS. If it isn't set, choose your desired OS from the window and choose Set as default on the same window. 3. To delete another partition, choose that partition, then select Delete, Apply, OK. If the error still shows up, boot your computer from the installation or repair disc, and follow these steps. 1. Skip the initial languages screen, and then choose Repair your computer on the main install screen. 2. On the Choose an option screen, choose Troubleshoot. 3. On the Advanced options screen, choose Command Prompts. 4. In the command prompt, enter bootrec.exe /fixmbr, then press Enter. BYOL import requires a 64 bit system. A 64 bit OS image must be used. For more information, see Windows versions supported for BYOL. BYOL import requires a system that has not been rearmed. The Image 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. Common error messages and their solutions 17 Amazon WorkSpaces Administration Guide To check the Windows rearm count 1. On the Windows Start menu, choose Windows System, then choose Command Prompt. 2. In the Command Prompt, enter cscript C:\Windows\System32\slmgr.vbs /dlv, and then press Enter. 3. To reset the rearm count to a value other than 0. For more information, see Sysprep (Generalize) a Windows installation. BYOL import requires a system that has not been upgraded in-place. This system has been upgraded in-place. Windows must not have been upgraded from a previous version. BYOL import requires that no antivirus is installed on the system. You must uninstall your antivirus software. Run BYOLChecker to get details for the antivirus software to uninstall. BYOL import requires Windows 10 systems to have a legacy Boot mode. The Legacy BIOS BootMode must be used for Windows 10.For more information, see Boot modes. BYOL Import requires Windows Reserved Storage state to be disabled To disable the Reserved Storage State 1. Install all Windows updates and reboot the operating system. 2. Make sure there are no new updates. 3. Run either of the following command in Powershell as an administrator. • • Set-WindowsReservedStorageState -State Disabled DISM.exe /Online /Set-ReservedStorageState /State:Disabled 4. Reboot the System. Common error messages and their solutions 18 Amazon WorkSpaces Note Administration Guide If reserved storage is in use, it might not be disabled, and the following error message is returned: This operation is not supported when reserved storage is in use. Please wait for any servicing operations to complete and then try again later. BYOL import has a restricted drive letter in use. The D: Drive is a restricted drive letter for WorkSpaces. Please ensure that D: is not being used or will not be mapped to during launch of an instance from the image. BYOL import has an OS image that is incompatible with the streaming protocol selected. The image
workspaces-ag-010	workspaces-ag.pdf	10	Guide If reserved storage is in use, it might not be disabled, and the following error message is returned: This operation is not supported when reserved storage is in use. Please wait for any servicing operations to complete and then try again later. BYOL import has a restricted drive letter in use. The D: Drive is a restricted drive letter for WorkSpaces. Please ensure that D: is not being used or will not be mapped to during launch of an instance from the image. BYOL import has an OS image that is incompatible with the streaming protocol selected. The image being imported is not supported by the streaming protocol chosen, see Create a BYOL image using the WorkSpaces console. BYOL import is incompatible with memory integrity. Memory Integrity is not supported when Credential Guard is enabled on the Windows operating system of a WorkSpace. Memory Integrity was detected with UEFILock which cannot be disabled during image import. Please import an image with UEFILock disabled, see Disable Credential Guard. List of SysPrep error messages and error ﬁxes The AMI you are importing has AppX packages installed. Remove them and re-import the image. Modern AppX Packages might still be installed for your users. Remove the AppX package by running the Powershell cmdlet, Remove-AppxPackage. Note During the BYOL import process, oﬀending AppX packages will be cleaned up and Sysprep will be retried. If the image import process continues to fail, it means AppX packages will need to be manually cleaned up. List of SysPrep error messages and error ﬁxes 19 Amazon WorkSpaces Administration Guide The AMI you are importing has reserved storage enabled. Disable it after Windows updates and re-import the image. To disable reserved storage 1. Open the Registry Editor but entering regedit.exe. 2. Navigate to the registry key: HKLM\Software\Microsoft\Windows\CurrentVersion \ReserveManager. 3. Change the value of the ShippedWithReserves parameter from 1 to 0. 4. Change the value of ActiveScenario to 0. 5. Disable Reserved Storage in Windows using the following command: DISM.exe /Online /Set-ReservedStorageState /State:Disabled The AMI you are importing has anti-virus or anti-spyware software installed. Remove it and re- import the image. You must uninstall your antivirus software. Run the BYOLChecker to get details for the antivirus software to uninstall. For more information, see Step 4: Conﬁrm that the Windows VM in Amazon WorkSpaces meets the requirements for Microsoft BYOL. An unknown error has occurred to the AMI you are importing during AMI SysPrep. SysPrep failure reason couldn't be determined. Contact AWS support at https://aws.amazon.com/ support. Step 5: Export a VM from your virtualization environment in Amazon WorkSpaces Note If you are using Amazon EC2 Image Builder, you can proceed to the section called “Step 6: Import a VM as an image into Amazon EC2”. Step 5: Export a VM from your virtualization environment 20 Amazon WorkSpaces Administration Guide After you conﬁrm that your VM meets the Microsoft BYOL requirements by following the instructions in Step 4: Conﬁrm that the Windows VM in Amazon WorkSpaces meets the requirements for Microsoft BYOL, you must export the VM from your virtualization environment. You will need this to create an image for BYOL that you can use in WorkSpaces. The VM that you export must be on a single volume with a maximum size of 70 GB and at least 10 GB of free space. For more information, see the documentation for your virtualization environment and Export your VM from its virtualization environment in the VM Import/Export User Guide. Windows 11 sets new hardware requirements for Uniﬁed Extensible Firmware Interface (UEFI), Trusted Platform Module (TPM) 2.0 and Secure Boot support. Unique to Windows 11 imports, VM Import/Export automatically enables UEFI Secure Boot using Microsoft keys and NitroTPM. For more information, see Bringing your Windows 11 image to AWS with VM Import/Export. Step 6: Import a VM as an image into Amazon EC2 in preparation to create a BYOL image for WorkSpaces After importing your Windows 11 ISO using Amazon EC2 Image Builder, proceed to import your AMI below. After you export your VM by following the instructions in Step 5: Export a VM from your virtualization environment in Amazon WorkSpaces, review the requirements for importing Windows operating systems from a VM. Take action as needed. For more information, see VM Import/Export Requirements. Note Importing a VM with an encrypted disk is not supported. If you've opted in to default encryption for Amazon Elastic Block Store (Amazon EBS) volumes, you must deselect that option before importing your VM. Import your VM into Amazon EC2 as an Amazon Machine Image (AMI). Use one of the following methods: • Use the import-image command with the AWS CLI. For more information, see import-image in the AWS CLI Command Reference. Step 6: Import a VM as an image into Amazon EC2 21 Amazon WorkSpaces Administration Guide • Use the
workspaces-ag-011	workspaces-ag.pdf	11	needed. For more information, see VM Import/Export Requirements. Note Importing a VM with an encrypted disk is not supported. If you've opted in to default encryption for Amazon Elastic Block Store (Amazon EBS) volumes, you must deselect that option before importing your VM. Import your VM into Amazon EC2 as an Amazon Machine Image (AMI). Use one of the following methods: • Use the import-image command with the AWS CLI. For more information, see import-image in the AWS CLI Command Reference. Step 6: Import a VM as an image into Amazon EC2 21 Amazon WorkSpaces Administration Guide • Use the ImportImage API operation. For more information, see ImportImage in the Amazon EC2 API Reference. For more information, see Importing a VM as an Image in the VM Import/Export User Guide. Step 7: Add Microsoft Oﬃce to your BYOL image in Amazon WorkSpaces During the BYOL image ingestion process, if you are using Windows 10, you have the option to subscribe to Microsoft Oﬃce Professional 2016 (32-bit) or 2019 (64-bit) through AWS. If you are using Windows 11, you can subscribe to Microsoft Oﬃce Professional 2019 (64-bit). If you choose either of these options, Microsoft Oﬃce is pre-installed in your BYOL image and included on any WorkSpaces that you launch from this image. Note • Graphics.g4dn and GraphicsPro.g4dn BYOL images with PCoIP support only Oﬃce 2019. They don't support Oﬃce 2016. • Graphics.g4dn and GraphicsPro.g4dn BYOL images with DCV support Oﬃce bundles through Manage applications in WorkSpaces Personal. If you choose to subscribe to Oﬃce through AWS, additional charges will apply. For more information, see WorkSpaces Pricing. Important • If Microsoft Oﬃce is already installed on the VM that you are using to create your BYOL image, you must uninstall it from the VM if you want to subscribe to Oﬃce through AWS. • If you plan to subscribe to Oﬃce through AWS, make sure that your VM has at least 20 GB of free disk space. • During image import, you can subscribe to Oﬃce 2016 or 2019 but not to Oﬃce 2021. For Oﬃce 2021 and other applications such as Microsoft Visual Studio 2022, Microsoft Visio 2021, and Microsoft Project 2021, see Manage applications. Step 7: Add Microsoft Oﬃce to your BYOL image 22 Amazon WorkSpaces Administration Guide • To bring your own Microsoft 365 licenses for both browser-based and desktop applications on Amazon WorkSpaces, install Microsoft 365 applications on your BYOL image after the BYOL image ingestion process is complete. Note Graphics.g4dn and GraphicsPro.g4dn BYOL images only support Oﬃce 2019 and do not support Oﬃce 2016. If you choose to subscribe to Oﬃce, the BYOL image ingestion process takes a minimum of 3 hours. For details about subscribing to Oﬃce during the BYOL ingestion process, see Step 8: Create a BYOL image using the WorkSpaces console. Oﬃce language settings We choose the language used for your Oﬃce subscription based on the AWS Region where you're performing your BYOL image ingestion. For example, if you're performing your BYOL image ingestion in the Asia Paciﬁc (Tokyo) Region, your Oﬃce subscription has Japanese as its language. By default, we install a number of frequently used Oﬃce language packs on your WorkSpaces. If the language pack that you want isn't installed, you can download additional language packs from Microsoft. For more information, see Language Accessory Pack for Oﬃce in the Microsoft documentation. To change the language for Oﬃce, you have several options: Option 1: Allow individual users to customize their Oﬃce language settings Individual users can adjust the Oﬃce language settings on their WorkSpaces. For more information, see Add an editing or authoring language or set language preferences in Oﬃce in the Microsoft documentation. Option 2: Use GPO administrative templates (.admx/.adml) to enforce default Oﬃce language settings for all of your WorkSpaces users You can use Group Policy Object (GPO) settings to enforce default Oﬃce language settings for your WorkSpaces users. Step 7: Add Microsoft Oﬃce to your BYOL image 23 Amazon WorkSpaces Note Administration Guide Your WorkSpaces users will not be able to override language settings enforced through GPO. For more information about using GPO to set the language for Oﬃce, see Customize language setup and settings for Oﬃce in the Microsoft documentation. Oﬃce 2016 and Oﬃce 2019 use the same GPO settings (labeled with Oﬃce 2016). To work with GPOs, you must install the Active Directory administration tools. For information about using the Active Directory administration tools to work with GPOs, see Set up Active Directory Administration Tools for WorkSpaces Personal. Before you can conﬁgure Oﬃce 2016 or Oﬃce 2019 policy settings, you must download the administrative template ﬁles (.admx/.adml) for Oﬃce from the Microsoft Download Center. After you download the administrative template ﬁles, you must add the office16.admx and office16.adml ﬁles to the Central Store of the domain controller
workspaces-ag-012	workspaces-ag.pdf	12	Microsoft documentation. Oﬃce 2016 and Oﬃce 2019 use the same GPO settings (labeled with Oﬃce 2016). To work with GPOs, you must install the Active Directory administration tools. For information about using the Active Directory administration tools to work with GPOs, see Set up Active Directory Administration Tools for WorkSpaces Personal. Before you can conﬁgure Oﬃce 2016 or Oﬃce 2019 policy settings, you must download the administrative template ﬁles (.admx/.adml) for Oﬃce from the Microsoft Download Center. After you download the administrative template ﬁles, you must add the office16.admx and office16.adml ﬁles to the Central Store of the domain controller for your WorkSpaces directory. (The office16.admx and office16.adml ﬁles apply to both Oﬃce 2016 and Oﬃce 2019.) For more information about working with .admx and .adml ﬁles, see How to create and manage the Central Store for Group Policy Administrative Templates in Windows in the Microsoft documentation. The following procedure describes how to create the Central Store and add the administrative template ﬁles to it. Perform the following procedure on a directory administration WorkSpace or Amazon EC2 instance that is joined to your WorkSpaces directory. To install the Group Policy administrative template ﬁles for Oﬃce 1. Download the administrative template ﬁles (.admx/.adml) for Oﬃce from the Microsoft Download Center. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open Windows File Explorer, and in the address bar, enter your organization's fully qualiﬁed domain name (FQDN), such as \\example.com. 3. Open the SYSVOL folder. 4. Open the folder with the FQDN name. 5. Open the Policies folder. You should now be in \\FQDN\SYSVOL\FQDN\Policies. 6. If it doesn't already exist, create a folder named PolicyDefinitions. Step 7: Add Microsoft Oﬃce to your BYOL image 24 Amazon WorkSpaces Administration Guide 7. Open the PolicyDefinitions folder. 8. Copy the office16.admx ﬁle into the \\FQDN\SYSVOL\FQDN\Policies \PolicyDefinitions folder. 9. Create a folder named en-US in the PolicyDefinitions folder. 10. Open the en-US folder. 11. Copy the office16.adml ﬁle into the \\FQDN\SYSVOL\FQDN\Policies \PolicyDefinitions\en-US folder. To conﬁgure the GPO language settings for Oﬃce 1. On your directory administration WorkSpace or Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 2. 3. 4. 5. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Select your FQDN, open the context (right-click) menu or open the Action menu, and choose Create a GPO in this domain, and Link it here. 6. Name your GPO (for example, Office). 7. 8. Select your GPO, open the context (right-click) menu or open the Action menu, and choose Edit. In the Group Policy Management Editor, choose User Conﬁguration, Policies, Administrative Template Policy deﬁnitions (ADMX ﬁles) retrieved from the local computer, Microsoft Oﬃce 2016, and Language Preferences. Note Oﬃce 2016 and Oﬃce 2019 use the same GPO settings (labeled with Oﬃce 2016). If you don't see Administrative Template Policy deﬁnitions (ADMX ﬁles) retrieved from the local computer under User Conﬁguration, Policies, the office16.admx and office16.adml ﬁles aren't correctly installed on your domain controller. 9. Under Language Preferences, specify the language that you want for the following settings. Be sure to set each setting to Enabled, and then under Options, select the language you want. Choose OK to save each setting. Step 7: Add Microsoft Oﬃce to your BYOL image 25 Amazon WorkSpaces Administration Guide • Display Language > Display help in • Display Language > Display menus and dialog boxes in • Editing languages > Primary Editing Language 10. Close the Group Policy Management tool when you're ﬁnished. 11. Group Policy setting changes take eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • From an administrative command prompt, enter gpupdate /force. Option 3: Update the Oﬃce language registry settings on your WorkSpaces To set the Oﬃce language settings through the registry, update the following registry settings: • HKEY_CURRENT_USER\SOFTWARE\Microsoft\Oﬃce\16.0\Common\LanguageResources \UILanguage • HKEY_CURRENT_USER\SOFTWARE\Microsoft\Oﬃce\16.0\Common\LanguageResources \HelpLanguage For these settings, add a DWORD key value with the appropriate Oﬃce locale ID (LCID). For example, the LCID for English (US) is 1033. Because LCIDs are decimal values, you must set the Base option for the DWORD value to Decimal. For a list of the Oﬃce LCIDs, see Language identiﬁers and OptionState Id values in Oﬃce 2016 in the Microsoft documentation. You can apply these registry settings to your WorkSpaces through GPO settings or a logon script. For more information about working with the language settings for Oﬃce, see Customize language setup and settings for Oﬃce in the Microsoft documentation. Add Oﬃce to your existing BYOL WorkSpaces You can also add a subscription to Oﬃce to
workspaces-ag-013	workspaces-ag.pdf	13	the LCID for English (US) is 1033. Because LCIDs are decimal values, you must set the Base option for the DWORD value to Decimal. For a list of the Oﬃce LCIDs, see Language identiﬁers and OptionState Id values in Oﬃce 2016 in the Microsoft documentation. You can apply these registry settings to your WorkSpaces through GPO settings or a logon script. For more information about working with the language settings for Oﬃce, see Customize language setup and settings for Oﬃce in the Microsoft documentation. Add Oﬃce to your existing BYOL WorkSpaces You can also add a subscription to Oﬃce to your existing BYOL WorkSpaces by doing the following. Step 7: Add Microsoft Oﬃce to your BYOL image 26 Amazon WorkSpaces Administration Guide • Manage applications (recommended) - You can install and conﬁgure Microsoft Oﬃce, Microsoft Visual Studio 2022, Microsoft Visio, or Microsoft Project 2021 on your existing WorkSpaces. For more information, see Manage applications. • Migrate a WorkSpace - After you have a BYOL bundle with Oﬃce installed, you can use the WorkSpaces migration feature to migrate your existing BYOL WorkSpaces to the BYOL bundle that's subscribed to Oﬃce. For more information, see Migrate a WorkSpace in WorkSpaces Personal. Note The manage applications option is available for installing Microsoft Oﬃce 2021 and other applications, such as Microsoft Visual Studio 2022, Microsoft Visio 2021, and Microsoft Project 2021 to your WorkSpaces. For installing Microsoft Oﬃce 2016 or 2019 on your WorkSpaces, use Migrate a WorkSpace in WorkSpaces Personal. Migrate between versions of Microsoft Oﬃce To migrate from one Microsoft Oﬃce version to another, you have the following options: • Manage applications (recommended) – You can uninstall the original Oﬃce version and install Oﬃce 2021 and other applications, such as Microsoft Visual Studio 2022, Microsoft Visio 2021, and Microsoft Project 2021, on your existing WorkSpaces. For example, to migrate from Microsoft Oﬃce 2019 to Microsoft Oﬃce 2021, use the manage applications workﬂow to uninstall Microsoft Oﬃce 2019 and install Microsoft Oﬃce 2021. For more information, see Manage applications. • Migrate a WorkSpace – To migrate from Microsoft Oﬃce 2016 to Microsoft Oﬃce 2019 or from Microsoft Oﬃce 2019 to Microsoft Oﬃce 2016, you must create a BYOL bundle that's subscribed to the version of Oﬃce that you want to migrate to. Then, use the WorkSpaces migration feature to migrate your existing BYOL WorkSpaces that are subscribed to Oﬃce to the BYOL bundle that's subscribed to the version of Oﬃce that you want to migrate to. For example, to migrate from Microsoft Oﬃce 2016 to Microsoft Oﬃce 2019, create a BYOL bundle that's subscribed to Microsoft Oﬃce 2019. Then use the WorkSpaces migration feature to migrate your existing BYOL WorkSpaces that are subscribed to Oﬃce 2016 to the BYOL bundle that's subscribed to Oﬃce 2019. For more information, see Migrate a WorkSpace. Migrate between versions of Microsoft Oﬃce 27 Amazon WorkSpaces Administration Guide You can use these options to migrate your WorkSpaces that are subscribed to Microsoft Oﬃce through AWS to Microsoft 365 applications. However, manage applications is limited to uninstalling Microsoft Oﬃce from your WorkSpace. You must bring in your own tools and installers to install Microsoft 365 applications on your WorkSpaces. Note Using manage applications, you can install or uninstall Microsoft Oﬃce, Microsoft Visio, or MicrosoftProject 2021 on your WorkSpaces. For Microsoft Oﬃce 2016 or 2019 versions, you can only remove them from your WorkSpaces. To install Microsoft Oﬃce 2016 or 2019 on your WorkSpaces, migrate a WorkSpace. For more information about the migration process, see Migrate a WorkSpace in WorkSpaces Personal. Unsubscribe from Oﬃce To unsubscribe from Oﬃce, you have the following options. • Manage applications (recommended) - You can uninstall Microsoft Oﬃce and other applications such as Microsoft Visio and Microsoft Project from your WorkSpaces. For more information, see Manage applications. • Migrate a WorkSpace - You can create a BYOL bundle that is not subscribed to Oﬃce. Then use the WorkSpaces migration feature to migrate your existing BYOL WorkSpaces to the BYOL bundle that is not subscribed to Oﬃce. For more information, see Migrate a WorkSpace in WorkSpaces Personal. Oﬃce updates If you have subscribed to Oﬃce through AWS, Oﬃce updates are included as part of your regular Windows updates. To stay current on all security patches and updates, we recommend that you periodically update your BYOL base images. Migrate between versions of Microsoft Oﬃce 28 Amazon WorkSpaces Administration Guide Step 8: Create a BYOL image using the WorkSpaces console After you import your VM into Amazon EC2 by following the instructions in Step 6: Import a VM as an image into Amazon EC2 in preparation to create a BYOL image for WorkSpaces, perform these steps to create an WorkSpaces BYOL image. Note To perform this procedure, verify that you have AWS Identity and Access Management (IAM) permissions
workspaces-ag-014	workspaces-ag.pdf	14	Windows updates. To stay current on all security patches and updates, we recommend that you periodically update your BYOL base images. Migrate between versions of Microsoft Oﬃce 28 Amazon WorkSpaces Administration Guide Step 8: Create a BYOL image using the WorkSpaces console After you import your VM into Amazon EC2 by following the instructions in Step 6: Import a VM as an image into Amazon EC2 in preparation to create a BYOL image for WorkSpaces, perform these steps to create an WorkSpaces BYOL image. Note To perform this procedure, verify that you have AWS Identity and Access Management (IAM) permissions to: • Call WorkSpaces ImportWorkspaceImage. • Call Amazon EC2 DescribeImages on the Amazon EC2 image that you want to use to create the BYOL image. • Call Amazon EC2 ModifyImageAttribute on the Amazon EC2 image that you want to use to create the BYOL image. Make sure that the launch permissions on the Amazon EC2 image are not restricted. The image must be shareable throughout the BYOL image creation process. For an example IAM policy speciﬁc to BYOL WorkSpaces, see Identity and access management for WorkSpaces. For more information about working with IAM permissions, see Changing Permissions for an IAM User in the IAM User Guide. To create a Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro bundle from your image, contact the AWS Support Center to get your account added to the allow list. After your account is on the allow list, you can use the AWS CLI import-workspace-image command to ingest the Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro image. For more information, see import-workspace-image in the AWS CLI Command Reference. To create an image from the Windows VM 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Images. 3. Choose Create BYOL image. 4. On the Create BYOL image page, do the following: Step 8: Create a BYOL image using the WorkSpaces console 29 Amazon WorkSpaces Administration Guide • For AMI ID, choose the EC2 Console link, and choose the Amazon EC2 image that you imported as described in the previous section (Step 6: Import a VM as an image into Amazon EC2 in preparation to create a BYOL image for WorkSpaces). The image name must begin with ami- and be followed by the identiﬁer for the AMI (for example, ami-1234567e). • For Image name, enter a unique name for the image. • For Description, enter a description to help you quickly identify the image. • For Instance type, choose the appropriate bundle type (either Regular, Graphics.g4dn, Graphics, or GraphicsPro), depending on which protocol you want to use for your image, either PCoIP or DCV. If you want to create a GraphicsPro.g4dn bundle, choose Graphics.g4dn. For non-GPU-enabled bundles (bundles other than Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro), choose Regular. Note • GraphicsPro images can be created only for the PCoIP protocol. • Windows 11 images can be created only for the DCV protocol. • Graphics and GraphicsPro Images are not supported for Windows 11. • (Optional) For Select applications, choose which version of Microsoft Oﬃce you want to subscribe to. For more information, see Step 7: Add Microsoft Oﬃce to your BYOL image in Amazon WorkSpaces. • (Optional) For Tags, choose Add new tag to associate tags with this image. For more information, see Tag resources in WorkSpaces Personal. 5. Choose Create BYOL image. While your image is being created, the image's status on the Images page of the console appears as Pending. The BYOL ingestion process takes a minimum of 90 minutes. If you have subscribed to Oﬃce as well, expect the process to take a minimum of 3 hours. If the image validation does not succeed, the console displays an error code. When the image creation is complete, the status changes to Available. Step 8: Create a BYOL image using the WorkSpaces console 30 Amazon WorkSpaces Note Administration Guide During the BYOL import process, oﬀending AppX packages will be cleaned up and Sysprep will be retried. If the image import process continues to fail, it means AppX packages will need to be manually cleaned up. Step 9: Create a custom bundle from the BYOL image in WorkSpaces After you create your BYOL image by following the instructions in Step 8: Create a BYOL image using the WorkSpaces console, you can use the image to create a custom bundle. For information, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. Step 10: Create a dedicated directory to use BYOL images for WorkSpaces To use BYOL images for WorkSpaces, you must create a directory for this purpose. To create a directory for WorkSpaces, see Create a directory for WorkSpaces Personal. Ensure that you choose Enable Dedicated WorkSpaces when creating the directory. If you've already registered an AWS Managed Microsoft AD directory or an AD Connector directory for
workspaces-ag-015	workspaces-ag.pdf	15	in Step 8: Create a BYOL image using the WorkSpaces console, you can use the image to create a custom bundle. For information, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. Step 10: Create a dedicated directory to use BYOL images for WorkSpaces To use BYOL images for WorkSpaces, you must create a directory for this purpose. To create a directory for WorkSpaces, see Create a directory for WorkSpaces Personal. Ensure that you choose Enable Dedicated WorkSpaces when creating the directory. If you've already registered an AWS Managed Microsoft AD directory or an AD Connector directory for WorkSpaces that doesn't run on dedicated hardware, you can set up a new AWS Managed Microsoft AD directory or AD Connector directory for this purpose. You can also deregister the directory and then register it again as a directory for dedicated WorkSpaces. To learn more about registering and deregistering an existing AWS Directory Service directory, see Register an existing AWS Directory Service directory with WorkSpaces Personal. Step 11: Launch your BYOL WorkSpaces After you register a directory for dedicated WorkSpaces by following the instructions in Step 8: Create a BYOL image using the WorkSpaces console, you can launch your BYOL WorkSpaces Personal and WorkSpaces Pool in this directory. Step 9: Create a custom bundle from the BYOL image in WorkSpaces 31 Amazon WorkSpaces Administration Guide Launch your BYOL WorkSpaces Personal To launch a personal WorkSpace, see Create a WorkSpace in WorkSpaces Personal. Launch your BYOL WorkSpaces Pool To launch a WorkSpaces Pool, you have to launch a personal WorkSpace, create an image of that personal WorkSpace, then use that image to launch a pool. To create an image for BYOL WorkSpaces Pools 1. Launch a personal WorkSpace with the BYOL image you want to use for your WorkSpaces Pools. For information about how to launch WorkSpaces Personal, see Create a WorkSpace in WorkSpaces Personal. 2. Login in to the personal WorkSpace and make sure all your Windows updates are installed. 3. Update your Amazon EC2 conﬁgurations. To update your EC2 conﬁgurations using Windows 10, see Install the latest version of EC2Conﬁg. To update your EC2 conﬁgurations using Windows 11, see Install the latest version of EC2Launch. 4. Add a Windows defender exclusion list. For more information, see Add an exclusion to Windows Security . Add the following folders to the exclusion list in Windows Defender: • C:\Program Files\Amazon\* • C:\ProgramData\Amazon\* • C:\Program Files\NICE\* • C:\ProgramData\NICE\* • C:\Program Files (x86)\AWS Tools\* • C:\Program Files (x86)\AWS SDK for .NET\* • C:\AWSEUC\* (This is for the session script) 5. Disable Windows update on startup by entering the following command. Open powershell as admin- Run following command - New-Item -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate" -Force New-Item -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate\AU" - Force Step 11: Launch your BYOL WorkSpaces 32 Amazon WorkSpaces Administration Guide Set-ItemProperty -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate \AU" -Name "NoAutoUpdate" -Value 1 -Force 6. Reboot the WorkSpace. For more information, see Reboot a WorkSpace in WorkSpaces Personal. Note We recommend doing the following before you begin creating an image for BYOL WorkSpaces Pools • Remove unnecessary startup applications. • Remove or disable unnecessary scheduled tasks. Open the start menu, choose Scheduled tasks, select the tasks you want to disable and then choose Disable. 7. Run image checker after the reboot by entering the following command. C:\Program Files\Amazon\ImageChecker.exe For more information on creating a custom WorkSpaces image, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. 8. Resolve any errors found by the image checker. For more information, see Tips for resolving issues detected by the Image Checker. 9. After all tests have passed the image checker, go back to the WorkSpaces console. 10. In the navigation pane, under WorkSpaces, choose Personal. Choose the BYOL personal WorkSpaces, then choose Actions, Create image. 11. In the navigation pane, choose Images. Under Images, check if the image is created. You can now launch WorkSpaces Pools with the image you created. For more information about launching WorkSpaces Pools, see Create a WorkSpaces Pool. Videos on uploading and creating BYOL images For a demonstration on uploading BYOL images, watch the following videos. Videos on uploading and creating BYOL images 33 Amazon WorkSpaces Administration Guide For a demonstration on creating BYOL images with Microsoft Hyper-V, watch the following video. For a demonstration on creating BYOL images with VMware Workstation, watch the following video. Link BYOL accounts in WorkSpaces You can use BYOL linking to link accounts and share BYOL conﬁgurations. BYOL conﬁgurations include the CIDR range used by your accounts and the images you use to create WorkSpaces with your Windows license. All accounts that are linked share the same underlying hardware infrastructure. The account enabled for BYOL linking is the primary owner of the underlying hardware infrastructure, and is called the Source account. The Source account manages access to the underlying hardware infrastructure.
workspaces-ag-016	workspaces-ag.pdf	16	Hyper-V, watch the following video. For a demonstration on creating BYOL images with VMware Workstation, watch the following video. Link BYOL accounts in WorkSpaces You can use BYOL linking to link accounts and share BYOL conﬁgurations. BYOL conﬁgurations include the CIDR range used by your accounts and the images you use to create WorkSpaces with your Windows license. All accounts that are linked share the same underlying hardware infrastructure. The account enabled for BYOL linking is the primary owner of the underlying hardware infrastructure, and is called the Source account. The Source account manages access to the underlying hardware infrastructure. Target accounts are the accounts that are linked to the Source account. Important APIs for BYOL account linking are not available in the AWS GovCloud (US) Region. Note The AWS accounts that you want to link with must be part of your organization and under the same payer account. You can only link accounts within the same Region. To link the Source and Target accounts 1. Send an invitation link from your Source account to the Target account by using the CreateAccountLinkInvitation API. 2. Accept the pending link from your Target account by using the AcceptAccountLinkInvitation API. 3. Verify the link has been established by using the GetAccountLink or ListAccountLinks API. Link BYOL accounts in WorkSpaces 34 Amazon WorkSpaces Administration Guide Use and manage WorkSpaces Personal WorkSpaces Personal oﬀers persistent virtual desktops that are tailored for users who need a highly-personalized desktop provisioned for their exclusive use, similar to a physical desktop computer assigned to an individual. Each WorkSpace is associated with a virtual private cloud (VPC), and a directory to store and manage information for your WorkSpaces and users. For more information, see the section called “VPC requirements”. Directories are either managed by the WorkSpaces service, or through the AWS Directory Service, which oﬀers the following options: Simple AD, AD Connector, or AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD. For more information, see the AWS Directory Service Administration Guide. WorkSpaces uses your IAM Identity Center (for directories managed by Amazon WorkSpaces), Simple AD, AD Connector, or AWS Managed Microsoft AD directory to authenticate users. Users access their WorkSpaces by using a client application from a supported device or, for Windows WorkSpaces, a web browser, and they log in by using their directory credentials. The login information is sent to an authentication gateway, which forwards the traﬃc to the directory for the WorkSpace. After the user is authenticated, streaming traﬃc is initiated through the streaming gateway. Client applications use HTTPS over port 443 for all authentication and session-related information. Client applications use port 4172 (PCoIP) and port 4195 (DCV) for pixel streaming to the WorkSpace and ports 4172 and 4195 for network health checks. For more information, see Ports for client applications. Each WorkSpace has two elastic network interfaces associated with it: a network interface for management and streaming (eth0) and a primary network interface (eth1). The primary network interface has an IP address provided by your VPC, from the same subnets used by the directory. This ensures that traﬃc from your WorkSpace can easily reach the directory. Access to resources in the VPC is controlled by the security groups assigned to the primary network interface. For more information, see Network interfaces. The following diagram shows the architecture of WorkSpaces that use AD Connector. 35 Amazon WorkSpaces Administration Guide Options for creating a WorkSpace with WorkSpaces Personal There are several methods to create a WorkSpace. You can use the quick setup instructions, the advanced setup instructions, or choose from the following options: • Create an AWS Managed Microsoft AD directory for WorkSpaces Personal • Create a Simple AD directory for WorkSpaces Personal • Create an AD Connector for WorkSpaces Personal • Create a trust relationship between your AWS Managed Microsoft AD directory and your on- premises domain for WorkSpaces Personal • Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal • Create a dedicated Custom directory with WorkSpaces Personal Get started with WorkSpaces Personal As a ﬁrst-time WorkSpaces user, you can choose to set up your WorkSpaces Personal with quick setup or advanced setup. The following tutorials describe how to provision a cloud-based desktop, known as a WorkSpace using WorkSpaces and AWS Directory Service. WorkSpaces Personal options 36 Amazon WorkSpaces Note Administration Guide To get started with WorkSpaces Pools, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory. WorkSpaces Personal quick setup In this tutorial, you learn how to provision a virtual, cloud-based Microsoft Windows, Amazon Linux 2, Ubuntu Linux, Rocky Linux, or Red Hat Enterprise Linux desktop, known as a WorkSpace, by using WorkSpaces and AWS Directory Service. This tutorial uses the quick setup option to launch your WorkSpace. This option is available only if you have never launched a
workspaces-ag-017	workspaces-ag.pdf	17	cloud-based desktop, known as a WorkSpace using WorkSpaces and AWS Directory Service. WorkSpaces Personal options 36 Amazon WorkSpaces Note Administration Guide To get started with WorkSpaces Pools, see Conﬁgure SAML 2.0 and create a WorkSpaces Pools directory. WorkSpaces Personal quick setup In this tutorial, you learn how to provision a virtual, cloud-based Microsoft Windows, Amazon Linux 2, Ubuntu Linux, Rocky Linux, or Red Hat Enterprise Linux desktop, known as a WorkSpace, by using WorkSpaces and AWS Directory Service. This tutorial uses the quick setup option to launch your WorkSpace. This option is available only if you have never launched a WorkSpace. Alternatively, see Create a directory for WorkSpaces Personal. Note This quick setup option and tutorial does not apply to WorkSpaces Pools. Note Quick setup is supported in the following AWS Regions: • US East (N. Virginia) • US West (Oregon) • Europe (Ireland) • Asia Paciﬁc (Singapore) • Asia Paciﬁc (Sydney) • Asia Paciﬁc (Tokyo) To change your Region, see Choosing a Region. Tasks • Before you begin Get started with WorkSpaces Personal 37 Administration Guide Amazon WorkSpaces • What quick setup does • Step 1: Launch the WorkSpace • Step 2: Connect to the WorkSpace • Step 3: Clean up (Optional) • Next steps Before you begin Before you begin, make sure that you meet the following requirements: • You must have an AWS account to create or administer a WorkSpace. Users do not need an AWS account to connect to and use their WorkSpaces. • WorkSpaces is not available in every Region. Verify the supported Regions and select a Region for your WorkSpaces. For more information about the supported Regions, see WorkSpaces Pricing by AWS Region. It's also helpful to review and understand the following before you proceed: • When you launch a WorkSpace, you must select a WorkSpace bundle. For more information, see Amazon WorkSpaces Bundles and Amazon WorkSpaces Pricing. • When you launch a WorkSpace, you must select which protocol (PCoIP or DCV) you want to use with your bundle. For more information, see Protocols for WorkSpaces Personal. • When you launch a WorkSpace, you must specify proﬁle information for the user, including a user name and email address. Users complete their proﬁles by specifying a password. Information about WorkSpaces and users is stored in a directory. For more information, see the section called “Manage directories for WorkSpaces”. What quick setup does Quick setup completes the following tasks on your behalf: • Creates an IAM role to allow the WorkSpaces service to create elastic network interfaces and list your WorkSpaces directories. This role has the name workspaces_DefaultRole. • Creates a virtual private cloud (VPC). If you want to use an existing VPC instead, make sure it meets the requirements noted in Conﬁgure a VPC for WorkSpaces Personal, and then follow the Get started with WorkSpaces Personal 38 Amazon WorkSpaces Administration Guide steps in one of the tutorials listed in Create a directory for WorkSpaces Personal. Choose the tutorial that corresponds to the type of Active Directory that you want to use. • Sets up a Simple AD directory in the VPC and enables it for Amazon WorkDocs. This Simple AD directory is used to store user and WorkSpace information. The ﬁrst AWS account created by quick setup is your admin AWS account. † The directory also has an Administrator account. For more information, see What gets created in the AWS Directory Service Administration Guide. • Creates the speciﬁed AWS accounts and adds them to the directory. • Creates WorkSpaces. Each WorkSpace receives a public IP address to provide internet access. The running mode is AlwaysOn. For more information, see Manage the running mode in WorkSpaces Personal. • Sends invitation emails to the speciﬁed users. If your users don't receive their invitation emails, see Send an invitation email. † The ﬁrst AWS account created by quick setup is your admin AWS account. You can't update this AWS account from the WorkSpaces Console. Don't share the information for this account with anyone else. To invite other users to use WorkSpaces, create new AWS accounts for them. Step 1: Launch the WorkSpace Using quick setup, you can launch your ﬁrst WorkSpace in minutes. To launch a WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Quick setup. If you don't see this button, either you have already launched a WorkSpace in this Region, or you aren't using one of the Regions that support quick setup. In this case, see Create a directory for WorkSpaces Personal. Get started with WorkSpaces Personal 39 Amazon WorkSpaces Administration Guide 3. For Identify users, enter the Username, First Name. Last Name, and Email. Then choose Next. Note If this is your ﬁrst time using WorkSpaces, we recommend creating a user for yourself for testing purposes. Get started with WorkSpaces Personal 40 Amazon
workspaces-ag-018	workspaces-ag.pdf	18	Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose Quick setup. If you don't see this button, either you have already launched a WorkSpace in this Region, or you aren't using one of the Regions that support quick setup. In this case, see Create a directory for WorkSpaces Personal. Get started with WorkSpaces Personal 39 Amazon WorkSpaces Administration Guide 3. For Identify users, enter the Username, First Name. Last Name, and Email. Then choose Next. Note If this is your ﬁrst time using WorkSpaces, we recommend creating a user for yourself for testing purposes. Get started with WorkSpaces Personal 40 Amazon WorkSpaces Administration Guide 4. For Bundles, select a bundle (hardware and software) for the user with the appropriate protocol (PCoIP or DCV). For more information about the various public bundles available for Amazon WorkSpaces, see Amazon WorkSpaces Bundles. 5. Review your information. Then choose Create WorkSpace. 6. It takes approximately 20 minutes for your WorkSpace to launch. To monitor the progress, go to the left navigation pane and choose Directories. You will see a directory being created with an initial status of REQUESTED and then CREATING. After the directory has been created and has a status of ACTIVE, you can choose WorkSpaces in the left navigation pane to monitor the progress of the WorkSpace launch process. The initial status of the WorkSpace is PENDING. When the launch is complete, the status is Get started with WorkSpaces Personal 41 Amazon WorkSpaces Administration Guide AVAILABLE and an invitation is sent to the email address that you speciﬁed for each user. If your users don't receive their invitation emails, see Send an invitation email. Step 2: Connect to the WorkSpace After you receive the invitation email, you can connect to the WorkSpace using the client of your choice. After you sign in, the client displays the WorkSpace desktop. To connect to the WorkSpace 1. If you haven't set up credentials for the user already, open the link in the invitation email and follow the directions. Remember the password that you specify as you will need it to connect to your WorkSpace. Note Passwords are case-sensitive and must be between 8 and 64 characters in length, inclusive. Passwords must contain at least one character from each of the following categories: lowercase letters (a-z), uppercase letters (A-Z), numbers (0-9), and the set ~! @#$%^&*_-+=`\|\(){}[]:;"'<>,.?/. 2. Review WorkSpaces Clients in the Amazon WorkSpaces User Guide for more information about the requirements for each client, and then do one of the following: • When prompted, download one of the client applications or launch Web Access. • If you aren't prompted and you haven't installed a client application already, open https:// clients.amazonworkspaces.com/ and download one of the client applications or launch Web Access. Note You cannot use a web browser (Web Access) to connect to Amazon Linux WorkSpaces. 3. Start the client, enter the registration code from the invitation email, and choose Register. 4. When prompted to sign in, enter the sign-in credentials, and then choose Sign In. 5. (Optional) When prompted to save your credentials, choose Yes. Get started with WorkSpaces Personal 42 Amazon WorkSpaces Administration Guide For more information about using the client applications, such as setting up multiple monitors or using peripheral devices, see WorkSpaces Clients and Peripheral Device Support in the Amazon WorkSpaces User Guide. Step 3: Clean up (Optional) If you are ﬁnished with the WorkSpace that you created for this tutorial, you can delete it. For more information, see the section called “Delete a WorkSpace”. Note Simple AD is made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD 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 directory, you can always create a new one when you want to start using WorkSpaces again. Next steps You can continue to customize the WorkSpace that you just created. For example, you can install software and then create a custom bundle from your WorkSpace. You can also perform various administrative tasks for your WorkSpaces and your WorkSpaces directory. For more information, see the following documentation. • Create a custom WorkSpaces image and bundle for WorkSpaces Personal • Administer WorkSpaces Personal • Manage directories for WorkSpaces Personal To create additional WorkSpaces, do one of the following: • If you want to continue using the VPC and the Simple AD directory that were created by quick setup, you can add WorkSpaces for additional users by following the steps in the Create a WorkSpace in WorkSpaces Personal section of the Launch a WorkSpace Using Simple
workspaces-ag-019	workspaces-ag.pdf	19	your WorkSpace. You can also perform various administrative tasks for your WorkSpaces and your WorkSpaces directory. For more information, see the following documentation. • Create a custom WorkSpaces image and bundle for WorkSpaces Personal • Administer WorkSpaces Personal • Manage directories for WorkSpaces Personal To create additional WorkSpaces, do one of the following: • If you want to continue using the VPC and the Simple AD directory that were created by quick setup, you can add WorkSpaces for additional users by following the steps in the Create a WorkSpace in WorkSpaces Personal section of the Launch a WorkSpace Using Simple AD tutorial. • If you need to use another directory type or if you need to use an existing Active Directory, see the appropriate tutorial in Create a directory for WorkSpaces Personal. Get started with WorkSpaces Personal 43 Amazon WorkSpaces Administration Guide For more information about using the WorkSpaces client applications, such as setting up multiple monitors or using peripheral devices, see WorkSpaces Clients and Peripheral Device Support in the Amazon WorkSpaces User Guide. Get started with WorkSpaces Personal advanced setup In this tutorial, you learn how to provision a virtual, cloud-based Microsoft Windows, Amazon Linux, Ubuntu Linux, or Red Hat Enterprise Linux desktop desktop, known as a WorkSpace, by using WorkSpaces and AWS Directory Service. This tutorial uses the advanced setup option to launch your WorkSpace. Note Advanced setup is supported in all Regions for WorkSpaces. Tasks • Before you begin • Using advanced setup to launch your WorkSpace Before you begin Before you begin, make sure you have an AWS account that you can use to create or administer a WorkSpace. Users don't need an AWS account to connect to and use their WorkSpaces. Review and understand the following concepts before you proceed: • When you launch a WorkSpace, you must select a WorkSpace bundle. For more information, see Amazon WorkSpaces Bundles. • When you launch a WorkSpace, you must select which protocol (PCoIP or DCV) you want to use with your bundle. For more information, see Protocols for WorkSpaces Personal. • When you launch a WorkSpace, you must specify proﬁle information for the user, including a user name and email address. Users complete their proﬁles by specifying a password. Information about WorkSpaces and users is stored in a directory. For more information, see the section called “Manage directories for WorkSpaces”. Get started with WorkSpaces Personal 44 Amazon WorkSpaces Administration Guide Using advanced setup to launch your WorkSpace To use advanced setup to launch your WorkSpace: 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. Choose one of the following directory types, and then choose Next: • AWS Managed Microsoft AD • Simple AD • AD Connector 3. Enter the directory information. 4. Choose two subnets in a VPC from two diﬀerent availability zones. For more information, see Conﬁgure a VPC with public subnets. 5. Review your directory's information and choose Create directory. Create a WorkSpace in WorkSpaces Personal WorkSpaces enables you to provision virtual, cloud-based Windows and Linux desktops for your users, known as WorkSpaces. Before creating a personal WorkSpace, create a directory by doing one of the following: • Create a Simple AD directory. • Create an AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD. • Connect to an existing Microsoft Active Directory by using Active Directory Connector. • Create a trust relationship between your AWS Managed Microsoft AD directory and your on- premises domain. • Create a dedicated directory that uses Microsoft Entra ID as the identity source (through IAM Identity Center). WorkSpaces in the directory are native Entra ID-joined and enrolled into Microsoft Intune through Microsoft Windows Autopilot user-driven mode. Create a WorkSpace 45 Amazon WorkSpaces Note Administration Guide Such directories currently only support Windows 10 and 11 Bring Your Own Licenses personal WorkSpaces. • Create a dedicated directory that uses an identity provider of your choice as the identity source (through IAM Identity Center). WorkSpaces in the directory are native Entra ID-joined and enrolled into Microsoft Intune through Microsoft Windows Autopilot user-driven mode. Note Such directories currently only support Windows 10 and 11 Bring Your Own Licenses personal WorkSpaces. Now that you have created a directory, you are ready to create a personal WorkSpace. To create a personal WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose WorkSpaces. 3. Choose Launch WorkSpaces, Personal. 4. Choose Create WorkSpaces 5. Under Onboarding (optional), you can choose Recommend options to me based on my use case to get recommendations on the type of WorkSpace you want to use. You can skip this step if you know that you want to use personal WorkSpaces. 6. Choose Next. WorkSpaces registers your AD Connector. 7. Under Conﬁgure WorkSpaces, enter the following details: • For Bundle, choose from the following
workspaces-ag-020	workspaces-ag.pdf	20	ready to create a personal WorkSpace. To create a personal WorkSpace 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose WorkSpaces. 3. Choose Launch WorkSpaces, Personal. 4. Choose Create WorkSpaces 5. Under Onboarding (optional), you can choose Recommend options to me based on my use case to get recommendations on the type of WorkSpace you want to use. You can skip this step if you know that you want to use personal WorkSpaces. 6. Choose Next. WorkSpaces registers your AD Connector. 7. Under Conﬁgure WorkSpaces, enter the following details: • For Bundle, choose from the following the bundle type that you want to use for your WorkSpaces. • Use a base WorkSpaces bundle - Choose one of the bundles from the drop down. For more information about the bundle type you selected, choose Bundle details. To compare bundles oﬀered for pools, choose Compare all bundles. Create a WorkSpace 46 Amazon WorkSpaces Administration Guide • Use your own custom or BYOL bundle - Choose a bundle that you previously created. To create a custom bundle, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. Note Review the recommended uses and speciﬁcations of each bundle to help ensure you select the bundle that works best for your users. For more information about each use case, see Amazon WorkSpaces Bundles. For more information about bundle speciﬁcations, recommended uses, and pricing, see Amazon WorkSpaces pricing. • For Running mode, choose from the following to conﬁgure your personal WorkSpace’s immediate availability and how you pay for it (monthly or hourly): • AlwaysOn — Bills 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 — Bills by the hour. With this mode, your WorkSpaces stop after a speciﬁed period of disconnection, and the state of apps and data is saved. • For Tags, specify the key pair value that you want to use. A key can be a general category, such as "project," "owner," or "environment," with speciﬁc associated values. 8. Under Select directory, enter the following details: • Choose the directory that you created. To create a directory, choose Create directory. For more information about creating personal directories, see Register an existing AWS Directory Service directory with WorkSpaces Personal. • Choose the users from that directory you want to provision personal WorkSpaces for by doing the following. 1. Choose Create users. 2. Enter the user’s Username, First name, Last name, and Email. To add additional users, choose Create additional user and enter their information. 9. Under Customization (optional), you can customize bundles, root and user volume encryption, and user volume for all users or speciﬁc users. 10. Choose Create WorkSpaces. The initial status of the WorkSpace is PENDING. When the creation is complete, the status is AVAILABLE and an invitation is sent to the email address that you speciﬁed for the users. Create a WorkSpace 47 Amazon WorkSpaces Administration Guide 11. Send invitations to the email address for each user. For more information, see Send an invitation email. Note • These invitations aren't sent automatically if you're using AD Connector or a trust relationship. • Invitation emails aren't sent if the user already exists in Active Directory. Instead, make sure you manually send the user an invitation email. For more information, see Send an invitation email. • In all Regions, the text of the invitation email is in English (US). In the following Regions, the English text is preceded by a second language: • Asia Paciﬁc (Seoul): Korean • Asia Paciﬁc (Tokyo): Japanese • Canada (Central): French (Canadian) • China (Ningxia): Simpliﬁed Chinese Connect to the WorkSpace You can connect to your WorkSpace using the client of your choice. After you sign in, the client displays the WorkSpace desktop. To connect to the WorkSpace 1. Open the link in the invitation email. 2. Review WorkSpaces Clients in the Amazon WorkSpaces User Guide for more information about the requirements for each client, and then do one of the following: • When prompted, download one of the client applications or launch Web Access. • If you aren't prompted and you haven't installed a client application already, open https:// clients.amazonworkspaces.com/ and download one of the client applications or launch Web Access. Connect to the WorkSpace 48 Amazon WorkSpaces Note Administration Guide You cannot use a web browser (Web Access) to connect to Amazon Linux WorkSpaces. 3. Start the client, enter the registration code from the invitation email, and choose Register. 4. When prompted to sign in, enter the the user's sign-in credentials, and then choose Sign In. 5. (Optional) When prompted to save your credentials, choose Yes. Note Because you're using AD Connector, your users won't be able to reset their own passwords. (The Forgot
workspaces-ag-021	workspaces-ag.pdf	21	application already, open https:// clients.amazonworkspaces.com/ and download one of the client applications or launch Web Access. Connect to the WorkSpace 48 Amazon WorkSpaces Note Administration Guide You cannot use a web browser (Web Access) to connect to Amazon Linux WorkSpaces. 3. Start the client, enter the registration code from the invitation email, and choose Register. 4. When prompted to sign in, enter the the user's sign-in credentials, and then choose Sign In. 5. (Optional) When prompted to save your credentials, choose Yes. Note Because you're using AD Connector, 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. Next steps You can continue to customize the WorkSpace that you just created. For example, you can install software and then create a custom bundle from your WorkSpace. You can also perform various administrative tasks for your WorkSpaces and your WorkSpaces directory. If you are ﬁnished with your WorkSpace, you can delete it. For more information, see the following documentation. • Create a custom WorkSpaces image and bundle for WorkSpaces Personal • Administer WorkSpaces Personal • Manage directories for WorkSpaces Personal • Delete a WorkSpace in WorkSpaces Personal For more information about using the WorkSpaces client applications, such as setting up multiple monitors or using peripheral devices, see WorkSpaces Clients and Peripheral Device Support in the Amazon WorkSpaces User Guide. Next steps 49 Amazon WorkSpaces Administration Guide Networking protocols and access for WorkSpaces Personal As a WorkSpace administrator, you must understand how to manage WorkSpaces networking and access, beginning with protocols. Protocols for WorkSpaces Personal Amazon WorkSpaces supports two protocols: PCoIP and DCV. The protocol that you choose depends on several factors, such as the type of devices your users will be accessing their WorkSpaces from, which operating system is on your WorkSpaces, what network conditions your users will be facing, and whether your users require bidirectional video support. Requirements DCV WorkSpaces are only supported with the following minimum requirements. Host agent requirements: • Windows host agent version 2.0.0.312 or above • Ubuntu host agent version 2.1.0.501 or above • Amazon Linux 2 host agent version 2.0.0.596 or above • Rocky Linux host agent version 2.1.0.1628 or above • Red Hat Enterprise Linux host agent version 2.1.0.1628 or above Client requirements: • Windows native client version 5.1.0.329 or higher • macOS native client version 5.5.0 or higher • Ubuntu 22.04 client version 2024.x or higher • Amazon WorkSpaces Thin Client (For more information, see the Amazon WorkSpaces Thin Client Documentation) • Web Access For more information about how to check your WorkSpace client version and host agent version, see the FAQ. Networking protocols and access 50 Amazon WorkSpaces When to use DCV Administration Guide • If you need higher loss/latency tolerance to support your end user network conditions. For example, you have users who are accessing their WorkSpaces across global distances or using unreliable networks. • If you need your users to authenticate with smart cards or to use smart cards in-session. • If you need webcam support capabilities in-session. • If you need to use Web Access with the Windows Server 2022-powered WorkSpaces bundle. • If you need to use Ubuntu WorkSpaces. • If you need to use Windows 11 BYOL WorkSpaces. • If you need to use Windows or Ubuntu GPU-based bundles (Graphics.g4dn and GraphicsPro.g4dn). • If you need your users to authenticate in-session with WebAuthn authenticators such as YubiKey or Windows Hello. When to use PCoIP • If you want to use the iPad or Android Linux clients. • If you use Teradici zero client devices. • If you need to use GPU-based bundles (Graphics.g4dn, GraphicsPro.g4dn, Graphics, or GraphicsPro). • If you need to use a Linux bundle for non-smart card use cases. • If you need to use WorkSpaces in the China (Ningxia) Region. Note • A directory can have a mix of PCoIP and DCV WorkSpaces in it. • A user can have both a PCoIP and a DCV WorkSpace as long as the two WorkSpaces are located in separate directories. The same user cannot have a PCoIP and a DCV WorkSpace in the same directory. For more information about creating multiple WorkSpaces for a user, see Create multiple WorkSpaces for a user in WorkSpaces Personal. Protocols for Amazon WorkSpaces 51 Amazon WorkSpaces Administration Guide • You can migrate a WorkSpace between the two protocols by using the WorkSpaces migration feature, which requires a rebuild of the WorkSpace. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • If your WorkSpace was created with PCoIP bundles you can modify the streaming protocol to migrate between the two protocols without requiring a rebuild, while retaining
workspaces-ag-022	workspaces-ag.pdf	22	have a PCoIP and a DCV WorkSpace in the same directory. For more information about creating multiple WorkSpaces for a user, see Create multiple WorkSpaces for a user in WorkSpaces Personal. Protocols for Amazon WorkSpaces 51 Amazon WorkSpaces Administration Guide • You can migrate a WorkSpace between the two protocols by using the WorkSpaces migration feature, which requires a rebuild of the WorkSpace. For more information, see Migrate a WorkSpace in WorkSpaces Personal. • If your WorkSpace was created with PCoIP bundles you can modify the streaming protocol to migrate between the two protocols without requiring a rebuild, while retaining the root volume. For more information, see Modify protocols. • For the best experience with video conferencing we recommend using Power, PowerPro, GeneralPurpose.4xlarge, or GeneralPurpose.8xlarge bundles only. The following topics oﬀer additional detail about how to manage networking and access for WorkSpaces Personal: Conﬁgure a VPC for WorkSpaces Personal WorkSpaces launches your WorkSpaces in a virtual private cloud (VPC). You can create a VPC with two private subnets for your WorkSpaces and a NAT gateway in a public subnet. Alternatively, you can create a VPC with two public subnets for your WorkSpaces and associate a public IP address or Elastic IP address with each WorkSpace. For more information about VPC design considerations, see Best Practices for VPCs and Networking in Amazon WorkSpaces Deployments and Best Practices for Deploying WorkSpaces - VPC Design. Contents • Requirements • Conﬁgure a VPC with private subnets and a NAT gateway • Conﬁgure a VPC with public subnets Requirements Your VPC's subnets must reside in diﬀerent Availability Zones in the Region where you're launching WorkSpaces. Availability Zones are distinct locations that are engineered to be isolated from failures in other Availability Zones. By launching instances in separate Availability Zones, you can protect your applications from the failure of a single location. Each subnet must reside entirely within one Availability Zone and cannot span zones. VPC requirements 52 Amazon WorkSpaces Note Administration Guide Amazon WorkSpaces is available in a subset of the Availability Zones in each supported Region. To determine which Availability Zones you can use for the subnets of the VPC that you're using for WorkSpaces, see Availability Zones for WorkSpaces Personal. Conﬁgure a VPC with private subnets and a NAT gateway If you use AWS Directory Service to create an AWS Managed Microsoft or a Simple AD, we recommend that you conﬁgure the VPC with one public subnet and two private subnets. Conﬁgure your directory to launch your WorkSpaces in the private subnets. To provide internet access to WorkSpaces in a private subnet, conﬁgure a NAT gateway in the public subnet. VPC requirements 53 Amazon WorkSpaces Administration Guide To create a VPC with one public subnet and two private subnets 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. Choose Create VPC. 3. Under Resources to create, choose VPC and more. 4. For Name tag auto-generation, enter a name for the VPC. VPC requirements 54 Amazon WorkSpaces Administration Guide 5. To conﬁgure the subnets, do the following: a. b. c. d. For Number of Availability Zones, choose 1 or 2, depending on your needs. Expand Customize AZs and choose your Availability Zones. Otherwise, AWS selects them for you. To make an appropriate selection, see Availability Zones for WorkSpaces Personal. For Number of public subnets, ensure that you have one public subnet per Availability Zone. For Number of private subnets, ensure that you have at least one private subnet per Availability Zone. e. Enter a CIDR block for each subnet. For more information, see Subnet sizing in the Amazon VPC User Guide. 6. For NAT gateways, choose 1 per AZ. 7. Choose Create VPC. IPv6 CIDR blocks You can associate IPv6 CIDR blocks with your VPC and subnets. However, if you conﬁgure your subnets to automatically assign IPv6 addresses to instances launched in the subnet, then you cannot use Graphics bundles. (You can use Graphics.g4dn, GraphicsPro.g4dn, and GraphicsPro bundles, however.) This restriction arises from a hardware limitation of previous-generation instance types that do not support IPv6. To work around this issue, you can temporarily disable the auto-assign IPv6 addresses setting on the WorkSpaces subnets before launching Graphics bundles, and then reenable this setting (if needed) after launching Graphics bundles so that any other bundles receive the desired IP addresses. By default, the auto-assign IPv6 addresses setting is disabled. To check this setting from the Amazon VPC console, in the navigation pane, choose Subnets. Select the subnet, and choose Actions, Modify auto-assign IP settings. Conﬁgure a VPC with public subnets If you prefer, you can create a VPC with two public subnets. To provide internet access to WorkSpaces in public subnets, conﬁgure the directory to assign Elastic IP addresses automatically or manually assign an Elastic IP address to each WorkSpace. Tasks VPC requirements 55 Amazon WorkSpaces
workspaces-ag-023	workspaces-ag.pdf	23	after launching Graphics bundles so that any other bundles receive the desired IP addresses. By default, the auto-assign IPv6 addresses setting is disabled. To check this setting from the Amazon VPC console, in the navigation pane, choose Subnets. Select the subnet, and choose Actions, Modify auto-assign IP settings. Conﬁgure a VPC with public subnets If you prefer, you can create a VPC with two public subnets. To provide internet access to WorkSpaces in public subnets, conﬁgure the directory to assign Elastic IP addresses automatically or manually assign an Elastic IP address to each WorkSpace. Tasks VPC requirements 55 Amazon WorkSpaces • Step 1: Create a VPC • Step 2: Assign public IP addresses to your WorkSpaces Step 1: Create a VPC Create a VPC with one public subnet as follows. To create the VPC Administration Guide 1. Open the Amazon VPC console at https://console.aws.amazon.com/vpc/. 2. Choose Create VPC. 3. Under Resources to create, choose VPC and more. 4. 5. For Name tag auto-generation, enter a name for the VPC. To conﬁgure the subnets, do the following: a. b. c. d. e. For Number of Availability Zones, choose 2. Expand Customize AZs and choose your Availability Zones. Otherwise, AWS selects them for you. To make an appropriate selection, see Availability Zones for WorkSpaces Personal. For Number of public subnets, choose 2. For Number of private subnets, choose 0. Enter a CIDR block for each public subnet. For more information, see Subnet sizing in the Amazon VPC User Guide. 6. Choose Create VPC. IPv6 CIDR blocks You can associate an IPv6 CIDR block with your VPC and subnets. However, if you conﬁgure your subnets to automatically assign IPv6 addresses to instances launched in the subnet, then you cannot use Graphics bundles. (You can use GraphicsPro bundles, however.) This restriction arises from a hardware limitation of previous-generation instance types that do not support IPv6. To work around this issue, you can temporarily disable the auto-assign IPv6 addresses setting on the WorkSpaces subnets before launching Graphics bundles, and then reenable this setting (if needed) after launching Graphics bundles so that any other bundles receive the desired IP addresses. VPC requirements 56 Amazon WorkSpaces Administration Guide By default, the auto-assign IPv6 addresses setting is disabled. To check this setting from the Amazon VPC console, in the navigation pane, choose Subnets. Select the subnet, and choose Actions, Modify auto-assign IP settings. Step 2: Assign public IP addresses to your WorkSpaces You can assign public IP addresses to your WorkSpaces automatically or manually. To use automatic assignment, see the section called “Conﬁgure automatic public IP addresses”. To assign public IP addresses manually, use the following procedure. To assign a public IP address to a WorkSpace manually 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose WorkSpaces. Expand the row (choose the arrow icon) for the WorkSpace and note the value of WorkSpace IP. This is the primary private IP address of the WorkSpace. 4. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 5. 6. 7. In the navigation pane, choose Elastic IPs. If you do not have an available Elastic IP address, choose Allocate Elastic IP address and choose Amazon's pool of IPv4 addresses or Customer owned pool of IPv4 addresses, and then choose Allocate. Make note of the new IP address. In the navigation pane, choose Network Interfaces. Select the network interface for your WorkSpace. To ﬁnd the network interface for your WorkSpace, enter the WorkSpace IP value (which you noted earlier) in the search box, and then press Enter. The WorkSpace IP value matches the primary private IPv4 address for the network interface. Note that the VPC ID of the network interface matches the ID of your WorkSpaces VPC. 8. Choose Actions, Manage IP Addresses. Choose Assign new IP, and then choose Yes, Update. Make note of the new IP address. 9. Choose Actions, Associate Address. 10. On the Associate Elastic IP Address page, choose an Elastic IP address from Address. For Associate to private IP address, specify the new private IP address, and then choose Associate Address. VPC requirements 57 Amazon WorkSpaces Administration Guide Conﬁgure AWS Global Accelerator (AGA) for WorkSpaces Personal You can enable AWS Global Accelerator (AGA) either at the WorkSpaces directory level or for individual WorkSpaces running DCV protocol. When enabled, the service automatically routes the streaming traﬃc through the nearest AWS edge location and across the AWS global network, which is congestion-free and redundant. This helps deliver a more responsive and stable streaming experience. The WorkSpaces service fully manages AGA usage and is subject to outbound data volume limits. Contents • Requirements • Limitations • Outbound data limits • Enable AGA for a WorkSpaces directory • Enable AGA for individual WorkSpaces Requirements • WorkSpaces use a range of public IPv4 addresses for the dedicated AWS Global
workspaces-ag-024	workspaces-ag.pdf	24	at the WorkSpaces directory level or for individual WorkSpaces running DCV protocol. When enabled, the service automatically routes the streaming traﬃc through the nearest AWS edge location and across the AWS global network, which is congestion-free and redundant. This helps deliver a more responsive and stable streaming experience. The WorkSpaces service fully manages AGA usage and is subject to outbound data volume limits. Contents • Requirements • Limitations • Outbound data limits • Enable AGA for a WorkSpaces directory • Enable AGA for individual WorkSpaces Requirements • WorkSpaces use a range of public IPv4 addresses for the dedicated AWS Global Accelerator (AGA) endpoints. Make sure to conﬁgure your ﬁrewall policies for devices that access WorkSpaces through AGA. If the AGA endpoints are blocked by the ﬁrewall, WorkSpaces streaming traﬃc won't be routed through AGA. For more information about the AGA endpoint IP ranges in each AWS region, see DCV gateway servers. • To access WorkSpaces through AGA, users must use WorkSpaces client versions 5.23 or later. Limitations • You can enable AGA for DCV WorkSpaces only. If you enable AGA at WorkSpaces directory level, it will only apply to the DCV WorkSpaces in the directory. • You can't enable AGA for a directory (or the WorkSpaces in the directory) that has both FIPS and IP access control groups enabled. You must disable FIPS or IP access control groups before enabling AGA for the directory. AWS Global Accelerator (AGA) 58 Amazon WorkSpaces Outbound data limits Administration Guide The following are applicable data volume limits for WorkSpaces bundles. • Value, Standard, and Performance bundles: Includes 20 GB of AGA outbound data per user per month. • Power, PowerPro, and Graphics bundles: Includes 50 GB of AGA outbound data per user per month. These outbound data limits are intended to cover the data usage of users streaming from their WorkSpaces. Beyond the limits, the WorkSpaces service might restrict AGA usage and route WorkSpaces traﬃc oﬀ of AGA on a case-by-case basis. Enable AGA for a WorkSpaces directory You can conﬁgure AGA settings on a directory level. The settings will apply to all the DCV WorkSpaces in the directory unless overridden by the individual WorkSpaces. To enable AGA for a directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Under the Directory ID column, choose the directory ID of the directory you want to conﬁgure AGA settings for. 4. On the Directory Details page, scroll down to the AWS Global Accelerator (AGA) conﬁguration section and choose Edit. 5. Choose Enable AGA (automatic). 6. Always use TCP with AGA is selected by default. If you unselect it, your WorkSpaces client will determine whether TCP or UDP is used with AGA based on the DCV streaming protocol settings on your clients. 7. Choose Save. After you enable AGA for a WorkSpaces directory, DCV WorkSpaces in the directory use AGA for streaming starting from the next session. No reboot is needed. AWS Global Accelerator (AGA) 59 Amazon WorkSpaces Administration Guide Enable AGA for individual WorkSpaces You can conﬁgure AGA settings for individual WorkSpaces, which overrides the settings inherited from the directory that the WorkSpaces are associated with. To enable AGA for individual WorkSpaces 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose WorkSpaces, Personal. 3. Under the WorkSpace ID column, choose the WorkSpace ID of the WorkSpace you want to conﬁgure AGA settings for. 4. On the WorkSpaces Details page, scroll down to the AWS Global Accelerator (AGA) conﬁguration section and choose Edit. 5. Choose Manually override AGA conﬁgurations for this WorkSpace. 6. Choose Enable AGA (automatic). 7. Always use TCP with AGA is selected by default. If you unselect it, your WorkSpaces client will determine whether TCP or UDP is used with AGA based on the DCV streaming protocol settings on your clients. 8. Choose Save. Availability Zones for WorkSpaces Personal When you are creating a virtual private cloud (VPC) for use with Amazon WorkSpaces, your VPC's subnets must reside in diﬀerent Availability Zones in the Region where you're launching WorkSpaces. Availability Zones are distinct locations that are engineered to be isolated from failures in other Availability Zones. By launching instances in separate Availability Zones, you can protect your applications from the failure of a single location. Each subnet must reside entirely within one Availability Zone and cannot span zones. An Availability Zone is represented by a Region code followed by a letter identiﬁer; for example, us-east-1a. To ensure that resources are distributed across the Availability Zones for a Region, we independently map Availability Zones to names for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not be the same location as us- east-1a for another AWS account. Availability Zones for WorkSpaces 60 Amazon WorkSpaces Administration Guide To coordinate
workspaces-ag-025	workspaces-ag.pdf	25	you can protect your applications from the failure of a single location. Each subnet must reside entirely within one Availability Zone and cannot span zones. An Availability Zone is represented by a Region code followed by a letter identiﬁer; for example, us-east-1a. To ensure that resources are distributed across the Availability Zones for a Region, we independently map Availability Zones to names for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not be the same location as us- east-1a for another AWS account. Availability Zones for WorkSpaces 60 Amazon WorkSpaces Administration Guide To coordinate Availability Zones across accounts, you must use the AZ ID, which is a unique and consistent identiﬁer for an Availability Zone. For example, use1-az2 is an AZ ID for the us- east-1 Region and it has the same location in every AWS account. Viewing AZ IDs enables you to determine the location of resources in one account relative to the resources in another account. For example, if you share a subnet in the Availability Zone with the AZ ID use1-az2 with another account, this subnet is available to that account in the Availability Zone whose AZ ID is also use1-az2. The AZ ID for each VPC and subnet is displayed in the Amazon VPC console. Amazon WorkSpaces is only available in a subset of the Availability Zones for each supported Region. The following table lists the AZ IDs that you can use for each Region. To see the mapping of AZ IDs to Availability Zones in your account, see AZ IDs for Your Resources in the AWS RAM User Guide. Region name Region code Supported AZ IDs US East (N. Virginia) us-east-1 use1-az2, use1-az4, use1- az6 US West (Oregon) us-west-2 usw2-az1, usw2-az2, usw2- az3 Asia Paciﬁc (Mumbai) ap-south-1 aps1-az1, aps1-az2, aps1- az3 Asia Paciﬁc (Seoul) ap-northeast-2 apne2-az1 , apne2-az3 Asia Paciﬁc (Singapore) ap-southeast-1 apse1-az1 , apse1-az2 Asia Paciﬁc (Sydney) ap-southeast-2 apse2-az1 , apse2-az3 Asia Paciﬁc (Tokyo) ap-northeast-1 apne1-az1 , apne1-az4 Canada (Central) ca-central-1 cac1-az1, cac1-az2 Europe (Frankfurt) eu-central-1 euc1-az2, euc1-az3 Europe (Ireland) eu-west-1 euw1-az1, euw1-az2, euw1- az3 Availability Zones for WorkSpaces 61 Amazon WorkSpaces Administration Guide Region name Region code Supported AZ IDs Europe (London) eu-west-2 euw2-az2, euw2-az3 Europe (Paris) eu-west-3 euw3-az1, euw3-az2, euw3- az3 South America (São Paulo) sa-east-1 sae1-az1, sae1-az3 Africa (Cape Town) af-south-1 afs1-az1, afs1-az2, afs1- az3 Israel (Tel Aviv) il-central-1 ilc1-az1, ilc1-az2, ilc1- az3 AWS GovCloud (US-West) us-gov-west-1 usgw1-az1 , usgw1-az2 , usgw1-az3 AWS GovCloud (US-East) us-gov-east-1 usge1-az1 , usge1-az2 , usge1-az3 For more information about Availability Zones and AZ IDs, see Regions, Availability Zones, and Local Zones in the Amazon EC2 User Guide. IP address and port requirements for WorkSpaces Personal To connect to your WorkSpaces, the network that your WorkSpaces clients are connected to must have certain ports open to the IP address ranges for the various AWS services (grouped in subsets). These address ranges vary by AWS Region. These same ports must also be open on any ﬁrewall running on the client. For more information about the AWS IP address ranges for diﬀerent Regions, see AWS IP Address Ranges in the Amazon Web Services General Reference. For additional architecture diagrams, see Best Practices for Deploying Amazon WorkSpaces. Ports for client applications The WorkSpaces client application requires outbound access on the following ports: IP address and port requirements 62 Amazon WorkSpaces Port 53 (UDP) Administration Guide This port is used to access DNS servers. It must be open to your DNS server IP addresses so that the client can resolve public domain names. This port requirement is optional if you are not using DNS servers for domain name resolution. Port 443 (UDP and TCP) This port is used for client application updates, registration, and authentication. The desktop client applications support the use of a proxy server for port 443 (HTTPS) traﬃc. To enable the use of a proxy server, open the client application, choose Advanced Settings, select Use Proxy Server, specify the address and port of the proxy server, and choose Save. This port must be open to the following IP address ranges: • The AMAZON subset in the GLOBAL Region. • The AMAZON subset in the Region that the WorkSpace is in. • The AMAZON subset in the us-east-1 Region. • The AMAZON subset in the us-west-2 Region. • The S3 subset in the us-west-2 Region. Port 4172 (UDP and TCP) This port is used for streaming the WorkSpace desktop and health checks for PCoIP WorkSpaces. This port must be open to the PCoIP Gateway and to the health check servers in the Region that the WorkSpace is in. For more information, see Health check servers and PCoIP gateway servers. For PCoIP WorkSpaces, the desktop client applications do not support the use of a proxy server nor TLS decryption and inspection for port
workspaces-ag-026	workspaces-ag.pdf	26	The AMAZON subset in the us-east-1 Region. • The AMAZON subset in the us-west-2 Region. • The S3 subset in the us-west-2 Region. Port 4172 (UDP and TCP) This port is used for streaming the WorkSpace desktop and health checks for PCoIP WorkSpaces. This port must be open to the PCoIP Gateway and to the health check servers in the Region that the WorkSpace is in. For more information, see Health check servers and PCoIP gateway servers. For PCoIP WorkSpaces, the desktop client applications do not support the use of a proxy server nor TLS decryption and inspection for port 4172 traﬃc in UDP (for desktop traﬃc). They require a direct connection to ports 4172. Port 4195 (UDP and TCP) This port is used for streaming the WorkSpace desktop and health checks for DCV WorkSpaces. This port must be open to the DCV Gateway IP address ranges and the health check servers in the Region that the WorkSpace is in. For more information, see Health check servers and DCV gateway servers. 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 IP address and port requirements 63 Amazon WorkSpaces Administration Guide 4195 TCP traﬃc, but the use of a proxy is not recommended. TLS decryption and inspection are not supported. For more information, see Conﬁgure device proxy server settings for internet access for Windows WorkSpaces, Amazon Linux WorkSpaces, and Ubuntu WorkSpaces. Note • If your ﬁrewall uses stateful ﬁltering, ephemeral ports (also known as dynamic ports) are automatically opened to allow return communication. If your ﬁrewall uses stateless ﬁltering, you must open ephemeral ports explicitly to allow return communication. The required ephemeral port range that you must open will vary depending on your conﬁguration. • Proxy server function is not supported for UDP traﬃc. If you choose to use a proxy server, the API calls that the client application makes to the Amazon WorkSpaces services are also proxied. Both API calls and desktop traﬃc should pass through the same proxy server. • The WorkSpaces client application ﬁrst attempts to stream using UDP (QUIC) for optimal performance. If the client network only allows TCP, then TCP will be used. The WorkSpaces web client will connect over TCP port 4195 or 443. If port 4195 is blocked, the client will only attempt to connect to over port 443. Ports for Web Access WorkSpaces Web Access requires outbound access for the following ports: Port 53 (UDP) This port is used to access DNS servers. It must be open to your DNS server IP addresses so that the client can resolve public domain names. This port requirement is optional if you are not using DNS servers for domain name resolution. Port 80 (UDP and TCP) This port is used for initial connections to https://clients.amazonworkspaces.com, which then switch to HTTPS. It must be open to all IP address ranges in the EC2 subset in the Region that the WorkSpace is in. IP address and port requirements 64 Amazon WorkSpaces Port 443 (UDP and TCP) Administration Guide This port is used for registration and authentication using HTTPS. It must be open to all IP address ranges in the EC2 subset in the Region that the WorkSpace is in. Port 4195 (UDP and TCP) For WorkSpaces that are conﬁgured for DCV, this port is used for streaming the WorkSpaces desktop traﬃc. This port must be open to the DCV Gateway IP address ranges. For more information, see DCV gateway servers. DCV web access supports the use of a proxy server for port 4195 TCP traﬃc, but it’s not recommended. For more information, see Conﬁgure device proxy server settings for internet access for Windows WorkSpaces, Amazon Linux WorkSpaces, or Ubuntu WorkSpaces. Note • If your ﬁrewall uses stateful ﬁltering, ephemeral ports (also known as dynamic ports) are automatically opened to allow return communication. If your ﬁrewall uses stateless ﬁltering, you must open ephemeral ports explicitly to allow return communication. The required ephemeral port range that you must open varies depending on your conﬁguration. • The WorkSpaces client application ﬁrst attempts to stream using UDP (QUIC) for optimal performance. If the client network only allows TCP, then TCP will be used. The WorkSpaces web client will connect over TCP port 4195 or 443. If port 4195 is blocked, the client will only attempt to connect to over port 443. Typically, the web browser randomly selects a source port in the high range to use for streaming traﬃc. WorkSpaces Web Access does not have control over the port that the browser selects. You must ensure that return traﬃc to this port is allowed. Domains and IP addresses to add to your allow list For the WorkSpaces client application to be able
workspaces-ag-027	workspaces-ag.pdf	27	the client network only allows TCP, then TCP will be used. The WorkSpaces web client will connect over TCP port 4195 or 443. If port 4195 is blocked, the client will only attempt to connect to over port 443. Typically, the web browser randomly selects a source port in the high range to use for streaming traﬃc. WorkSpaces Web Access does not have control over the port that the browser selects. You must ensure that return traﬃc to this port is allowed. Domains and IP addresses to add to your allow list For the WorkSpaces client application to be able to access the WorkSpaces service, you must add the following domains and IP addresses to the allow list on the network from which the client is trying to access the service. IP address and port requirements 65 Amazon WorkSpaces Administration Guide Domains and IP addresses to add to your allow list Category CAPTCHA Domain or IP address https://opfcaptcha-prod.s3.amazonaws.com/ Client Auto-update • https://d2td7dqidlhjx7.cloudfront.net/ • In the AWS GovCloud (US-West) Region: https://d2td7dqidlhjx7.cloudfront.net/ prod/pdt/windows/WorkSpacesAppCast x64.xml Connectivity Check https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domains (IPv4): • https://skylight-client-ds.us-east-1 .amazonaws.com • https://skylight-client-ds.us-west-2 .amazonaws.com • https://skylight-client-ds.ap-south- 1.amazonaws.com • https://skylight-client-ds.ap-northe ast-2.amazonaws.com • https://skylight-client-ds.ap-southe ast-1.amazonaws.com • https://skylight-client-ds.ap-southe ast-2.amazonaws.com • https://skylight-client-ds.ap-northe ast-1.amazonaws.com • https://skylight-client-ds.ca-centra l-1.amazonaws.com • https://skylight-client-ds.eu-centra l-1.amazonaws.com • https://skylight-client-ds.eu-west-1 .amazonaws.com IP address and port requirements 66 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://skylight-client-ds.eu-west-2 .amazonaws.com • https://skylight-client-ds.eu-west-3 .amazonaws.com • https://skylight-client-ds.sa-east-1 .amazonaws.com • https://skylight-client-ds.af-south- 1.amazonaws.com • https://skylight-client-ds.il-central-1.amazo naws.com • In the AWS GovCloud (US-West) Region: https://skylight-client-ds.us-gov-we st-1.amazonaws.com • In the AWS GovCloud (US-East) Region: https://skylight-client-ds.us-gov-ea st-1.amazonaws.com • In the AWS GovCloud (US-West) Region: https://skylight-client-ds.us-gov-we st-1.amazonaws.com • In the AWS GovCloud (US-East) Region: https://skylight-client-ds.us-gov-ea st-1.amazonaws.com Domains (IPv6): • https://skylight-client-ds.eu-west-2.api.aws • https://skylight-client-ds.eu-west-1.api.aws • https://skylight-client-ds.us-east-1.api.aws IP address and port requirements 67 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://skylight-client-ds.ap-southeast-1.api .aws • https://skylight-client-ds.sa-east-1.api.aws • https://skylight-client-ds.ap-northeast-1.api .aws • https://skylight-client-ds.us-west-2.api.aws • https://skylight-client-ds.ap-southeast-2.api .aws • https://skylight-client-ds.ap-south- 1.api.aws • https://skylight-client-ds.af-south-1.api.aws • https://skylight-client-ds.eu-central-1.api.a ws • https://skylight-client-ds.ap-northeast-2.api .aws • https://skylight-client-ds.il-central-1.api.a ws • https://skylight-client-ds.ca-central-1.api.a ws • https://skylight-client-ds.us-gov-east-1.api. aws • https://skylight-client-ds.us-gov-west-1.api. aws IP address and port requirements 68 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Administration Guide Domain or IP address Domains (IPv4): • https://ws-client-service.us-east-1. amazonaws.com • https://ws-client-service.us-west-2. amazonaws.com • https://ws-client-service.ap-south-1 .amazonaws.com • https://ws-client-service.ap-northea st-2.amazonaws.com • https://ws-client-service.ap-southea st-1.amazonaws.com • https://ws-client-service.ap-southea st-2.amazonaws.com • https://ws-client-service.ap-northea st-1.amazonaws.com • https://ws-client-service.ca-central -1.amazonaws.com • https://ws-client-service.eu-central -1.amazonaws.com • https://ws-client-service.eu-west-1. amazonaws.com • https://ws-client-service.eu-west-2. amazonaws.com • https://ws-client-service.eu-west-3. amazonaws.com • https://ws-client-service.sa-east-1. amazonaws.com • https://ws-client-service.af-south-1 .amazonaws.com • https://ws-client-service.il-central -1.amazonaws.com IP address and port requirements 69 Amazon WorkSpaces Category Administration Guide Domain or IP address • In the AWS GovCloud (US-West) Region: https://ws-client-service.us-gov-wes t-1.amazonaws.com • In the AWS GovCloud (US-East) Region: https://ws-client-service.us-gov-eas t-1.amazonaws.com Domains (IPv6): • https://ws-client-service.eu-west-2.api.aws • https://ws-client-service.eu-west-1.api.aws • https://ws-client-service.us-east-1. amazonaws.com • https://ws-client-service.ap-southeast-1.api. aws • https://ws-client-service.sa-east-1.api.aws • https://ws-client-service.ap-northeast-1.api. aws • https://ws-client-service.us-west-2.api.aws • https://ws-client-service.ap-southeast-2.api. aws • https://ws-client-service.ap-south-1.api.aws • https://ws-client-service.af-south-1.api.aws • https://ws-client-service.eu-central-1.api.aw s • https://ws-client-service.ap-northeast-2.api. aws • https://ws-client-service.il-central-1.api.aws • https://ws-client-service.ca-central-1.api.aw s IP address and port requirements 70 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://ws-client-service.us-gov-east-1.api.a ws • https://ws-client-service.us-gov-wes t-1.api.aws IP address and port requirements 71 Amazon WorkSpaces Category Directory Settings Administration Guide Domain or IP address Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • Legacy — https://d1cbg795sa4g1u.clou dfront.net/prod/<region>/<directory ID> • US East (N. Virginia) — https://d2h1yryv1j xiq.cloudfront.net/ • US West (Oregon) — https://d1fq42e1gi 7rtq.cloudfront.net/ • Asia Paciﬁc (Mumbai) — https://d1ctsk4u02 kky7.cloudfront.net/ • Asia Paciﬁc (Seoul) — https://dyoj3cw6ik tvg.cloudfront.net • Asia Paciﬁc (Singapore) — https://d 1525ef92caquk.cloudfront.net/ • Asia Paciﬁc (Sydney) — https://dodwxjr2am r8p.cloudfront.net/ IP address and port requirements 72 Amazon WorkSpaces Category Administration Guide Domain or IP address • Asia Paciﬁc (Tokyo) — https://d3v7kcib8i r2e1.cloudfront.net/ • Canada (Central) — https://d1ebdk07rr o1qy.cloudfront.net/ • Europe (Frankfurt) — https://d39q4y7cnd earu.cloudfront.net/ • Europe (Ireland) — https://d2127w6wvr c6l3.cloudfront.net/ • Europe (London) — https://df4ahgpxbx qy2.cloudfront.net/ • Europe (Paris) — https://d2kmf63k5s it88.cloudfront.net/ • South America (São Paulo) — https://d 2nezqurrjvain.cloudfront.net/ • Africa (Cape Town) — https://dr6ry0pwao y23.cloudfront.net • Israel (Tel Aviv) — https://d2kmf63k5s it88.cloudfront.net CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • US East (N. Virginia) — https://d32i4gd7pg 4909.cloudfront.net/ • US West (Oregon) — https://d18af777lc o7lp.cloudfront.net/ • Asia Paciﬁc (Mumbai) — https://d 78hovzzqqtsb.cloudfront.net/ IP address and port requirements 73 Amazon WorkSpaces Category Administration Guide Domain or IP address • Asia Paciﬁc (Seoul) — https://dtyv4uwoh7 ynt.cloudfront.net/ • Asia Paciﬁc (Singapore) — https://d 3qzmd7y07pz0i.cloudfront.net/ • Asia Paciﬁc (Sydney) — https://dwcpoxuuza 83q.cloudfront.net/ • Asia Paciﬁc (Tokyo) — https://d2c2t8mxjh q5z1.cloudfront.net/ • Canada (Central) — https://d2wfbsypmq jmog.cloudfront.net/ • Europe (Frankfurt) — https://d1whcm4957 0jjw.cloudfront.net/ • Europe (Ireland) — https://d3pgﬀbf39 h4k4.cloudfront.net/ • Europe (London) — https://d16q6638mh 01s7.cloudfront.net/ • Europe (Paris) — https://d1a3pnge9o n3sx.cloudfront.net/ • South America (São Paulo) — https://d 2lh2qc5bdoq4b.cloudfront.net/ • Africa
workspaces-ag-028	workspaces-ag.pdf	28	— https://d32i4gd7pg 4909.cloudfront.net/ • US West (Oregon) — https://d18af777lc o7lp.cloudfront.net/ • Asia Paciﬁc (Mumbai) — https://d 78hovzzqqtsb.cloudfront.net/ IP address and port requirements 73 Amazon WorkSpaces Category Administration Guide Domain or IP address • Asia Paciﬁc (Seoul) — https://dtyv4uwoh7 ynt.cloudfront.net/ • Asia Paciﬁc (Singapore) — https://d 3qzmd7y07pz0i.cloudfront.net/ • Asia Paciﬁc (Sydney) — https://dwcpoxuuza 83q.cloudfront.net/ • Asia Paciﬁc (Tokyo) — https://d2c2t8mxjh q5z1.cloudfront.net/ • Canada (Central) — https://d2wfbsypmq jmog.cloudfront.net/ • Europe (Frankfurt) — https://d1whcm4957 0jjw.cloudfront.net/ • Europe (Ireland) — https://d3pgﬀbf39 h4k4.cloudfront.net/ • Europe (London) — https://d16q6638mh 01s7.cloudfront.net/ • Europe (Paris) — https://d1a3pnge9o n3sx.cloudfront.net/ • South America (São Paulo) — https://d 2lh2qc5bdoq4b.cloudfront.net/ • Africa (Cape Town) — https://di5ygl2cs0 mrh.cloudfront.net/ • Israel (Tel Aviv) — https://d1a3pnge9o n3sx.cloudfront.net In the AWS GovCloud (US-West) Region: • Customer directory settings: https://s3.amazonaws.com/workspaces- client-properties/prod/pdt/<directory ID> • Login page graphics for customer directory level co-branding: IP address and port requirements 74 Amazon WorkSpaces Category Administration Guide Domain or IP address https://workspace-client-assets-pdt.s3-us- gov-west-1.amazonaws.com • CSS ﬁle to style the login pages: https://s3.amazonaws.com/workspaces- clients-css/workspaces_v2.css • JavaScript ﬁle for the login pages: Not applicable In the AWS GovCloud (US-East) Region: • Customer directory settings: https://s3.amazonaws.com/workspaces- client-properties/prod/osu/<directory ID> • Login page graphics for customer directory level co-branding: https://workspace-client-assets-pdt.s3-us- gov-east-1.amazonaws.com • CSS ﬁle to style the login pages: https://s3.amazonaws.com/workspaces- clients-css/workspaces_v2.css • JavaScript ﬁle for the login pages: Not applicable Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers IP address and port requirements 75 Amazon WorkSpaces Category Pre-session Smart Card Authentication Endpoints User Login Pages Administration Guide Domain or IP address • https://smartcard.us-east-1.signin.aws • https://smartcard.us-west-2.signin.aws • https://smartcard.ap-southeast-2.sig nin.aws • https://smartcard.ap-northeast-1.signin.aws • https://smartcard.eu-west-1.signin.aws • https://smartcard.signin.amazonaws-us- gov.com https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) In the AWS GovCloud (US-West) and AWS GovCloud (US-East) Regions: https://login.us-gov-home.awsapps.com/ directory/<directory id>/ (where <directory id> is the customer's domain) IP address and port requirements 76 Amazon WorkSpaces Category WS Broker Administration Guide Domain or IP address Domains (IPv4): • https://ws-broker-service.us-east-1. amazonaws.com • https://ws-broker-service-fips.us-ea st-1.amazonaws.com • https://ws-broker-service.us-west-2. amazonaws.com • https://ws-broker-service-fips.us-we st-2.amazonaws.com • https://ws-broker-service.ap-south-1 .amazonaws.com • https://ws-broker-service.ap-northea st-2.amazonaws.com • https://ws-broker-service.ap-southea st-1.amazonaws.com • https://ws-broker-service.ap-southea st-2.amazonaws.com • https://ws-broker-service.ap-northea st-1.amazonaws.com • https://ws-broker-service.ca-central -1.amazonaws.com • https://ws-broker-service.eu-central -1.amazonaws.com • https://ws-broker-service.eu-west-1. amazonaws.com • https://ws-broker-service.eu-west-2. amazonaws.com • https://ws-broker-service.eu-west-3. amazonaws.com • https://ws-broker-service.sa-east-1. amazonaws.com IP address and port requirements 77 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://ws-broker-service.af-south-1 .amazonaws.com • https://ws-broker-service.il-central -1.amazonaws.com • https://ws-broker-service.us-gov-wes t-1.amazonaws.com • https://ws-broker-service-fips.us-gov- west-1.amazonaws.com • https://ws-broker-service.us-gov-eas t-1.amazonaws.com • https://ws-broker-service-fips.us-gov- east-1.amazonaws.com Domains (IPv6): • https://ws-broker-service.eu-west-3.api.aws • https://ws-broker-service.eu-west-2.api.aws • https://ws-broker-service.eu-west-1.api.aws • https://ws-broker-service.us-east-1.api.aws • https://ws-broker-service.us-west-2.api.aws • https://ws-broker-service.eu-central -1.api.aws • https://ws-broker-service.ap-northea st-1.api.aws • https://ws-broker-service.ap-northea st-2.api.aws • https://ws-broker-service.ap-southea st-1.api.aws • https://ws-broker-service.ap-southea st-2.api.aws • https://ws-broker-service.sa-east-1.api.aws IP address and port requirements 78 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://ws-broker-service.ap-south-1 .api.aws • https://ws-broker-service.af-south-1 .api.aws • https://ws-broker-service.ca-central -1.api.aws • https://ws-broker-service.il-central-1.api.aw s • https://ws-broker-service.us-gov-wes t-1.api.aws • https://ws-broker-service.us-gov-eas t-1.api.aws • https://ws-broker-service-fips.us-we st-2.api.aws • https://ws-broker-service-fips.us-east-1.api. aws • https://ws-broker-service-fips.us-gov- west-1.api.aws • https://ws-broker-service-fips.us-gov- east-1.api.aws IP address and port requirements 79 Amazon WorkSpaces Category Domain or IP address Administration Guide WorkSpaces API Endpoints Domains (IPv4): • https://workspaces.us-east-1.amazona ws.com • https://workspaces-ﬁps.us-east-1.am azonaws.com • https://workspaces.us-west-2.amazona ws.com • https://workspaces-ﬁps.us-west-2.am azonaws.com • https://workspaces.ap-south-1.amazon aws.com • https://workspaces.ap-northeast-2.am azonaws.com • https://workspaces.ap-southeast-1.am azonaws.com • https://workspaces.ap-southeast-2.am azonaws.com • https://workspaces.ap-northeast-1.am azonaws.com • https://workspaces.ca-central-1.amaz onaws.com • https://workspaces.eu-central-1.amaz onaws.com • https://workspaces.eu-west-1.amazona ws.com • https://workspaces.eu-west-2.amazona ws.com • https://workspaces.eu-west-3.amazona ws.com • https://workspaces.sa-east-1.amazona ws.com IP address and port requirements 80 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://workspaces.af-south-1.amazon aws.com • https://workspaces.il-central-1.amaz onaws.com • https://workspaces.us-gov-west-1.ama zonaws.com • https://workspaces-ﬁps.us-gov-west- 1.amazonaws.com • https://workspaces.us-gov-east-1.ama zonaws.com • https://workspaces-ﬁps.us-gov-east- 1.amazonaws.com Domains (IPv6): • https://workspaces.eu-west-3.api.aws • https://workspaces.eu-west-2.api.aws • https://workspaces.eu-west-1.api.aws • https://workspaces.us-east-1.api.aws • https://workspaces.us-west-2.api.aws • https://workspaces.eu-central-1.api.aws • https://workspaces.ap-northeast-1.api.aws • https://workspaces.ap-northeast-2.api.aws • https://workspaces.ap-southeast-1.api.aws • https://workspaces.ap-southeast-2.api.aws • https://workspaces.sa-east-1.api.aws • https://workspaces.ap-south-1.api.aws • https://workspaces.af-south-1.api.aws • https://workspaces.ca-central-1.api.aws • https://workspaces.il-central-1.api.aws • https://workspaces.us-gov-west-1.api.aws IP address and port requirements 81 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://workspaces.us-gov-east-1.api.aws • https://workspaces-ﬁps.us-west-2.api.aws • https://workspaces-ﬁps.us-east-1.api.aws • https://workspaces-ﬁps.us-gov-west- 1.api.aws • https://workspaces-ﬁps.us-gov-east- 1.api.aws IP address and port requirements 82 Amazon WorkSpaces Category Domain or IP address Administration Guide WorkSpaces Endpoints for SAML Single Sign- On (SSO) Domains: • https://euc-sso-sm.us-east-1.amazona ws.com/v1/report-heartbeat • https://euc-sso-sm-ﬁps.us-east-1.am azonaws.com/v1/report-heartbeat • https://euc-sso-sm.us-west-2.amazona ws.com/v1/report-heartbeat • https://euc-sso-sm-ﬁps.us-west-2.am azonaws.com/v1/report-heartbeat • https://euc-sso-sm.ap-south-1.amazon aws.com/v1/report-heartbeat • https://euc-sso-sm.ap-northeast-2.am azonaws.com/v1/report-heartbeat • https://euc-sso-sm.ap-southeast-1.am azonaws.com/v1/report-heartbeat • https://euc-sso-sm.ap-southeast-2.am azonaws.com/v1/report-heartbeat • https://euc-sso-sm.ap-northeast-1.am azonaws.com/v1/report-heartbeat • https://euc-sso-sm.eu-central-1.amaz onaws.com/v1/report-heartbeat • https://euc-sso-sm.eu-west-2.amazona ws.com/v1/report-heartbeat • https://euc-sso-sm.eu-west-3.amazona ws.com/v1/report-heartbeat • https://euc-sso-sm.af-south-1.amazon aws.com/v1/report-heartbeat • https://euc-sso-sm.il-central-1.amaz onaws.com/v1/report-heartbeat • https://euc-sso-sm.us-gov-west-1.ama zonaws.com/v1/report-heartbeat IP address and port requirements 83 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://euc-sso-sm-ﬁps.us-gov-west- 1.amazonaws.com/v1/report-heartbeat • https://euc-sso-sm.us-gov-east-1.ama zonaws.com/v1/report-heartbeat • https://euc-sso-sm-ﬁps.us-gov-east- 1.amazonaws.com/v1/report-heartbeat Domains and IP addresses to add to your allow list for PCoIP Category Domain or IP address PCoIP Session Gateway (PSG) PCoIP gateway servers Session Broker (PCM) Domains (IPv4): • https://skylight-cm.us-east-1.amazon aws.com • https://skylight-cm-ﬁps.us-east-1.a mazonaws.com • https://skylight-cm.us-west-2.amazon aws.com • https://skylight-cm-ﬁps.us-west-2.a mazonaws.com • https://skylight-cm.ap-south-1.amazo naws.com • https://skylight-cm.ap-northeast-2.a mazonaws.com • https://skylight-cm.ap-southeast-1.a mazonaws.com • https://skylight-cm.ap-southeast-2.a mazonaws.com • https://skylight-cm.ap-northeast-1.a mazonaws.com IP address and port requirements 84 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://skylight-cm.ca-central-1.ama zonaws.com • https://skylight-cm.eu-central-1.ama zonaws.com • https://skylight-cm.eu-west-1.amazon aws.com • https://skylight-cm.eu-west-2.amazon aws.com • https://skylight-cm.eu-west-3.amazon aws.com •
workspaces-ag-029	workspaces-ag.pdf	29	Domain or IP address • https://euc-sso-sm-ﬁps.us-gov-west- 1.amazonaws.com/v1/report-heartbeat • https://euc-sso-sm.us-gov-east-1.ama zonaws.com/v1/report-heartbeat • https://euc-sso-sm-ﬁps.us-gov-east- 1.amazonaws.com/v1/report-heartbeat Domains and IP addresses to add to your allow list for PCoIP Category Domain or IP address PCoIP Session Gateway (PSG) PCoIP gateway servers Session Broker (PCM) Domains (IPv4): • https://skylight-cm.us-east-1.amazon aws.com • https://skylight-cm-ﬁps.us-east-1.a mazonaws.com • https://skylight-cm.us-west-2.amazon aws.com • https://skylight-cm-ﬁps.us-west-2.a mazonaws.com • https://skylight-cm.ap-south-1.amazo naws.com • https://skylight-cm.ap-northeast-2.a mazonaws.com • https://skylight-cm.ap-southeast-1.a mazonaws.com • https://skylight-cm.ap-southeast-2.a mazonaws.com • https://skylight-cm.ap-northeast-1.a mazonaws.com IP address and port requirements 84 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://skylight-cm.ca-central-1.ama zonaws.com • https://skylight-cm.eu-central-1.ama zonaws.com • https://skylight-cm.eu-west-1.amazon aws.com • https://skylight-cm.eu-west-2.amazon aws.com • https://skylight-cm.eu-west-3.amazon aws.com • https://skylight-cm.sa-east-1.amazon aws.com • https://skylight-cm.af-south-1.amazo naws.com • https://skylight-cm.il-central-1.ama zonaws.com • https://skylight-cm.us-gov-west-1.am azonaws.com • https://skylight-cm-ﬁps.us-gov-west -1.amazonaws.com • https://skylight-cm.us-gov-east-1.am azonaws.com • https://skylight-cm-ﬁps.us-gov-east -1.amazonaws.com Domains (IPv6): • https://skylight-cm.us-east-1.api.aws • https://skylight-cm.us-west-2.api.aws • https://skylight-cm.eu-west-3.api.aws • https://skylight-cm.eu-west-2.api.aws • https://skylight-cm.eu-west-1.api.aws IP address and port requirements 85 Amazon WorkSpaces Category Administration Guide Domain or IP address • https://skylight-cm.eu-central-1.api.aws • https://skylight-cm.ap-northeast-1.api.aws • https://skylight-cm.ap-northeast-2.api.aws • https://skylight-cm.ap-southeast-1.api.aws • https://skylight-cm.ap-southeast-2.api.aws • https://skylight-cm.ap-south-1.api.aws • https://skylight-cm.sa-east-1.api.aws • https://skylight-cm.af-south-1.api.aws • https://skylight-cm.ca-central-1.api.aws • https://skylight-cm.il-central-1.api.aws • https://skylight-cm.us-gov-west-1.api.aws • https://skylight-cm.us-gov-east-1.api.aws • https://skylight-cm-ﬁps.us-west-2.api.aws • https://skylight-cm-ﬁps.us-east-1.api.aws • https://skylight-cm-ﬁps.us-gov-west -1.api.aws • https://skylight-cm-ﬁps.us-gov-east -1.api.aws IP address and port requirements 86 Amazon WorkSpaces Category Domain or IP address Administration Guide Web Access TURN Servers for PCoIP Servers: • turn:.us-east-1.rdn.amazonaws.com • turn:.us-west-2.rdn.amazonaws.com • Web Access isn't currently available in the Asia Paciﬁc (Mumbai) Region. • turn:.ap-northeast-2.rdn.amazonaws.com • turn:.ap-southeast-1.rdn.amazonaws.com • turn:.ap-southeast-2.rdn.amazonaws.com • turn:.ap-northeast-1.rdn.amazonaws.com • turn:.ca-central-1.rdn.amazonaws.com • turn:.eu-central-1.rdn.amazonaws.com • turn:.eu-west-1.rdn.amazonaws.com • turn:.eu-west-2.rdn.amazonaws.com • turn:*.sa-east-1.rdn.amazonaws.com • Web Access isn't currently available in the Africa (Cape Town) Region • Web Access isn't currently available in the Israel (Tel Aviv) Region. Domains and IP addresses to add to your allow list for DCV Category Domain or IP address DCV Session Gateway (WSG) DCV gateway servers Web Access TURN Servers for DCV DCV gateway servers Health check servers The WorkSpaces client applications perform health checks over ports 4172 and 4195. These checks validate whether TCP or UDP traﬃc streams from the WorkSpaces servers to the client IP address and port requirements 87 Amazon WorkSpaces Administration Guide applications. For these checks to ﬁnish successfully, your ﬁrewall policies must allow outbound traﬃc to the IP addresses of the following Regional health check servers. Region Health check hostname IP addresses US East (N. Virginia) drp-iad.amazonworkspaces.co m 3.209.215.252 3.212.50.30 3.225.55.35 3.226.24.234 34.200.29.95 52.200.219.150 34.217.248.177 52.34.160.80 54.68.150.54 54.185.4.125 54.188.171.18 54.244.158.140 13.127.57.82 13.234.250.73 13.124.44.166 13.124.203.105 52.78.44.253 52.79.54.102 3.0.212.144 US West (Oregon) drp-pdx.amazonwork spaces.com Asia Paciﬁc (Mumbai) drp-bom.amazonwork spaces.com Asia Paciﬁc (Seoul) drp-icn.amazonworkspaces.co m Asia Paciﬁc (Singapore) drp-sin.amazonworkspaces.co m IP address and port requirements 88 Amazon WorkSpaces Administration Guide Region Health check hostname IP addresses Asia Paciﬁc (Sydney) drp-syd.amazonwork spaces.com Asia Paciﬁc (Tokyo) drp-nrt.amazonworkspaces.co m Canada (Central) drp-yul.amazonworkspaces.co m Europe (Frankfurt) drp-fra.amazonworkspaces.co m Europe (Ireland) drp-dub.amazonwork spaces.com 18.138.99.116 18.140.252.123 52.74.175.118 3.24.11.127 13.237.232.125 18.178.102.247 54.64.174.128 52.60.69.16 52.60.80.237 52.60.173.117 52.60.201.0 52.59.191.224 52.59.191.225 52.59.191.226 52.59.191.227 18.200.177.86 52.48.86.38 54.76.137.224 IP address and port requirements 89 Amazon WorkSpaces Administration Guide Region Health check hostname IP addresses Europe (London) drp-lhr.amazonworkspaces.co m Europe (Paris) drp-cdg.amazonwork spaces.com South America (São Paulo) drp-gru.amazonwork spaces.com Africa (Cape Town) drp-cpt.amazonworkspaces.co m/ Israel (Tel Aviv) drp-tlv.amazonworkspaces.co m/ 35.176.62.54 35.177.255.44 52.56.46.102 52.56.111.36 51.17.52.90 51.17.109.231 51.16.190.43 18.231.0.105 52.67.55.29 54.233.156.245 54.233.216.234 13.244.128.155 13.245.205.255 13.245.216.116 51.17.52.90 51.17.109.231 51.16.190.43 IP address and port requirements 90 Amazon WorkSpaces Administration Guide Region Health check hostname IP addresses AWS GovCloud (US-West) drp-pdt.amazonwork spaces.com AWS GovCloud (US-East) drp-osu.amazonwork spaces.com 52.61.60.65 52.61.65.14 52.61.88.170 52.61.137.87 52.61.155.110 52.222.20.88 18.253.251.70 18.254.0.118 PCoIP gateway servers WorkSpaces uses PCoIP to stream the desktop session to clients over port 4172. For its PCoIP gateway servers, WorkSpaces uses a small range of Amazon EC2 public IPv4 and IPv6 addresses. This enables you to set more ﬁnely grained ﬁrewall policies for devices that access WorkSpaces. Note that the WorkSpaces client prioritizes IPv6 connections when IPv6 is supported and gateways are reachable. If IPv6 is unavailable, it falls back to IPv4. Region Region code Public IP address range US East (N. Virginia) us-east-1 3.217.228.0 - 3.217.231.255 3.235.112.0 - 3.235.119.255 52.23.61.0 - 52.23.62.255 2600:1f32:8000::/39 US West (Oregon) us-west-2 35.80.88.0 - 35.80.95.255 44.234.54.0 - 44.234.55.255 IP address and port requirements 91 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Asia Paciﬁc (Mumbai) ap-south-1 54.244.46.0 - 54.244.47.255 2600:1f32:4000::/39 13.126.243.0 - 13.126.24 3.255 2406:da32:a000::/40 Asia Paciﬁc (Seoul) ap-northeast-2 3.34.37.0 - 3.34.37.255 Asia Paciﬁc (Singapore) ap-southeast-1 3.34.38.0 - 3.34.39.255 13.124.247.0 - 13.124.24 7.255 2406:da32:2000::/40 18.141.152.0 - 18.141.15 2.255 18.141.154.0 - 18.141.15 5.255 52.76.127.0 - 52.76.127.255 2406:da32:8000::/40 Asia Paciﬁc (Sydney) ap-southeast-2 3.25.43.0 - 3.25.43.255 3.25.44.0 - 3.25.45.255 54.153.254.0 - 54.153.25 4.255 2406:da32:c000::/40 IP address and port requirements 92 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Asia Paciﬁc (Tokyo) ap-northeast-1 Canada (Central) ca-central-1 18.180.178.0 - 18.180.17 8.255 18.180.180.0 - 18.180.18 1.255 54.250.251.0 - 54.250.25 1.255 2406:da32:4000::/40 15.223.100.0 - 15.223.10 0.255 15.223.102.0 - 15.223.10 3.255 35.183.255.0 - 35.183.25 5.255 2600:1f32:1000::/40 Europe (Frankfurt) eu-central-1 18.156.52.0 - 18.156.52.255 18.156.54.0 - 18.156.55.255 52.59.127.0
workspaces-ag-030	workspaces-ag.pdf	30	3.34.37.255 Asia Paciﬁc (Singapore) ap-southeast-1 3.34.38.0 - 3.34.39.255 13.124.247.0 - 13.124.24 7.255 2406:da32:2000::/40 18.141.152.0 - 18.141.15 2.255 18.141.154.0 - 18.141.15 5.255 52.76.127.0 - 52.76.127.255 2406:da32:8000::/40 Asia Paciﬁc (Sydney) ap-southeast-2 3.25.43.0 - 3.25.43.255 3.25.44.0 - 3.25.45.255 54.153.254.0 - 54.153.25 4.255 2406:da32:c000::/40 IP address and port requirements 92 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Asia Paciﬁc (Tokyo) ap-northeast-1 Canada (Central) ca-central-1 18.180.178.0 - 18.180.17 8.255 18.180.180.0 - 18.180.18 1.255 54.250.251.0 - 54.250.25 1.255 2406:da32:4000::/40 15.223.100.0 - 15.223.10 0.255 15.223.102.0 - 15.223.10 3.255 35.183.255.0 - 35.183.25 5.255 2600:1f32:1000::/40 Europe (Frankfurt) eu-central-1 18.156.52.0 - 18.156.52.255 18.156.54.0 - 18.156.55.255 52.59.127.0 - 52.59.127.255 2a05:d032:4000::/40 Europe (Ireland) eu-west-1 3.249.28.0 - 3.249.29.255 52.19.124.0 - 52.19.125.255 2a05:d032:8000::/40 IP address and port requirements 93 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Europe (London) eu-west-2 18.132.21.0 - 18.132.21.255 18.132.22.0 - 18.132.23.255 35.176.32.0 - 35.176.32.255 2a05:d032:c000::/40 Europe (Paris) eu-west-3 51.44.204.0-51.44.207.255 South America (São Paulo) sa-east-1 Africa (Cape Town) af-south-1 18.230.103.0 - 18.230.10 3.255 18.230.104.0 - 18.230.10 5.255 54.233.204.0 - 54.233.20 4.255 2600:1f32:e000::/40 13.246.120.0 - 13.246.12 3.255 2406:da32:1000::/40 Israel (Tel Aviv) il-central-1 51.17.28.0-51.17.31.255 2a05:d032:5000::/40 AWS GovCloud (US-West) us-gov-west-1 52.61.193.0 - 52.61.193.255 AWS GovCloud (US-East) us-gov-east-1 2600:1f32:2000::/40 18.254.140.0 - 18.254.14 3.255 2600:1f32:5000::/40 IP address and port requirements 94 Amazon WorkSpaces DCV gateway servers Important Administration Guide Starting in June 2020, WorkSpaces streams the desktop session for DCV WorkSpaces to clients over port 4195 instead of port 4172. If you want to use DCV WorkSpaces, make sure that port 4195 is open to traﬃc. Note For non-BYOL WorkSpaces Pools, IP address ranges are not guaranteed. Instead, you must allowlist the DCV gateway domain names. For more information, see DCV gateway domain names. WorkSpaces uses a small range of Amazon EC2 public IPv4 and IPv6 addresses for its DCV gateway servers. This enables you to set more ﬁnely grained ﬁrewall policies for devices that access WorkSpaces. WorkSpaces use a separate range of public IPv4 addresses for the dedicated AWS Global Accelerator (AGA) endpoints. Make sure to conﬁgure your ﬁrewall policies to allowlist the IP ranges if you plan to enable AGA for your WorkSpaces. Note that the WorkSpaces client prioritizes IPv6 connections when IPv6 is supported and gateways are reachable. If IPv6 is unavailable, it falls back to IPv4. Region Region code Public IP address range US East (N. Virginia) us-east-1 • 3.227.4.0/22 • 44.209.84.0/22 • 93.77.138.0/24 (AGA endpoints) • 93.77.139.0/24 (AGA endpoints) • 2600:1f28:34c::/48 US East (Ohio) us-east-2 • 3.146.84.0/22 IP address and port requirements 95 Amazon WorkSpaces Administration Guide Region Region code Public IP address range • 93.77.130.0/24 (AGA endpoints) • 93.77.131.0/24 (AGA endpoints) • 2600:1f26:28::/48 US West (Oregon) us-west-2 • 34.223.96.0/22 • 93.77.148.0/24 (AGA endpoints) • 93.77.149.0/24 (AGA endpoints) • 2600:1f24:34::/48 Asia Paciﬁc (Mumbai) ap-south-1 • 65.1.156.0/22 • 93.77.142.0/24 (AGA endpoints) • 93.77.143.0/24 (AGA endpoints) • 2406:da2a:14::/48 Asia Paciﬁc (Seoul) ap-northeast-2 • 3.35.160.0/22 • 93.77.156.0/24 (AGA endpoints) • 93.77.157.0/24 (AGA endpoints) • 2406:da22:4::/48 Asia Paciﬁc (Singapore) ap-southeast-1 • 13.212.132.0/22 • 93.77.158.0/24 (AGA endpoints) • 93.77.159.0/24 (AGA endpoints) • 2406:da28:28::/48 IP address and port requirements 96 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Asia Paciﬁc (Sydney) ap-southeast-2 • 3.25.248.0/22 • 93.77.150.0/24 (AGA endpoints) • 93.77.151.0/24 (AGA endpoints) • 2406:da2c:24::/48 Asia Paciﬁc (Tokyo) ap-northeast-1 • 3.114.164.0/22 • 93.77.134.0/24 (AGA endpoints) • 93.77.135.0/24 (AGA endpoints) • 2406:da24:28::/48 Canada (Central) ca-central-1 • 3.97.20.0/22 • 93.77.128.0/24 (AGA endpoints) • 93.77.129.0/24 (AGA endpoints) • 2600:1f21:8::/48 Europe (Frankfurt) eu-central-1 • 18.192.216.0/22 • 93.77.154.0/24 (AGA endpoints) • 93.77.155.0/24 (AGA endpoints) • 2a05:d024:18::/48 IP address and port requirements 97 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Europe (Ireland) eu-west-1 • 3.248.176.0/22 • 93.77.132.0/24 (AGA endpoints) • 93.77.133.0/24 (AGA endpoints) • 2a05:d028:40::/48 Europe (London) eu-west-2 • 18.134.68.0/22 • 93.77.140.0/24 (AGA endpoints) • 93.77.141.0/24 (AGA endpoints) • 2a05:d02c:8::/48 Europe (Paris) eu-west-3 • 51.44.72.0/22 • 93.77.144.0/24 (AGA endpoints) • 93.77.145.0/24 (AGA endpoints) • 2a05:d022:1c::/48 South America (São Paulo) sa-east-1 • 15.228.64.0/22 • 93.77.146.0/24 (AGA endpoints) • 93.77.147.0/24 (AGA endpoints) • 2600:1f2e:14::/48 IP address and port requirements 98 Amazon WorkSpaces Administration Guide Region Region code Public IP address range Africa (Cape Town) af-south-1 • 13.246.108.0/22 • 93.77.136.0/24 (AGA endpoints) • 93.77.137.0/24 (AGA endpoints) • 2406:da21:c::/48 Israel (Tel Aviv) il-central-1 • 51.17.72.0/22 AWS GovCloud (US-West) us-gov-west-1 AWS GovCloud (US-East) us-gov-east-1 • 93.77.152.0/24 (AGA endpoints) • 93.77.153.0/24 (AGA endpoints) • 2a05:d025:1000::/48 • 3.32.139.0/24 • 3.30.129.0/24 • 3.30.130.0/23 • 2600:1f22:28::/48 • 18.254.148.0/22 • 2600:1f25:14::/48 DCV gateway domain names The following table lists the DCV WorkSpace gateway domain names. These domains must be contactable, for the WorkSpaces client application to be able to access the WorkSpace DCV service. Region Domain US East (N. Virginia) • .prod.us-east-1.highlander.aws.a2z.com • (FIPS) .wsp-ﬁps.prod.us-east-1.highlander .aws.a2z.com IP address and port requirements 99 Amazon WorkSpaces Region Domain Administration Guide US West (Oregon) • .prod.us-west-2.highlander.aws.a2z.com • (FIPS) .wsp-ﬁps.prod.us-west-2.highlander .aws.a2z.com Asia Paciﬁc (Mumbai) .prod.ap-south-1.highlander.aws.a2z.com Asia Paciﬁc (Seoul) .prod.ap-northeast-2.highlander.aws.a2z.com Asia Paciﬁc (Singapore) *.prod.ap-southeast-1.highlander.aws.a2z.com
workspaces-ag-031	workspaces-ag.pdf	31	• 93.77.152.0/24 (AGA endpoints) • 93.77.153.0/24 (AGA endpoints) • 2a05:d025:1000::/48 • 3.32.139.0/24 • 3.30.129.0/24 • 3.30.130.0/23 • 2600:1f22:28::/48 • 18.254.148.0/22 • 2600:1f25:14::/48 DCV gateway domain names The following table lists the DCV WorkSpace gateway domain names. These domains must be contactable, for the WorkSpaces client application to be able to access the WorkSpace DCV service. Region Domain US East (N. Virginia) • .prod.us-east-1.highlander.aws.a2z.com • (FIPS) .wsp-ﬁps.prod.us-east-1.highlander .aws.a2z.com IP address and port requirements 99 Amazon WorkSpaces Region Domain Administration Guide US West (Oregon) • .prod.us-west-2.highlander.aws.a2z.com • (FIPS) .wsp-ﬁps.prod.us-west-2.highlander .aws.a2z.com Asia Paciﬁc (Mumbai) .prod.ap-south-1.highlander.aws.a2z.com Asia Paciﬁc (Seoul) .prod.ap-northeast-2.highlander.aws.a2z.com Asia Paciﬁc (Singapore) .prod.ap-southeast-1.highlander.aws.a2z.com Asia Paciﬁc (Sydney) .prod.ap-southeast-2.highlander.aws.a2z.com Asia Paciﬁc (Tokyo) .prod.ap-northeast-1.highlander.aws.a2z.com Canada (Central) Europe (Frankfurt) Europe (Ireland) Europe (London) Europe (Paris) .prod.ca-central-1.highlander.aws.a2z.com .prod.eu-central-1.highlander.aws.a2z.com .prod.eu-west-1.highlander.aws.a2z.com .prod.eu-west-2.highlander.aws.a2z.com .prod.eu-west-3.highlander.aws.a2z.com South America (São Paulo) .prod.sa-east-1.highlander.aws.a2z.com Africa (Cape Town) .prod.af-south-1.highlander.aws.a2z.com Israel (Tel Aviv) .prod.il-central-1.highlander.aws.a2z.com AWS GovCloud (US-West) • .prod.us-gov-west-1.highlander.aws. a2z.com • (FIPS) .wsp-ﬁps.prod.us-gov-west-1.highla nder.aws.a2z.com IP address and port requirements 100 Amazon WorkSpaces Region Domain Administration Guide AWS GovCloud (US-East) • .prod.us-gov-east-1.highlander.aws. a2z.com • (FIPS) *.wsp-ﬁps.prod.us-gov-east-1.highla nder.aws.a2z.com Network interfaces Each WorkSpace has the following network interfaces: • The primary network interface (eth1) provides connectivity to the resources within your VPC and on the internet, and is used to join the WorkSpace to the directory. • The management network interface (eth0) is connected to a secure WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to WorkSpaces clients, and to allow WorkSpaces to manage the WorkSpace. WorkSpaces selects the IP address for the management network interface from various address ranges, depending on the Region that the WorkSpaces are created in. When a directory is registered, WorkSpaces tests the VPC CIDR and the route tables in your VPC to determine if these address ranges create a conﬂict. If a conﬂict is found in all available address ranges in the Region, an error message is displayed and the directory is not registered. If you change the route tables in your VPC after the directory is registered, you might cause a conﬂict. Warning Do not modify or delete any of the network interfaces that are attached to a WorkSpace. Doing so might cause the WorkSpace to become unreachable or lose internet access. For example, 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. IP address and port requirements 101 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. Management interface IP ranges The following table lists the IP address ranges used for the management network interface. Note • If you're using Bring Your Own License (BYOL) Windows WorkSpaces, the IP address ranges in the following table do not apply. Instead, PCoIP BYOL WorkSpaces use the 54.239.224.0/20 IP address range for management interface traﬃc in all AWS Regions. For DCV BYOL Windows WorkSpaces, both the 54.239.224.0/20 and 10.0.0.0/8 IP address ranges apply in all AWS Regions. (These IP address ranges are used in addition to the /16 CIDR block that you select for management traﬃc for your BYOL WorkSpaces.) • If you're using DCV WorkSpaces created from public bundles, the IP address range 10.0.0.0/8 also applies for management interface traﬃc in all AWS Regions, in addition to the PCoIP/DCV ranges shown in the following table. Region IP address range US East (N. Virginia) US West (Oregon) PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, 198.19.0.0/16 WSP: 10.0.0.0/8 PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 WSP: 10.0.0.0/8 Asia Paciﬁc (Mumbai) PCoIP/WSP: 192.168.0.0/16 Asia Paciﬁc (Seoul) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 IP address and port requirements 102 Amazon WorkSpaces Region Administration Guide IP address range WSP: 10.0.0.0/8 Asia Paciﬁc (Singapore) PCoIP/WSP: 198.19.0.0/16 Asia Paciﬁc (Sydney) WSP: 10.0.0.0/8 PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 WSP: 10.0.0.0/8 Asia Paciﬁc (Tokyo) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Canada (Central) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Europe (Frankfurt) PCoIP/WSP: 198.19.0.0/16 Europe (Ireland) WSP: 10.0.0.0/8 PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 WSP: 10.0.0.0/8 Europe (London) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Europe (Paris) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 South America (São Paulo) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 IP address and port requirements 103 Amazon WorkSpaces Region IP address range Administration Guide Africa (Cape Town) PCoIP/WSP: 172.31.0.0/16 and 198.19.0.0/16 WSP: 10.0.0.0/8 Israel (Tel Aviv) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 AWS GovCloud (US-West) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 and 192.169.0.0/16 AWS GovCloud (US-East) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Management interface ports The following ports must be open on
workspaces-ag-032	workspaces-ag.pdf	32	198.19.0.0/16 WSP: 10.0.0.0/8 Canada (Central) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Europe (Frankfurt) PCoIP/WSP: 198.19.0.0/16 Europe (Ireland) WSP: 10.0.0.0/8 PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 WSP: 10.0.0.0/8 Europe (London) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Europe (Paris) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 South America (São Paulo) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 IP address and port requirements 103 Amazon WorkSpaces Region IP address range Administration Guide Africa (Cape Town) PCoIP/WSP: 172.31.0.0/16 and 198.19.0.0/16 WSP: 10.0.0.0/8 Israel (Tel Aviv) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 AWS GovCloud (US-West) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 and 192.169.0.0/16 AWS GovCloud (US-East) PCoIP/WSP: 198.19.0.0/16 WSP: 10.0.0.0/8 Management interface ports The following ports must be open on the management network interface of all WorkSpaces: • Inbound TCP on port 4172. This is used for establishment of the streaming connection on the PCoIP protocol. • Inbound UDP on port 4172. This is used for streaming user input on the PCoIP protocol. • Inbound TCP on port 4489. This is used for access using the web client. • Inbound TCP on port 8200. This is used for management and conﬁguration of the WorkSpace. • Inbound TCP on ports 8201-8250. These ports are used for establishment of the streaming connection and for streaming user input on the DCV protocol. • Inbound UDP on port 8220. This port is used for establishment of the streaming connection and for streaming user input on the DCV protocol • Outbound TCP on ports 8443 and 9997. This is used for access using the web client. • Outbound UDP on ports 3478, 4172, and 4195. This is used for access using the web client. • Outbound UDP on ports 50002 and 55002. This is used for streaming. If your ﬁrewall uses stateful ﬁltering, the ephemeral ports 50002 and 55002 are automatically opened to allow return communication. If your ﬁrewall uses stateless ﬁltering, you must open ephemeral ports 49152 - 65535 to allow return communication. IP address and port requirements 104 Amazon WorkSpaces Administration Guide • Outbound TCP on port 80, as deﬁned in Management interface IP ranges, to IP address 169.254.169.254 for access to the EC2 metadata service. Any HTTP proxy assigned to your WorkSpaces must also exclude 169.254.169.254. • Outbound TCP on port 1688 to IP addresses 169.254.169.250 and 169.254.169.251 to allow access to Microsoft KMS for Windows activation for Workspaces that are based on public bundles. If you're using Bring Your Own License (BYOL) Windows WorkSpaces, you must allow access to your own KMS servers for Windows activation. • Outbound TCP on port 1688 to IP address 54.239.236.220 to allow access to Microsoft KMS for Oﬃce activation for BYOL WorkSpaces. If you're using Oﬃce through one of the WorkSpaces public bundles, the IP address for Microsoft KMS for Oﬃce activation varies. To determine that IP address, ﬁnd the IP address for the management interface of the WorkSpace, and then replace the last two octets with 64.250. For example, if the IP address of the management interface is 192.168.3.5, the IP address for Microsoft KMS Oﬃce activation is 192.168.64.250. • Outbound TCP to IP address 127.0.0.2 for DCV WorkSpaces when the WorkSpace host is conﬁgured to use a proxy server. • Communications originating from loopback address 127.0.01. Under normal circumstances, the WorkSpaces service conﬁgures these ports for your WorkSpaces. If any security or ﬁrewall software is installed on a WorkSpace that blocks any of these ports, the WorkSpace may not function correctly or may be unreachable. Primary interface ports No matter which type of directory you have, the following ports must be open on the primary network interface of all WorkSpaces: • For internet connectivity, the following ports must be open outbound to all destinations and inbound from the WorkSpaces VPC. You need to add these manually to the security group for your WorkSpaces if you want them to have internet access. • TCP 80 (HTTP) • TCP 443 (HTTPS) • To communicate with the directory controllers, the following ports must be open between your WorkSpaces VPC and your directory controllers. For a Simple AD directory, the security group IP address and port requirements 105 Amazon WorkSpaces Administration Guide created by AWS Directory Service will have these ports conﬁgured correctly. For an AD Connector directory, you might need to adjust the default security group for the VPC to open these ports. • TCP/UDP 53 - DNS • TCP/UDP 88 - Kerberos authentication • UDP 123 - NTP • TCP 135 - RPC • UDP 137-138 - Netlogon • TCP 139 - Netlogon • TCP/UDP 389 - LDAP • TCP/UDP 445 - SMB • TCP/UDP 636 - LDAPS (LDAP over TLS/SSL) • TCP 1024-65535 - Dynamic ports for RPC • TTCP 3268-3269 - Global Catalog If any security or ﬁrewall software is installed on a WorkSpace that blocks any of these ports, the WorkSpace may not function correctly or may be unreachable. IP address and
workspaces-ag-033	workspaces-ag.pdf	33	for the VPC to open these ports. • TCP/UDP 53 - DNS • TCP/UDP 88 - Kerberos authentication • UDP 123 - NTP • TCP 135 - RPC • UDP 137-138 - Netlogon • TCP 139 - Netlogon • TCP/UDP 389 - LDAP • TCP/UDP 445 - SMB • TCP/UDP 636 - LDAPS (LDAP over TLS/SSL) • TCP 1024-65535 - Dynamic ports for RPC • TTCP 3268-3269 - Global Catalog If any security or ﬁrewall software is installed on a WorkSpace that blocks any of these ports, the WorkSpace may not function correctly or may be unreachable. IP address and port requirements by Region US East (N. Virginia) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.us-east-1.amazonaw s.com IP address and port requirements 106 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Details Domain: Administration Guide Directory Settings https://ws-client-service.us-east-1.amazonaws .com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • US East (N. Virginia) — https://d32i4gd7pg 4909.cloudfront.net/ IP address and port requirements 107 Amazon WorkSpaces Category Details Administration Guide Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.us-east-1.signin.aws Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domains: • https://ws-broker-service.us-east-1. amazonaws.com • https://ws-broker-service-fips.us-ea st-1.amazonaws.com WorkSpaces API Endpoints Domains: https://workspaces.us-east-1.amazonaws.com Session Broker (PCM) Domains: • https://skylight-cm.us-east-1.amazon aws.com • https://skylight-cm-ﬁps.us-east-1.a mazonaws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-iad.amazonworkspaces.com • turn:.us-east-1.rdn.amazonaws.com IP address and port requirements 108 Amazon WorkSpaces Category Health check IP addresses Administration Guide Details • 3.209.215.252 • 3.212.50.30 • 3.225.55.35 • 3.226.24.234 • 34.200.29.95 • 52.200.219.150 PCoIP gateway servers public IP address ranges • 3.217.228.0 - 3.217.231.255 • 3.235.112.0 - 3.235.119.255 • 52.23.61.0 - 52.23.62.255 DCV gateway servers IP address range • 3.227.4.0/22 • 44.209.84.0/22 DCV gateway domain name .prod.us-east-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, 198.19.0.0/16 • WSP: 10.0.0.0/8 US West (Oregon) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: IP address and port requirements 109 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Administration Guide Details https://skylight-client-ds.us-west-2 .amazonaws.com Domain: https://ws-client-service.us-west-2. amazonaws.com IP address and port requirements 110 Amazon WorkSpaces Category Directory Settings Administration Guide Details Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • US West (Oregon) — https://d18af777lc o7lp.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers IP address and port requirements 111 Amazon WorkSpaces Category Details Administration Guide Pre-session Smart Card Authentication Endpoints https://smartcard.us-west-2.signin.aws Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domains: • https://ws-broker-service.us-west-2. amazonaws.com • https://ws-broker-service-fips.us-we st-2.amazonaws.com WorkSpaces API Endpoints Domains: • https://workspaces.us-west-2.amazona ws.com • https://workspaces-ﬁps.us-west-2.am azonaws.com Session Broker (PCM) Domains: • https://skylight-cm.us-west-2.amazon aws.com • https://skylight-cm-ﬁps.us-west-2.a mazonaws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-pdx.amazonworkspaces.com • turn:.us-west-2.rdn.amazonaws.com IP address and port requirements 112 Amazon WorkSpaces Category Details Administration Guide Health check IP addresses • 34.217.248.177 • 52.34.160.80 • 54.68.150.54 • 54.185.4.125 • 54.188.171.18 • 54.244.158.140 PCoIP gateway servers public IP address ranges • 35.80.88.0 - 35.80.95.255 • 44.234.54.0 - 44.234.55.255 • 54.244.46.0 - 54.244.47.255 DCV gateway servers IP address range 34.223.96.0/22 DCV gateway domain name .prod.us-west-2.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, 198.19.0.0/16 • WSP: 10.0.0.0/8 Asia Paciﬁc (Mumbai) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.ap-south-1.amazona ws.com IP address and port requirements 113 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Details Domain: Administration Guide Directory Settings https://ws-client-service.ap-south-1 .amazonaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages:
workspaces-ag-034	workspaces-ag.pdf	34	Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.ap-south-1.amazona ws.com IP address and port requirements 113 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Details Domain: Administration Guide Directory Settings https://ws-client-service.ap-south-1 .amazonaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Asia Paciﬁc (Mumbai) — https://d 78hovzzqqtsb.cloudfront.net/ IP address and port requirements 114 Amazon WorkSpaces Category Details Administration Guide Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: WorkSpaces API Endpoints Domain: • https://ws-broker-service.ap-south-1 .amazonaws.com Session Broker (PCM) Web Access TURN Servers for PCoIP • https://workspaces.ap-south-1.amazon aws.com Domain: • https://skylight-cm.ap-south-1.amazo naws.com Web Access isn't currently available in the Asia Paciﬁc (Mumbai) Region Health check hostname drp-bom.amazonworkspaces.com Health check IP addresses • 13.127.57.82 • 13.234.250.73 PCoIP gateway servers public IP address ranges 13.126.243.0 - 13.126.243.255 DCV gateway servers IP address range 65.1.156.0/22 DCV gateway domain name .prod.ap-south-1.highlander.aws.a2z.com IP address and port requirements 115 Amazon WorkSpaces Category Details Administration Guide Management interface IP address ranges • PCoIP/WSP: 192.168.0.0/16 • WSP: 10.0.0.0/8 Asia Paciﬁc (Seoul) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Device Metrics (for 1.0+ and 2.0+ WorkSpaces client applications) https://device-metrics-us-2.amazon.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings https://skylight-client-ds.ap-northeast-2.ama zonaws.com Domain: https://ws-client-service.ap-northeast-2.amaz onaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ IP address and port requirements 116 Amazon WorkSpaces Category Administration Guide Details Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Asia Paciﬁc (Seoul) — https://dtyv4uwoh7 ynt.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.ap-northea st-2.amazonaws.com IP address and port requirements 117 Amazon WorkSpaces Category WorkSpaces API Endpoints Details Domain: Administration Guide • https://workspaces.ap-northeast-2.am azonaws.com Session Broker (PCM) Domain: • https://skylight-cm.ap-northeast-2.a mazonaws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-icn.amazonworkspaces.com • turn:.ap-northeast-2.rdn.amazonaws.com Health check IP addresses • 13.124.44.166 • 13.124.203.105 • 52.78.44.253 • 52.79.54.102 PCoIP gateway servers public IP address ranges • 3.34.37.0 - 3.34.37.255 • 3.34.38.0 - 3.34.39.255 • 13.124.247.0 - 13.124.247.255 DCV gateway servers IP address range 3.35.160.0/22 DCV gateway domain name .prod.ap-northeast-2.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 198.19.0.0/16 • WSP: 10.0.0.0/8 IP address and port requirements 118 Amazon WorkSpaces Asia Paciﬁc (Singapore) Domains and IP Addresses to add to your allowlist Administration Guide Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.ap-southeast-1.ama zonaws.com Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Domain: https://ws-client-service.ap-southea st-1.amazonaws.com Directory Settings Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> IP address and port requirements 119 Amazon WorkSpaces Category Administration Guide Details CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Asia Paciﬁc (Singapore) — https://d 3qzmd7y07pz0i.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.ap-southea st-1.amazonaws.com WorkSpaces API Endpoints Domain: • https://workspaces.ap-southeast-1.am azonaws.com Session Broker (PCM) Domain: • https://skylight-cm.ap-southeast-1.a mazonaws.com Web Access TURN Servers for PCoIP Server: • turn:.ap-southeast-1.rdn.amazonaws.com IP address and port requirements 120 Amazon WorkSpaces Category Details Administration Guide Health check hostname drp-sin.amazonworkspaces.com Health check IP addresses • 3.0.212.144 • 18.138.99.116 • 18.140.252.123 • 52.74.175.118 PCoIP gateway servers public IP address ranges • 18.141.152.0 - 18.141.152.255 • 18.141.154.0 - 18.141.155.255 • 52.76.127.0 - 52.76.127.255 DCV gateway servers IP address range 13.212.132.0/22 DCV gateway domain name *.prod.ap-southeast-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 198.19.0.0/16 • WSP: 10.0.0.0/8 Asia Paciﬁc (Sydney) Domains and IP Addresses to add to your
workspaces-ag-035	workspaces-ag.pdf	35	• https://workspaces.ap-southeast-1.am azonaws.com Session Broker (PCM) Domain: • https://skylight-cm.ap-southeast-1.a mazonaws.com Web Access TURN Servers for PCoIP Server: • turn:.ap-southeast-1.rdn.amazonaws.com IP address and port requirements 120 Amazon WorkSpaces Category Details Administration Guide Health check hostname drp-sin.amazonworkspaces.com Health check IP addresses • 3.0.212.144 • 18.138.99.116 • 18.140.252.123 • 52.74.175.118 PCoIP gateway servers public IP address ranges • 18.141.152.0 - 18.141.152.255 • 18.141.154.0 - 18.141.155.255 • 52.76.127.0 - 52.76.127.255 DCV gateway servers IP address range 13.212.132.0/22 DCV gateway domain name .prod.ap-southeast-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 198.19.0.0/16 • WSP: 10.0.0.0/8 Asia Paciﬁc (Sydney) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Client Metrics (for 3.0+ WorkSpaces client applications) Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Domain: https://skylight-client-ds.ap-southeast-2.ama zonaws.com Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Domain: IP address and port requirements 121 Amazon WorkSpaces Category Directory Settings Administration Guide Details https://ws-client-service.ap-southeast-2.amaz onaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Asia Paciﬁc (Sydney) — https://dwcpoxuuza 83q.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ IP address and port requirements 122 Amazon WorkSpaces Category Details Administration Guide Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.ap-southeast-2.signin.aws Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.ap-southea st-2.amazonaws.com WorkSpaces API Endpoints Domain: • https://workspaces.ap-southeast-2.am azonaws.com Session Broker (PCM) Domain: • https://skylight-cm.ap-southeast-2.a mazonaws.com Web Access TURN Servers for PCoIP Server: • turn:.ap-southeast-2.rdn.amazonaws.com Health check hostname drp-syd.amazonworkspaces.com Health check IP addresses • 3.24.11.127 • 13.237.232.125 PCoIP gateway servers public IP address ranges • 3.25.43.0 - 3.25.43.255 • 3.25.44.0 - 3.25.45.255 • 54.153.254.0 - 54.153.254.255 IP address and port requirements 123 Amazon WorkSpaces Category Details DCV gateway servers IP address range 3.25.248.0/22 Administration Guide DCV gateway domain name .prod.ap-southeast-2.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 • WSP: 10.0.0.0/8 Asia Paciﬁc (Tokyo) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings https://skylight-client-ds.ap-northeast-1.ama zonaws.com Domain: https://ws-client-service.ap-northeast-1.amaz onaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: IP address and port requirements 124 Amazon WorkSpaces Category Administration Guide Details • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Asia Paciﬁc (Tokyo) — https://d2c2t8mxjh q5z1.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.ap-northeast-1.signin.aws Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) IP address and port requirements 125 Amazon WorkSpaces Category WS Broker Administration Guide Details Domain: • https://ws-broker-service.ap-northea st-1.amazonaws.com WorkSpaces API Endpoints Domain: • https://workspaces.ap-northeast-1.am azonaws.com Session Broker (PCM) Domain: • https://skylight-cm.ap-northeast-1.a mazonaws.com Web Access TURN Servers for PCoIP Server: • turn:.ap-northeast-1.rdn.amazonaws.com Health check hostname drp-nrt.amazonworkspaces.com Health check IP addresses PCoIP gateway servers public IP address ranges • 18.178.102.247 • 54.64.174.128 • 18.180.178.0 - 18.180.178.255 • 18.180.180.0 - 18.180.181.255 • 54.250.251.0 - 54.250.251.255 DCV gateway servers IP address range 3.114.164.0/22 DCV gateway domain name .prod.ap-northeast-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 198.19.0.0/16 • WSP: 10.0.0.0/8 IP address and port requirements 126 Amazon WorkSpaces Canada (Central) Domains and IP Addresses to add to your allowlist Administration Guide Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.ca-central-1.amazo Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings naws.com Domain: https://ws-client-service.ca-central-1.amazon aws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: IP address and port requirements 127 Amazon WorkSpaces Category Administration Guide Details • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Canada (Central) — https://d2wfbsypmq jmog.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.ca-central -1.amazonaws.com WorkSpaces API Endpoints Domain: Session Broker (PCM) • https://workspaces.ca-central-1.amaz
workspaces-ag-036	workspaces-ag.pdf	36	• https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: IP address and port requirements 127 Amazon WorkSpaces Category Administration Guide Details • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Canada (Central) — https://d2wfbsypmq jmog.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.ca-central -1.amazonaws.com WorkSpaces API Endpoints Domain: Session Broker (PCM) • https://workspaces.ca-central-1.amaz onaws.com Domain: • https://skylight-cm.ca-central-1.ama zonaws.com IP address and port requirements 128 Amazon WorkSpaces Category Web Access TURN Servers for PCoIP Details Server: Administration Guide Health check hostname drp-yul.amazonworkspaces.com • turn:.ca-central-1.rdn.amazonaws.com Health check IP addresses • 52.60.69.16 • 52.60.80.237 • 52.60.173.117 • 52.60.201.0 PCoIP gateway servers public IP address ranges • 15.223.100.0 - 15.223.100.255 • 15.223.102.0 - 15.223.103.255 • 35.183.255.0 - 35.183.255.255 DCV gateway servers IP address range 3.97.20.0/22 DCV gateway domain name .prod.ca-central-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 198.19.0.0/16 • WSP: 10.0.0.0/8 Europe (Frankfurt) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: IP address and port requirements 129 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Administration Guide Details https://skylight-client-ds.eu-central-1.amazo naws.com Domain: https://ws-client-service.eu-central-1.amazon aws.com IP address and port requirements 130 Amazon WorkSpaces Category Directory Settings Administration Guide Details Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Europe (Frankfurt) — https://d1whcm4957 0jjw.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers IP address and port requirements 131 Amazon WorkSpaces Category Details Administration Guide Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: WorkSpaces API Endpoints Domain: • https://ws-broker-service.eu-central -1.amazonaws.com Session Broker (PCM) • https://workspaces.eu-central-1.amaz onaws.com Domain: • https://skylight-cm.eu-central-1.ama zonaws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-fra.amazonworkspaces.com • turn:.eu-central-1.rdn.amazonaws.com Health check IP addresses • 52.59.191.224 • 52.59.191.225 • 52.59.191.226 • 52.59.191.227 PCoIP gateway servers public IP address ranges • 18.156.52.0 - 18.156.52.255 • 18.156.54.0 - 18.156.55.255 • 52.59.127.0 - 52.59.127.255 DCV gateway servers IP address range 18.192.216.0/22 IP address and port requirements 132 Amazon WorkSpaces Category Details Administration Guide DCV gateway domain name .prod.eu-central-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 198.19.0.0/16 • WSP: 10.0.0.0/8 Europe (Ireland) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings https://skylight-client-ds.eu-west-1 .amazonaws.com Domain: https://ws-client-service.eu-west-1. amazonaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ IP address and port requirements 133 Amazon WorkSpaces Category Administration Guide Details Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Europe (Ireland) — https://d3pgﬀbf39 h4k4.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.eu-west-1.signin.aws Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) IP address and port requirements 134 Amazon WorkSpaces Category WS Broker Administration Guide Details Domain: • https://ws-broker-service.eu-west-1. amazonaws.com WorkSpaces API Endpoints Domain: Session Broker (PCM) • https://workspaces.eu-west-1.amazona ws.com Domain: • https://skylight-cm.eu-west-1.amazon aws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-dub.amazonworkspaces.com • turn:.eu-west-1.rdn.amazonaws.com Health check IP addresses • 18.200.177.86 • 52.48.86.38 • 54.76.137.224 PCoIP gateway servers public IP address ranges • 3.249.28.0 - 3.249.29.255 • 52.19.124.0 - 52.19.125.255 DCV gateway servers IP address range 3.248.176.0/22 DCV gateway domain name .prod.eu-west-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 • WSP: 10.0.0.0/8 IP address and port requirements 135 Amazon WorkSpaces Europe (London) Domains and IP Addresses to add to your allowlist Administration Guide Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings https://skylight-client-ds.eu-west-2 .amazonaws.com Domain: https://ws-client-service.eu-west-2. amazonaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: •
workspaces-ag-037	workspaces-ag.pdf	37	DCV gateway domain name .prod.eu-west-1.highlander.aws.a2z.com Management interface IP address ranges • PCoIP/WSP: 172.31.0.0/16, 192.168.0.0/16, and 198.19.0.0/16 • WSP: 10.0.0.0/8 IP address and port requirements 135 Amazon WorkSpaces Europe (London) Domains and IP Addresses to add to your allowlist Administration Guide Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings https://skylight-client-ds.eu-west-2 .amazonaws.com Domain: https://ws-client-service.eu-west-2. amazonaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: IP address and port requirements 136 Amazon WorkSpaces Category Administration Guide Details • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Europe (London) — https://d16q6638mh 01s7.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.eu-west-2. amazonaws.com WorkSpaces API Endpoints Domain: Session Broker (PCM) • https://workspaces.eu-west-2.amazona ws.com Domain: • https://skylight-cm.eu-west-2.amazon aws.com IP address and port requirements 137 Amazon WorkSpaces Category Web Access TURN Servers for PCoIP Details Server: Administration Guide Health check hostname drp-lhr.amazonworkspaces.com • turn:.eu-west-2.rdn.amazonaws.com Health check IP addresses • 35.176.62.54 • 35.177.255.44 • 52.56.46.102 • 52.56.111.36 PCoIP gateway servers public IP address ranges • 18.132.21.0 - 18.132.21.255 • 18.132.22.0 - 18.132.23.255 • 35.176.32.0 - 35.176.32.255 DCV gateway servers IP address range 18.134.68.0/22 DCV gateway domain name .prod.eu-west-2.highlander.aws.a2z.com Management interface IP address ranges • 198.19.0.0/16 • WSP: 10.0.0.0/8 Europe (Paris) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ Client https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: IP address and port requirements 138 Amazon WorkSpaces Category Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Administration Guide Details https://skylight-client-ds.eu-west-3 .amazonaws.com Domain: https://ws-client-service.eu-west-3. amazonaws.com IP address and port requirements 139 Amazon WorkSpaces Category Directory Settings Administration Guide Details Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d2kmf63k5sit88.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Europe (Paris) — https://d1a3pnge9o n3sx.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers IP address and port requirements 140 Amazon WorkSpaces Category Details Administration Guide Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: WorkSpaces API Endpoints Domain: • https://ws-broker-service.eu-west-3. amazonaws.com Session Broker (PCM) • https://workspaces.eu-west-3.amazona ws.com Domain: • https://skylight-cm.eu-west-3.amazon aws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-cdg.amazonworkspaces.com • turn:.eu-west-3.rdn.amazonaws.com Health check IP addresses • 51.17.52.90 • 51.17.109.231 • 51.16.190.43 PCoIP gateway servers public IP address ranges • 51.44.204.0-51.44.207.255 2a05:d032:2000::/40 DCV gateway servers IP address range 51.17.72.0/22 DCV gateway domain name .prod.eu-west-3.highlander.aws.a2z.com IP address and port requirements 141 Amazon WorkSpaces Category Details Administration Guide Management interface IP address ranges • 198.19.0.0/16 • WSP: 10.0.0.0/8 South America (São Paulo) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.sa-east-1.amazonaw Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) s.com Domain: Directory Settings https://ws-client-service.sa-east-1.amazonaws .com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: IP address and port requirements 142 Amazon WorkSpaces Category Administration Guide Details • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • South America (São Paulo) — https://d 2lh2qc5bdoq4b.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.sa-east-1. amazonaws.com IP address and port requirements 143 Amazon WorkSpaces Category WorkSpaces API Endpoints Details Domain: Administration Guide Session Broker (PCM) • https://workspaces.sa-east-1.amazona ws.com Domain: • https://skylight-cm.sa-east-1.amazon aws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-gru.amazonworkspaces.com • turn:.sa-east-1.rdn.amazonaws.com Health check IP addresses • 18.231.0.105 • 52.67.55.29 • 54.233.156.245 • 54.233.216.234 PCoIP gateway servers public IP address ranges • 18.230.103.0 - 18.230.103.255 • 18.230.104.0 - 18.230.105.255 • 54.233.204.0 - 54.233.204.255 DCV gateway servers IP address range 15.228.64.0/22 DCV gateway domain name *.prod.sa-east-1.highlander.aws.a2z.com Management interface IP address
workspaces-ag-038	workspaces-ag.pdf	38	id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.sa-east-1. amazonaws.com IP address and port requirements 143 Amazon WorkSpaces Category WorkSpaces API Endpoints Details Domain: Administration Guide Session Broker (PCM) • https://workspaces.sa-east-1.amazona ws.com Domain: • https://skylight-cm.sa-east-1.amazon aws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-gru.amazonworkspaces.com • turn:.sa-east-1.rdn.amazonaws.com Health check IP addresses • 18.231.0.105 • 52.67.55.29 • 54.233.156.245 • 54.233.216.234 PCoIP gateway servers public IP address ranges • 18.230.103.0 - 18.230.103.255 • 18.230.104.0 - 18.230.105.255 • 54.233.204.0 - 54.233.204.255 DCV gateway servers IP address range 15.228.64.0/22 DCV gateway domain name .prod.sa-east-1.highlander.aws.a2z.com Management interface IP address ranges • 198.19.0.0/16 • WSP: 10.0.0.0/8 IP address and port requirements 144 Amazon WorkSpaces Africa (Cape Town) Domains and IP Addresses to add to your allowlist Administration Guide Category CAPTCHA Client Auto-update Connectivity Check Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: https://skylight-client-ds.af-south-1.amazona Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) ws.com Domain: Directory Settings https://ws-client-service.af-south-1 .amazonaws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: IP address and port requirements 145 Amazon WorkSpaces Category Administration Guide Details • https://d1cbg795sa4g1u.cloudfront.net/ prod/<region>/<directory ID> CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Africa (Cape Town); — https://di5ygl2cs0 mrh.cloudfront.net/ Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.af-south-1 .amazonaws.com WorkSpaces API Endpoints Domain: Session Broker (PCM) • https://workspaces.af-south-1.amazon aws.com Domain: • https://skylight-cm.af-south-1.amazo naws.com IP address and port requirements 146 Amazon WorkSpaces Category Details Administration Guide Health check hostname drp-cpt.amazonworkspaces.com Health check IP addresses • 18.231.0.105 • 52.67.55.29 • 54.233.156.245 • 54.233.216.234 PCoIP gateway servers public IP address ranges • 13.246.120.0 - 13.246.123.255 DCV gateway servers IP address range 15.228.64.0/22 DCV gateway domain name .prod.af-south-1.highlander.aws.a2z.com Management interface IP address ranges • 172.31.0.0/16 and 198.19.0.0/16 • WSP: 10.0.0.0/8 Israel (Tel Aviv) Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Connectivity Check Client Metrics (for 3.0+ WorkSpaces client applications) Details https://opfcaptcha-prod.s3.amazonaws.com/ https://d2td7dqidlhjx7.cloudfront.net/ https://connectivity.amazonworkspaces.com/ Domain: https://skylight-client-ds.il-central-1.amazo naws.com Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Domain: IP address and port requirements 147 Amazon WorkSpaces Category Directory Settings Administration Guide Details https://ws-client-service.il-central-1.amazon aws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://d21ui22avrxoh6.cloudfront.net/ prod/<region>/<directory ID> Login page graphics for customer directory level co-branding: • CSS ﬁle to style the login pages: • https://d3s98kk2h6f4oh.cloudfront.net/ • https://dyqsoz7pkju4e.cloudfront.net/ JavaScript ﬁle for the login pages: • Israel (Tel Aviv); — Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers IP address and port requirements 148 Amazon WorkSpaces Category Details Administration Guide Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://<directory id>.awsapps.com/ (where <directory id> is the customer's domain) WS Broker Domain: WorkSpaces API Endpoints Domain: • https://ws-broker-service.il-central -1.amazonaws.com Session Broker (PCM) • https://workspaces.il-central-1.amaz onaws.com Domain: • https://skylight-cm.il-central-1.ama zonaws.com Web Access TURN Servers for PCoIP Server: Health check hostname drp-tlv.amazonworkspaces.com • turn:.il-central-1.rdn.amazonaws.com Health check IP addresses • 51.17.52.90 • 51.17.109.231 • 51.16.190.43 PCoIP gateway servers public IP address ranges • 51.17.28.0-51.17.31.255 DCV gateway servers IP address range 51.17.72.0/22 DCV gateway domain name *.prod.il-central-1.highlander.aws.a2z.com IP address and port requirements 149 Amazon WorkSpaces Category Details Administration Guide Management interface IP address ranges • 198.19.0.0/16 • WSP: 10.0.0.0/8 AWS GovCloud (US-West) Region Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Details https://opfcaptcha-prod.s3.amazonaws.com/ https://s3.amazonaws.com/workspaces- client-updates/prod/pdt/windows/Work SpacesAppCast.xml Connectivity Check https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: hhttps://skylight-client-ds.us-gov-west-1.ama Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings zonaws.com Domain: https://ws-client-service.us-gov-west-1.amazo naws.com Authentication from the client to the customer directory before login to the WorkSpace: • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ IP address and port requirements 150 Amazon WorkSpaces Category Administration Guide Details Customer directory settings: • https://s3.amazonaws.com/workspaces- client-properties/prod/pdt/<directory ID> Login page graphics for customer directory level co-branding: • https://s3.amazonaws.com/workspaces- client-assets/prod/pdt/<directory ID> CSS ﬁle to style the login pages: • https://s3.amazonaws.com/workspaces- clients-css/workspaces_v2.css JavaScript ﬁle for the login pages: • Not applicable Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.signin.amazonaws-us- gov.com Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://login.us-gov-home.awsapps.com/ directory/<directory id>/ (where <directory id> is the customer's domain) IP address and port requirements 151 Amazon WorkSpaces Category WS Broker Administration Guide Details Domain: • https://ws-broker-service.us-gov-wes t-1.amazonaws.com • https://ws-broker-service-fips.us-gov- west-1.amazonaws.com WorkSpaces API Endpoints Domain: • https://workspaces.us-gov-west-1.ama zonaws.com • https://workspaces-ﬁps.us-gov-west- 1.amazonaws.com
workspaces-ag-039	workspaces-ag.pdf	39	customer directory level co-branding: • https://s3.amazonaws.com/workspaces- client-assets/prod/pdt/<directory ID> CSS ﬁle to style the login pages: • https://s3.amazonaws.com/workspaces- clients-css/workspaces_v2.css JavaScript ﬁle for the login pages: • Not applicable Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.signin.amazonaws-us- gov.com Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com User Login Pages https://login.us-gov-home.awsapps.com/ directory/<directory id>/ (where <directory id> is the customer's domain) IP address and port requirements 151 Amazon WorkSpaces Category WS Broker Administration Guide Details Domain: • https://ws-broker-service.us-gov-wes t-1.amazonaws.com • https://ws-broker-service-fips.us-gov- west-1.amazonaws.com WorkSpaces API Endpoints Domain: • https://workspaces.us-gov-west-1.ama zonaws.com • https://workspaces-ﬁps.us-gov-west- 1.amazonaws.com Session Broker (PCM) Domain: • https://skylight-cm.us-gov-west-1.am azonaws.com • https://skylight-cm-ﬁps.us-gov-west -1.amazonaws.com Health check hostname drp-pdt.amazonworkspaces.com Health check IP addresses • 52.61.60.65 • 52.61.65.14 • 52.61.88.170 • 52.61.137.87 • 52.61.155.110 • 52.222.20.88 PCoIP gateway servers public IP address ranges • 52.61.193.0 - 52.61.193.255 IP address and port requirements 152 Amazon WorkSpaces Category Details Administration Guide DCV gateway servers IP address range • 3.32.139.0/24 • 3.30.129.0/24 • 3.30.130.0/23 DCV gateway domain name .prod.us-gov-west-1.highlander.aws.a2z.com Management interface IP address ranges • 198.19.0.0/16 • WSP: 10.0.0.0/8 and 192.169.0.0/16 AWS GovCloud (US-East) Region Domains and IP Addresses to add to your allowlist Category CAPTCHA Client Auto-update Details https://opfcaptcha-prod.s3.amazonaws.com/ https://s3.amazonaws.com/workspaces- client-updates/prod/osu/windows/Work SpacesAppCast.xml Connectivity Check https://connectivity.amazonworkspaces.com/ Client Metrics (for 3.0+ WorkSpaces client applications) Domain: Dynamic Messaging Service (for 3.0+ WorkSpaces client applications) Directory Settings hhttps://skylight-client-ds.us-gov-east-1.ama zonaws.com Domain: https://ws-client-service.us-gov-east-1.amazo naws.com Authentication from the client to the customer directory before login to the WorkSpace: IP address and port requirements 153 Amazon WorkSpaces Category Administration Guide Details • https://d32i4gd7pg4909.cloudfront.net/ prod/<region>/<directory ID> Connections from macOS clients: • https://d32i4gd7pg4909.cloudfront.net/ Customer directory settings: • https://s3.amazonaws.com/workspaces- client-properties/prod/osu/<directory ID> Login page graphics for customer directory level co-branding: • https://s3.amazonaws.com/workspaces- client-assets/prod/osu/<directory ID> CSS ﬁle to style the login pages: • https://s3.amazonaws.com/workspaces- clients-css/workspaces_v2.css JavaScript ﬁle for the login pages: • Not applicable Forrester Log Service https://fls-na.amazon.com/ Health Check (DRP) Servers Health check servers Pre-session Smart Card Authentication Endpoints https://smartcard.signin.amazonaws-us- gov.com Registration Dependency (for Web Access and Teradici PCoIP Zero Clients) https://s3.amazonaws.com IP address and port requirements 154 Amazon WorkSpaces Category User Login Pages Administration Guide Details https://login.us-gov-home.awsapps.com/ directory/<directory id>/ (where <directory id> is the customer's domain) WS Broker Domain: • https://ws-broker-service.us-gov-eas t-1.amazonaws.com • https://ws-broker-service-fips.us-gov- east-1.amazonaws.com WorkSpaces API Endpoints Domain: • https://workspaces.us-gov-east-1.ama zonaws.com • https://workspaces-ﬁps.us-gov-east- 1.amazonaws.com Session Broker (PCM) Domain: • https://skylight-cm.us-gov-east-1.am azonaws.com • https://skylight-cm-ﬁps.us-gov-east -1.amazonaws.com Health check hostname drp-osu.amazonworkspaces.com Health check IP addresses • 18.253.251.70 • 18.254.0.118 PCoIP gateway servers public IP address ranges • 18.254.140.0 - 18.254.143.255 DCV gateway servers IP address range 18.254.148.0/22 DCV gateway domain name .prod.us-gov-east-1.highlander.aws.a2z.com IP address and port requirements 155 Amazon WorkSpaces Category Details Administration Guide Management interface IP address ranges • 198.19.0.0/16 • WSP: 10.0.0.0/8 Client network requirements for WorkSpaces Personal Your WorkSpaces users can connect to their WorkSpaces by using the client application for a supported device. Alternatively, they can use a web browser to connect to WorkSpaces that support this form of access. For a list of WorkSpaces that support web browser access, see "Which Amazon WorkSpaces bundles support web access?" in Client Access, Web Access, and User Experience. Note A web browser cannot be used to connect to Amazon Linux WorkSpaces. Important 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. To provide your users with a good experience with their WorkSpaces, verify that their client devices meet the following network requirements: • The client device must have a broadband internet connection. We recommend planning for a minimum of 1 Mbps per simultaneous user watching a 480p video window. Depending on your user-quality requirements for video resolution, more bandwidth might be required. • The network that the client device is connected to, and any ﬁrewall on the client device, must have certain ports open to the IP address ranges for various AWS services. For more information, see IP address and port requirements for WorkSpaces Personal. • For the best performance for PCoIP, the round trip time (RTT) from the client's network to the Region that the WorkSpaces are in should be less than 100ms. If the RTT is between 100ms and Network requirements 156 Amazon WorkSpaces Administration Guide 200ms, the user can access the WorkSpace, but performance is aﬀected. If the RTT is between 200ms and 375ms, the performance is degraded. If the RTT exceeds 375ms, the WorkSpaces client connection is terminated. For the best performance for DCV, the RTT from the client's network to the Region that the WorkSpaces are in should be less than 250ms. If the RTT is between 250ms and 400ms, the user can access the WorkSpace, but the performance is degraded. To check the RTT to the various AWS Regions from your location, use the Amazon WorkSpaces Connection
workspaces-ag-040	workspaces-ag.pdf	40	156 Amazon WorkSpaces Administration Guide 200ms, the user can access the WorkSpace, but performance is aﬀected. If the RTT is between 200ms and 375ms, the performance is degraded. If the RTT exceeds 375ms, the WorkSpaces client connection is terminated. For the best performance for DCV, the RTT from the client's network to the Region that the WorkSpaces are in should be less than 250ms. If the RTT is between 250ms and 400ms, the user can access the WorkSpace, but the performance is degraded. To check the RTT to the various AWS Regions from your location, use the Amazon WorkSpaces Connection Health Check. • To use webcams with DCV, we recommend a minimum upload bandwidth of 1.7 megabits per second. • If users will access their WorkSpaces through a virtual private network (VPN), the connection must support a maximum transmission unit (MTU) of at least 1200 bytes. Note You cannot access WorkSpaces through a VPN connected to your virtual private cloud (VPC). To access WorkSpaces using a VPN, internet connectivity (through the VPN's public IP addresses) is required, as described in IP address and port requirements for WorkSpaces Personal. • The clients require HTTPS access to WorkSpaces resources hosted by the service and Amazon Simple Storage Service (Amazon S3). The clients do not support proxy redirection at the application level. HTTPS access is required so that users can successfully complete registration and access their WorkSpaces. • To allow access from PCoIP zero client devices, you must be using a PCoIP protocol bundle for WorkSpaces. You must also enable Network Time Protocol (NTP) in Teradici. For more information, see Set up PCoIP zero clients for WorkSpaces Personal. You can verify that a client device meets the networking requirements as follows. To verify networking requirements for 3.0+ clients 1. Open your WorkSpaces client. If this is the ﬁrst time you have opened the client, you are prompted to enter the registration code that you received in the invitation email. 2. Depending on which client you're using, do one of the following. Network requirements 157 Amazon WorkSpaces Administration Guide If you're using... Do this Windows or Linux clients In the upper-right corner of the client application, select the Network icon macOS client Choose Connections, Network. . The client application tests the network connection, ports, and round-trip time, and reports the results of these tests. 3. Close the Network dialog box to return to the sign-in page. To verify networking requirements for 1.0+ and 2.0+ clients 1. Open your WorkSpaces client. If this is the ﬁrst time you have opened the client, you are prompted to enter the registration code that you received in the invitation email. 2. Choose Network in the lower-right corner of the client application. The client application tests the network connection, ports, and round-trip time, and reports the results of these tests. 3. Choose Dismiss to return to the sign-in page. Restrict access to trusted devices for WorkSpaces Personal By default, users can access their WorkSpaces from any supported device that is connected to the internet. If your company limits corporate data access to trusted devices (also known as managed devices), you can restrict WorkSpaces access to trusted devices with valid certiﬁcates. Note This feature is currently available only when your WorkSpaces Personal directories are managed through AWS Directory Service including Simple AD, AD Connector, and AWS Managed Microsoft AD directory. Trusted devices 158 Amazon WorkSpaces Administration Guide When you enable this feature, WorkSpaces uses certiﬁcate-based authentication to determine whether a device is trusted. If the WorkSpaces client application can't verify that a device is trusted, it blocks attempts to log in or reconnect from the device. For each directory, you can import up to two root certiﬁcates. If you import two root certiﬁcates, WorkSpaces presents them both to the client and the client ﬁnds the ﬁrst valid matching certiﬁcate that chains up to either of the root certiﬁcates. Supported clients • Android, running on Android or Android-compatible Chrome OS systems • macOS • Windows Important This feature is not supported by the following clients: • WorkSpaces client applications for Linux or iPad • Third-party clients, including but not limited to, Teradici PCoIP, RDP clients, and remote desktop applications. Note When you enable access for speciﬁc clients, make sure that you block access for other device types that you don't need. For more information about how to do this, see Step 3.7 below. Step 1: Create the certiﬁcates This feature requires two types of certiﬁcates: root certiﬁcates generated by an internal Certiﬁcate Authority (CA) and client certiﬁcates that chain up to a root certiﬁcate. Requirements • Root certiﬁcates must be Base64-encoded certiﬁcate ﬁles in CRT, CERT, or PEM format. Trusted devices 159 Amazon WorkSpaces Administration Guide • Root certiﬁcates must satisfy the following regular expression pattern, which means that every encoded
workspaces-ag-041	workspaces-ag.pdf	41	you enable access for speciﬁc clients, make sure that you block access for other device types that you don't need. For more information about how to do this, see Step 3.7 below. Step 1: Create the certiﬁcates This feature requires two types of certiﬁcates: root certiﬁcates generated by an internal Certiﬁcate Authority (CA) and client certiﬁcates that chain up to a root certiﬁcate. Requirements • Root certiﬁcates must be Base64-encoded certiﬁcate ﬁles in CRT, CERT, or PEM format. Trusted devices 159 Amazon WorkSpaces Administration Guide • Root certiﬁcates must satisfy the following regular expression pattern, which means that every encoded line, beside the last one, has to be exactly 64 characters long: -{5}BEGIN CERTIFICATE-{5}\u000D?\u000A([A-Za-z0-9/+]{64} \u000D?\u000A)*[A-Za-z0-9/ +]{1,64}={0,2}\u000D?\u000A-{5}END CERTIFICATE-{5}(\u000D?\u000A). • Device certiﬁcates must include a Common Name. • Device certiﬁcates must include the following extensions: Key Usage: Digital Signature, and Enhanced Key Usage: Client Authentication. • All the certiﬁcates in the chain from the device certiﬁcate to the trusted root Certiﬁcate Authority must be installed on the client device. • The maximum supported length of certiﬁcate chain is 4. • WorkSpaces does not currently support device revocation mechanisms, such as certiﬁcate revocation lists (CRL) or Online Certiﬁcate Status Protocol (OCSP), for client certiﬁcates. • Use a strong encryption algorithm. We recommend SHA256 with RSA, SHA256 with ECDSA, SHA384 with ECDSA, or SHA512 with ECDSA. • For macOS, if the device certiﬁcate is in the system keychain, we recommend that you authorize the WorkSpaces client application to access those certiﬁcates. Otherwise, users must enter keychain credentials when they log in or reconnect. Step 2: Deploy client certiﬁcates to the trusted devices On the trusted devices for your users, you must install a certiﬁcate bundle that includes all the certiﬁcates in the chain from the device certiﬁcate to the trusted root Certiﬁcate Authority. You can use your preferred solution to install certiﬁcates to your ﬂeet of client devices; for example, System Center Conﬁguration Manager (SCCM) or mobile device management (MDM). Note that SCCM and MDM can optionally perform a security posture assessment to determine whether the devices meet your corporate policies to access WorkSpaces. The WorkSpaces client applications search for certiﬁcates as follows: • Android - Go to Settings, choose Security & location, Credentials, then choose Install from SD card. • Android-compatible Chrome OS systems - Open Android settings and choose Security & location, Credentials, then choose Install from SD card. • macOS - Searches the keychain for client certiﬁcates. • Windows - Searches the user and root certiﬁcate stores for client certiﬁcates. Trusted devices 160 Amazon WorkSpaces Administration Guide Step 3: Conﬁgure the restriction After you have deployed the client certiﬁcates on the trusted devices, you can enable restricted access at the directory level. This requires the WorkSpaces client application to validate the certiﬁcate on a device before allowing a user to log in to a WorkSpace. To conﬁgure the restriction 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select the directory and then choose Actions, Update Details. Expand Access Control Options. 5. Under For each device type, specify which devices can access WorkSpaces, choose Trusted Devices. 6. Import up to two root certiﬁcates. For each root certiﬁcate, do the following: a. Choose Import. b. Copy the body of the certiﬁcate to the form. c. Choose Import. 7. Specify whether other types of devices have access to WorkSpaces. a. b. c. Scroll down to the Other Platforms section. By default, WorkSpaces Linux clients are disabled, and users can access their WorkSpaces from their iOS devices, Android devices, Web Access, Chromebooks, and PCoIP zero client devices. Select the device types to enable and clear the device types to disable. To block access from all selected device types, choose Block. 8. Choose Update and Exit. Integrate SAML 2.0 with WorkSpaces Personal Note SAML 2.0 is available only when your WorkSpaces Personal directories are managed through AWS Directory Service including Simple AD, AD Connector, and AWS Managed Microsoft AD directory. The feature doesn't apply to directories that are managed by SAML 2.0 integration 161 Amazon WorkSpaces Administration Guide Amazon WorkSpaces, which normally use IAM Identity Center for user authentication instead of SAML 2.0 federation. Integrating SAML 2.0 with your WorkSpaces for desktop session authentication allows your users to use their existing SAML 2.0 identity provider (IdP) credentials and authentication methods through their default web browser. By using your IdP to authenticate users for WorkSpaces, you can protect WorkSpaces by employing IdP features like multi-factor authentication and contextual access policies. Authentication workﬂow The following sections describe the authentication workﬂow initiated by WorkSpaces client application, WorkSpaces Web Access, and a SAML 2.0 identity provider (IdP): • When the ﬂow is initiated by the IdP. For example, when users choose an application in the IdP user portal in a web browser.
workspaces-ag-042	workspaces-ag.pdf	42	your WorkSpaces for desktop session authentication allows your users to use their existing SAML 2.0 identity provider (IdP) credentials and authentication methods through their default web browser. By using your IdP to authenticate users for WorkSpaces, you can protect WorkSpaces by employing IdP features like multi-factor authentication and contextual access policies. Authentication workﬂow The following sections describe the authentication workﬂow initiated by WorkSpaces client application, WorkSpaces Web Access, and a SAML 2.0 identity provider (IdP): • When the ﬂow is initiated by the IdP. For example, when users choose an application in the IdP user portal in a web browser. • When the ﬂow is initiated by the WorkSpaces client. For example, when users open the client application and sign in. • When the ﬂow is initiated by WorkSpaces Web Access. For example, when users open Web Access in a browser and sign in. In these examples, users enter [email protected] sign in to the IdP. The IdP has a SAML 2.0 service provider application conﬁgured for a WorkSpaces directory and users are authorized for the WorkSpaces SAML 2.0 application. Users create a WorkSpace for their usernames, user, in a directory that's enabled for SAML 2.0 authentication. Additionally, users install the WorkSpaces client application on their device or the user uses Web Access in a web browser. Identity provider (IdP)-initiated ﬂow with client application The IdP-initiated ﬂow allows users to automatically register the WorkSpaces client application on their devices without having to enter a WorkSpaces registration code. Users don't sign in to their WorkSpaces using the IdP-initiated ﬂow. WorkSpaces authentication must originate from the client application. 1. Using their web browser, users sign in to the IdP. 2. After signing in to the IdP, users choose the WorkSpaces application from the IdP user portal. SAML 2.0 integration 162 Amazon WorkSpaces Administration Guide 3. Users are redirected to this page in the browser, and the WorkSpaces client application is opened automatically. 4. The WorkSpaces client application is now registered and users can continue to sign by clicking Continue to sign in to WorkSpaces. Identity provider (IdP)-initiated ﬂow with Web Access The IdP-initiated Web Access ﬂow allows users to automatically register their WorkSpaces through a web browser without having to enter a WorkSpaces registration code. Users don't sign in to their WorkSpaces using the IdP-initiated ﬂow. WorkSpaces authentication must originate from Web Access. 1. Using their web browser, users sign in to the IdP. 2. After signing in to the IdP, users click the WorkSpaces application from the IdP user portal. 3. Users are redirected to this page in the browser. To open WorkSpaces, choose Amazon WorkSpaces in the browser. SAML 2.0 integration 163 Amazon WorkSpaces Administration Guide 4. The WorkSpaces client application is now registered and users can continue to sign in through WorkSpaces Web Access. WorkSpaces client-initiated ﬂow The client-initiated ﬂow allows users to sign in to their WorkSpaces after signing in to an IdP. 1. Users launch the WorkSpaces client application (if it isn't already running) and clicks Continue to sign in to WorkSpaces. 2. Users are redirected to their default web browser to sign in to the IdP. If the users are already signed in to the IdP in their browser, they don't need to sign in again and will skip this step. 3. Once signed in to the IdP, users are redirected to a pop up. Follow the prompts to allow your web browser to open the client application. SAML 2.0 integration 164 Amazon WorkSpaces Administration Guide 4. Users are redirected to the WorkSpaces client application to complete sign in to their WorkSpace. WorkSpaces usernames are populated automatically from the IdP SAML 2.0 assertion. When you use certiﬁcate-based authentication (CBA) , users are automatically signed in. 5. Users are signed in to their WorkSpace. WorkSpaces Web Access-initiated ﬂow The Web Access-initiated ﬂow allows users to sign in to their WorkSpaces after signing in to an IdP. 1. Users launch the WorkSpaces Web Access and chooses Sign in. 2. In the same browser tab, users are redirected to IdP portal. If the users are already signed in to the IdP in their browser, they don't need to sign in again and can skip this step. 3. Once signed in to the IdP, users redirected to this page in the browser, and clicks Log in to WorkSpaces. 4. Users redirected to the WorkSpaces client application to complete sign in to their WorkSpace. WorkSpaces usernames are populated automatically from the IdP SAML 2.0 assertion. When you use certiﬁcate-based authentication (CBA) , users are automatically signed in. 5. Users are signed in to their WorkSpace. SAML 2.0 integration 165 Amazon WorkSpaces Administration Guide Set up SAML 2.0 for WorkSpaces Personal Enable WorkSpaces client application registration and signing in to WorkSpaces for your users by using their SAML 2.0 identity provider (IdP) credentials
workspaces-ag-043	workspaces-ag.pdf	43	to the IdP, users redirected to this page in the browser, and clicks Log in to WorkSpaces. 4. Users redirected to the WorkSpaces client application to complete sign in to their WorkSpace. WorkSpaces usernames are populated automatically from the IdP SAML 2.0 assertion. When you use certiﬁcate-based authentication (CBA) , users are automatically signed in. 5. Users are signed in to their WorkSpace. SAML 2.0 integration 165 Amazon WorkSpaces Administration Guide Set up SAML 2.0 for WorkSpaces Personal Enable WorkSpaces client application registration and signing in to WorkSpaces for your users by using their SAML 2.0 identity provider (IdP) credentials and authentication methods by setting up identity federation using SAML 2.0. To set up identity federation using SAML 2.0, use an IAM role and a relay state URL to conﬁgure your IdP and enable AWS. This grants your federated users access to a WorkSpaces directory. The relay state is the WorkSpaces directory endpoint to which users are forwarded after successfully signing in to AWS. Contents • Requirements • Prerequisites • Step 1: Create a SAML identity provider in AWS IAM • Step 2: Create a SAML 2.0 federation IAM role • Step 3: Embed an inline policy for the IAM role • Step 4: Conﬁgure your SAML 2.0 identity provider • Step 5: Create assertions for the SAML authentication response • Step 6: Conﬁgure the relay state of your federation • Step 7: Enable integration with SAML 2.0 on your WorkSpaces directory Requirements • SAML 2.0 authentication is available in the following Regions: • US East (N. Virginia) Region • US West (Oregon) Region • Africa (Cape Town) Region • Asia Paciﬁc (Mumbai) Region • Asia Paciﬁc (Seoul) Region • Asia Paciﬁc (Singapore) Region • Asia Paciﬁc (Sydney) Region • Asia Paciﬁc (Tokyo) Region • Canada (Central) Region • Europe (Frankfurt) Region SAML 2.0 integration 166 Amazon WorkSpaces Administration Guide • Europe (Ireland) Region • Europe (London) Region • South America (São Paulo) Region • Israel (Tel Aviv) Region • AWS GovCloud (US-West) • AWS GovCloud (US-East) • 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 include ADFS, Azure AD, Duo Single Sign-On, Okta, PingFederate, and PingOne. Consult your IdP documentation for more information. • SAML 2.0 authentication will function with WorkSpaces launched using Simple AD, but this isn't recommended as Simple AD doesn't integrate with SAML 2.0 IdPs. • SAML 2.0 authentication is supported on the following WorkSpaces clients. Other client versions are unsupported for SAML 2.0 authentication. Open Amazon WorkSpaces Client Downloads to ﬁnd the latest versions: • Windows client application version 5.1.0.3029 or later • macOS client version 5.x or later • Linux client for Ubuntu 22.04 version 2024.1 or later, Ubuntu 20.04 version 24.1 or later • Web Access Other client versions won't be able to connect to WorkSpaces enabled for SAML 2.0 authentication unless fallback is enabled. For more information, see Enable SAML 2.0 authentication on the WorkSpaces directory. For step-by-step instructions to integrate SAML 2.0 with WorkSpaces using ADFS, Azure AD, Duo Single Sign-On, Okta, OneLogin, PingFederate and PingOne for Enterprise, review the Amazon WorkSpaces SAML Authentication Implementation Guide. Prerequisites Complete the following prerequisites before conﬁguring your SAML 2.0 identity provider (IdP) connection to a WorkSpaces directory. 1. Conﬁgure your IdP to integrate user identities from the Microsoft Active Directory that is used with the WorkSpaces directory. For a user with a WorkSpace, the sAMAccountName and email SAML 2.0 integration 167 Amazon WorkSpaces Administration Guide attributes for the Active Directory user and the SAML claim values must match for the user to sign in to WorkSpaces using the IdP. For more information about integrating Active Directory with your IdP, consult your IdP documentation. 2. Conﬁgure your IdP to establish a trust relationship with AWS. • See Integrating third-party SAML solution providers with AWS for more information on conﬁguring AWS federation. Relevant examples include IdP integration with AWS 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 ﬁle to a location that you can access from the IAM console later. 3. Create or register a directory for WorkSpaces by using the WorkSpaces management console. For more information, see Manage directories for WorkSpaces. SAML 2.0 authentication for WorkSpaces is supported for the following directory types: • AD Connector • AWS Managed Microsoft AD 4. Create a WorkSpace for a user who can sign in to the IdP using a supported directory type. You can create a WorkSpace using the WorkSpaces management console, AWS CLI, or WorkSpaces API. For more information, see Launch a virtual desktop using
workspaces-ag-044	workspaces-ag.pdf	44	Save this ﬁle to a location that you can access from the IAM console later. 3. Create or register a directory for WorkSpaces by using the WorkSpaces management console. For more information, see Manage directories for WorkSpaces. SAML 2.0 authentication for WorkSpaces is supported for the following directory types: • AD Connector • AWS Managed Microsoft AD 4. Create a WorkSpace for a user who can sign in to the IdP using a supported directory type. You can create a WorkSpace using the WorkSpaces management console, AWS CLI, or WorkSpaces API. For more information, see Launch a virtual desktop using WorkSpaces. Step 1: Create a SAML identity provider in AWS IAM First, create a SAML IdP in AWS IAM. This IdP deﬁnes 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 (Amazon Web Services Management Console). For information about working with SAML IdPs in AWS GovCloud (US- West)and AWS GovCloud (US-East), see AWS Identity and Access Management. Step 2: Create a SAML 2.0 federation IAM role Next, create a SAML 2.0 federation IAM role. This step establishes a trust relationship between IAM and your organization's IdP, which identiﬁes your IdP as a trusted entity for federation. To create an IAM role for SAML IdP 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Roles > Create role. SAML 2.0 integration 168 Amazon WorkSpaces Administration Guide 3. 4. 5. 6. For Role type, choose SAML 2.0 federation. For SAML Provider select the SAML IdP that you created. Important Don't choose either of the two SAML 2.0 access methods, Allow programmatic access only or Allow programmatic and Amazon Web Services Management Console access. For Attribute, choose SAML:sub_type. For Value enter persistent. 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 about the SAML:sub_type assertion, see the Uniquely identifying users in SAML-based federation section in Using SAML-based federation for API access to AWS. 7. Review your SAML 2.0 trust information, conﬁrming the correct trusted entity and condition, and then choose Next: Permissions. 8. On the Attach permissions policies page, choose Next: Tags. 9. (Optional) Enter a key and value for each tag that you want to add. For more information, see Tagging IAM users and roles. 10. When you're done, choose Next: Review. You'll create and embed an inline policy for this role later. 11. For Role name, enter a name that identiﬁes the purpose of this role. Because multiple entities might reference the role, you can't edit the role's name once it is created. 12. (Optional) For Role description, enter a description for the new role. 13. Review the role details and choose Create role. 14. Add the sts:TagSession permission to your new IAM role's trust policy. For more information, see Passing session tags in AWS STS. In your new IAM role's details, choose the Trust relationships tab, and then choose Edit trust relationship. When Edit Trust Relationship policy editor opens, add the sts:TagSession permission, as follows: { "Version": "2012-10-17", "Statement": [{ SAML 2.0 integration 169 Amazon WorkSpaces Administration Guide "Effect": "Allow", "Principal": { "Federated": "arn:aws:iam::ACCOUNT-ID-WITHOUT-HYPHENS:saml-provider/ IDENTITY-PROVIDER" }, "Action": [ "sts:AssumeRoleWithSAML", "sts:TagSession" ], "Condition": { "StringEquals": { "SAML:aud": "https://signin.aws.amazon.com/saml" } } }] } Replace IDENTITY-PROVIDER with the name of the SAML IdP you created in Step 1. Then choose Update Trust Policy. Step 3: Embed an inline policy for the IAM role Next, embed an inline IAM policy for the role that you created. When you embed an inline policy, the permissions in that policy can't be accidentally attached to the wrong principal entity. The inline policy provides federated users with access to the WorkSpaces directory. Important IAM policies to manage access to AWS based on the source IP are not supported for the workspaces:Stream action. To manage IP access controls for WorkSpaces, use IP access control groups. Additionally, when using SAML 2.0 authentication you can use IP access control policies if they are available from your SAML 2.0 IdP. 1. In the details for the IAM role that you created, choose the Permissions tab, and then add required permissions to the role's permissions policy. The Create policy wizard will start. 2. In Create policy, choose the JSON tab. 3. Copy and paste the following JSON policy into the JSON window. Then, modify the resource by entering your AWS Region Code, account ID, and directory ID. In the following policy, SAML 2.0 integration 170 Amazon WorkSpaces Administration Guide "Action": "workspaces:Stream" is the action that provides your WorkSpaces users with
workspaces-ag-045	workspaces-ag.pdf	45	control policies if they are available from your SAML 2.0 IdP. 1. In the details for the IAM role that you created, choose the Permissions tab, and then add required permissions to the role's permissions policy. The Create policy wizard will start. 2. In Create policy, choose the JSON tab. 3. Copy and paste the following JSON policy into the JSON window. Then, modify the resource by entering your AWS Region Code, account ID, and directory ID. In the following policy, SAML 2.0 integration 170 Amazon WorkSpaces Administration Guide "Action": "workspaces:Stream" is the action that provides your WorkSpaces users with permissions to connect to their desktop sessions in the WorkSpaces directory. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "workspaces:Stream", "Resource": "arn:aws:workspaces:REGION-CODE:ACCOUNT-ID-WITHOUT- HYPHENS:directory/DIRECTORY-ID", "Condition": { "StringEquals": { "workspaces:userId": "${saml:sub}" } } } ] } Replace REGION-CODE with the AWS Region where your WorkSpaces directory exists. Replace DIRECTORY-ID with the WorkSpaces directory ID, which can be found in the WorkSpaces management console. For resources in AWS GovCloud (US-West) or AWS GovCloud (US- East), use the following format for the ARN: arn:aws-us-gov:workspaces:REGION- CODE:ACCOUNT-ID-WITHOUT-HYPHENS:directory/DIRECTORY-ID. 4. When you're done, choose Review policy. The Policy Validator will report any syntax errors. Step 4: Conﬁgure your SAML 2.0 identity provider Next, depending on your SAML 2.0 IdP, you may need to manually update your IdP to trust AWS as a service provider by uploading the saml-metadata.xml ﬁle at https://signin.aws.amazon.com/ static/saml-metadata.xml to your IdP. This step updates your IdP’s metadata. For some IdPs, the update may already be conﬁgured. If this is the case, proceed to the next step. If this update isn't already conﬁgured 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, and the IdP obtains and installs the ﬁle for you. Others require you to download the ﬁle from the URL and then provide it as a local ﬁle. SAML 2.0 integration 171 Amazon WorkSpaces Important Administration Guide At this time, you can also authorize users in your IdP to access the WorkSpaces application you have conﬁgured 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 5: Create assertions for the SAML authentication response Next, conﬁgure the information that your IdP sends to AWS as SAML attributes in its authentication response. Depending on your IdP, this is already conﬁgured, skip this step and continue to Step 6: Conﬁgure the relay state of your federation. If this information isn't already conﬁgured in your IdP, provide the following: • SAML Subject NameID – The unique identiﬁer for the user who is signing in. The value must match the WorkSpaces user name, and is typically the sAMAccountName attribute for the Active Directory user. • 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 Step 2: Create a SAML 2.0 federation IAM role. • 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 speciﬁed as a comma-delimited pair of ARNs. An example of the expected value is arn:aws:iam::ACCOUNTNUMBER:role/ROLENAME,arn:aws:iam::ACCOUNTNUMBER:saml- provider/PROVIDERNAME. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/RoleSessionName – This element contains one AttributeValue element that provides an identiﬁer 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 only alphanumeric characters, underscores, and the following characters: _ . : / = + - @. It SAML 2.0 integration 172 Amazon WorkSpaces Administration Guide 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 deﬁned in the WorkSpaces directory. Tag values may include combinations of letters, numbers, spaces, and _ . : /
workspaces-ag-046	workspaces-ag.pdf	46	/ = + - @. It SAML 2.0 integration 172 Amazon WorkSpaces Administration Guide 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 deﬁned 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 IAM User Guide. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/PrincipalTag:UserPrincipalName (optional) – 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 format of [email protected]. This parameter is used with certiﬁcate-based authentication as the Subject Alternative Name in the end user certiﬁcate. For more information, see Certiﬁcate-Based Authentication. • 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 identiﬁer (SID) for the user who is signing in. This parameter is used with certiﬁcate-based authentication to enable strong mapping to the Active Directory user. For more information, see Certiﬁcate-Based Authentication. • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/PrincipalTag:ClientUserName (optional) – This element contains one AttributeValue element that provides an alternative user name format. Use this attribute if you have use cases that require user name formats such as corp\username, corp.example.com\username, or [email protected] to login using the WorkSpaces client. Tag keys and values can include any combination of letters, numbers, spaces, and _ : / . + = @ - characters. For more information, see Rules for tagging in IAM and AWS STS in the IAM User Guide. To claim corp\username or corp.example.com\username formats, replace \ with /in the SAML assertion. • Attributeelement with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/PrincipalTag:Domain (optional) – This element contains one AttributeValue element that provides the Active Directory DNS fully qualiﬁed domain name (FQDN) for users signing in. This parameter is used with certiﬁcate-based authentication when the Active Directory userPrincipalName for the user contains an alternative suﬃx. The value must be provided in the domain.com, including any subdomains. SAML 2.0 integration 173 Amazon WorkSpaces Administration Guide • Attribute element with the Name attribute set to https://aws.amazon.com/SAML/ Attributes/SessionDuration (optional) – This element contains one AttributeValue element that speciﬁes the maximum amount of time that a federated streaming session for a user can remain active before reauthentication is required. The default value is 3600 seconds (60 minutes). For more information, see the SAML SessionDurationAttribute. 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 conﬁgure these elements, see Conﬁguring SAML assertions for the authentication response in the IAM User Guide. For information about speciﬁc conﬁguration requirements for your IdP, see your IdP's documentation. Step 6: Conﬁgure the relay state of your federation Next, use your IdP to conﬁgure the relay state of your federation to point to the WorkSpaces directory relay state URL. After successful authentication by AWS, the user is directed to the WorkSpaces directory endpoint, deﬁned as the relay state in the SAML authentication response. The following is the relay state URL format: https://relay-state-region-endpoint/sso-idp?registrationCode=registration-code Construct your relay state URL from your WorkSpaces directory registration code and the relay state endpoint associated with the Region in which your directory is located. The registration code can be found in the WorkSpaces management console. Optionally, if you are using cross-region redirection for WorkSpaces, you can substitute the registration code with the fully qualiﬁed domain name (FQDN) associated with directories in your primary and failover Regions. For more information, see Cross-region redirection for Amazon WorkSpaces. When using cross-region redirection and SAML 2.0 authentication, both primary and failover directories need to be enabled for SAML 2.0 authentication and independently conﬁgured SAML 2.0 integration 174 Amazon WorkSpaces Administration Guide with the IdP, using the relay state endpoint associated with each Region. This will allow the FQDN to be conﬁgured correctly when users register their WorkSpaces client applications before signing in, and will allow users to authenticate during a failover event. The following table lists the relay state endpoints for the Regions where WorkSpaces SAML 2.0 authentication is available. Regions where WorkSpaces SAML 2.0 authentication is available Region Relay state endpoint US East
workspaces-ag-047	workspaces-ag.pdf	47	SAML 2.0 authentication, both primary and failover directories need to be enabled for SAML 2.0 authentication and independently conﬁgured SAML 2.0 integration 174 Amazon WorkSpaces Administration Guide with the IdP, using the relay state endpoint associated with each Region. This will allow the FQDN to be conﬁgured correctly when users register their WorkSpaces client applications before signing in, and will allow users to authenticate during a failover event. The following table lists the relay state endpoints for the Regions where WorkSpaces SAML 2.0 authentication is available. Regions where WorkSpaces SAML 2.0 authentication is available Region Relay state endpoint US East (N. Virginia) Region • workspaces.euc-sso.us-east-1.aws.ama zon.com • (FIPS) workspaces.euc-sso-ﬁps.us-east-1.aw s.amazon.com US West (Oregon) Region • workspaces.euc-sso.us-west-2.aws.ama Africa (Cape Town) Region Asia Paciﬁc (Mumbai) Region Asia Paciﬁc (Seoul) Region Asia Paciﬁc (Singapore) Region Asia Paciﬁc (Sydney) Region Asia Paciﬁc (Tokyo) Region zon.com • (FIPS) workspaces.euc-sso-ﬁps.us-west-2.aw s.amazon.com workspaces.euc-sso.af-south-1.aws.am azon.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 SAML 2.0 integration 175 Amazon WorkSpaces Region Canada (Central) Region Europe (Frankfurt) Region Europe (Ireland) Region Europe (London) Region South America (São Paulo) Region Administration Guide Relay state endpoint workspaces.euc-sso.ca-central-1.aws. amazon.com 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 Israel (Tel Aviv) Region workspaces.euc-sso.il-central-1.aws.amazon.co m AWS GovCloud (US-West) • workspaces.euc-sso.us-gov-west-1.ama zonaws-us-gov.com • (FIPS) workspaces.euc-sso-ﬁps.us-gov-west- 1.amazonaws-us-gov.com Note For more information about, see Amazon WorkSpaces in the AWS GovCloud (US) User Guide. SAML 2.0 integration 176 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-ﬁps.us-gov-east- 1.amazonaws-us-gov.com Note For more information about, see Amazon WorkSpaces in the AWS GovCloud (US) User Guide. With an identity provider (IdP)-initiated ﬂow, you can opt to specify the client you want to use for SAML 2.0 federation. To do so, specify either native or web at end of the relay state URL, after &client=. When the parameter is speciﬁed in a relay state URL, the corresponding sessions will automatically start in the speciﬁed client. Step 7: Enable integration with SAML 2.0 on your WorkSpaces directory You can use the WorkSpaces console to enable SAML 2.0 authentication on the WorkSpaces directory. To enable integration with SAML 2.0 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose on the Directory ID for your WorkSpaces. 4. Under Authentication, choose Edit. 5. Choose Edit SAML 2.0 Identity Provider. 6. Check Enable SAML 2.0 authentication. 7. For the User Access URL and IdP deep link parameter name, enter values that are applicable to your IdP and the application you have conﬁgured in Step 1. The default value for the IdP deep link parameter name is “RelayState“ if you omit this parameter. The following table SAML 2.0 integration 177 Amazon WorkSpaces Administration Guide lists user access URL and parameter names that are unique to various identity providers for applications. Domains and IP addresses to add to your allow list Identity provider Parameter User access URL ADFS RelayState Azure AD RelayState Duo Single Sign-On RelayState Okta RelayState OneLogin RelayState JumpCloud RelayState https://<host>/adf s/ls/idpinitiateds ignon.aspx?RelaySt ate=RPID=<relaying -party-uri> https://myapps.mic rosoft.com/signin/ <app_id>?tenantId= <tenant_id> https://<sub-domai n>.sso.duosecurity .com/saml2/sp/<app _id>/sso https://<sub_domai n>.okta.com/app/<a pp_name>/<app_id>/ sso/saml https://<sub-domai n>.onelogin.com/tr ust/saml2/http-pos t/sso/<app-id> https://sso.jumpcl oud.com/saml2/<app -id> SAML 2.0 integration 178 Amazon WorkSpaces Administration Guide Identity provider Parameter User access URL Auth0 RelayState PingFederate TargetResource PingOne for Enterprise TargetResource https://<DefaultTe natName>.us.auth0. com/samlp/<Client_ Id> https://<host>/idp /startSSO.ping?Par tnerSpId=<sp_id> https://sso.connec t.pingidentity.com /sso/sp/initsso?sa asid=<app_id>&idpi d=<idp_id> The user access URL is usually deﬁned by the provider for unsolicited IdP-initiated SSO. A user can enter this URL in a web browser to federate directly to the SAML application. To test the user access URL and parameter values for your IdP, choose Test. Copy and paste the test URL to a private window in your current browser or another browser to test the SAML 2.0 logon without disrupting your current AWS management console session. When IdP-initiated ﬂow opens, you can register your WorkSpaces client. For more information, see Identity provider (IdP)-initiated ﬂow. 8. Manage fallback settings by checking or unchecking Allow clients that do not support SAML 2.0 to login. Enable this setting to continue providing your users access to WorkSpaces using client types or versions that do not support SAML 2.0 or if users need time to upgrade to the latest client version. Note This setting allows users to bypass SAML 2.0 and log in using directory authentication using older client versions. 9. To use SAML with the web client, enable Web Access. For more information, see Enable and conﬁgure Amazon WorkSpaces Web Access. SAML 2.0 integration 179 Amazon WorkSpaces Note PCoIP with SAML is not supported on Web Access. Administration Guide 10. Choose Save. Your WorkSpaces directory is now enabled with SAML 2.0 integration. You can use the IdP-initiated and client application-initiated ﬂows to register WorkSpaces client applications and sign in to WorkSpaces. Certiﬁcate-based authentication and WorkSpaces Personal You
workspaces-ag-048	workspaces-ag.pdf	48	latest client version. Note This setting allows users to bypass SAML 2.0 and log in using directory authentication using older client versions. 9. To use SAML with the web client, enable Web Access. For more information, see Enable and conﬁgure Amazon WorkSpaces Web Access. SAML 2.0 integration 179 Amazon WorkSpaces Note PCoIP with SAML is not supported on Web Access. Administration Guide 10. Choose Save. Your WorkSpaces directory is now enabled with SAML 2.0 integration. You can use the IdP-initiated and client application-initiated ﬂows to register WorkSpaces client applications and sign in to WorkSpaces. Certiﬁcate-based authentication and WorkSpaces Personal You can use certiﬁcate-based authentication with WorkSpaces to remove the user prompt for the Active Directory domain password. By using certiﬁcate-based authentication with your Active Directory domain, you can: • Rely on your SAML 2.0 identity provider to authenticate the user and provide SAML assertions to match the user in Active Directory. • Enable a single sign-on logon experience with fewer user prompts. • Enable passwordless authentication ﬂows using your SAML 2.0 identity provider. Certiﬁcate-based authentication uses AWS Private CA resources in your AWS account. AWS Private CA enables creation of private certiﬁcate authority (CA) hierarchies, including root and subordinate CAs. With AWS Private CA, you can create your own CA hierarchy and issue certiﬁcates with it for authenticating internal users. For more information, see the AWS Private Certiﬁcate Authority User Guide. When using AWS Private CA for certiﬁcate-based authentication, WorkSpaces will request certiﬁcates for your users automatically during session authentication. Users are authenticated to Active Directory using a virtual smart card provisioned with the certiﬁcates. Certiﬁcate-based authentication is supported with Windows WorkSpaces on DCV bundles using the latest WorkSpaces Web Access, Windows, and macOS client applications. Open Amazon WorkSpaces Client downloads to ﬁnd the latest versions: • Windows client version 5.5.0 or later • macOS client version 5.6.0 or later SAML 2.0 integration 180 Amazon WorkSpaces Administration Guide For more information on conﬁguring certiﬁcate-based authentication with Amazon WorkSpaces, see How to conﬁgure certiﬁcate-based authentication for Amazon WorkSpaces and Design considerations in highly regulated environments for Certiﬁcate Based Authentication with AppStream 2.0 and WorkSpaces . Prerequisites Complete the following steps before enabling certiﬁcate-based authentication. 1. Conﬁgure your WorkSpaces directory with SAML 2.0 integration to use certiﬁcate-based authentication. For more information, see WorkSpaces Integration with SAML 2.0. 2. Conﬁgure the userPrincipalName attribute in your SAML assertion. For more information, see Create Assertions for the SAML Authentication Response. 3. Conﬁgure the ObjectSid attribute in your SAML assertion. This is required to perform strong mapping to the Active Directory user. Certiﬁcate-based authentication will fail if the attribute does not match the Active Directory security identiﬁer (SID) for user speciﬁed in the SAML_Subject NameID. For more information, see Create Assertions for the SAML Authentication Response. Note According to Microsoft KB5014754, the ObjectSid attribute will become mandatory for certiﬁcate-based authentication after September 10, 2025. 4. Add the sts:TagSession permission to your IAM role trust policy used with your SAML 2.0 conﬁguration if it is not already present. This permission is required to use certiﬁcate-based authentication. For more information, see Create a SAML 2.0 Federation IAM Role. 5. Create a private certiﬁcate authority (CA) using AWS Private CA if you do not have one conﬁgured with your Active Directory. AWS Private CA is required to use certiﬁcate-based authentication. For more information, see Planning your AWS Private CA deployment and follow the guidance to conﬁgure a CA for certiﬁcate-based authentication. The following AWS Private CA settings are the most common for certiﬁcate-based authentication use cases: a. CA type options: i. Short-lived certiﬁcate CA usage mode (recommended if you are only using the CA to issue end user certiﬁcates for certiﬁcate-based authentication) ii. Single level hierarchy with a Root CA (alternatively, choose a subordinate CA if you want to integrate with an existing CA hierarchy) SAML 2.0 integration 181 Amazon WorkSpaces Administration Guide b. Key algorithm options: RSA 2048 c. Subject distinguished name options: Use any combination of options to identify the CA in your Active Directory Trusted Root Certiﬁcation Authorities store. d. Certiﬁcate revocation options: CRL distribution Note Certiﬁcate-based authentication requires an online CRL distribution point accessible from desktops and the domain controller. This requires unauthenticated access to the Amazon S3 bucket conﬁgured for Private CA CRL entries, or a CloudFront distribution that will have access to the S3 bucket if it is blocking public access. For more information on these options, see Planning a certiﬁcate revocation list (CRL). 6. Tag your private CA with a key entitled euc-private-ca to designate the CA for use with EUC certiﬁcate-based authentication. The key does not require a value. For more information, see Managing tags for your private CA. 7. Certiﬁcate-based authentication utilizes virtual smart cards for logon. Following the Guidelines for enabling smart card logon with third-party certiﬁcation authorities in
workspaces-ag-049	workspaces-ag.pdf	49	the Amazon S3 bucket conﬁgured for Private CA CRL entries, or a CloudFront distribution that will have access to the S3 bucket if it is blocking public access. For more information on these options, see Planning a certiﬁcate revocation list (CRL). 6. Tag your private CA with a key entitled euc-private-ca to designate the CA for use with EUC certiﬁcate-based authentication. The key does not require a value. For more information, see Managing tags for your private CA. 7. Certiﬁcate-based authentication utilizes virtual smart cards for logon. Following the Guidelines for enabling smart card logon with third-party certiﬁcation authorities in Active Directory, perform the following steps: • Conﬁgure domain controllers with a domain controller certiﬁcate to authenticate smart card users. If you have an Active Directory Certiﬁcate Services enterprise CA conﬁgured in your Active Directory, domain controllers are automatically enrolled with certiﬁcates to enable smart card logon. If you don't have Active Directory Certiﬁcate Services, see Requirements for domain controller certiﬁcates from a third-party CA. You can create a domain controller certiﬁcate with AWS Private CA. If you do this, don't use a private CA conﬁgured for short- lived certiﬁcates. Note If you are using AWS Managed Microsoft AD, you can conﬁgure Certiﬁcate Services on an EC2 instance to satisfy the requirement for domain controller certiﬁcates. See AWS Launch Wizard for example deployments of AWS Managed Microsoft AD conﬁgured with Active Directory Certiﬁcate Services. AWS Private CA can be conﬁgured as a subordinate to the Active Directory Certiﬁcate Services CA, or can be conﬁgured as its own root when using AWS Managed Microsoft AD. SAML 2.0 integration 182 Amazon WorkSpaces Administration Guide An additional conﬁguration task with AWS Managed Microsoft AD and Active Directory Certiﬁcate Services is to create outbound rules from the controllers VPC security group to the EC2 instance running Certiﬁcate Services allowing TCP ports 135 and 49152-65535 to enable certiﬁcate autoenrollment. In addition, the EC2 instance running must allow inbound access on the same ports from domain instances, including domain controllers. For more information on locating the security group for AWS Managed Microsoft AD see Conﬁgure your VPC subnets and security groups. • On the AWS Private CA console or using the SDK or CLI, select your CA and under the CA certiﬁcate, export the CA private certiﬁcate. For more information, see Exporting a private certiﬁcate. • Publish the CA to Active Directory. Logon to a domain controller or a domain-joined machine. Copy the CA private certiﬁcate to any <path>\<file> and run the following commands as a domain administrator. Alternatively, you can use Group Policy and the Microsoft PKI Health Tool (PKIView) tool to publish the CA. For more information, see Conﬁguration instructions. certutil -dspublish -f <path>\<file> RootCA certutil -dspublish -f <path>\<file> NTAuthCA Ensure that the commands complete successfully, and then remove the private certiﬁcate ﬁle. Depending on Active Directory replication settings, it can take several minutes for the CA to be published to your domain controllers and desktop instances. Note • It is required that Active Directory distribute the CA to the Trusted Root Certiﬁcation Authorities and Enterprise NTAuth stores automatically for WorkSpaces desktops when they are joined to the domain. Enable certiﬁcate-based authentication Complete the following steps to enable certiﬁcate-based authentication. 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 ID for your WorkSpaces. SAML 2.0 integration 183 Amazon WorkSpaces Administration Guide 4. Under Authentication, click Edit. 5. Click Edit Certiﬁcate-Based Authentication. 6. Check Enable Certiﬁcate-Based Authentication. 7. Conﬁrm that your private CA ARN is associated in the list. The private CA should be in the same AWS account and AWS Region, and must be tagged with a key entitled euc-private-ca to appear in the list. 8. Click Save Changes. Certiﬁcate-based authentication is now enabled. 9. Reboot your Windows WorkSpaces on DCV bundles for the changes to take eﬀect. For more information, see Reboot a WorkSpace. 10. After rebooting, when users authenticate via SAML 2.0 using a supported client, they will no longer receive a prompt for the domain password. Note When certiﬁcate-based authentication is enabled to sign in to WorkSpaces, users are not prompted for multi-factor authentication (MFA) even if enabled on the Directory. When using certiﬁcate-based authentication, MFA can be enabled through your SAML 2.0 identity provider. For more information on AWS Directory Service MFA, see Multi-factor authentication (AD Connector) or Enable multi-factor authentication for AWS Managed Microsoft AD. Manage certiﬁcate-based authentication CA Certiﬁcate In a typical conﬁguration, the private CA certiﬁcate has a validity period of 10 years. See Managing the private CA lifecycle for more information on replacing a CA with an expired certiﬁcate, or reissuing the CA with a new validity period. End User Certiﬁcates End user certiﬁcates issued by AWS Private CA for WorkSpaces certiﬁcate-based authentication don't require renewal or
workspaces-ag-050	workspaces-ag.pdf	50	using certiﬁcate-based authentication, MFA can be enabled through your SAML 2.0 identity provider. For more information on AWS Directory Service MFA, see Multi-factor authentication (AD Connector) or Enable multi-factor authentication for AWS Managed Microsoft AD. Manage certiﬁcate-based authentication CA Certiﬁcate In a typical conﬁguration, the private CA certiﬁcate has a validity period of 10 years. See Managing the private CA lifecycle for more information on replacing a CA with an expired certiﬁcate, or reissuing the CA with a new validity period. End User Certiﬁcates End user certiﬁcates issued by AWS Private CA for WorkSpaces certiﬁcate-based authentication don't require renewal or revocation. These certiﬁcates are short-lived. WorkSpaces automatically issues a new certiﬁcate every 24 hours. These end user certiﬁcates have a shorter validity period than a typical AWS Private CA CRL distribution. As a result, end user certiﬁcates don't need to be revoked and won't appear in a CRL. SAML 2.0 integration 184 Amazon WorkSpaces Audit Reports Administration Guide You can create an audit report to list all of the certiﬁcates that your private CA has issued or revoked. For more information, see Using audit reports with your private CA. Logging and Monitoring You can use AWS CloudTrail to record API calls to AWS Private CA by WorkSpaces. For more information, see Using CloudTrail. In CloudTrail Event history you can view GetCertificate and IssueCertificate event names from acm-pca.amazonaws.com event source made by the WorkSpaces EcmAssumeRoleSession user name. These events will be recorded for every EUC certiﬁcate-based authentication request. Enable cross-account PCA sharing When you use Private CA cross-account sharing, you can grant other accounts permissions to use a centralized CA, which removes the needs for a Private CA in every account. The CA can generate and issue certiﬁcates by using AWS Resource Access Manager to manage permissions. Private CA cross-account sharing can be used with WorkSpaces certiﬁcate-based Authentication (CBA) within the same AWS Region. To use a shared Private CA resource with WorkSpaces CBA 1. Conﬁgure the Private CA for CBA in a centralized AWS account. For more information, see Certiﬁcate-based authentication and WorkSpaces Personal. 2. Share the Private CA with the resource AWS accounts where WorkSpaces resources utilize CBA by following the steps in How to use AWS RAM to share your ACM Private CA cross- account. You don't need to complete step 3 to create a certiﬁcate. You can either share the Private CA with individual AWS accounts, or share through AWS Organizations. To share with individual accounts, you need to accept the shared Private CA in your resource account by using the Resource Access Manager (RAM) console or APIs. When conﬁguring the share, conﬁrm that the RAM resource share for the Private CA in the resource account is using the AWSRAMBlankEndEntityCertificateAPICSRPassthroughIssuanceCertificateAuthority managed permission template. This template aligns with the PCA template used by the WorkSpaces service role when issuing CBA certiﬁcates. 3. After the share is successful, you should be able to view the shared Private CA by using the Private CA console in the resource account. SAML 2.0 integration 185 Amazon WorkSpaces Administration Guide 4. Use the API or CLI to associate the Private CA ARN with CBA in your WorkSpaces directory properties. At this time, the WorkSpaces console doesn't support selection of shared Private CA ARNs. Example CLI commands: aws workspaces modify-certificate-based-auth-properties —resource-id <value> — certificate-based-auth-properties Status=<value>,CertificateAuthorityArn=<value> Access Microsoft Entra ID-joined WorkSpaces Personal You can create Windows 10 or 11 BYOL personal WorkSpaces that are Microsoft Entra ID-joined and enrolled to Intune. For more details, see Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal. Authentication workﬂow The following sections describe the authentication workﬂow initiated by WorkSpaces client application, WorkSpaces Web Access, and a SAML 2.0 identity provider (IdP), Microsoft Entra ID: • When the ﬂow is initiated by the IdP. For example, when users choose an application in the Entra ID’s user portal in a web browser.. • When the ﬂow is initiated by the WorkSpaces client. For example, when users open the client application and sign in. • When the ﬂow is initiated by WorkSpaces Web Access. For example, when users open Web Access in a browser and sign in. In these examples, users enter [email protected] sign in to the IdP. On Entra ID, an enterprise application is conﬁgured to integrate with IAM Identity Center. Users create a WorkSpace for their user names in a directory that uses IAM Identity Center as the identity source to connect to an Entra ID tenant. Additionally, users install the WorkSpaces client application on their device or the user uses Web Access in a web browser. Identity provider (IdP)-initiated ﬂow with client application The IdP-initiated ﬂow allows users to automatically register the WorkSpaces client application on their devices without having to enter a WorkSpaces registration code. Users don't sign in to their Microsoft Entra ID access 186
workspaces-ag-051	workspaces-ag.pdf	51	ID, an enterprise application is conﬁgured to integrate with IAM Identity Center. Users create a WorkSpace for their user names in a directory that uses IAM Identity Center as the identity source to connect to an Entra ID tenant. Additionally, users install the WorkSpaces client application on their device or the user uses Web Access in a web browser. Identity provider (IdP)-initiated ﬂow with client application The IdP-initiated ﬂow allows users to automatically register the WorkSpaces client application on their devices without having to enter a WorkSpaces registration code. Users don't sign in to their Microsoft Entra ID access 186 Amazon WorkSpaces Administration Guide WorkSpaces using the IdP-initiated ﬂow. WorkSpaces authentication must originate from the client application. 1. Using their web browser, users sign in to the IdP (Microsoft Entra ID). 2. After signing in to the IdP, users choose the AWS IAM Identity Center application from the IdP user portal. 3. Users are redirected to the AWS access portal in the browser. Then, users choose the WorkSpaces icon. 4. Users are redirected to the page below and the WorkSpaces client application is opened automatically. Choose Open Amazon WorkSpaces app if the client application doesn't opened automatically. 5. The WorkSpaces client application is now registered and users can continue to sign by clicking Continue to sign in to WorkSpaces. Identity provider (IdP)-initiated ﬂow with Web Access The IdP-initiated Web Access ﬂow allows users to automatically register their WorkSpaces through a web browser without having to enter a WorkSpaces registration code. Users don't sign in to their WorkSpaces using the IdP-initiated ﬂow. WorkSpaces authentication must originate from Web Access. 1. Using their web browser, users sign in to the IdP. 2. After signing in to the IdP, users click the AWS IAM Identity Center application from the IdP user portal. Microsoft Entra ID access 187 Amazon WorkSpaces Administration Guide 3. Users are redirected to AWS access portal in the browser. Then, users choose the WorkSpaces icon. 4. Users are redirected to this page in the browser. To open WorkSpaces, choose Amazon WorkSpaces in the browser. 5. The WorkSpaces client application is now registered and users can continue to sign in through WorkSpaces Web Access. WorkSpaces client-initiated ﬂow The client-initiated ﬂow allows users to sign in to their WorkSpaces after signing in to an IdP. 1. Users launch the WorkSpaces client application (if it isn't already running) and clicks Continue to sign in to WorkSpaces. 2. Users are redirected to their default web browser to sign in to the IdP. If the users are already signed in to the IdP in their browser, they don't need to sign in again and will skip this step. 3. Once signed in to the IdP, users are redirected to a pop up. Follow the prompts to allow your web browser to open the client application. 4. Users are redirected to the WorkSpaces client application, on Windows login screen. 5. Users complete sign-in to Windows using their Entra ID username and credentials. WorkSpaces Web Access-initiated ﬂow The Web Access-initiated ﬂow allows users to sign in to their WorkSpaces after signing in to an IdP. Microsoft Entra ID access 188 Amazon WorkSpaces Administration Guide 1. Users launch the WorkSpaces Web Access and chooses Sign in. 2. In the same browser tab, users are redirected to IdP portal. If the users are already signed in to the IdP in their browser, they don't need to sign in again and can skip this step. 3. Once signed in to the IdP, users redirected to this page in the browser, and clicks Log in to WorkSpaces. 4. Users are redirected to the WorkSpaces client application, on the Windows login screen. 5. Users complete sign-in to Windows using their Entra ID username and credentials. First-time user experience If you're logging in for the ﬁrst time to a Microsoft Entra ID-joined Windows WorkSpaces, you must go through the out-of-box experience (OOBE). During OOBE, the WorkSpaces are joined to Entra ID. You can customize the OOBE experience by conﬁguring the Autopilot proﬁle assigned to the Microsoft Intune device group that you create for your WorkSpaces. For more information, see Step 3: Conﬁgure Windows Autopilot user-driven mode. Use smart cards for authentication in WorkSpaces Personal Windows and Linux WorkSpaces on DCV bundles allow the use of Common Access Card (CAC) and Personal Identity Veriﬁcation (PIV) smart cards for authentication. Amazon WorkSpaces supports the use of smart cards for both pre-session authentication and in-session authentication. Pre-session authentication refers to smart card authentication that's performed while users are logging in to their WorkSpaces. In-session authentication refers to authentication that's performed after logging in. For example, users can use smart cards for in-session authentication while working with web browsers and applications. They can also use smart cards for actions that require administrative permissions. For example, if the
workspaces-ag-052	workspaces-ag.pdf	52	Personal Windows and Linux WorkSpaces on DCV bundles allow the use of Common Access Card (CAC) and Personal Identity Veriﬁcation (PIV) smart cards for authentication. Amazon WorkSpaces supports the use of smart cards for both pre-session authentication and in-session authentication. Pre-session authentication refers to smart card authentication that's performed while users are logging in to their WorkSpaces. In-session authentication refers to authentication that's performed after logging in. For example, users can use smart cards for in-session authentication while working with web browsers and applications. They can also use smart cards for actions that require administrative permissions. For example, if the user has administrative permissions on their Linux WorkSpace, they can use smart cards to authenticate themselves when running sudo and sudo -i commands. Contents • Requirements • Limitations • Directory conﬁguration • Enable smart cards for Windows WorkSpaces Smart card authentication 189 Amazon WorkSpaces Administration Guide • Enable smart cards for Linux WorkSpaces Requirements • An Active Directory Connector (AD Connector) directory is required for pre-session authentication. AD Connector uses certiﬁcate-based mutual Transport Layer Security (mutual TLS) authentication to authenticate users to Active Directory using a hardware or software-based smart card certiﬁcate. For more information about how to conﬁgure your AD Connector and your on-premises directory, see Directory conﬁguration. • To use a smart card with a Windows or Linux WorkSpace, the user must use the Amazon WorkSpaces Windows client version 3.1.1 or later or the WorkSpaces macOS client version 3.1.5 or later. For more information about using smart cards with the Windows and macOS clients, see Smart Card Support in the Amazon WorkSpaces User Guide. • The root CA and smart card certiﬁcates must meet certain requirements. For more information, see Enable mTLS authentication in AD Connector for use with smart cards in the AWS Directory Service Administration Guide and Certiﬁcate Requirements in the Microsoft documentation. In addition to those requirements, user certiﬁcates employed for smart card authentication to Amazon WorkSpaces must include the following attributes: • The AD user's userPrincipalName (UPN) in the subjectAltName (SAN) ﬁeld of the certiﬁcate. We recommend issuing smart card certiﬁcates for the user's default UPN. • The Client Authentication (1.3.6.1.5.5.7.3.2) Extended Key Usage (EKU) attribute. • The Smart Card Logon (1.3.6.1.4.1.311.20.2.2) EKU attribute. • For pre-session authentication, Online Certiﬁcate Status Protocol (OCSP) is required for certiﬁcate revocation checking. For in-session authentication, OCSP is recommended, but not required. Limitations • Only the WorkSpaces Windows client application version 3.1.1 or later and the macOS client application version 3.1.5 or later are currently supported for smart card authentication. • The WorkSpaces Windows client application 3.1.1 or later supports smart cards only when the client is running on a 64-bit version of Windows. • Ubuntu WorkSpaces does not currently support smart card authentication. • Only AD Connector directories are currently supported for smart card authentication. Smart card authentication 190 Amazon WorkSpaces Administration Guide • In-session authentication is available in all Regions where DCV is supported. Pre-session authentication is available in the following Regions: • Asia Paciﬁc (Sydney) Region • Asia Paciﬁc (Tokyo) Region • Europe (Ireland) Region • AWS GovCloud (US-East) Region • AWS GovCloud (US-West) Region • US East (N. Virginia) Region • US West (Oregon) Region • For in-session authentication and pre-session authentication on Linux or Windows WorkSpaces, only one smart card is currently allowed at a time. • For pre-session authentication, enabling both smart card authentication and sign-in authentication on the same directory is not currently supported. • Only CAC and PIV cards are supported at this time. Other types of hardware or software-based smart cards might also work, but they haven't been fully tested for use with DCV. Directory conﬁguration To enable smart card authentication, you must conﬁgure your AD Connector directory and your on- premises directory in the following manner. AD Connector directory conﬁguration Before you begin, make sure your AD Connector directory has been set up as described in AD Connector Prerequisites in the AWS Directory Service Administration Guide. In particular, make sure that you have opened up the necessary ports in your ﬁrewall. To ﬁnish conﬁguring your AD Connector directory, follow the instructions in Enable mTLS authentication in AD Connector for use with smart cards in the AWS Directory Service Administration Guide. Note Smart card authentication requires Kerberos Constrained Delegation (KCD) to function properly. KCD requires the username portion of the AD Connector service account to match the sAMAccountName of the same user. A sAMAccountName can't exceed 20 characters. Smart card authentication 191 Amazon WorkSpaces Administration Guide On-premises directory conﬁguration In addition to conﬁguring your AD Connector directory, you must also make sure that the certiﬁcates that are issued to the domain controllers for your on-premises directory have the "KDC Authentication" extended key usage (EKU) set. To do this, use the Active Directory Domain Services (AD DS) default Kerberos Authentication
workspaces-ag-053	workspaces-ag.pdf	53	Administration Guide. Note Smart card authentication requires Kerberos Constrained Delegation (KCD) to function properly. KCD requires the username portion of the AD Connector service account to match the sAMAccountName of the same user. A sAMAccountName can't exceed 20 characters. Smart card authentication 191 Amazon WorkSpaces Administration Guide On-premises directory conﬁguration In addition to conﬁguring your AD Connector directory, you must also make sure that the certiﬁcates that are issued to the domain controllers for your on-premises directory have the "KDC Authentication" extended key usage (EKU) set. To do this, use the Active Directory Domain Services (AD DS) default Kerberos Authentication certiﬁcate template. Do not use a Domain Controller certiﬁcate template or a Domain Controller Authentication certiﬁcate template because those templates don't contain the necessary settings for smart card authentication. Enable smart cards for Windows WorkSpaces For general guidance on how to enable smart card authentication on Windows, see Guidelines for enabling smart card logon with third-party certiﬁcation authorities in the Microsoft documentation. To detect the Windows lock screen and disconnect the session To allow users to unlock Windows WorkSpaces that are enabled for smart card pre-session authentication when the screen is locked, you can enable Windows lock screen detection in users' sessions. When the Windows lock screen is detected, the WorkSpace session is disconnected, and the user can reconnect from the WorkSpaces client by using their smart card. You can enable disconnecting the session when the Windows lock screen is detected by using Group Policy settings. For more information, see Enable or disable disconnect session on screen lock for DCV. To enable in-session or pre-session authentication By default, Windows WorkSpaces are not enabled to support the use of smart cards for pre-session or in-session authentication. If needed, you can enable in-session and pre-session authentication for Windows WorkSpaces by using Group Policy settings. For more information, see Enable or disable smart card redirection for DCV. To use pre-session authentication, in addition to updating the Group Policy settings, you must also enable pre-session authentication through your AD Connector directory settings. For more information, follow the instructions in Enable mTLS authentication in AD Connector for use in smart cards in the AWS Directory Service Administration Guide. To enable users to use smart cards in a browser Smart card authentication 192 Amazon WorkSpaces Administration Guide If your users are using Chrome as their browser, no special conﬁguration is required to use smart cards. If your users are using Firefox as their browser, you can enable your users to use smart cards in Firefox through Group Policy. You can use these Firefox Group Policy templates in GitHub. For example, you can install the 64-bit version of OpenSC for Windows to support PKCS #11, and then use the following Group Policy setting, where NAME_OF_DEVICE is whatever value you want to use to identify PKCS #11, such as OpenSC, and where PATH_TO_LIBRARY_FOR_DEVICE is the path to the PKCS #11 module. This path should point to a library with a .DLL extension, such as C: \Program Files\OpenSC Project\OpenSC\pkcs11\onepin-opensc-pkcs11.dll. Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE = PATH_TO_LIBRARY_FOR_DEVICE Tip If you're using OpenSC, you can also load the OpenSC pkcs11 module into Firefox by running the pkcs11-register.exe program. To run this program, either double- click the ﬁle at C:\Program Files\OpenSC Project\OpenSC\tools\pkcs11- register.exe, or open a Command Prompt window and run the following command: "C:\Program Files\OpenSC Project\OpenSC\tools\pkcs11-register.exe" To verify that the OpenSC pkcs11 module has been loaded into Firefox, do the following: 1. If Firefox is already running, close it. 2. Open Firefox. Choose the menu button in the upper-right corner, and then choose Options. 3. On the about:preferences page, in the left navigation pane, choose Privacy & Security. 4. Under Certiﬁcates, choose Security Devices. 5. In the Device Manager dialog box, you should see OpenSC smartcard framework (0.21) in the left navigation, and it should have the following values when you select it: Module: OpenSC smartcard framework (0.21) Smart card authentication 193 Amazon WorkSpaces Administration Guide Path: C:\Program Files\OpenSC Project\OpenSC\pkcs11\onepin-opensc- pkcs11.dll Troubleshooting For information about troubleshooting smart cards, see Certiﬁcate and conﬁguration problems in the Microsoft documentation. Some common issues that can cause problems: • Incorrect mapping of the slots to the certiﬁcates. • Having multiple certiﬁcates on the smart card that can match the user. Certiﬁcates are matched using the following criteria: • The root CA for the certiﬁcate. • The <KU> and <EKU> ﬁelds of the certiﬁcate. • The UPN in the certiﬁcate subject. • Having multiple certiﬁcates that have <EKU>msScLogin in their key usage. In general, it's best to have only one certiﬁcate for smart card authentication that is mapped to the very ﬁrst slot in the smart card. The tools for managing the certiﬁcates and keys on the smart card (such as removing or remapping the certiﬁcates and keys) might be manufacturer-speciﬁc. For more information, see the documentation provided by the
workspaces-ag-054	workspaces-ag.pdf	54	user. Certiﬁcates are matched using the following criteria: • The root CA for the certiﬁcate. • The <KU> and <EKU> ﬁelds of the certiﬁcate. • The UPN in the certiﬁcate subject. • Having multiple certiﬁcates that have <EKU>msScLogin in their key usage. In general, it's best to have only one certiﬁcate for smart card authentication that is mapped to the very ﬁrst slot in the smart card. The tools for managing the certiﬁcates and keys on the smart card (such as removing or remapping the certiﬁcates and keys) might be manufacturer-speciﬁc. For more information, see the documentation provided by the manufacturer of your smart cards. Enable smart cards for Linux WorkSpaces Note Linux WorkSpaces on DCV currently have the following limitations: • Clipboard, audio-in, video-in, and time zone redirection aren't supported. • Multiple monitors aren't supported. • You must use the WorkSpaces Windows client application to connect to Linux WorkSpaces on DCV. Smart card authentication 194 Amazon WorkSpaces Administration Guide To enable the use of smart cards on Linux WorkSpaces, you need to include a root CA certiﬁcate ﬁle in the PEM format in the WorkSpace image. To obtain your root CA certiﬁcate You can obtain your root CA certiﬁcate in several ways: • You can use a root CA certiﬁcate operated by a third-party certiﬁcation authority. • You can export your own root CA certiﬁcate by using the Web Enrollment site, which is either http://ip_address/certsrv or http://fqdn/certsrv, where ip_address and fqdn are the IP address and the fully qualiﬁed domain name (FQDN) of the root certiﬁcation CA server. For more information about using the Web Enrollment site, see How to export a Root Certiﬁcation Authority Certiﬁcate in the Microsoft documentation. • You can use the following procedure to export the root CA certiﬁcate from a root CA certiﬁcation server that is running Active Directory Certiﬁcate Services (AD CS). For information about installing AD CS, see Install the Certiﬁcation Authority in the Microsoft documentation. 1. 2. Log into the root CA server using an administrator account. From the Windows Start menu, open a command prompt window (Start > Windows System > Command Prompt). 3. Use the following command to export the root CA certiﬁcate to a new ﬁle, where rootca.cer is the name of the new ﬁle: certutil -ca.cert rootca.cer For more information about running certutil, see certutil in the Microsoft documentation. 4. Use the following OpenSSL command to convert the exported root CA certiﬁcate from DER format to PEM format, where rootca is the name of the certiﬁcate. For more information about OpenSSL, see www.openssl.org. openssl x509 -inform der -in rootca.cer -out /tmp/rootca.pem To add your root CA certiﬁcate to your Linux WorkSpaces To assist you with enabling smart cards, we've added the enable_smartcard script to our Amazon Linux DCV bundles. This script performs the following actions: Smart card authentication 195 Amazon WorkSpaces Administration Guide • Imports your root CA certiﬁcate into the Network Security Services (NSS) database. • Installs the pam_pkcs11 module for Pluggable Authentication Module (PAM) authentication. • Performs a default conﬁguration, which includes enabling pkinit during WorkSpace provisioning. The following procedure explains how to use the enable_smartcard script to add your root CA certiﬁcate to your Linux WorkSpaces and to enable smart cards for your Linux WorkSpaces. 1. Create a new Linux WorkSpace with the DCV protocol enabled. When launching the WorkSpace in the Amazon WorkSpaces console, on the Select Bundles page, be sure to select DCV for the protocol, and then select one of the Amazon Linux 2 public bundles. 2. On the new WorkSpace, run the following command as root, where pem-path is the path to the root CA certiﬁcate ﬁle in PEM format. /usr/lib/skylight/enable_smartcard --ca-cert pem-path Note Linux WorkSpaces assume that the certiﬁcates on the smart cards are issued for the user's default user principal name (UPN), such as sAMAccountName@domain, where domain is a fully qualiﬁed domain name (FQDN). To use alternate UPN suﬃxes, run /usr/lib/skylight/enable_smartcard --help for more information. The mapping for alternate UPN suﬃxes is unique to each user. Therefore, that mapping must be performed individually on each user's WorkSpace. 3. (Optional) By default, all services are enabled to use smart card authentication on Linux WorkSpaces. To limit smart card authentication to only speciﬁc services, you must edit /etc/ pam.d/system-auth. Uncomment the auth line for pam_succeed_if.so and edit the list of services as needed. After the auth line is uncommented, to allow a service to use smart card authentication, you must add it to the list. To make a service use only password authentication, you must remove it from the list. 4. Perform any additional customizations to the WorkSpace. For example, you might want to add a system-wide policy to enable users to use smart cards in Firefox. (Chrome users must enable Smart card authentication 196 Amazon WorkSpaces Administration Guide smart
workspaces-ag-055	workspaces-ag.pdf	55	to only speciﬁc services, you must edit /etc/ pam.d/system-auth. Uncomment the auth line for pam_succeed_if.so and edit the list of services as needed. After the auth line is uncommented, to allow a service to use smart card authentication, you must add it to the list. To make a service use only password authentication, you must remove it from the list. 4. Perform any additional customizations to the WorkSpace. For example, you might want to add a system-wide policy to enable users to use smart cards in Firefox. (Chrome users must enable Smart card authentication 196 Amazon WorkSpaces Administration Guide smart cards on their clients themselves. For more information, see Smart Card Support in the Amazon WorkSpaces User Guide.) 5. Create a custom WorkSpace image and bundle from the WorkSpace. 6. Use the new custom bundle to launch WorkSpaces for your users. To enable users to use smart cards in Firefox You can enable your users to use smart cards in Firefox by adding a SecurityDevices policy to your Linux WorkSpace image. For more information about adding system-wide policies to Firefox, see the Mozilla policy templates on GitHub. 1. On the WorkSpace that you're using to create your WorkSpace image, create a new ﬁle named policies.json in /usr/lib64/firefox/distribution/. 2. In the JSON ﬁle, add the following SecurityDevices policy, where NAME_OF_DEVICE is whatever value you want to use to identify the pkcs module. For example, you might want to use a value such as "OpenSC": { "policies": { "SecurityDevices": { "NAME_OF_DEVICE": "/usr/lib64/opensc-pkcs11.so" } } } Troubleshooting For troubleshooting, we recommend adding the pkcs11-tools utility. This utility allows you to perform the following actions: • List each smart card. • List the slots on each smart card. • List the certiﬁcates on each smart card. Some common issues that can cause problems: • Incorrect mapping of the slots to the certiﬁcates. Smart card authentication 197 Amazon WorkSpaces Administration Guide • Having multiple certiﬁcates on the smart card that can match the user. Certiﬁcates are matched using the following criteria: • The root CA for the certiﬁcate. • The <KU> and <EKU> ﬁelds of the certiﬁcate. • The UPN in the certiﬁcate subject. • Having multiple certiﬁcates that have <EKU>msScLogin in their key usage. In general, it's best to have only one certiﬁcate for smart card authentication that is mapped to the very ﬁrst slot in the smart card. The tools for managing the certiﬁcates and keys on the smart card (such as removing or remapping the certiﬁcates and keys) might be manufacturer-speciﬁc. Additional tools that you can use to work with smart cards are: • opensc-explorer • opensc-tool • pkcs11_inspect • pkcs11_listcerts • pkcs15-tool To enable debug logging To troubleshoot your pam_pkcs11 and pam-krb5 conﬁguration, you can enable debug logging. 1. 2. 3. In the /etc/pam.d/system-auth-ac ﬁle, edit the auth action and change the nodebug parameter of pam_pksc11.so to debug. In the /etc/pam_pkcs11/pam_pkcs11.conf ﬁle, change debug = false; to debug = true;. The debug option applies separately to each mapper module, so you might need to change it both directly under the pam_pkcs11 section and also under the appropriate mapper section (by default, this is mapper generic). In the /etc/pam.d/system-auth-ac ﬁle, edit the auth action and add the debug or the debug_sensitive parameter to pam_krb5.so. After you've enabled debug logging, the system prints out pam_pkcs11 debug messages directly in the active terminal. Messages from pam_krb5 are logged in /var/log/secure. Smart card authentication 198 Amazon WorkSpaces Administration Guide To check which username a smart card certiﬁcate maps to, use the following pklogin_finder command: sudo pklogin_finder debug config_file=/etc/pam_pkcs11/pam_pkcs11.conf When prompted, enter the smart card PIN. pklogin_finder outputs on stdout the username on the smart card certiﬁcate in the form NETBIOS\username. This username should match the WorkSpace username. In Active Directory Domain Services (AD DS), the NetBIOS domain name is the pre-Windows 2000 domain name. Typically (but not always), the NetBIOS domain name is the subdomain of the Domain Name System (DNS) domain name. For example, if the DNS domain name is example.com, the NetBIOS domain name is usually EXAMPLE. If the DNS domain name is corp.example.com, the NetBIOS domain name is usually CORP. For example, for the user mmajor in the domain corp.example.com, the output from pklogin_finder is CORP\mmajor. Note If you receive the message "ERROR:pam_pkcs11.c:504: verify_certificate() failed", this message indicates that pam_pkcs11 has found a certiﬁcate on the smart card that matches the username criteria but that doesn't chain up to a root CA certiﬁcate that is recognized by the machine. When that happens, pam_pkcs11 outputs the above message and then tries the next certiﬁcate. It allows authentication only if it ﬁnds a certiﬁcate that both matches the username and chains up to a recognized root CA certiﬁcate. To troubleshoot your pam_krb5 conﬁguration, you can manually invoke kinit in debug mode with the following
workspaces-ag-056	workspaces-ag.pdf	56	from pklogin_finder is CORP\mmajor. Note If you receive the message "ERROR:pam_pkcs11.c:504: verify_certificate() failed", this message indicates that pam_pkcs11 has found a certiﬁcate on the smart card that matches the username criteria but that doesn't chain up to a root CA certiﬁcate that is recognized by the machine. When that happens, pam_pkcs11 outputs the above message and then tries the next certiﬁcate. It allows authentication only if it ﬁnds a certiﬁcate that both matches the username and chains up to a recognized root CA certiﬁcate. To troubleshoot your pam_krb5 conﬁguration, you can manually invoke kinit in debug mode with the following command: KRB5_TRACE=/dev/stdout kinit -V This command should successfully obtain a Kerberos Ticket Granting Ticket (TGT). If it fails, try adding the correct Kerberos principal name explicitly to the command. For example, for the user mmajor in the domain corp.example.com, use this command: Smart card authentication 199 Amazon WorkSpaces Administration Guide KRB5_TRACE=/dev/stdout kinit -V mmajor If this command succeeds, the issue is most likely in the mapping from the WorkSpace username to the Kerberos principal name. Check the [appdefaults]/pam/mappings section in the /etc/ krb5.conf ﬁle. If this command doesn't succeed, but a password-based kinit command does succeed, check the pkinit_-related conﬁgurations in the /etc/krb5.conf ﬁle. For example, if the smart card contains more than one certiﬁcate, you might need to make changes to pkinit_cert_match. Provide internet access for WorkSpaces Personal Your WorkSpaces must have access to the internet so that you can install updates to the operating system and deploy applications. You can use one of the following options to allow your WorkSpaces in a virtual private cloud (VPC) to access the internet. Options • Launch your WorkSpaces in private subnets and conﬁgure a NAT gateway in a public subnet in your VPC. • Launch your WorkSpaces in public subnets and automatically or manually assign public IP addresses to your WorkSpaces. For more information about these options, see the corresponding sections in Conﬁgure a VPC for WorkSpaces Personal. With any of these options, you must ensure that the security group for your WorkSpaces allows outbound traﬃc on ports 80 (HTTP) and 443 (HTTPS) to all destinations (0.0.0.0/0). Amazon Linux extras library If you are using the Amazon Linux repository, your Amazon Linux WorkSpaces must either have internet access or you must conﬁgure VPC endpoints to this repository and to the main Amazon Linux repository. For more information, see the Example: Enabling Access to the Amazon Linux AMI Repositories section in Endpoints for Amazon S3. The Amazon Linux AMI repositories are Amazon S3 buckets in each Region. If you want instances in your VPC to access the repositories through an endpoint, create an endpoint policy that enables access to these buckets. The following policy allows access to the Amazon Linux repositories. Internet access 200 Administration Guide Amazon WorkSpaces { "Statement": [ { "Sid": "AmazonLinux2AMIRepositoryAccess", "Principal": "", "Action": [ "s3:GetObject" ], "Effect": "Allow", "Resource": [ "arn:aws:s3:::amazonlinux..amazonaws.com/*" ] } ] } Security groups for WorkSpaces Personal When you register a directory with WorkSpaces, it creates two security groups, one for directory controllers and another for WorkSpaces in the directory. The security group for directory controllers has a name that consists of the directory identiﬁer followed by _controllers (for example, d-12345678e1_controllers). The security group for WorkSpaces has a name that consists of the directory identiﬁer followed by _workspacesMembers (for example, d-123456fc11_workspacesMembers). Warning Avoid modifying, deleting, or detaching the _controllers and the _workspacesMembers security groups. Be cautious when modifying or deleting these security groups, because you will not be able to recreate these groups and add them back after they have been modiﬁed or deleted. For more information, see Amazon EC2 security groups for Linux instance or Amazon EC2 security groups for Windows instances. You can add a default WorkSpaces security group to a directory. After you associate a new security group with a WorkSpaces directory, new WorkSpaces that you launch or existing WorkSpaces that you rebuild will have the new security group. You can also add this new default security group to existing WorkSpaces without rebuilding them, as explained later in this topic. Security groups 201 Amazon WorkSpaces Administration Guide When you associate multiple security groups with a WorkSpaces directory, the rules from each security group are eﬀectively aggregated to create one set of rules. We recommend condensing your security group rules as much as possible. For more information about security groups, see Security Groups for Your VPC in the Amazon VPC User Guide. To add a security group to a WorkSpaces directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select the directory and choose Actions, Update Details. Expand Security Group and select a security group. 5. Choose Update and Exit. To add a security group to an existing WorkSpace without rebuilding it, you assign the
workspaces-ag-057	workspaces-ag.pdf	57	group are eﬀectively aggregated to create one set of rules. We recommend condensing your security group rules as much as possible. For more information about security groups, see Security Groups for Your VPC in the Amazon VPC User Guide. To add a security group to a WorkSpaces directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select the directory and choose Actions, Update Details. Expand Security Group and select a security group. 5. Choose Update and Exit. To add a security group to an existing WorkSpace without rebuilding it, you assign the new security group to the elastic network interface (ENI) of the WorkSpace. To add a security group to an existing WorkSpace 1. Find the IP address for each WorkSpace that needs to be updated. a. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. b. Expand each WorkSpace and record its WorkSpace IP address. 2. Find the ENI for each WorkSpace and update its security group assignment. a. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. b. Under Network & Security, choose Network Interfaces. c. d. e. f. Search for the ﬁrst IP address that you recorded in Step 1. Select the ENI associated with the IP address, choose Actions, and then choose Change Security Groups. Select the new security group, and choose Save. Repeat this process as needed for any other WorkSpaces. Security groups 202 Amazon WorkSpaces Administration Guide IP access control groups for WorkSpaces Personal Amazon WorkSpaces allows you to control which IP addresses your WorkSpaces can be accessed from. By using IP address-based control groups, you can deﬁne and manage groups of trusted IP addresses, and only allow users to access their WorkSpaces when they're connected to a trusted network. An IP access control group acts as a virtual ﬁrewall that controls the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group, and then associate the group with your directory. You can associate each IP access control group with one or more directories. You can create up to 100 IP access control groups per Region per AWS account. However, you can only associate up to 25 IP access control groups with a single directory. A default IP access control group is associated with each directory. This default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory. If you don't associate an IP access control group with your directory, the default group is used. If you associate an IP access control group with a directory, the default IP access control group is disassociated. To specify the public IP addresses and ranges of IP addresses for your trusted networks, add rules to your IP access control groups. If your users access their WorkSpaces through a NAT gateway or VPN, you must create rules that allow traﬃc from the public IP addresses for the NAT gateway or VPN. Note • IP access control groups do not allow the use of dynamic IP addresses for NATs. If you're using a NAT, conﬁgure it to use a static IP address instead of a dynamic IP address. Make sure the NAT routes all the UDP traﬃc through the same static IP address for the duration of the WorkSpaces session. • IP access control groups control the IP addresses from which users can connect their streaming sessions to WorkSpaces. Users can still execute functionalities, such as restart, rebuild, shutdown, from any IP address using Amazon WorkSpaces public APIs. You can use this feature with Web Access, PCoIP zero clients, and the client applications for macOS, iPad, Windows, Chromebook, and Android. IP access control groups 203 Amazon WorkSpaces Administration Guide Create an IP access control group You can create an IP access control group as follows. Each IP access control group can contain up to 10 rules. To create an IP access control group 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose IP Access Controls. 3. Choose Create IP Group. 4. 5. 6. In the Create IP Group dialog box, enter a name and description for the group and choose Create. Select the group and choose Edit. For each IP address, choose Add Rule. For Source, enter the IP address or IP address range. For Description, enter a description. When you are done adding rules, choose Save. Associate an IP access control group with a directory You can associate an IP access control group with a directory to ensure that WorkSpaces are accessed only from trusted networks. If you associate an IP access control group that has no rules with a directory, this blocks all access to all WorkSpaces. To associate
workspaces-ag-058	workspaces-ag.pdf	58	a name and description for the group and choose Create. Select the group and choose Edit. For each IP address, choose Add Rule. For Source, enter the IP address or IP address range. For Description, enter a description. When you are done adding rules, choose Save. Associate an IP access control group with a directory You can associate an IP access control group with a directory to ensure that WorkSpaces are accessed only from trusted networks. If you associate an IP access control group that has no rules with a directory, this blocks all access to all WorkSpaces. To associate an IP access control group with a directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select the directory and choose Actions, Update Details. Expand IP Access Control Groups and select one or more IP access control groups. 5. Choose Update and Exit. Copy an IP access control group You can use an existing IP access control group as a base for creating a new IP access control group. IP access control groups 204 Amazon WorkSpaces Administration Guide To create an IP access control group from an existing one 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. 5. In the navigation pane, choose IP Access Controls. Select the group and choose Actions, Copy to New. In the Copy IP Group dialog box, enter a name and description for the new group and choose Copy Group. (Optional) To modify the rules copied from the original group, select the new group and choose Edit. Add, update, or remove rules as needed. Choose Save. Delete an IP access control group You can delete a rule from an IP access control group at any time. If you remove a rule that was used to allow a connection to a WorkSpace, the user is disconnected from the WorkSpace. Before you can delete an IP access control group, you must disassociate it from any directories. To delete an IP access control group 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. 5. In the navigation pane, choose Directories. For each directory that is associated with the IP access control group, select the directory and choose Actions, Update Details. Expand IP Access Control Groups, clear the check box for the IP access control group, and choose Update and Exit. In the navigation pane, choose IP Access Controls. Select the group and choose Actions, Delete IP Group. Set up PCoIP zero clients for WorkSpaces Personal PCoIP zero clients are compatible only with WorkSpaces bundles that are using the PCoIP protocol. If your zero client device has ﬁrmware version 6.0.0 or later, your users can connect to their WorkSpaces directly. When your users are connecting directly to their WorkSpaces using a zero client device, we recommend using multi-factor authentication (MFA) with your WorkSpaces directory. For more information about using MFA with your directory, see the following documentation: PCoIP zero client 205 Amazon WorkSpaces Administration Guide • AWS Managed Microsoft AD — Enable multi-factor authentication for AWS Managed Microsoft AD in the AWS Directory Service Administration Guide • AD Connector — Enable multi-factor authentication for AD Connector in the AWS Directory Service Administration Guide and Multi-factor authentication (AD Connector) for WorkSpaces Personal • Trusted domains — Enable multi-factor authentication for AWS Managed Microsoft AD in the AWS Directory Service Administration Guide • Simple AD — Multi-factor authentication is not available for Simple AD. As of April 13, 2021, PCoIP Connection Manager is no longer supported for use with zero client device ﬁrmware versions between 4.6.0 and 6.0.0. If your zero client ﬁrmware is not version 6.0.0 or later, you can get the latest ﬁrmware through a Desktop Access subscription at https:// www.teradici.com/desktop-access. Important • In the Teradici PCoIP Administrative Web Interface (AWI) or the Teradici PCoIP Management Console (MC), make sure you enable Network Time Protocol (NTP). For the NTP host DNS name, use pool.ntp.org, and set the NTP host port to 123. If NTP isn't enabled, your PCoIP zero client users might receive certiﬁcate failure errors, such as "The supplied certiﬁcate is invalid due to timestamp." • Starting with version 20.10.4 of the PCoIP agent, Amazon WorkSpaces disables USB redirection by default through the Windows registry. This registry setting aﬀects the behavior of USB peripherals when your users are using PCoIP zero client devices to connect to their WorkSpaces. For more information, see USB printers and other USB peripherals aren't working for PCoIP zero clients. For information about setting up and connecting with a PCoIP zero client device, see PCoIP Zero Client in the Amazon WorkSpaces User Guide. For a list of approved PCoIP zero client devices, see PCoIP Zero Clients on the Teradici website. PCoIP zero client 206 Amazon WorkSpaces Administration Guide Set up Android for Chromebook
workspaces-ag-059	workspaces-ag.pdf	59	USB redirection by default through the Windows registry. This registry setting aﬀects the behavior of USB peripherals when your users are using PCoIP zero client devices to connect to their WorkSpaces. For more information, see USB printers and other USB peripherals aren't working for PCoIP zero clients. For information about setting up and connecting with a PCoIP zero client device, see PCoIP Zero Client in the Amazon WorkSpaces User Guide. For a list of approved PCoIP zero client devices, see PCoIP Zero Clients on the Teradici website. PCoIP zero client 206 Amazon WorkSpaces Administration Guide Set up Android for Chromebook for WorkSpaces Personal Version 2.4.13 is the ﬁnal 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. Some Chromebooks launched before 2019 must be enabled to install Android apps before users can install the Amazon WorkSpaces Android client application. For more information, see Chrome OS Systems Supporting Android Apps. To remotely manage enabling your users' Chromebooks to install Android apps, see Set up Android on Chrome devices. Enable and conﬁgure WorkSpaces Web Access for WorkSpaces Personal Most WorkSpaces bundles support Amazon WorkSpaces Web Access. For a list of WorkSpaces that support web browser access, see "Which Amazon WorkSpaces bundles support Web Access?" in Client Access, Web Access, and User Experience. Note • Web Access with DCV for Windows and Ubuntu WorkSpaces is supported in all Regions where DCV WorkSpaces are available. DCV for Amazon Linux WorkSpaces is only available in AWS GovCloud (US-West). • We strongly recommend using Web Access with DCV WorkSpaces for best streaming quality and user experience. The following are limitations when using Web Access with PCoIP WorkSpaces: • Web Access with PCoIP is not supported in the AWS GovCloud (US) Regions, Asia Paciﬁc (Mumbai), Africa (Cape Town), Europe (Frankfurt), and Israel (Tel Aviv) • Web Access with PCoIP is only supported for Windows WorkSpaces, not with Amazon Linux or Ubuntu WorkSpaces. • Web Access is not available for some Windows 10 WorkSpaces that are using the PCoIP protocol. If your PCoIP WorkSpaces are powered by Windows Server 2019 or 2022, Web Access is not available. Set up Android for Chromebook 207 Amazon WorkSpaces Administration Guide • Web Access with PCoIP is limited in feature functionality. It supports video-out, audio- out, keyboard and mouse. It does not support many features, including video-in, audio- in, clipboard redirection, and web cams. • If you are using macOS on VPN and using the Firefox web browser, the web browser will not support streaming PCoIP WorkSpaces using WorkSpaces Web Access. This is due to a limitation in Firefox implementation of the WebRTC protocol. Important 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. Step 1: Enable Web Access to your WorkSpaces You control Web Access to your WorkSpaces at the directory level. For each directory containing WorkSpaces that you want to allow users to access through the Web Access client, do the following steps. To enable Web Access to your WorkSpaces 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Under the Directory ID column, choose the directory ID of the directory you want to enable Web Access for. 4. On the Directory Details page, scroll down to the Other platforms section and choose Edit. 5. Choose Web Access. 6. Choose Save. Note After you enable Web Access, reboot your WorkSpace for the change to apply. Conﬁgure web access 208 Amazon WorkSpaces Administration Guide Step 2: Conﬁgure inbound and outbound access to ports for Web Access Amazon WorkSpaces Web Access requires inbound and outbound access for certain ports. For more information, see Ports for Web Access. Step 3: Conﬁgure Group Policy and security policy settings to enable users to log on Amazon WorkSpaces relies on a speciﬁc logon screen conﬁguration 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 conﬁgure a Group Policy setting and three Security Policy settings. If these settings are not correctly conﬁgured, users might experience long logon times or black screens when they try to log on to their WorkSpaces. To conﬁgure these settings, use the following procedures. You can use Group Policy Objects (GPOs) to apply settings to manage Windows WorkSpaces or users that are part of your Windows WorkSpaces directory. We recommend that you create an organizational unit for your WorkSpaces Computer Objects and an organizational
workspaces-ag-060	workspaces-ag.pdf	60	their Web Access client. To enable Web Access users to log on to their WorkSpaces, you must conﬁgure a Group Policy setting and three Security Policy settings. If these settings are not correctly conﬁgured, users might experience long logon times or black screens when they try to log on to their WorkSpaces. To conﬁgure these settings, use the following procedures. You can use Group Policy Objects (GPOs) to apply settings to manage Windows WorkSpaces or users that are part of your Windows WorkSpaces directory. We recommend that you create an organizational unit for your WorkSpaces Computer Objects and an organizational unit for your WorkSpaces User Objects. For information about using the Active Directory administration tools to work with GPOs, see Installing the Active Directory Administration Tools in the AWS Directory Service Administration Guide. To enable the WorkSpaces logon agent to switch users In most cases, when a user attempts to log on to a WorkSpace, the user name ﬁeld is prepopulated with the name of that user. However, if an administrator has established an RDP connection to the WorkSpace to perform maintenance tasks, the user name ﬁeld is populated with the name of the administrator instead. To avoid this issue, disable the Hide entry points for Fast User Switching Group Policy setting. When you disable this setting, the WorkSpaces logon agent can use the Switch User button to populate the user name ﬁeld with the correct name. 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) Conﬁgure web access 209 Amazon WorkSpaces Administration Guide 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, System, and Logon. 4. Open the Hide entry points for Fast User Switching setting. 5. In the Hide entry points for Fast User Switching dialog box, choose Disabled, and then choose OK. To hide the last logged on user name By default, the list of last logged on users is displayed instead of the Switch User button. Depending on the conﬁguration of the WorkSpace, the list might not display the Other User tile. When this situation occurs, if the prepopulated user name isn't correct, the WorkSpaces logon agent can't populate the ﬁeld with the correct name. To avoid this issue, enable the Security Policy setting Interactive logon: Don't display last signed- in or Interactive logon: Do not display last user name (depending on which version of Windows you're using). 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open one of the following settings: • For Windows 7 — Interactive logon: Don't display last signed-in • For Windows 10 — Interactive logon: Do not display last user name 5. In the Properties dialog box for the setting, choose Enabled, and then choose OK. To require pressing CTRL+ALT+DEL before users can log on For WorkSpaces Web Access, you need to require that users press CTRL+ALT+DEL before they can log on. Requiring users to press CTRL+ALT+DEL before they log on ensures that users are using a trusted path when they're entering their passwords. Conﬁgure web access 210 Amazon WorkSpaces Administration Guide 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open the Interactive logon: Do not require CTRL+ALT+DEL setting. 5. On the Local Security Setting tab, choose Disabled, and then choose OK. To display the domain and user information when the session is locked The WorkSpaces logon agent looks for the user's name and domain. After this setting is conﬁgured, the lock screen will display the user's full name (if it is speciﬁed in Active Directory), their domain name, and their user name. 1. Open the Group Policy Management tool (gpmc.msc) and navigate
workspaces-ag-061	workspaces-ag.pdf	61	Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open the Interactive logon: Do not require CTRL+ALT+DEL setting. 5. On the Local Security Setting tab, choose Disabled, and then choose OK. To display the domain and user information when the session is locked The WorkSpaces logon agent looks for the user's name and domain. After this setting is conﬁgured, the lock screen will display the user's full name (if it is speciﬁed in Active Directory), their domain name, and their user name. 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open the Interactive logon: Display user information when the session is locked setting. 5. On the Local Security Setting tab, choose User display name, domain and user names, and then choose OK. To apply the Group Policy and Security Policy settings changes Group Policy and Security Policy settings changes take eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy and Security Policy changes in the prior procedures, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • From an administrative command prompt, enter gpupdate /force. Conﬁgure web access 211 Amazon WorkSpaces Administration Guide Conﬁgure WorkSpaces Thin Client Most WorkSpaces bundles support Amazon WorkSpaces Thin Client Access. For a list of WorkSpaces that support web browser access, see "Which Amazon WorkSpaces bundles support Thin Client Access?" in Client Access, Web Access, and User Experience. Step 1: Enable Access Control to your Amazon WorkSpaces Thin Client You control Thin Client Access to your WorkSpaces at the directory level with user-agent based access control. For each directory containing WorkSpaces that you want to allow users to access through the Thin Client Access client, do the following steps. To enable Thin Client Access to your WorkSpaces 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Under the Directory ID column, choose the directory ID of the directory you want to enable Thin Client Access for. 4. On the Directory Details page, scroll down to the Other platforms section and choose Edit. 5. Select WorkSpaces Thin Client. 6. Choose Save. Step 2: Conﬁgure inbound and outbound access to ports for Thin Client Access Amazon WorkSpaces Thin Client Access requires inbound and outbound access for certain ports. For more information, see Ports for Web Access. Step 3: Conﬁgure Group Policy and security policy settings to enable users to log on Amazon WorkSpaces relies on a speciﬁc logon screen conﬁguration to enable users to successfully log on from their Thin Client Access client. To enable Thin Client Access users to log on to their WorkSpaces, you must conﬁgure a Group Policy setting and three Security Policy settings. If these settings are not correctly conﬁgured, users might experience long logon times or black screens when they try to log on to their WorkSpaces. To conﬁgure these settings, use the following procedures. Conﬁgure Amazon WorkSpaces Thin Client 212 Amazon WorkSpaces Administration Guide You can use Group Policy Objects (GPOs) to apply settings to manage Windows WorkSpaces or users that are part of your Windows WorkSpaces directory. We recommend that you create an organizational unit for your WorkSpaces Computer Objects and an organizational unit for your WorkSpaces User Objects. For information about using the Active Directory administration tools to work with GPOs, see Installing the Active Directory Administration Tools in the AWS Directory Service Administration Guide. To enable the WorkSpaces logon agent to switch users In most cases, when a user attempts to log on to a WorkSpace, the user name ﬁeld is prepopulated with the name of that user. However, if an administrator has established an RDP connection to the WorkSpace to perform maintenance tasks, the user name ﬁeld is populated with the name of the administrator instead. To avoid this issue, disable the Hide entry points for Fast User Switching Group Policy setting. When you disable this setting, the WorkSpaces logon agent can use the Switch User button to populate the user name ﬁeld with the correct name. 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the
workspaces-ag-062	workspaces-ag.pdf	62	established an RDP connection to the WorkSpace to perform maintenance tasks, the user name ﬁeld is populated with the name of the administrator instead. To avoid this issue, disable the Hide entry points for Fast User Switching Group Policy setting. When you disable this setting, the WorkSpaces logon agent can use the Switch User button to populate the user name ﬁeld with the correct name. 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, System, and Logon. 4. Open the Hide entry points for Fast User Switching setting. 5. In the Hide entry points for Fast User Switching dialog box, choose Disabled, and then choose OK. To hide the last logged on user name By default, the list of last logged on users is displayed instead of the Switch User button. Depending on the conﬁguration of the WorkSpace, the list might not display the Other User tile. When this situation occurs, if the prepopulated user name isn't correct, the WorkSpaces logon agent can't populate the ﬁeld with the correct name. Conﬁgure Amazon WorkSpaces Thin Client 213 Amazon WorkSpaces Administration Guide To avoid this issue, enable the Security Policy setting Interactive logon: Don't display last signed- in or Interactive logon: Do not display last user name (depending on which version of Windows you're using). 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open one of the following settings: • For Windows 7 — Interactive logon: Don't display last signed-in • For Windows 10 — Interactive logon: Do not display last user name 5. In the Properties dialog box for the setting, choose Enabled, and then choose OK. To require pressing CTRL+ALT+DEL before users can log on For WorkSpaces Thin Client Access, you need to require that users press CTRL+ALT+DEL before they can log on. Requiring users to press CTRL+ALT+DEL before they log on ensures that users are using a trusted path when they're entering their passwords. 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open the Interactive logon: Do not require CTRL+ALT+DEL setting. 5. On the Local Security Setting tab, choose Disabled, and then choose OK. Conﬁgure Amazon WorkSpaces Thin Client 214 Amazon WorkSpaces Administration Guide To display the domain and user information when the session is locked The WorkSpaces logon agent looks for the user's name and domain. After this setting is conﬁgured, the lock screen will display the user's full name (if it is speciﬁed in Active Directory), their domain name, and their user name. 1. Open the Group Policy Management tool (gpmc.msc) and navigate to and select a GPO at the domain or domain controller level of the directory that you use for your WorkSpaces. (If you have the WorkSpaces Group Policy administrative template installed in your domain, you can use the WorkSpaces GPO for your WorkSpaces machine accounts.) 2. Choose Action, Edit in the main menu. 3. In the Group Policy Management Editor, choose Computer Conﬁguration, Windows Settings, Security Settings, Local Policies, and Security Options. 4. Open the Interactive logon: Display user information when the session is locked setting. 5. On the Local Security Setting tab, choose User display name, domain and user names, and then choose OK. To apply the Group Policy and Security Policy settings changes Group Policy and Security Policy settings changes take eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy and Security Policy changes in the prior procedures, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console,
workspaces-ag-063	workspaces-ag.pdf	63	Local Policies, and Security Options. 4. Open the Interactive logon: Display user information when the session is locked setting. 5. On the Local Security Setting tab, choose User display name, domain and user names, and then choose OK. To apply the Group Policy and Security Policy settings changes Group Policy and Security Policy settings changes take eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy and Security Policy changes in the prior procedures, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • From an administrative command prompt, enter gpupdate /force. Conﬁgure FedRAMP authorization or DoD SRG compliance for WorkSpaces Personal To comply with the Federal Risk and Authorization Management Program (FedRAMP) or the Department of Defense (DoD) Cloud Computing Security Requirements Guide (SRG), you must conﬁgure Amazon WorkSpaces to use Federal Information Processing Standards (FIPS) endpoint encryption at the directory level. You must also use a US AWS Region that has FedRAMP authorization or is DoD SRG compliant. Conﬁgure FIPS endpoint encryption 215 Amazon WorkSpaces Administration Guide The level of FedRAMP authorization (Moderate or High) or DoD SRG Impact Level (2, 4, or 5) depends on the US AWS Region in which Amazon WorkSpaces is being used. For the levels of FedRAMP authorization and DoD SRG compliance that apply to each Region, see AWS Services in Scope by Compliance Program. Note In addition to using FIPS endpoint encryption, you can also encrypt your WorkSpaces. For more information, see Encrypted WorkSpaces in WorkSpaces Personal. Requirements • You must create your WorkSpaces in a US AWS Region that has FedRAMP authorization or is DoD SRG-compliant. • The WorkSpaces directory must be conﬁgured to use FIPS 140-2 Validated Mode for endpoint encryption. Note To use the FIPS 140-2 Validated Mode setting, the WorkSpaces directory must either be new, or all existing WorkSpaces in the directory must be using FIPS 140-2 Validated Mode for endpoint encryption. Otherwise, you cannot use this setting, and therefore the WorkSpaces that you create will not comply with FedRAMP or DoD security requirements. Refer to step 3 below for details on how to verify the directory. • Users must access their WorkSpaces from one of the following WorkSpaces client applications: • Windows: 2.4.3 or later • macOS: 2.4.3 or later for PCoIP WorkSpaces, and 5.21.0 or later for DCV WorkSpaces • Linux: 3.0.0 or later • iOS: 2.4.1 or later • Android: 2.4.1 or later • Fire Tablet: 2.4.1 or later • ChromeOS: 2.4.1 or later • Web Access Conﬁgure FIPS endpoint encryption 216 Amazon WorkSpaces Administration Guide To use FIPS endpoint encryption 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Verify that the directory where you want to create FedRAMP-authorized and DoD SRG- compliant WorkSpaces does not have any existing WorkSpaces associated with it. If there are WorkSpaces associated with the directory and the directory is not already enabled to use FIPS 140-2 Validated Mode, either terminate the WorkSpaces or create a new directory. 4. Choose the directory that meets the above criteria, and then choose Actions, Update Details. 5. 6. On the Update Directory Details page, choose the arrow to expand the Access Control Options section. For Endpoint Encryption, choose FIPS 140-2 Validated Mode instead of TLS Encryption Mode (Standard). 7. Choose Update and Exit. 8. You can now create WorkSpaces from this directory that are FedRAMP authorized and DoD SRG compliant. To access these WorkSpaces, users must use one of the WorkSpaces client applications listed earlier in the Requirements section. Enable SSH connections for your Linux WorkSpaces in WorkSpaces Personal If you or your users want to connect to your Linux WorkSpaces by using the command line, you can enable SSH connections. You can enable SSH connections to all WorkSpaces in a directory or to individual WorkSpaces in a directory. To enable SSH connections, you create a new security group or update an existing security group and add a rule to allow inbound traﬃc for this purpose. Security groups act as a ﬁrewall for associated instances, controlling both inbound and outbound traﬃc at the instance level. After you create or update your security group, your users and others can use PuTTY or other terminals to connect from their devices to your Linux WorkSpaces. For more information, see the section called “Security groups”. For a video tutorial, see How can I connect to my Linux Amazon WorkSpaces using SSH? on the AWS Knowledge Center. This tutorial is for Amazon Linux 2 WorkSpaces only. Enable SSH connections for Linux WorkSpaces 217 Administration Guide Amazon WorkSpaces Contents • Prerequisites for SSH connections to Linux WorkSpaces • Enable SSH connections to all Linux WorkSpaces in a
workspaces-ag-064	workspaces-ag.pdf	64	at the instance level. After you create or update your security group, your users and others can use PuTTY or other terminals to connect from their devices to your Linux WorkSpaces. For more information, see the section called “Security groups”. For a video tutorial, see How can I connect to my Linux Amazon WorkSpaces using SSH? on the AWS Knowledge Center. This tutorial is for Amazon Linux 2 WorkSpaces only. Enable SSH connections for Linux WorkSpaces 217 Administration Guide Amazon WorkSpaces Contents • Prerequisites for SSH connections to Linux WorkSpaces • Enable SSH connections to all Linux WorkSpaces in a directory • Password-based authentication in WorkSpaces • Enable SSH connections to a speciﬁc Linux WorkSpace • Connect to a Linux WorkSpace using Linux or PuTTY Prerequisites for SSH connections to Linux WorkSpaces • Enabling inbound SSH traﬃc to a WorkSpace — To add a rule to allow inbound SSH traﬃc to one or more Linux WorkSpaces, make sure that you have the public or private IP addresses of the devices that require SSH connections to your WorkSpaces. For example, you can specify the public IP addresses of devices outside your virtual private cloud (VPC) or the private IP address of another EC2 instance in the same VPC as your WorkSpace. If you plan to connect to a WorkSpace from your local device, you can use the search phrase "what is my IP address" in an internet browser or use the following service: Check IP. • Connecting to a WorkSpace — The following information is required to initiate an SSH connection from a device to a Linux WorkSpace. • The NetBIOS name of the Active Directory domain that you are connected to. • Your WorkSpace user name. • The public or private IP address of the WorkSpace that you want to connect to. Private: If your VPC is attached to a corporate network and you have access to that network, you can specify the private IP address of the WorkSpace. Public: If your WorkSpace has a public IP address, you can use the WorkSpaces console to ﬁnd the public IP address, as described in the following procedure. To ﬁnd the IP addresses for the Linux WorkSpace you want to connect to and your user name 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose WorkSpaces. In the list of WorkSpaces, choose the WorkSpace that you want to enable SSH connections to. In the Running mode column, conﬁrm that the WorkSpace status is Available. Enable SSH connections for Linux WorkSpaces 218 Amazon WorkSpaces Administration Guide 5. Click the arrow to the left of the WorkSpace name to display the inline summary, and note the following information: • The WorkSpace IP. This is the private IP address of the WorkSpace. The private IP address is required for obtaining the elastic network interface associated with the WorkSpace. The network interface is required to retrieve information such as the security group or public IP address associated with the WorkSpace. • The WorkSpace Username. This is the user name that you specify to connect to the WorkSpace. 6. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 7. 8. 9. In the navigation pane, choose Network Interfaces. In the search box, type the WorkSpace IP that you noted in Step 5. Select the network interface associated with the WorkSpace IP. 10. If your WorkSpace has a public IP address, it is displayed in the IPv4 Public IP column. Make a note of this address, if applicable. To ﬁnd the NetBIOS name of the Active Directory domain that you are connected to 1. Open the AWS Directory Service console at https://console.aws.amazon.com/ directoryservicev2/. 2. 3. In the list of directories, click the Directory ID link of the directory for the WorkSpace. In the Directory details section, note the Directory NetBIOS name. Enable SSH connections to all Linux WorkSpaces in a directory To enable SSH connections to all Linux WorkSpaces in a directory, do the following. To create a security group with a rule to allow inbound SSH traﬃc to all Linux WorkSpaces in a directory 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. In the navigation pane, choose Security Groups. 3. Choose Create Security Group. 4. Type a name and optionally, a description for your security group. Enable SSH connections for Linux WorkSpaces 219 Amazon WorkSpaces Administration Guide 5. For VPC, choose the VPC that contains the WorkSpaces that you want to enable SSH connections to. 6. On the Inbound tab, choose Add Rule, and do the following: • For Type, choose SSH. • For Protocol, TCP is automatically speciﬁed when you choose SSH. • For Port Range, 22 is automatically speciﬁed when you choose SSH. • For Source, specify the CIDR range of the public IP addresses for the computers that users
workspaces-ag-065	workspaces-ag.pdf	65	Security Group. 4. Type a name and optionally, a description for your security group. Enable SSH connections for Linux WorkSpaces 219 Amazon WorkSpaces Administration Guide 5. For VPC, choose the VPC that contains the WorkSpaces that you want to enable SSH connections to. 6. On the Inbound tab, choose Add Rule, and do the following: • For Type, choose SSH. • For Protocol, TCP is automatically speciﬁed when you choose SSH. • For Port Range, 22 is automatically speciﬁed when you choose SSH. • For Source, specify the CIDR range of the public IP addresses for the computers that users will use to connect to their WorkSpaces. For example, a corporate network or a home network. • For Description (optional), type a description for the rule. 7. Choose Create. 8. Attach this security group to your WorkSpaces. For more information on adding this security group to your WorkSpaces, see Security groups for WorkSpaces Personal. If you want to automatically attach additional security groups to your WorkSpaces, refer to this blog post. Password-based authentication in WorkSpaces To enable password authentication in newly created Linux WorkSpaces 1. Launch the WorkSpaces client and login to your WorkSpace. 2. Open the Terminal window. 3. In the Terminal window, run the following command to enable SSH Password Authentication in cloud-init. sudo bash -c 'touch /etc/cloud/cloud.cfg.d/15_sshpwauth.cfg && echo "ssh_pwauth: true" > /etc/cloud/cloud.cfg.d/15_sshpwauth.cfg && sudo rm /var/lib/cloud/ instance/sem/config_set_passwords && sudo cloud-init single --name set-passwords' This script will do the following: • Create a conﬁguration ﬁle in the cloud-init directory /etc/cloud/cloud.cfg.d/. • Modify the conﬁguration ﬁle to tell cloud-init to enable SSH password authentication. • Reset the set-passwords cloud-init module so that it can be run again. Enable SSH connections for Linux WorkSpaces 220 Amazon WorkSpaces Administration Guide • Run the set-passwords cloud-init module by itself. This will write a ﬁle that enables SSH password authentication to the SSH conﬁguration directory, /etc/ssh/sshd_config.d/, and restart SSHD so that the setting will take place immediately. This enables SSH password authentication on your WorkSpace and will persist through custom images. If you enable SSH password authentication only in the SSHD conﬁguration ﬁle, without conﬁguring cloud-init, the setting will not persist through imaging on some Linux WorkSpaces. For more information, see Set Passwords in the cloud-init module documentation. To disable password authentication in existing Linux WorkSpaces 1. Launch the WorkSpaces client and login to your WorkSpace. 2. Open the Terminal window. 3. In the Terminal window, run the following command to disable SSH Password Authentication in cloud-init. sudo bash -c 'touch /etc/cloud/cloud.cfg.d/15_sshpwauth.cfg && echo "ssh_pwauth: false" > /etc/cloud/cloud.cfg.d/15_sshpwauth.cfg && sudo rm /var/lib/cloud/ instance/sem/config_set_passwords && sudo cloud-init single —name set-passwords' This script will do the following: • Create a conﬁguration ﬁle in the cloud-init directory /etc/cloud/cloud.cfg.d/. • Modify the conﬁguration ﬁle to tell cloud-init to disable SSH password authentication. • Reset the set-passwords cloud-init module so that it can be run again. • Run the set-passwords cloud-init module by itself. This will write a ﬁle that enables SSH password authentication to the SSH conﬁguration directory, /etc/ssh/sshd_config.d/, and restart SSHD so that the setting will take place immediately. This immediately disables SSH in the WorkSpace and will persist through custom images. Enable SSH connections to a speciﬁc Linux WorkSpace To enable SSH connections to a speciﬁc Linux WorkSpace, do the following. Enable SSH connections for Linux WorkSpaces 221 Amazon WorkSpaces Administration Guide To add a rule to an existing security group to allow inbound SSH traﬃc to a speciﬁc Linux WorkSpace 1. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. 2. 3. In the navigation pane, under Network & Security, choose Network Interfaces. In the search bar, type the private IP address of the WorkSpace that you want to enable SSH connections to. 4. In the Security groups column, click the link for the security group. 5. On the Inbound tab, choose Edit. 6. Choose Add Rule, and then do the following: • For Type, choose SSH. • For Protocol, TCP is automatically speciﬁed when you choose SSH. • For Port Range, 22 is automatically speciﬁed when you choose SSH. • For Source, choose My IP or Custom, and specify a single IP address or an IP address range in CIDR notation. For example, if your IPv4 address is 203.0.113.25, specify 203.0.113.25/32 to list this single IPv4 address in CIDR notation. If your company allocates addresses from a range, specify the entire range, such as 203.0.113.0/24. • For Description (optional), type a description for the rule. 7. Choose Save. Connect to a Linux WorkSpace using Linux or PuTTY After you create or update your security group and add the required rule, your users and others can use Linux or PuTTY to connect from their devices to your WorkSpaces. Note Before completing either of the following procedures, make sure that you have the following: • The
workspaces-ag-066	workspaces-ag.pdf	66	your IPv4 address is 203.0.113.25, specify 203.0.113.25/32 to list this single IPv4 address in CIDR notation. If your company allocates addresses from a range, specify the entire range, such as 203.0.113.0/24. • For Description (optional), type a description for the rule. 7. Choose Save. Connect to a Linux WorkSpace using Linux or PuTTY After you create or update your security group and add the required rule, your users and others can use Linux or PuTTY to connect from their devices to your WorkSpaces. Note Before completing either of the following procedures, make sure that you have the following: • The NetBIOS name of the Active Directory domain that you are connected to. • The username that you use to connect to the WorkSpace. • The public or private IP address of the WorkSpace that you want to connect to. Enable SSH connections for Linux WorkSpaces 222 Amazon WorkSpaces Administration Guide For instructions on how to obtain this information, see "Prerequisites for SSH Connections to Linux WorkSpaces" earlier in this topic. To connect to an Linux WorkSpace using Linux 1. Open the command prompt as an administrator and enter the following command. For NetBIOS name, Username, and WorkSpace IP, enter the applicable values. ssh "NetBIOS_NAME\Username"@WorkSpaceIP The following is an example of the SSH command where: • The NetBIOS_NAME is anycompany • The Username is janedoe • The WorkSpace IP is 203.0.113.25 ssh "anycompany\janedoe"@203.0.113.25 2. When prompted, enter the same password that you use when authenticating with the WorkSpaces client (your Active Directory password). To connect to an Linux WorkSpace using PuTTY 1. Open PuTTY. 2. In the PuTTY Conﬁguration dialog box, do the following: • For Host Name (or IP address), enter the following command. Replace the values with the NetBIOS name of the Active Directory domain that you are connected to, the user name that you use to connect to the WorkSpace, and the IP address of the WorkSpace that you want to connect to. NetBIOS_NAME\Username@WorkSpaceIP • For Port, enter 22. • For Connection type, choose SSH. Enable SSH connections for Linux WorkSpaces 223 Amazon WorkSpaces Administration Guide For an example of the SSH command, see step 1 in the previous procedure. 3. Choose Open. 4. When prompted, enter the same password that you use when authenticating with the WorkSpaces client (your Active Directory password). Required conﬁguration and service components for WorkSpaces Personal As a WorkSpace administrator, you must understand the following about required conﬁguration and service components. • the section called “Routing table conﬁguration” • the section called “Components for Windows” • the section called “Components for Linux” • the section called “Components for Ubuntu” • the section called “Components for Rocky Linux ” • the section called “Components for Red Hat Enterprise Linux ” Required routing table conﬁguration We recommend that you not modify the operating system-level routing table for a WorkSpace. The WorkSpaces service requires the preconﬁgured routes in this table to monitor the system state and update system components. If routing table changes are required for your organization, contact AWS Support or your AWS account team before applying any changes. Required service components for Windows On Windows WorkSpaces, the service components are installed in the following locations. Do not delete, change, block, or quarantine these objects. If you do so, the WorkSpace will not function correctly. If antivirus software is installed on the WorkSpace, make sure it does not interfere with the service components installed in the following locations. • C:\Program Files\Amazon Required conﬁguration and service components 224 Amazon WorkSpaces Administration Guide • C:\Program Files\NICE • C:\Program Files\Teradici • C:\Program Files (x86)\Teradici • C:\ProgramData\Amazon • C:\ProgramData\NICE • C:\ProgramData\Teradici If antivirus software is installed on the WorkSpaces Core, make sure it does not interfere with the service components installed in the following locations. • C:\Program Files\Amazon • C:\ProgramData\Amazon 32-bit PCoIP agent As of March 29, 2021, we updated the PCoIP agent from 32-bit to 64-bit. For Windows WorkSpaces that are using the PCoIP protocol, this means that the location of the Teradici ﬁles changed from C:\Program Files (x86)\Teradici to C:\Program Files\Teradici. Because we updated PCoIP agents during regular maintenance windows, some of your WorkSpaces might have used the 32-bit agent longer than others during the transition. If you've conﬁgured ﬁrewall rules, antivirus software exclusions (on the client side and host side), Group Policy Object (GPO) settings, or settings for Microsoft System Center Conﬁguration Manager (SCCM), Microsoft Endpoint Conﬁguration Manager, or similar conﬁguration management tools based on the full path to the 32-bit agent, you must also add the full path to the 64-bit agent to those settings. If you're ﬁltering on the paths to any 32-bit PCoIP components, be sure to add the paths to the 64-bit versions of the components. Because your WorkSpaces might not all be updated at the same time, do not replace the
workspaces-ag-067	workspaces-ag.pdf	67	you've conﬁgured ﬁrewall rules, antivirus software exclusions (on the client side and host side), Group Policy Object (GPO) settings, or settings for Microsoft System Center Conﬁguration Manager (SCCM), Microsoft Endpoint Conﬁguration Manager, or similar conﬁguration management tools based on the full path to the 32-bit agent, you must also add the full path to the 64-bit agent to those settings. If you're ﬁltering on the paths to any 32-bit PCoIP components, be sure to add the paths to the 64-bit versions of the components. Because your WorkSpaces might not all be updated at the same time, do not replace the 32-bit path with the 64-bit path, or some of your WorkSpaces might not work. For example, if you're basing your exclusions or communication ﬁlters on C: \Program Files (x86)\Teradici\PCoIP Agent\bin\pcoip_server_win32.exe, you must also add C:\Program Files\Teradici\PCoIP Agent\bin\pcoip_server.exe. Likewise, if you're basing your exclusions or communications ﬁlters on C:\Program Files (x86)\Teradici\PCoIP Agent\bin\pcoip_agent.exe, you must also add C:\Program Files\Teradici\PCoIP Agent\bin\pcoip_agent.exe. Required conﬁguration and service components 225 Amazon WorkSpaces Administration Guide PCoIP arbiter service change — Be aware that the PCoIP arbiter service (C:\Program Files (x86)\Teradici\PCoIP Agent\bin\pcoip_arbiter_win32.exe) is removed when your WorkSpaces are updated to use the 64-bit agent. PCoIP zero clients and USB devices — Starting with version 20.10.4 of the PCoIP agent, Amazon WorkSpaces disables USB redirection by default through the Windows registry. This registry setting aﬀects the behavior of USB peripherals when your users are using PCoIP zero client devices to connect to their WorkSpaces. For more information, see USB printers and other USB peripherals aren't working for PCoIP zero clients. Required service components for Linux On Amazon Linux WorkSpaces, the service components are installed in the following locations. Do not delete, change, block, or quarantine these objects. If you do so, the WorkSpace will not function correctly. Note Making changes to ﬁles other than /etc/pcoip-agent/pcoip-agent.conf might cause your WorkSpaces to stop working and might require you to rebuild them. For information about modifying /etc/pcoip-agent/pcoip-agent.conf, see Manage your Amazon Linux 2 WorkSpaces in WorkSpaces Personal. • /etc/dhcp/dhclient.conf • /etc/logrotate.d/pcoip-agent • /etc/logrotate.d/pcoip-server • /etc/os-release • /etc/pam.d/pcoip • /etc/pam.d/pcoip-session • /etc/pcoip-agent • /etc/profile.d/system-restart-check.sh • /etc/X11/default-display-manager • /etc/yum/pluginconf.d/halt_os_update_check.conf • /etc/systemd/system/euc-analytic-agent.service Required conﬁguration and service components 226 Amazon WorkSpaces Administration Guide • /lib/systemd/system/pcoip.service • /lib/systemd/system/pcoip-agent.service • /lib64/security/pam_self.so • /usr/bin/pcoip-fne-view-license • /usr/bin/pcoip-list-licenses • /usr/bin/pcoip-validate-license • /usr/bin/euc-analytics-agent • /usr/lib/firewalld/services/pcoip-agent.xml • /usr/lib/modules-load.d/usb-vhci.conf • /usr/lib/pcoip-agent • /usr/lib/skylight • /usr/lib/systemd/system/pcoip.service • /usr/lib/systemd/system/pcoip.service.d/ • /usr/lib/systemd/system/skylight-agent.service • /usr/lib/tmpfiles.d/pcoip-agent.conf • /usr/lib/yum-plugins/halt_os_update_check.py • /usr/sbin/pcoip-agent • /usr/sbin/pcoip-register-host • /usr/sbin/pcoip-support-bundler • /usr/share/doc/pcoip-agent • /usr/share/pcoip-agent • /usr/share/selinux/packages/pcoip-agent.pp • /usr/share/X11 • /var/crash/pcoip-agent • /var/lib/pcoip-agent • /var/lib/skylight • /var/log/pcoip-agent • /var/log/skylight Required conﬁguration and service components 227 Amazon WorkSpaces • /var/logs/wsp • /var/log/eucanalytics Administration Guide Required service components for Ubuntu On Ubuntu WorkSpaces, the service components are installed in the following locations. Do not delete, change, block, or quarantine these objects. If you do so, the WorkSpace will not function correctly. • /etc/X11/default-display-manager • /etc/dcv • /etc/default/grub.d/zz-hibernation.cfg • /etc/netplan • /etc/os-release • /etc/pam.d/dcv • /etc/pam.d/dcv-graphical-sso • /etc/sssd/sssd.conf • /etc/wsp • /etc/systemd/system/euc-analytic-agent.service • /lib64/security/pam_self.so • /usr/lib/skylight • /usr/lib/systemd/system/dcvserver.service • /usr/lib/systemd/system/dcvsessionlauncher.service • /usr/lib/systemd/system/skylight-agent.service • /usr/lib/systemd/system/wspdcvhostadapter.service • /usr/share/X11 • /usr/bin/euc-analytics-agent • /var/lib/skylight • /var/log/skylight • /var/log/eucanalytics Required conﬁguration and service components 228 Amazon WorkSpaces Administration Guide Required service components for Rocky Linux On Red Hat Enterprise Linux WorkSpaces, the service components are installed in the following locations. Do not delete, change, block, or quarantine these objects. If you do so, the WorkSpace will not function correctly. • /etc/dcv • /etc/os-release • /etc/pam.d/dcv-graphical-sso • /etc/pam.d/dcv • /etc/systemd/system/euc-analytic-agent.service • /etc/wsp • /usr/bin/euc-analytics-agent • /usr/lib/skylight • /usr/lib/systemd/system/dcvserver.service • /usr/lib/systemd/system/dcvsessionlauncher.service • /usr/lib/systemd/system/skylight-agent.service • /usr/lib/systemd/system/wspdcvhostadapter.service • /usr/lib/systemd/system/xdcv-console.path • /usr/lib/systemd/system/xdcv-console.service • /usr/lib/systemd/system/xdcv-console-update.service • /usr/share/X11 • /var/lib/skylight • /var/log/eucanalytics • /var/log/skylight Required service components for Red Hat Enterprise Linux On Red Hat Enterprise Linux WorkSpaces, the service components are installed in the following locations. Do not delete, change, block, or quarantine these objects. If you do so, the WorkSpace will not function correctly. • /etc/dcv Required conﬁguration and service components 229 Administration Guide Amazon WorkSpaces • /etc/os-release • /etc/pam.d/dcv-graphical-sso • /etc/pam.d/dcv • /etc/systemd/system/euc-analytic-agent.service • /etc/wsp • /usr/bin/euc-analytics-agent • /usr/lib/skylight • /usr/lib/systemd/system/dcvserver.service • /usr/lib/systemd/system/dcvsessionlauncher.service • /usr/lib/systemd/system/skylight-agent.service • /usr/lib/systemd/system/wspdcvhostadapter.service • /usr/lib/systemd/system/xdcv-console.path • /usr/lib/systemd/system/xdcv-console.service • /usr/lib/systemd/system/xdcv-console-update.service • /usr/share/X11 • /var/log/eucanalytics • /var/log/skylight Manage directories for WorkSpaces Personal WorkSpaces uses a directory to store and manage information for your WorkSpaces and users. You can use one of the following options: • AD Connector — Use your existing on-premises Microsoft Active Directory. Users can sign into their WorkSpaces using their on-premises credentials and access on-premises resources from their WorkSpaces. • AWS Managed Microsoft AD — Create a Microsoft Active Directory hosted on AWS. • Simple AD — Create a directory that is compatible with Microsoft Active Directory, powered by Samba 4, and hosted on AWS. • Cross trust — Create a trust relationship between your AWS Managed Microsoft AD directory and your on-premises
workspaces-ag-068	workspaces-ag.pdf	68	to store and manage information for your WorkSpaces and users. You can use one of the following options: • AD Connector — Use your existing on-premises Microsoft Active Directory. Users can sign into their WorkSpaces using their on-premises credentials and access on-premises resources from their WorkSpaces. • AWS Managed Microsoft AD — Create a Microsoft Active Directory hosted on AWS. • Simple AD — Create a directory that is compatible with Microsoft Active Directory, powered by Samba 4, and hosted on AWS. • Cross trust — Create a trust relationship between your AWS Managed Microsoft AD directory and your on-premises domain. Manage directories for WorkSpaces 230 Amazon WorkSpaces Administration Guide • Microsoft Entra ID — Create a directory that uses Microsoft Entra ID as its identity source (through IAM Identity Center). Personal WorkSpaces in the directory are joined using Microsoft Entra's native authentication and are enrolled into Microsoft Intune through Microsoft Windows Autopilot user-driven mode. Directories using Microsoft Entra ID only support Windows 10 and 11 Bring Your Own Licenses WorkSpaces. • Custom — Create a directory that use an identity provider of your choice (through IAM Identity Center). WorkSpaces in the directory are managed using the device management solution of your choice such as JumpCloud. Directories using custom identity providers only support Windows 10 and 11 Bring Your Own Licenses WorkSpaces. For tutorials that demonstrate how to set up these directories and launch WorkSpaces, see Create a directory for WorkSpaces Personal. Tip For a detailed exploration of directory and virtual private cloud (VPC) design considerations for various deployment scenarios, see Best Practices for Deploying Amazon WorkSpaces. After you create a directory, you'll perform most directory administration tasks using tools such as the Active Directory Administration Tools. You can perform some directory administration tasks using the WorkSpaces console and other tasks using Group Policy. For more information about managing users and groups, see Manage users in WorkSpaces Personal and Set up Active Directory Administration Tools for WorkSpaces Personal. Note • Shared directories are not currently supported for use with Amazon WorkSpaces. • If you conﬁgure 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. • Simple AD and AD Connector are made 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 Manage directories for WorkSpaces 231 Amazon WorkSpaces Administration Guide 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. Contents • Register an existing AWS Directory Service directory with WorkSpaces Personal • Select an organizational unit for WorkSpaces Personal • Conﬁgure automatic public IP addresses for WorkSpaces Personal • Control device access for WorkSpaces Personal • Manage local administrator permissions for WorkSpaces Personal • Update the AD Connector account (AD Connector) for WorkSpaces Personal • Multi-factor authentication (AD Connector) for WorkSpaces Personal • Create a directory for WorkSpaces Personal • Update DNS servers for WorkSpaces Personal • Delete a directory for WorkSpaces Personal • Set up Active Directory Administration Tools for WorkSpaces Personal Register an existing AWS Directory Service directory with WorkSpaces Personal To allow WorkSpaces to use an existing AWS Directory Service directory, you must register it with WorkSpaces. After you register a directory, you can launch WorkSpaces in the directory. Requirements To register a directory for use with WorkSpaces, it must meet the following requirement: • If you're using AWS Managed Microsoft AD or Simple AD, your directory can be in a dedicated private subnet, as long as the directory has access to the VPC where the WorkSpaces are located. Register an existing AWS Directory Service directory 232 Amazon WorkSpaces Administration Guide For more information about directory and VPC design, see the Best Practices for Deploying Amazon WorkSpaces whitepaper. Note Simple AD and AD Connector are made 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
workspaces-ag-069	workspaces-ag.pdf	69	directory 232 Amazon WorkSpaces Administration Guide For more information about directory and VPC design, see the Best Practices for Deploying Amazon WorkSpaces whitepaper. Note Simple AD and AD Connector are made 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 register an existing AWS Directory Service directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose Create directory. 4. On the Create directory page, for WorkSpaces type choose Personal. For WorkSpace device management, choose AWS Directory Service. 5. 6. Select the directory you want to register in the Directories in AWS Directory Service table Select two subnets of your VPC that are not from the same Availability Zone. These subnets will be used to launch your WorkSpaces. For more information, see Availability Zones for WorkSpaces Personal. Note If you do not know which subnets to choose, select No Preference. 7. For Enable Self Service Permissions, choose Yes to enable your users to rebuild their WorkSpaces, change volume size, compute type and running mode. Enabling may impact how much you pay for Amazon WorkSpaces. Choose No otherwise. 8. Choose Register. Initially the value of Registered is REGISTERING. After registration is complete, the value is Yes. Register an existing AWS Directory Service directory 233 Amazon WorkSpaces Administration Guide After you've registered the AWS Directory Service directory, you can create a personal WorkSpace. For more information, see Create a WorkSpace in WorkSpaces Personal. When you are ﬁnished using the directory with WorkSpaces, you can deregister it. Note that you must deregister a directory before you can delete it. If you want to deregister and delete a directory, you must ﬁrst ﬁnd and remove all the applications and services that are registered to the directory. For more information, see Delete Your Directory in the AWS Directory Service Administration Guide. To deregister a directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Directories. Select the directory. 4. Choose Actions, Deregister. 5. When prompted for conﬁrmation, choose Conﬁrm. After deregistration is complete, the directory becomes unregistered and is removed from the list. Select an organizational unit for WorkSpaces Personal Note This feature is only available for directories managed through AWS Directory Service, including AD Connector, AWS Managed Microsoft AD, and Simple AD. WorkSpace machine accounts are placed in the default organizational unit (OU) for the WorkSpaces directory. Initially, the machine accounts are placed in the Computers OU of your directory or the directory that your AD Connector is connected to. You can select a diﬀerent OU from your directory or connected directory, or specify an OU in a separate target domain. Note that you can select only one OU per directory. After you select a new OU, the machine accounts for all WorkSpaces that are created or rebuilt are placed in the newly selected OU. To select an organizational unit 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. Select an organizational unit 234 Amazon WorkSpaces Administration Guide 2. In the navigation pane, choose Directories. 3. Choose your directory. 4. Under Target domain and organizational unit, choose Edit. 5. To ﬁnd an OU, under Target and organizational unit, you can start typing all or part of the OU name and choose the OU you want to use. 6. (Optional) Choose an OU distiguished name to overwrite your selected OU with a custom OU. 7. Choose Save. 8. (Optional) Rebuild the existing WorkSpaces to update the OU. For more information, see Rebuild a WorkSpace in WorkSpaces Personal. Conﬁgure automatic public IP addresses for WorkSpaces Personal After you enable automatic assignment of public IP addresses, each WorkSpace that you launch is assigned a public IP address from the Amazon-provided pool of public addresses. A WorkSpace in a public subnet can access the internet through the internet gateway if it has a public IP address. WorkSpaces that already exist before you enable automatic assignment do not receive public addresses until you rebuild them. Note that you do not need to enable automatic assignment of public addresses if your WorkSpaces are in private subnets and you conﬁgured a NAT gateway for the virtual private cloud (VPC), or if your WorkSpaces are in public subnets and you assigned them Elastic IP addresses. For more information, see Conﬁgure a VPC for WorkSpaces Personal. Warning If you associate
workspaces-ag-070	workspaces-ag.pdf	70	A WorkSpace in a public subnet can access the internet through the internet gateway if it has a public IP address. WorkSpaces that already exist before you enable automatic assignment do not receive public addresses until you rebuild them. Note that you do not need to enable automatic assignment of public addresses if your WorkSpaces are in private subnets and you conﬁgured a NAT gateway for the virtual private cloud (VPC), or if your WorkSpaces are in public subnets and you assigned them Elastic IP addresses. For more information, see Conﬁgure a VPC for WorkSpaces Personal. Warning 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. 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. To conﬁgure Elastic IP addresses 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. Conﬁgure automatic public IP addresses 235 Amazon WorkSpaces Administration Guide 2. 3. In the navigation pane, choose Directories. Select the directory for your WorkSpaces. 4. Choose Actions, Update Details. 5. Expand Access to Internet and select Enable or Disable. 6. Choose Update. Control device access for WorkSpaces Personal You can specify the types of devices that have access to WorkSpaces based on the device platform. You can use certiﬁcates to restrict access to WorkSpaces to trusted devices (also known as managed devices). To control device access to WorkSpaces 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose your directory. 4. Under Access control options, choose Edit. 5. Under Trusted devices, specify which device types can access WorkSpaces by selecting either Allow all, Trusted devices, or Deny all. For more information, see Restrict access to trusted devices for WorkSpaces Personal. 6. Choose Save. Manage local administrator permissions for WorkSpaces Personal Note This feature is only available for directories managed through AWS Directory Service, including AD Connector, AWS Managed Microsoft AD, and Simple AD. You can specify whether users are local administrators on their WorkSpaces, which enables them to install application and modify settings on their WorkSpaces. Users are local administrators by default. If you modify this setting, the change applies to all new WorkSpaces that you create and any WorkSpaces that you rebuild. Control device access 236 Amazon WorkSpaces Administration Guide To modify local administrator permissions 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose your directory. 4. Under Local administrator settings, choose Edit. 5. To ensure that users are local administrators, choose Enable local administrator setting. 6. Choose Save. Update the AD Connector account (AD Connector) for WorkSpaces Personal You can update the AD Connector account that is used to read users and groups and join WorkSpaces machine accounts to your AD Connector directory. To update the AD Connector account 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Directories. Select your directory and then choose View details. 4. Under AD connector account, choose Edit. 5. Enter the sign-in credentials for the new account. 6. Choose Save. Multi-factor authentication (AD Connector) for WorkSpaces Personal You can enable multi-factor authentication (MFA) for your AD Connector directory. For more information about using multi-factor authentication with AWS Directory Service, see Enable multi- factor authentication for AD Connector and AD Connector prerequisites. Note • Your RADIUS server can either be hosted by AWS or it can be on-premises. • The usernames must match between Active Directory and your RADIUS server. Update the AD Connector account (AD Connector) 237 Amazon WorkSpaces Administration Guide To enable multi-factor authentication 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. 5. 6. 7. 8. 9. In the navigation pane, choose Directories. Select your directory and then choose Actions, Update Details. Expand Multi-Factor Authentication and then select Enable Multi-Factor Authentication. For RADIUS server IP address(es), type the IP addresses of your RADIUS server endpoints separated by commas, or type the IP address of your RADIUS server load balancer. For Port, type the port that your RADIUS server is using for communications. Your on-premises network must allow inbound traﬃc over the default RADIUS server port (UDP:1812) from AD Connector. For Shared secret code and Conﬁrm shared secret code, type the shared secret code for your RADIUS server. For Protocol, choose the protocol for your RADIUS server. For Server timeout, type the time, in seconds, to wait for the RADIUS server to respond. This value must be between 1 and 50. 10. For Max retries, type the number of
workspaces-ag-071	workspaces-ag.pdf	71	or type the IP address of your RADIUS server load balancer. For Port, type the port that your RADIUS server is using for communications. Your on-premises network must allow inbound traﬃc over the default RADIUS server port (UDP:1812) from AD Connector. For Shared secret code and Conﬁrm shared secret code, type the shared secret code for your RADIUS server. For Protocol, choose the protocol for your RADIUS server. For Server timeout, type the time, in seconds, to wait for the RADIUS server to respond. This value must be between 1 and 50. 10. For Max retries, type the number of times to attempt communication with the RADIUS server. This value must be between 0 and 10. 11. Choose Update and Exit. Multi-factor authentication is available when RADIUS status is Enabled. While multi-factor authentication is being set up, users cannot log in to their WorkSpaces. Create a directory for WorkSpaces Personal WorkSpaces Personal allows you to use directories managed through AWS Directory Service to store and manage information for your WorkSpaces and users. Use the following options to create a WorkSpaces Personal directory: • Create a Simple AD directory. • Create an AWS Directory Service for Microsoft Active Directory, also known as AWS Managed Microsoft AD. • Connect to an existing Microsoft Active Directory by using Active Directory Connector. • Create a trust relationship between your AWS Managed Microsoft AD directory and your on- premises domain. Create a directory 238 Amazon WorkSpaces Administration Guide • Create a dedicated Microsoft Entra ID WorkSpaces directory. • Create a dedicated Custom WorkSpaces directory. Note • Shared directories are not currently supported for use with Amazon WorkSpaces. • If you conﬁgure 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. • Simple AD and AD Connector are made 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. Before you create a directory • WorkSpaces is not available in every Region. Verify the supported Regions and select a Region for your WorkSpaces. For more information about the supported Regions, see WorkSpaces Pricing by AWS Region. • Create a virtual private cloud with at least two private subnets. For more information, see Conﬁgure a VPC for WorkSpaces Personal. The VPC must be connected to your on-premises network through a virtual private network (VPN) connection or AWS Direct Connect. For more information, see AD Connector Prerequisites in the AWS Directory Service Administration Guide. • Provide access to the internet from the WorkSpace. For more information, see Provide internet access for WorkSpaces Personal. For information about how to delete an empty directory, 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. Contents Create a directory 239 Amazon WorkSpaces Administration Guide • Identify the computer name for your WorkSpaces Personal directory • Create an AWS Managed Microsoft AD directory for WorkSpaces Personal • Create a Simple AD directory for WorkSpaces Personal • Create an AD Connector for WorkSpaces Personal • Create a trust relationship between your AWS Managed Microsoft AD directory and your on- premises domain for WorkSpaces Personal • Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal • Create a dedicated Custom directory with WorkSpaces Personal Identify the computer name for your WorkSpaces Personal directory The Computer Name value shown for a WorkSpace in the Amazon WorkSpaces console varies, depending on which type of WorkSpace you've launched (Amazon Linux, Ubuntu, or Windows). The computer name for a WorkSpace can be in one of these formats: • Amazon Linux: A-xxxxxxxxxxxxx • Red Hat Enterprise Linux: R-xxxxxxxxxxxxx • Rocky Linux: R-xxxxxxxxxxxxx • Ubuntu: U-xxxxxxxxxxxxx • Windows: IP-Cxxxxxx or WSAMZN-xxxxxxx or EC2AMAZ-xxxxxxx For Windows WorkSpaces, the computer name format is determined by the bundle type, and in the case of WorkSpaces created from public bundles or from custom bundles based on public images, by when the public images were created. Starting June 22, 2020, Windows WorkSpaces launched from public bundles have the WSAMZN-xxxxxxx format for their computer names instead of the IP-Cxxxxxx format. For custom bundles based on a public image, if the public image was created before June 22, 2020, the computer names are in the EC2AMAZ-xxxxxxx format. If the public
workspaces-ag-072	workspaces-ag.pdf	72	• Ubuntu: U-xxxxxxxxxxxxx • Windows: IP-Cxxxxxx or WSAMZN-xxxxxxx or EC2AMAZ-xxxxxxx For Windows WorkSpaces, the computer name format is determined by the bundle type, and in the case of WorkSpaces created from public bundles or from custom bundles based on public images, by when the public images were created. Starting June 22, 2020, Windows WorkSpaces launched from public bundles have the WSAMZN-xxxxxxx format for their computer names instead of the IP-Cxxxxxx format. For custom bundles based on a public image, if the public image was created before June 22, 2020, the computer names are in the EC2AMAZ-xxxxxxx format. If the public image was created on or after June 22, 2020, the computer names are in the WSAMZN-xxxxxxx format. For Bring Your Own License (BYOL) bundles, either the DESKTOP-xxxxxxx or the EC2AMAZ-xxxxxxx format is used for the computer names by default. Create a directory 240 Amazon WorkSpaces Administration Guide If you've speciﬁed a custom format for the computer names in your custom or BYOL bundles, your custom format overrides these defaults. To specify a custom format, see Create a custom WorkSpaces image and bundle for WorkSpaces Personal. Important After a WorkSpace is created, you can safely change its computer name. For example, you can execute a PowerShell script with the command Rename-Computer on your WorkSpace or remotely. The updated computer name value will then be shown for a WorkSpace in the Amazon WorkSpaces console. Create an AWS Managed Microsoft AD directory for WorkSpaces Personal In this tutorial, we create an AWS Managed Microsoft AD directory. For tutorials that use the other options, see Create a directory for WorkSpaces Personal. First, create an AWS Managed Microsoft AD directory. AWS Directory Service creates two directory servers, one in each of the private subnets of your VPC. Note that there are no users in the directory initially. You will add a user in the next step when you launch the WorkSpace. Note • Shared directories are not currently supported for use with Amazon WorkSpaces. • If your AWS Managed Microsoft AD directory has been conﬁgured 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. To create an AWS Managed Microsoft AD directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose Create directory. 4. On the Create directory page, for WorkSpaces type choose Personal. Then, for WorkSpace device management choose AWS Directory Service. Create a directory 241 Amazon WorkSpaces Administration Guide 5. Choose Create directory, which opens the Set up a directory page on the AWS Directory Service 6. Choose AWS Managed Microsoft AD, and then Next. 7. Conﬁgure the directory as follows: a. For Organization name, enter a unique organization name for your directory (for example, my-demo-directory). This name must be at least four characters in length, consist of only alphanumeric characters and hyphens (-), and begin or end with a character other than a hyphen. b. For Directory DNS, enter the fully-qualiﬁed name for the directory (for example, workspaces.demo.com). Important If you need to update your DNS server after launching your WorkSpaces, follow the procedure in Update DNS servers for WorkSpaces Personal to ensure that your WorkSpaces get properly updated. c. d. e. f. g. For NetBIOS name, enter a short name for the directory (for example, workspaces). For Admin password and Conﬁrm password, enter a password for the directory administrator account. For more information about the password requirements, see Create Your AWS Managed Microsoft AD Directory in the AWS Directory Service Administration Guide. (Optional) For Description, enter a description for the directory. For VPC, select the VPC that you created. For Subnets, select the two private subnets (with the CIDR blocks 10.0.1.0/24 and 10.0.2.0/24). h. Choose Next Step. 8. Choose Create directory. 9. You will be brought back to the Create directory page on WorkSpaces console. The initial status of the directory is Requested and then Creating. When directory creation is complete (this might take a few minutes), the status is Active. Create a directory 242 Amazon WorkSpaces Administration Guide After you’ve created an AWS Managed Microsoft AD directory, you can register it with Amazon WorkSpaces. For more information, see Register an existing AWS Directory Service directory with WorkSpaces Personal Create a Simple AD directory for WorkSpaces Personal In this tutorial, we launch a WorkSpace that uses Simple AD. For tutorials that use the other options, see Create a directory for WorkSpaces Personal. Note • Simple AD is not available in every Region. Verify the supported Regions and select a Region for your Simple AD directory. For more information about the supported Regions
workspaces-ag-073	workspaces-ag.pdf	73	a directory 242 Amazon WorkSpaces Administration Guide After you’ve created an AWS Managed Microsoft AD directory, you can register it with Amazon WorkSpaces. For more information, see Register an existing AWS Directory Service directory with WorkSpaces Personal Create a Simple AD directory for WorkSpaces Personal In this tutorial, we launch a WorkSpace that uses Simple AD. For tutorials that use the other options, see Create a directory for WorkSpaces Personal. Note • Simple AD is not available in every Region. Verify the supported Regions and select a Region for your Simple AD directory. For more information about the supported Regions for Simple AD, see Region Availability for AWS Directory Service. • Simple AD is made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD 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. When you create a Simple AD directory. AWS Directory Service creates two directory servers, one in each of the private subnets of your VPC. There are no users in the directory initially. Add a user after you create the WorkSpace. For more information, see Create a WorkSpace in WorkSpaces Personal To create a Simple AD directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose Create directory. 4. On the Create directory page, for WorkSpaces type choose Personal. Then, for WorkSpace device management choose AWS Directory Service. 5. Choose Create directory, which opens the Set up a directory page on the AWS Directory Service 6. Choose Simple AD, and then Next. 7. Conﬁgure the directory as follows: Create a directory 243 Amazon WorkSpaces Administration Guide a. For Organization name, enter a unique organization name for your directory (for example, my-example-directory). This name must be at least four characters in length, consist of only alphanumeric characters and hyphens (-), and begin or end with a character other than a hyphen. b. For Directory DNS name, enter the fully-qualiﬁed name for the directory (for example, example.com). Important If you need to update your DNS server after launching your WorkSpaces, follow the procedure in Update DNS servers for WorkSpaces Personal to ensure that your WorkSpaces get properly updated. c. d. e. f. g. h. For NetBIOS name, enter a short name for the directory (for example, example). For Admin password and Conﬁrm password, enter a password for the directory administrator account. For more information about the password requirements, see How to Create a Microsoft AD Directory in the AWS Directory Service Administration Guide. (Optional) For Description, enter a description for the directory. For Directory size, choose Small. For VPC, select the VPC that you created. For Subnets, select the two private subnets (with the CIDR blocks 10.0.1.0/24 and 10.0.2.0/24). i. Choose Next. 8. Choose Create directory. 9. You will be brought back to the Create directory page on WorkSpaces console. The initial status of the directory is Requested and then Creating. When directory creation is complete (this might take a few minutes), the status is Active. What happens during directory creation WorkSpaces completes the following tasks on your behalf: • Creates an IAM role to allow the WorkSpaces service to create elastic network interfaces and list your WorkSpaces directories. This role has the name workspaces_DefaultRole. Create a directory 244 Amazon WorkSpaces Administration Guide • Sets up a Simple AD directory in the VPC that is used to store user and WorkSpace information. The directory has an administrator account with the user name Administrator and the speciﬁed password. • Creates two security groups, one for directory controllers and another for WorkSpaces in the directory. After you’ve created an Simple AD directory, you can register it with Amazon WorkSpaces. For more information, see Register an existing AWS Directory Service directory with WorkSpaces Personal Create an AD Connector for WorkSpaces Personal In this tutorial, we create an AD Connector. For tutorials that use the other options, see Create a directory for WorkSpaces Personal. Create an AD Connector Note AD Connector is made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your 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 AD Connector directory, you can always create a new one when you want to start using WorkSpaces again. To create an AD Connector 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose Create directory.
workspaces-ag-074	workspaces-ag.pdf	74	WorkSpaces. If there are no WorkSpaces being used with your 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 AD Connector directory, you can always create a new one when you want to start using WorkSpaces again. To create an AD Connector 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose Create directory. 4. On the Create directory page, for WorkSpaces type choose Personal. Then, for WorkSpace device management choose AWS Directory Service. 5. Choose Create directory, which opens the Set up a directory page on the AWS Directory Service Create a directory 245 Amazon WorkSpaces Administration Guide 6. Choose AWS Managed Microsoft AD, and then Next. 7. For Organization name, enter a unique organization name for your directory (for example, my-example-directory). This name must be at least four characters in length, consist of only alphanumeric characters and hyphens (-), and begin or end with a character other than a hyphen. 8. 9. For Connected directory DNS, enter the fully-qualiﬁed name of your on-premises directory (for example, example.com). For Connected directory NetBIOS name, enter the short name of your on-premises directory (for example, example). 10. For Connector account username, enter the user name of a user in your on-premises directory. The user must have permissions to read users and groups, create computer objects, and join computers to the domain. 11. For Connector account password and Conﬁrm password, enter the password for the on- premises user. 12. For DNS address, enter the IP address of at least one DNS server in your on-premises directory. Important If you need to update your DNS server IP address after launching your WorkSpaces, follow the procedure in Update DNS servers for WorkSpaces Personal to ensure that your WorkSpaces get properly updated. 13. (Optional) For Description, enter a description for the directory. 14. Keep Size as Small. 15. For VPC, select your VPC. 16. For Subnets, select your subnets. The DNS servers that you speciﬁed must be accessible from each subnet. 17. Choose Create directory. 18. You will be brought back to the Create directory page on WorkSpaces console. The initial status of the directory is Requested and then Creating. When directory creation is complete (this might take a few minutes), the status is Active. Create a directory 246 Amazon WorkSpaces Administration Guide Create a trust relationship between your AWS Managed Microsoft AD directory and your on-premises domain for WorkSpaces Personal In this tutorial, we create a trust relationship between your AWS Managed Microsoft AD directory and your on-premises domain. For tutorials that use the other options, see Create a directory for WorkSpaces Personal. Note Launching WorkSpaces with AWS accounts in a separate trusted domain works with AWS Managed Microsoft AD when it is conﬁgured with a trust relationship to your on- premises directory. However, WorkSpaces using Simple AD or AD Connector cannot launch WorkSpaces for users from a trusted domain. To set up the trust relationship 1. Set up AWS Managed Microsoft AD in your virtual private cloud (VPC). For more information, see Create Your AWS Managed Microsoft AD directory in the AWS Directory Service Administration Guide. Note • Shared directories are not currently supported for use with Amazon WorkSpaces. • If your AWS Managed Microsoft AD directory has been conﬁgured 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. 2. Create a trust relationship between your AWS Managed Microsoft AD and your on-premises domain. Ensure that the trust is conﬁgured as a two-way trust. For more information, see Tutorial: Create a Trust Relationship Between Your AWS Managed Microsoft AD and Your On- Premises Domain in the AWS Directory Service Administration Guide. Create a directory 247 Amazon WorkSpaces Administration Guide A one-way or two-way trust can be used to manage and authenticate with WorkSpaces, and so that WorkSpaces can be provisioned to on-premises users and groups. For more information, see Deploy Amazon WorkSpaces using a One-Way Trust Resource Domain with AWS Directory Service. Note • Red Hat Enterprise Linux, Rocky Linux, and Ubuntu WorkSpaces use System Security Services Daemon (SSSD) for Active Directory integration, and SSSD does not support forest trust. Conﬁgure external trust instead. Two-way trust is recommended for Amazon Linux, Ubuntu, Rocky Linux, and Red Hat Enterprise Linux WorkSpaces. • You cannot use a web browser (Web Access) to connect to Linux WorkSpaces. Create
workspaces-ag-075	workspaces-ag.pdf	75	be used to manage and authenticate with WorkSpaces, and so that WorkSpaces can be provisioned to on-premises users and groups. For more information, see Deploy Amazon WorkSpaces using a One-Way Trust Resource Domain with AWS Directory Service. Note • Red Hat Enterprise Linux, Rocky Linux, and Ubuntu WorkSpaces use System Security Services Daemon (SSSD) for Active Directory integration, and SSSD does not support forest trust. Conﬁgure external trust instead. Two-way trust is recommended for Amazon Linux, Ubuntu, Rocky Linux, and Red Hat Enterprise Linux WorkSpaces. • You cannot use a web browser (Web Access) to connect to Linux WorkSpaces. Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal In this tutorial, we create Bring Your Own License (BYOL) Windows 10 and 11 personal WorkSpaces that are Microsoft Entra ID joined and enrolled to Microsoft Intune. Before creating such WorkSpaces, you need to ﬁrst create a dedicated WorkSpaces Personal directory for Entra ID-joined WorkSpaces. Note Microsoft Entra joined personal WorkSpaces are available in all AWS regions where Amazon WorkSpaces is oﬀered except for Africa (Cape Town), Israel (Tel Aviv), and China (Ningxia). Contents • Overview • Requirements and limitations • Step 1: Enable IAM Identity Center and synchronize with Microsoft Entra ID • Step 2: Register a Microsoft Entra ID application to grant permissions for Windows Autopilot • Step 3: Conﬁgure Windows Autopilot user-driven mode • Step 4: Create an AWS Secrets Manager secret • Step 5: Create a dedicated Microsoft Entra ID WorkSpaces directory • Conﬁgure the IAM Identity Center application for a WorkSpaces directory (optional) Create a directory 248 Amazon WorkSpaces Administration Guide • Create a cross-Region IAM Identity Center integration (optional) Overview A Microsoft Entra ID personal WorkSpaces directory contains all the information needed to launch Microsoft Entra ID-joined WorkSpaces that are assigned to your users managed with Microsoft Entra ID. User information is made available to WorkSpaces through AWS IAM Identity Center, which acts as an identity broker to bring your workforce identity from Entra ID to AWS. Microsoft Windows Autopilot user-driven mode is used to accomplish WorkSpaces Intune enrollment and Entra join. The following diagram illustrates the Autopilot process. Requirements and limitations • Microsoft Entra ID P1 plan or higher. • Microsoft Entra ID and Intune is enabled and have role assignments. • Intune administrator - Required for managing Autopilot deployment proﬁles. • Global administrator - Required for granting admin consent for the API permissions assigned to the application created in step 3. The application can be created without this permission. However, a Global Administrator would need to provide admin consent on the application permissions. • Assign Windows 10/11 VDA E3 or E5 user subscription licenses to your WorkSpaces users. • Entra ID directories only support Windows 10 or 11 Bring Your Own License personal WorkSpaces. The following are supported versions. • Windows 10 Version 21H2 (December 2021 Update) Create a directory 249 Amazon WorkSpaces Administration Guide • Windows 10 Version 22H2 (November 2022 Update) • Windows 11 Enterprise 23H2 (October 2023 release) • Windows 11 Enterprise 22H2 (October 2022 release) • Bring Your Own License (BYOL) is enabled for your AWS account and you have a valid Windows 10 or 11 BYOL image imported in your account. For more information, see Bring Your Own Windows desktop licenses in WorkSpaces. • Microsoft Entra ID directories only support Windows 10 or 11 BYOL personal WorkSpaces. • Microsoft Entra ID directories support only DCV protocol. Step 1: Enable IAM Identity Center and synchronize with Microsoft Entra ID To create Microsoft Entra ID-joined personal WorkSpaces and assign them to your Entra ID users, you have to make the user information available to AWS through IAM Identity Center. IAM Identity Center is the recommended AWS service for managing user access to AWS resources. For more information, see What is IAM Identity Center?. This is a one-time setup. If you don’t have an existing IAM Identity Center instance to integrate with your WorkSpaces, we recommend that you create one in the same Region as your WorkSpaces. If you have an existing AWS Identity Center instance in a diﬀerent Region, you can set up cross-Region integration. For more information about cross-Region setup, see the section called “ Create a cross-Region IAM Identity Center integration (optional)”. Note Cross-region integration between WorkSpaces and IAM Identity Center is not supported in AWS GovCloud (US) Region. 1. Enable IAM Identity Center with your AWS Organizations, especially if you are using a multi- account environment. You can also create an account instance of IAM Identity Center. To learn more, see Enabling AWS IAM Identity Center. Each WorkSpaces directory can be associated with one IAM Identity Center instance, organization or account. If you are using an organization instance and trying to create a WorkSpaces directory in one of the member accounts, make sure you have the following
workspaces-ag-076	workspaces-ag.pdf	76	Identity Center integration (optional)”. Note Cross-region integration between WorkSpaces and IAM Identity Center is not supported in AWS GovCloud (US) Region. 1. Enable IAM Identity Center with your AWS Organizations, especially if you are using a multi- account environment. You can also create an account instance of IAM Identity Center. To learn more, see Enabling AWS IAM Identity Center. Each WorkSpaces directory can be associated with one IAM Identity Center instance, organization or account. If you are using an organization instance and trying to create a WorkSpaces directory in one of the member accounts, make sure you have the following IAM Identity Center permissions. • "sso:DescribeInstance" Create a directory 250 Amazon WorkSpaces Administration Guide • "sso:CreateApplication" • "sso:PutApplicationGrant" • "sso:PutApplicationAuthenticationMethod" • "sso:DeleteApplication" • "sso:DescribeApplication" • "sso:getApplicationGrant" For more information, see Overview of managing access permissions to your IAM Identity Center resources. Also, ensure that no Service Control Policies (SCPs) are blocking these permissions. To learn more about SCPs, see Service control policies (SCPs). 2. Conﬁgure IAM Identity Center and Microsoft Entra ID to automatically synchronize selected or all users from your Entra ID tenant to your IAM Identity Center instance. For more information, see Conﬁgure SAML and SCIM with Microsoft Entra ID and IAM Identity Center and Tutorial: Conﬁgure AWS IAM Identity Center for automatic user provisioning. 3. Verify that the users you conﬁgured on Microsoft Entra ID are synchronized correctly to AWS IAM Identity Center instance. If you see an error message in Microsoft Entra ID, it indicates that the user in Entra ID is conﬁgured in a way that IAM Identity Center doesn’t support. The error message will identify this issue. For example, if the user object in Entra ID lacks a ﬁrst name, a last name, and/or a display name, you’ll receive an error message similar to "2 validation errors detected: Value at 'name.givenName' failed to satisfy constraint: Member must satisfy regular expression pattern: [\\p{L}\ \p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+; Value at 'name.givenName' failed to satisfy constraint: Member must have length greater than or equal to 1". For more information, see Speciﬁc users fail to synchronize into IAM Identity Center from an external SCIM provider. Note WorkSpaces uses Entra ID UserPrincipalName (UPN) attribute to identify individual users and the following are its limitations: • UPNs cannot exceed 63 characters in length. • If you change the UPN after assigning a WorkSpace to a user, the user won't be able to connect to their WorkSpace unless you change the UPN back to what it was before. Create a directory 251 Amazon WorkSpaces Administration Guide Step 2: Register a Microsoft Entra ID application to grant permissions for Windows Autopilot WorkSpaces Personal uses Microsoft Windows Autopilot user-driven mode to enroll WorkSpaces to Microsoft Intune and join them to Microsoft Entra ID. To allow Amazon WorkSpaces to register WorkSpaces Personal into Autopilot, you must register a Microsoft Entra ID application that grants necessary Microsoft Graph API permissions. For more information about registering an Entra ID application, see Quickstart: Register an application with the Microsoft identity platform. We recommend providing the following API permissions in your Entra ID application. • To create a new personal WorkSpace that needs to be joined to Entra ID, following API permission is required. • DeviceManagementServiceConfig.ReadWrite.All • When you terminate a personal WorkSpace or rebuild it, the following permissions are used. Note If you don’t provide these permissions, WorkSpace will be terminated but it will not be removed from your Intune and Entra ID tenants and you will have to remove them separately. • DeviceManagementServiceConfig.ReadWrite.All • Device.ReadWrite.All • DeviceManagementManagedDevices.ReadWrite.All • These permissions require admin consent. For more information, see Grant tenant-wide admin consent to an application . Next, you must add a client secret for the Entra ID application. For more information, see Add credentials. Make sure you remember the client secret string as you will need it when creating the AWS Secrets Manager secret in Step 4. Step 3: Conﬁgure Windows Autopilot user-driven mode Ensure you are familiar with the Step by step tutorial for Windows Autopilot user-driven Microsoft Entra join in Intune. Create a directory 252 Amazon WorkSpaces Administration Guide To conﬁgure your Microsoft Intune for Autopilot 1. Sign into the Microsoft Intune admin center 2. Create a new Autopilot device group for personal WorkSpaces. For more information, see Create device groups for Windows Autopilot. a. b. c. Choose Groups, New group For Group type, choose Security. For Membership type, choose Dynamic Device. d. Choose Edit dynamic query to create a dynamic membership rule. The rule should be in the following format: (device.devicePhysicalIds -any (_ -eq "[OrderID]:WorkSpacesDirectoryName")) Important WorkSpacesDirectoryName should match the directory name of the Entra ID WorkSpaces Personal directory you create in step 5. This is because the directory name string is used as group tag when WorkSpaces registers virtual desktops into Autopilot. Additionally, group tag
workspaces-ag-077	workspaces-ag.pdf	77	new Autopilot device group for personal WorkSpaces. For more information, see Create device groups for Windows Autopilot. a. b. c. Choose Groups, New group For Group type, choose Security. For Membership type, choose Dynamic Device. d. Choose Edit dynamic query to create a dynamic membership rule. The rule should be in the following format: (device.devicePhysicalIds -any (_ -eq "[OrderID]:WorkSpacesDirectoryName")) Important WorkSpacesDirectoryName should match the directory name of the Entra ID WorkSpaces Personal directory you create in step 5. This is because the directory name string is used as group tag when WorkSpaces registers virtual desktops into Autopilot. Additionally, group tag maps to the OrderID attribute on Microsoft Entra devices. 3. Choose Devices, Windows, Enrollment. For Enrollment Options, choose Automatic Enrollment. For MDM user scope select All. 4. Create an Autopilot deployment proﬁle. For more information, see Create an Autopilot deployment proﬁle. a. b. c. For Windows Autopilot, choose Deployment proﬁles, Create proﬁle. In the Windows Autopilot deployment proﬁles screen, select the Create Proﬁle drop down menu and then select Windows PC. In the Create proﬁle screen, on On the Out-of-box experience (OOBE) page. For Deployment mode, select User-driven. For Join to Microsoft Entra ID, select Microsoft Entra joined. You can customize the computer names for your Entra ID-joined personal WorkSpaces by selecting Yes for Apply device name template, to create a template to use when naming a device during enrollment. Create a directory 253 Amazon WorkSpaces Administration Guide d. On the Assignments page, for Assign to, choose Selected groups. Choose Select groups to include, and select the Autopilot device group you’ve just created in 2. Step 4: Create an AWS Secrets Manager secret You must create a secret in AWS Secrets Manager to securely store the information, including the application ID and client secret, for the Entra ID application you created in Step 2: Register a Microsoft Entra ID application to grant permissions for Windows Autopilot. This is a one-time setup. To create an AWS Secrets Manager secret 1. Create a customer managed key on AWS Key Management Service. The key will later be used to encrypt the AWS Secrets Manager secret. Don't use the default key to encrypt your secret as the default key cannot be accessed by the WorkSpaces service. Follow the steps below to create the key. a. Open the AWS KMS console at https://console.aws.amazon.com/kms. b. c. To change the AWS Region, use the Region selector in the upper-right corner of the page. Choose Create key. d. On the Conﬁgure key page, for Key type choose Symmetric. For Key usage, choose Encrypt and decrypt. e. On the Review page, in the Key policy editor, ensure you allow the WorkSpaces service's principal workspaces.amazonaws.com access to the key by including following permissions in the key policy. { "Effect": "Allow", "Principal": { "Service": [ "workspaces.amazonaws.com" ] }, "Action": [ "kms:Decrypt", "kms:DescribeKey" ], "Resource": "" Create a directory 254 Amazon WorkSpaces } Administration Guide 2. Create the secret on AWS Secrets Manager, using the AWS KMS key created in previous step. a. Open the Secrets Manager console at https://console.aws.amazon.com/secretsmanager/. b. Choose Store a new secret. c. On the Choose secret type page, for Secret type, select Other type of secret. d. e. f. For Key/value pairs, in the key box, enter “application_id” into the key box, then copy the Entra ID application ID from Step 2 and paste it into the value box. Choose Add row, in the key box, enter “application_password”, then copy the Entra ID application client secret from Step 2 and paste it into the value box. Choose the AWS KMS key that you created in the previous step from the Encryption key drop-down list. g. Choose Next. h. On the Conﬁgure secret page, enter a Secret name and Description. i. In the Resource permissions section, choose Edit permissions. j. Make sure you allow the WorkSpaces service's principal workspaces.amazonaws.com access to the secret by including following resource policy in the resource permissions. { "Version" : "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Principal" : { "Service" : [ "workspaces.amazonaws.com"] }, "Action" : "secretsmanager:GetSecretValue", "Resource" : "" } ] } Step 5: Create a dedicated Microsoft Entra ID WorkSpaces directory Create a dedicated WorkSpaces directory that stores information for your Microsoft Entra ID-joined WorkSpaces and Entra ID users. Create a directory 255 Amazon WorkSpaces Administration Guide To create an Entra ID WorkSpaces directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. On the Create directory page, for WorkSpaces type choose Personal. For WorkSpace device management, choose Microsoft Entra ID. 4. 5. 6. For Microsoft Entra tenant ID, enter your Microsoft Entra ID tenant ID that you want your directory's WorkSpaces to join to. You won't be able to change the tenant ID after the directory is created. For Entra ID Application
workspaces-ag-078	workspaces-ag.pdf	78	for your Microsoft Entra ID-joined WorkSpaces and Entra ID users. Create a directory 255 Amazon WorkSpaces Administration Guide To create an Entra ID WorkSpaces directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. On the Create directory page, for WorkSpaces type choose Personal. For WorkSpace device management, choose Microsoft Entra ID. 4. 5. 6. For Microsoft Entra tenant ID, enter your Microsoft Entra ID tenant ID that you want your directory's WorkSpaces to join to. You won't be able to change the tenant ID after the directory is created. For Entra ID Application ID and password, select the AWS Secrets Manager secret that you created in Step 4 from the drop down list. You won't be able to change the secret associated with the directory after the directory is created. However, you can always update the content of the secret, including the Entra ID Application ID and its password through the AWS Secrets Manager console at https://console.aws.amazon.com/secretsmanager/. If your IAM Identity Center instance is in the same AWS Region as your WorkSpaces directory, for User identity source, select the IAM Identity Center instance that you conﬁgured in Step 1 from the dropdown list. You won't be able to change the IAM Identity Center instance associated with the directory after the directory is created. If your IAM Identity Center instance is in a diﬀerent AWS Region than your WorkSpaces directory, choose Enable Cross-Region and then select the Region from the dropdown list. Note If you have an existing IAM Identity Center instance in a diﬀerent Region, you must opt-in to set up a cross-Region integration. For more information about cross-Region setup, see the section called “ Create a cross-Region IAM Identity Center integration (optional)”. 7. For Directory name, enter a unique name for the directory (For example, WorkSpacesDirectoryName). Important The directory name should match the OrderID used to construct the dynamic query for the Autopilot device group that you created with Microsoft Intune in Step 3. The directory name string is used as the group tag when registering personal WorkSpaces Create a directory 256 Amazon WorkSpaces Administration Guide into Windows Autopilot. The group tag maps to the OrderID attribute on Microsoft Entra devices. 8. 9. (Optional) For Description, enter a description for the directory. For VPC, select the VPC that you used to launch your WorkSpaces. For more information, see Conﬁgure a VPC for WorkSpaces Personal. 10. For Subnets, select two subnets of your VPC that are not from the same Availability Zone. These subnets will be used to launch your personal WorkSpaces. For more information, see Availability Zones for WorkSpaces Personal. Important Make sure the WorkSpaces launched in the subnets have internet access, which is needed when users login to the Windows desktops. For more information, see Provide internet access for WorkSpaces Personal. 11. For Conﬁguration, select Enable dedicated WorkSpace. You must enable it to create a dedicated WorkSpaces Personal directory to launch Bring Your Own License (BYOL) Windows 10 or 11 personal WorkSpaces. Note If you don't see the Enable dedicated WorkSpace option under Conﬁguration, your account hasn't been enabled for BYOL. To enable BYOL for your account, see Bring Your Own Windows desktop licenses in WorkSpaces. 12. (Optional) For Tags, specify the key pair value that you want to use for personal WorkSpaces in the directory. 13. Review the directory summary and choose Create directory. It takes several minutes for your directory to be connected. The initial status of the directory is Creating. When directory creation is complete, the status is Active. An IAM Identity Center application is also automatically created on your behalf once the directory is created. To ﬁnd the application’s ARN go to the directory's summary page. Create a directory 257 Amazon WorkSpaces Administration Guide You can now use the directory to launch Windows 10 or 11 personal WorkSpaces that are enrolled to Microsoft Intune and joined to Microsoft Entra ID. For more information, see Create a WorkSpace in WorkSpaces Personal. After you've created a WorkSpaces Personal directory, you can create a personal WorkSpace. For more information, see Create a WorkSpace in WorkSpaces Personal Conﬁgure the IAM Identity Center application for a WorkSpaces directory (optional) A corresponding IAM Identity Center application is automatically created once a directory is created. You can ﬁnd the application’s ARN in the Summary section on the directory detail page. By default, all users in the Identity Center instance can access their assigned WorkSpaces without conﬁguring the corresponding Identity Center application. However, you can manage user access to WorkSpaces in a directory by conﬁguring the user assignment for the IAM Identity Center application. To conﬁgure the user assignment for the IAM Identity Center application 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. On the AWS managed applications tab, choose the application for the WorkSpaces
workspaces-ag-079	workspaces-ag.pdf	79	Identity Center application is automatically created once a directory is created. You can ﬁnd the application’s ARN in the Summary section on the directory detail page. By default, all users in the Identity Center instance can access their assigned WorkSpaces without conﬁguring the corresponding Identity Center application. However, you can manage user access to WorkSpaces in a directory by conﬁguring the user assignment for the IAM Identity Center application. To conﬁgure the user assignment for the IAM Identity Center application 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. On the AWS managed applications tab, choose the application for the WorkSpaces directory. The application names are in the following format: WorkSpaces.wsd-xxxxx, where wsd- xxxxx is the WorkSpaces directory ID. 3. Choose Actions, Edit details. 4. Change the User and group assignment method from Do not require assignments to Require assignments. 5. Choose Save changes. After you make this change, users in the Identity Center instance will lose access their assign WorkSpaces unless they are assigned to the application. To assign your users to the application, use the AWS CLI command create-application-assignment to assign users or groups to an application. For more information, see the AWS CLI Command Reference. Create a cross-Region IAM Identity Center integration (optional) We recommend that your WorkSpaces and the associated IAM Identity Center instance are in the same AWS Region. However, if you already have an IAM Identity Center instance conﬁgured in a diﬀerent Region from your WorkSpaces Region, you can create a cross-Region integration. When you create a cross-Region WorkSpaces and IAM Identity Center integration, you enable WorkSpaces Create a directory 258 Amazon WorkSpaces Administration Guide to make cross-Region calls to access and store information from your IAM Identity Center instance, such as user and group attributes. Important Amazon WorkSpaces supports cross-Region IAM Identity Center and WorkSpaces integrations only for organization-level instances. WorkSpaces doesn't support cross- Region IAM Identity Center integrations for account-level instances. For more information about IAM Identity Center instance types and their use cases, see, Understanding types of IAM Identity Center instances. If you create a cross-Region integration between a WorkSpaces directory and an IAM Identity Center instance, you may experience higher latency when deploying WorkSpaces and during login because of cross-Region calls. The increase in latency is proportional to the distance between your WorkSpaces Region and the IAM Identity Center Region. We recommend that you perform latency tests for your speciﬁc use case. Before you can create a cross-Region IAM Identity Center integration, you must complete an opt-in process to allow your AWS accounts to use this feature. To get started, contact your AWS account manager, sales representative, or AWS Support Center. Until you complete this process, the Enable cross-Region IAM Identity Center Support option isn't available in your Amazon WorkSpaces console when you create a WorkSpaces directory. Note This opt-in process requires a minimum of one business day to complete. After you opt in, you can enable cross-Region IAM Identity Center connections during Step 5: Create a dedicated Microsoft Entra ID WorkSpaces directory. For User identity source, choose the IAM Identity Center instance that you conﬁgured in the section called “Step 1: Enable IAM Identity Center and synchronize with Microsoft Entra ID” from the dropdown menu. Important You can't change the IAM Identity Center instance associated with the directory after you create it. Create a directory 259 Amazon WorkSpaces Administration Guide Create a dedicated Custom directory with WorkSpaces Personal Before you create Windows 10 and 11 BYOL personal WorkSpaces and assign them to your users, managed with AWS IAM Identity Center Identity Providers (IdPs), you must create a dedicated Custom WorkSpaces directory. Personal WorkSpaces are not joined to any Microsoft Active Directory but can be managed with a Mobile Device Management (MDM) solution of your choice, such as JumpCloud. For more information about JumpCloud, see this article. For tutorials that use the other options, see Create a directory for WorkSpaces Personal. Note • Amazon WorkSpaces can't create or manage user accounts on personal WorkSpaces launched in a Custom directory. As an administrator, you will have to manage them. • Custom WorkSpaces directory is available in all AWS regions where Amazon WorkSpaces is oﬀered except for Africa (Cape Town), Israel (Tel Aviv), and China (Ningxia). • Amazon WorkSpaces can't create or manage user accounts on WorkSpaces using Custom directories. To ensure the MDM agent software you use can create the user proﬁle on the Windows WorkSpaces, contact the MDM solution providers. Creating the user proﬁle allows your users to sign into the Windows desktop from Windows login screen. Contents • Requirements and limitations • Step 1: Enable IAM Identity Center and connect with your Identity Provider • Step 2: Create a dedicated Custom WorkSpaces directory Requirements and limitations • Custom WorkSpaces directories only support Windows 10 or 11 Bring Your Own License
workspaces-ag-080	workspaces-ag.pdf	80	and China (Ningxia). • Amazon WorkSpaces can't create or manage user accounts on WorkSpaces using Custom directories. To ensure the MDM agent software you use can create the user proﬁle on the Windows WorkSpaces, contact the MDM solution providers. Creating the user proﬁle allows your users to sign into the Windows desktop from Windows login screen. Contents • Requirements and limitations • Step 1: Enable IAM Identity Center and connect with your Identity Provider • Step 2: Create a dedicated Custom WorkSpaces directory Requirements and limitations • Custom WorkSpaces directories only support Windows 10 or 11 Bring Your Own License personal WorkSpaces. • Custom WorkSpaces directories only support DCV protocol. • Ensure you enable BYOL for your AWS account and you have your own AWS KMS server that your personal WorkSpaces can access for Windows 10 and 11 activation. For details, see Bring Your Own Windows desktop licenses in WorkSpaces. Create a directory 260 Amazon WorkSpaces Administration Guide • Ensure you pre-install the MDM agent software on the BYOL image that you imported to your AWS account. Step 1: Enable IAM Identity Center and connect with your Identity Provider To assign WorkSpaces to your users managed with your Identity Providers, the user information must be made available to AWS through AWS IAM Identity Center. We recommend using IAM Identity Center to manage your user's access to AWS resources. For more information, see What is IAM Identity Center?. This is a one-time setup. To make user information available to AWS 1. Enable IAM Identity Center on AWS. You can enable IAM Identity Center with your AWS organizations, especially if you are using a multi-account environment. You can also create an account instance of IAM Identity Center. For more information, see Enabling AWS IAM Identity Center. Each WorkSpaces directory can associate with one IAM Identity Center organization or account instance. Each IAM Identity Center instance can be associated with one or more WorkSpaces Personal directory. If you are using an organization instance and trying to create a WorkSpaces directory in one of the member accounts, ensure you have the following IAM Identity Center permissions. • "sso:DescribeInstance" • "sso:CreateApplication" • "sso:PutApplicationGrant" • "sso:PutApplicationAuthenticationMethod" • "sso:DeleteApplication" • "sso:DescribeApplication" • "sso:getApplicationGrant" For more information, see Overview of managing access permissions to your IAM Identity Center resources. Ensure that no Service Control Policies (SCPs) are blocking these permissions. To learn more about SCPs, see Service control policies (SCPs). 2. Conﬁgure IAM Identity Center and your Identity Provider (IdP) to automatically synchronize users from your IdP to your IAM Identity Center instance. For more information, see Getting Create a directory 261 Amazon WorkSpaces Administration Guide started tutorials and choose the speciﬁc tutorial for the IdP that you want to use. For example, Using IAM Identity Center to connect with your JumpCloud Directory Platform. 3. Verify that the users you conﬁgured on your IdP are synchronized correctly to AWS IAM Identity Center instance. The ﬁrst synchronization can take up to an hour depending the conﬁguration of your IdP. Step 2: Create a dedicated Custom WorkSpaces directory Create a dedicated WorkSpaces Personal directory that stores information about your personal WorkSpaces and your users. To create a dedicated Custom WorkSpaces directory 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose Directories. 3. Choose Create directory. 4. On the Create directory page, for WorkSpaces type, choose Personal. For WorkSpace device management, choose Custom. 5. For User identity source, select the IAM Identity Center instance that you conﬁgured in Step 1 from the dropdown list. You won't be able to change the IAM Identity Center instance associated with the directory once the directory is created. Note You have to specify an IAM Identity Center instance for the directory or you won't be able to launch personal WorkSpaces with the directory using the WorkSpaces console. WorkSpaces directories with no associated Identity Center are only compatible with WorkSpaces Core partner solutions. 6. 7. 8. For Directory name, enter a unique name for the directory. For VPC, select the VPC that you used to launch your WorkSpaces. For more information, see Conﬁgure a VPC for WorkSpaces Personal. For Subnets, select two subnets of your VPC that are not from the same Availability Zone. These subnets will be used to launch your personal WorkSpaces. For more information, see Availability Zones for WorkSpaces Personal. Create a directory 262 Amazon WorkSpaces Administration Guide Important Make sure the WorkSpaces launched in the subnets have internet access, which is needed when users login to the Windows desktops. For more information, see Provide internet access for WorkSpaces Personal. 9. For Conﬁguration, select Enable dedicated WorkSpace. You must enable it to create a dedicated WorkSpaces Personal directory to launch Bring Your Own License (BYOL) Windows 10 or 11 personal WorkSpaces. 10. (Optional) For Tags, specify the key pair
workspaces-ag-081	workspaces-ag.pdf	81	Availability Zone. These subnets will be used to launch your personal WorkSpaces. For more information, see Availability Zones for WorkSpaces Personal. Create a directory 262 Amazon WorkSpaces Administration Guide Important Make sure the WorkSpaces launched in the subnets have internet access, which is needed when users login to the Windows desktops. For more information, see Provide internet access for WorkSpaces Personal. 9. For Conﬁguration, select Enable dedicated WorkSpace. You must enable it to create a dedicated WorkSpaces Personal directory to launch Bring Your Own License (BYOL) Windows 10 or 11 personal WorkSpaces. 10. (Optional) For Tags, specify the key pair value that you want to use for personal WorkSpaces in the directory. 11. Review the directory summary and choose Create directory. It takes several minutes for your directory to be connected. The initial status of the directory is Creating. When directory creation is complete, the status is Active. An IAM Identity Center application is also automatically created on your behalf once the directory is created. To ﬁnd the application’s ARN go to the directory's summary page. You can now use the directory to launch Windows 10 or 11 personal WorkSpaces that are enrolled to Microsoft Intune and joined to Microsoft Entra ID. For more information, see Create a WorkSpace in WorkSpaces Personal. After you've created a WorkSpaces Personal directory, you can create a personal WorkSpace. For more information, see Create a WorkSpace in WorkSpaces Personal Update DNS servers for WorkSpaces Personal If you need to update the DNS server IP addresses for your Active Directory after launching your WorkSpaces, you must also update your WorkSpaces with the new DNS server settings. You can update your WorkSpaces with the new DNS settings in one of the following ways: • Update the DNS settings on the WorkSpaces before you update the DNS settings for Active Directory. • Rebuild the WorkSpaces after you update the DNS settings for Active Directory. Update DNS servers for WorkSpaces 263 Amazon WorkSpaces Administration Guide We recommend updating the DNS settings on the WorkSpaces before updating the DNS settings in Active Directory (as explained in Step 1 of the following procedure). If you want to rebuild the WorkSpaces instead, update one of the DNS server IP addresses in your Active Directory (Step 2), and then follow the procedure in Rebuild a WorkSpace in WorkSpaces Personal to rebuild your WorkSpaces. After you've rebuilt your WorkSpaces, follow the procedure in Step 3 to test your DNS server updates. After completing that step, update the IP address of your second DNS server in Active Directory, and then rebuild your WorkSpaces again. Be sure to follow the procedure in Step 3 to test your second DNS server update. As noted in the Best Practices section, we recommend updating your DNS server IP addresses one at a time. Best practices When you're updating your DNS server settings, we recommend the following best practices: • To avoid disconnections and inaccessibility of domain resources, we strongly recommend performing DNS server updates during oﬀ-peak hours or during a planned maintenance period. • Don't launch any new WorkSpaces during the 15 minutes before and the 15 minutes after changing your DNS server settings. • When updating your DNS server settings, change one DNS server IP address at a time. Verify that the ﬁrst update is correct before updating the second IP address. We recommend performing the following procedure (Step 1, Step 2, and Step 3) twice to update the IP addresses one at a time. Step 1: Update the DNS server settings on your WorkSpaces In the following procedure, the current and new DNS server IP address values are referred to as follows: • Current DNS IP addresses: OldIP1, OldIP2 • New DNS IP addresses: NewIP1, NewIP2 Note If this is the second time you're performing this procedure, replace OldIP1 with OldIP2 and NewIP1 with NewIP2. Update DNS servers for WorkSpaces 264 Amazon WorkSpaces Administration Guide Update the DNS server settings for Windows WorkSpaces If you have multiple WorkSpaces, you can deploy the following registry update to the WorkSpaces by applying a Group Policy Object (GPO) on the Active Directory OU for your WorkSpaces. For more information about working with GPOs, see Manage your Windows WorkSpaces in WorkSpaces Personal. You can make these updates either by using the Registry Editor or by using Windows PowerShell. Both procedures are described in this section. To update the DNS registry settings using the Registry Editor 1. On your Windows WorkSpace, open the Windows search box, and enter registry editor to open the Registry Editor (regedit.exe). 2. When asked "Do you want to allow this app to make changes to your device?", choose Yes. 3. In the Registry Editor, navigate to the following registry entry: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\SkyLight 4. Open the DomainJoinDns registry key. Update OldIP1 with NewIP1, and then choose OK. 5.
workspaces-ag-082	workspaces-ag.pdf	82	WorkSpaces Personal. You can make these updates either by using the Registry Editor or by using Windows PowerShell. Both procedures are described in this section. To update the DNS registry settings using the Registry Editor 1. On your Windows WorkSpace, open the Windows search box, and enter registry editor to open the Registry Editor (regedit.exe). 2. When asked "Do you want to allow this app to make changes to your device?", choose Yes. 3. In the Registry Editor, navigate to the following registry entry: HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\SkyLight 4. Open the DomainJoinDns registry key. Update OldIP1 with NewIP1, and then choose OK. 5. Close the Registry Editor. 6. Reboot the WorkSpace, or restart the service SkyLightWorkspaceConﬁgService. Note After you restart the service SkyLightWorkspaceConﬁgService, it can take up to 1 minute for the network adapter to reﬂect the change. 7. Proceed to Step 2, and update your DNS server settings in Active Directory to replace OldIP1 with NewIP1. To update the DNS registry settings using PowerShell The following procedure uses PowerShell commands to update your registry and restart the service SkyLightWorkspaceConﬁgService. 1. On your Windows WorkSpace, open the Windows search box, and enter powershell. Choose Run as Administrator. 2. When asked "Do you want to allow this app to make changes to your device?", choose Yes. Update DNS servers for WorkSpaces 265 Amazon WorkSpaces Administration Guide 3. In the PowerShell window, run the following command to retrieve the current DNS server IP addresses. Get-ItemProperty -Path HKLM:\SOFTWARE\Amazon\SkyLight -Name DomainJoinDNS You should receive the following output. DomainJoinDns : OldIP1,OldIP2 PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\SOFTWARE \Amazon\SkyLight PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\SOFTWARE \Amazon PSChildName : SkyLight PSDrive : HKLM PSProvider : Microsoft.PowerShell.Core\Registry 4. In the PowerShell window, run the following command to change OldIP1 to NewIP1. Be sure to leave OldIP2 as is for now. Set-ItemProperty -Path HKLM:\SOFTWARE\Amazon\SkyLight -Name DomainJoinDNS -Value "NewIP1,OldIP2" 5. Run the following command to restart the service SkyLightWorkspaceConﬁgService. restart-service -Name SkyLightWorkspaceConfigService Note After you restart the service SkyLightWorkspaceConﬁgService, it can take up to 1 minute for the network adapter to reﬂect the change. 6. Proceed to Step 2, and update your DNS server settings in Active Directory to replace OldIP1 with NewIP1. Update the DNS server settings for Amazon Linux 2 WorkSpaces If you have more than one Amazon Linux 2 WorkSpace, we recommend that you use a conﬁguration management solution to distribute and enforce policy. For example, you can use Ansible. Update DNS servers for WorkSpaces 266 Amazon WorkSpaces Administration Guide To update the DNS server settings on a Amazon Linux 2 WorkSpace 1. On your Linux WorkSpace, open a Terminal window. 2. Use the following Linux command to edit the /etc/dhcp/dhclient.conf ﬁle. You must have root user privileges to edit this ﬁle. Either become root by using the sudo -i command, or run all commands with sudo as shown. sudo vi /etc/dhcp/dhclient.conf In the /etc/dhcp/dhclient.conf ﬁle, you will see the following prepend command, where OldIP1 and OldIP2 are the IP addresses of your DNS servers. prepend domain-name-servers OldIP1, OldIP2; # skylight 3. Replace OldIP1 with NewIP1, and leave OldIP2 as is for now. 4. Save your changes to /etc/dhcp/dhclient.conf. 5. Reboot the WorkSpace. 6. Proceed to Step 2, and update your DNS server settings in Active Directory to replace OldIP1 with NewIP1. Update the DNS server settings for Ubuntu WorkSpaces If you have more than one Ubuntu WorkSpace, we recommend that you use a conﬁguration management solution to distribute and enforce policy. For example, you can use Landscape. To update the DNS server settings on a Ubuntu WorkSpace 1. On your Ubuntu WorkSpace, open a Terminal window and run the following command. You must have root user privileges to edit this ﬁle. Either become root by using the sudo -i command, or run all commands with sudo as shown. sudo vi /etc/netplan/zz-workspaces-domain.yaml 2. In the yaml ﬁle, you will see the following nameserver command. nameservers: search:[Your domain FQDN] addresses:[OldIP1, OldIP2] Update DNS servers for WorkSpaces 267 Amazon WorkSpaces Administration Guide Replace the OldIP1 and OldIP2 with the NewIP1 and NewIP2. If you have multiple DNS servers IP addesses, add them as comma separated values. For example, [NewDNSIP1, NewDNSIP2, NewDNSIP3]. 3. Save the yaml ﬁle. 4. Run the command sudo netplan apply to apply the changes. 5. Run the command resolvectl status to verify that the new DNS IP address is being used. 6. Proceed to Step 2, and update your DNS server settings in Active Directory. Update the DNS server settings for Red Hat Enterprise Linux WorkSpaces If you have more than one Red Hat Enterprise Linux WorkSpace, we recommend that you use a conﬁguration management solution to distribute and enforce policy. For example, you can use Ansible. To update the DNS server settings on a Red Hat Enterprise Linux WorkSpace 1. On your Red Hat Enterprise Linux WorkSpace, open a Terminal window and run the
workspaces-ag-083	workspaces-ag.pdf	83	Run the command resolvectl status to verify that the new DNS IP address is being used. 6. Proceed to Step 2, and update your DNS server settings in Active Directory. Update the DNS server settings for Red Hat Enterprise Linux WorkSpaces If you have more than one Red Hat Enterprise Linux WorkSpace, we recommend that you use a conﬁguration management solution to distribute and enforce policy. For example, you can use Ansible. To update the DNS server settings on a Red Hat Enterprise Linux WorkSpace 1. On your Red Hat Enterprise Linux WorkSpace, open a Terminal window and run the command below. You must have root user privileges to edit this ﬁle. Either become root by using the sudo -i command, or run all commands with sudo as shown. sudo nmcli conn modify CustomerNIC ipv4.dns 'NewIP1 NewIP2' 2. Run the following command. sudo systemctl restart NetworkManager 3. To check the updated DNS and network conﬁguration run the following command. nmcli device show eth1 4. Proceed to Step 2, and update your DNS server settings in Active Directory. Step 2: Update the DNS server settings for Active Directory In this step, you update your DNS server settings for Active Directory. As noted in the Best Practices section, we recommend updating your DNS server IP addresses one at a time. Update DNS servers for WorkSpaces 268 Amazon WorkSpaces Administration Guide To update your DNS server settings for Active Directory, see the following documentation in the AWS Directory Service Administration Guide: • AD Connector: Update the DNS Address for Your AD Connector • AWS Managed Microsoft AD: Conﬁgure DNS Conditional Forwarders for Your On-premises Domain • Simple AD: Conﬁgure DNS After updating your DNS server settings, proceed to Step 3. Step 3: Test the updated DNS server settings After completing Step 1 and Step 2, use the following procedure to verify that your updated DNS server settings are working as expected. In the following procedure, the current and new DNS server IP address values are referred to as follows: • Current DNS IP addresses: OldIP1, OldIP2 • New DNS IP addresses: NewIP1, NewIP2 Note If this is the second time you're performing this procedure, replace OldIP1 with OldIP2 and NewIP1 with NewIP2. Test the updated DNS server settings for Windows WorkSpaces 1. 2. Shut down the OldIP1 DNS server. Log in to a Windows WorkSpace. 3. On the Windows Start menu, choose Windows System, then choose Command Prompt. 4. Run the following command, where AD_Name is the name of your Active Directory (for example, corp.example.com). nslookup AD_Name Update DNS servers for WorkSpaces 269 Amazon WorkSpaces Administration Guide The nslookup command should return the following output. (If this is the second time you're performing this procedure, you should see NewIP2 in place of OldIP2.) Server: Full_AD_Name Address: NewIP1 Name: AD_Name Addresses: OldIP2 NewIP1 5. If the output is not what you were expecting or if you receive any errors, repeat Step 1. 6. Wait for an hour and conﬁrm that no user issues have been reported. Verify that NewIP1 is getting DNS queries and responding with answers. 7. After you've veriﬁed that the ﬁrst DNS server is working properly, repeat Step 1 to update the second DNS server, this time replacing OldIP2 with NewIP2. Then repeat Step 2 and Step 3. Test the updated DNS server settings for Linux WorkSpaces 1. 2. Shut down the OldIP1 DNS server. Log in to a Linux WorkSpace. 3. On your Linux WorkSpace, open a Terminal window. 4. The DNS server IP addresses returned in the DHCP response are written to the local /etc/ resolv.conf ﬁle on the WorkSpace. Run the following command to view the contents of the /etc/resolv.conf ﬁle. cat /etc/resolv.conf You should see the following output. (If this is the second time you're performing this procedure, you should see NewIP2 in place of OldIP2.) ; This file is generated by Amazon WorkSpaces ; Modifying it can make your WorkSpace inaccessible until reboot options timeout:2 attempts:5 ; generated by /usr/sbin/dhclient-script search region.compute.internal nameserver NewIP1 nameserver OldIP2 Update DNS servers for WorkSpaces 270 Amazon WorkSpaces Administration Guide nameserver WorkSpaceIP Note If you make manual modiﬁcations to the /etc/resolv.conf ﬁle, those changes are lost when the WorkSpace is restarted. 5. 6. If the output is not what you were expecting or if you receive any errors, repeat Step 1. The actual DNS server IP addresses are stored in the /etc/dhcp/dhclient.conf ﬁle. To see the contents of this ﬁle, run the following command. sudo cat /etc/dhcp/dhclient.conf You should see the following output. (If this is the second time you're performing this procedure, you should see NewIP2 in place of OldIP2.) # This file is generated by Amazon WorkSpaces # Modifying it can make your WorkSpace inaccessible until rebuild prepend domain-name-servers NewIP1, OldIP2; # skylight 7. Wait for an hour
workspaces-ag-084	workspaces-ag.pdf	84	restarted. 5. 6. If the output is not what you were expecting or if you receive any errors, repeat Step 1. The actual DNS server IP addresses are stored in the /etc/dhcp/dhclient.conf ﬁle. To see the contents of this ﬁle, run the following command. sudo cat /etc/dhcp/dhclient.conf You should see the following output. (If this is the second time you're performing this procedure, you should see NewIP2 in place of OldIP2.) # This file is generated by Amazon WorkSpaces # Modifying it can make your WorkSpace inaccessible until rebuild prepend domain-name-servers NewIP1, OldIP2; # skylight 7. Wait for an hour and conﬁrm that no user issues have been reported. Verify that NewIP1 is getting DNS queries and responding with answers. 8. After you've veriﬁed that the ﬁrst DNS server is working properly, repeat Step 1 to update the second DNS server, this time replacing OldIP2 with NewIP2. Then repeat Step 2 and Step 3. Delete a directory for WorkSpaces Personal Note Simple AD and AD Connector are made 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. 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. Delete a directory 271 Amazon WorkSpaces Administration Guide What happens when you delete a directory When a Simple AD or AWS Directory Service for Microsoft Active Directory directory is deleted, all of the directory data and snapshots are deleted and cannot be recovered. After the directory is deleted, any Amazon EC2 instances that are joined to the directory remain intact. You cannot, however, use your directory credentials to log in to these instances. You need to log in to these instances with an AWS account that is local to the instance. When an AD Connector directory is deleted, your on-premises directory remains intact. Any Amazon EC2 instances that are joined to the directory also remain intact and remain joined to your on-premises directory. You can still use your directory credentials to log in to these instances. Delete an Entra ID or Custom WorkSpaces directory Entra ID WorkSpaces directory allows you to create Entra ID-joined Windows 10 or 11 BYOL WorkSpaces. For more information, see Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal. Custom WorkSpaces directory allows you to create WorkSpaces that are not Active Directory domain-joined, but use your own device management software and IAM Identity Center. For more information, see Create a dedicated Custom directory with WorkSpaces Personal. To delete an Entra ID or Custom WorkSpaces directory 1. Delete all the WorkSpaces in the directory. For more information, see Delete a WorkSpace in WorkSpaces Personal. In the navigation pane, choose Directories. Select the directory. 2. 3. 4. Choose Actions, Delete. 5. When prompted for conﬁrmation, enter delete. Delete an AWS Directory Service directory You can delete the AWS Directory Service directory for your WorkSpaces if it is no longer in use by other WorkSpaces or other applications, such as Amazon WorkDocs, Amazon WorkMail, or Amazon Chime. Note that you must deregister a directory before you can delete it. Delete a directory 272 Amazon WorkSpaces To deregister a directory Administration Guide 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. In the navigation pane, choose Directories. Select the directory. 4. Choose Actions, Deregister. 5. When prompted for conﬁrmation, choose Deregister. After deregistration is complete, the value of Registered is No. To delete a directory 1. Delete all WorkSpaces in the directory. For more information, see Delete a WorkSpace in WorkSpaces Personal. 2. Find and remove all of the applications and services that are registered to the directory. For more information, see Delete Your Directory in the AWS Directory Service Administration Guide. 3. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 4. 5. In the navigation pane, choose Directories. Select the directory and choose Actions, Deregister. 6. When prompted for conﬁrmation, choose Deregister. 7. Select the directory again and choose Actions, Delete. 8. When prompted for conﬁrmation, choose Delete. Note Removing application assignments can sometimes take more time than expected. If you receive the following error message, verify that you've removed all application assignments, and then wait 30 to 60 minutes before trying again to delete the directory: An Error Has Occurred Cannot delete the directory because it still has authorized applications. Additional directory details can be viewed at the Directory Service console. 9. (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
workspaces-ag-085	workspaces-ag.pdf	85	8. When prompted for conﬁrmation, choose Delete. Note Removing application assignments can sometimes take more time than expected. If you receive the following error message, verify that you've removed all application assignments, and then wait 30 to 60 minutes before trying again to delete the directory: An Error Has Occurred Cannot delete the directory because it still has authorized applications. Additional directory details can be viewed at the Directory Service console. 9. (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 Delete a directory 273 Amazon WorkSpaces Administration Guide information, see Deleting your VPC and Working with Elastic IP addresses in the Amazon VPC User Guide. 10. (Optional) To delete any custom bundles and images that you are ﬁnished with, see Delete a custom bundle or image in WorkSpaces Personal. Set up Active Directory Administration Tools for WorkSpaces Personal You'll perform most administrative tasks for your WorkSpaces directory using directory management tools, such as the Active Directory Administration Tools. However, you'll use the WorkSpaces console to perform some directory-related tasks. For more information, see Manage directories for WorkSpaces Personal. If you create a directory with AWS Managed Microsoft AD or Simple AD that includes ﬁve or more WorkSpaces, we recommend that you centralize administration on an Amazon EC2 instance. Although you can install the directory management tools on a WorkSpace, using an Amazon EC2 instance is a more robust solution. To set up the Active Directory Administration Tools 1. Launch an Amazon EC2 Windows instance and join it to your WorkSpaces directory by using one of the following options: • If you don't already have an existing Amazon EC2 Windows instance, you can join the instance to your directory domain when you launch the instance. For more information, see Seamlessly join a Windows EC2 instance in the AWS Directory Service Administration Guide. • If you already have an existing Amazon EC2 Windows instance, you can join it to your directory manually. For more information, see Manually Add a Windows Instance in the AWS Directory Service Administration Guide. 2. Install the Active Directory Administration Tools on the Amazon EC2 Windows instance. For more information, see Installing the Active Directory Administration Tools in the AWS Directory Service Administration Guide. Note When you're installing the Active Directory Administration Tools, make sure to also select Group Policy Management to install the Group Policy Management Editor (gpmc.msc) tool. Set up Directory Administration 274 Amazon WorkSpaces Administration Guide When the feature installation is ﬁnished, the Active Directory tools are available on the Windows Start menu under Windows Administrative Tools. 3. Run the tools as a directory administrator as follows: a. On the Windows Start menu, open Windows Administrative Tools. b. Hold down the Shift key, right-click the shortcut for the tool you want to use, and choose Run as diﬀerent user. c. Enter the sign-in credentials for the administrator. With Simple AD, the username is Administrator and with AWS Managed Microsoft AD, the administrator is Admin. You can now perform directory administration tasks using the Active Directory tools that you are familiar with. For example, you can use the Active Directory Users and Computers Tool to add users, remove users, promote a user to directory administrator, or reset a user password. Note that you must be logged into your Windows instance as a user that has permissions to manage users in the directory. To promote a user to a directory administrator Note This procedure applies only to directories created with Simple AD, not AWS Managed AD. For directories created with AWS Managed AD, see Manage Users and Groups in AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. 1. Open the Active Directory Users and Computers tool. 2. Navigate to the Users folder under your domain and select the user to promote. 3. Choose Action, Properties. 4. In the username Properties dialog box, choose Member Of. 5. Add the user to the following groups and choose OK. • Administrators • Domain Admins • Enterprise Admins Set up Directory Administration 275 Amazon WorkSpaces Administration Guide • Group Policy Creator Owners • Schema Admins To add or remove users You can create new users from the Amazon WorkSpaces console only during the process of launching a WorkSpace, and you cannot delete users through the Amazon WorkSpaces console. Most user management tasks, including managing user groups, must be performed through your directory. Important Before you can remove a user, you must delete the WorkSpace assigned to that user. For more information, see Delete a WorkSpace in WorkSpaces Personal. The process you use for managing users and groups depends on which type of directory you're using. • If you're using AWS Managed Microsoft AD,
workspaces-ag-086	workspaces-ag.pdf	86	Schema Admins To add or remove users You can create new users from the Amazon WorkSpaces console only during the process of launching a WorkSpace, and you cannot delete users through the Amazon WorkSpaces console. Most user management tasks, including managing user groups, must be performed through your directory. Important Before you can remove a user, you must delete the WorkSpace assigned to that user. For more information, see Delete a WorkSpace in WorkSpaces Personal. The process you use for managing users and groups depends on which type of directory you're using. • If you're using AWS Managed Microsoft AD, see Manage Users and Groups in AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. • If you're using Simple AD, see Manage Users and Groups in Simple AD in the AWS Directory Service Administration Guide. • If you use Microsoft Active Directory through AD Connector or a trust relationship, you can manage users and groups using the Active Directory module. To reset a user password When you reset the password for an existing user, do not set User must change password at next logon. Otherwise, the users cannot connect to their WorkSpaces. Instead, assign a secure temporary password to each user and then ask the users to manually change their passwords from within the WorkSpace the next time they log on. Set up Directory Administration 276 Amazon WorkSpaces Note Administration Guide If you're using AD Connector or if your users are in the AWS GovCloud (US-West) Region, 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 .) Administer users in WorkSpaces Personal Each WorkSpace is assigned to a single user and cannot be shared by multiple users. By default, only one WorkSpace per user per directory is allowed. Contents • Manage users in WorkSpaces Personal • Create multiple WorkSpaces for a user in WorkSpaces Personal • Customize how users log in to their WorkSpaces in WorkSpaces Personal • Enable self-service WorkSpaces management capabilities for your users in WorkSpaces Personal • Enable Amazon Connect audio optimization for your users in WorkSpaces Personal • Enable diagnostic log uploads in WorkSpaces Personal Manage users in WorkSpaces Personal As an administrator for WorkSpaces, you can perform the following tasks to manage WorkSpaces users. Edit user information You can use the WorkSpaces console to edit the user information for a WorkSpace. Note This feature is available only if you use AWS Managed Microsoft AD or Simple AD. If you use Microsoft Active Directory through AD Connector or a trust relationship, you can manage users and groups using the Active Directory module. If you use Microsoft Entra ID or Custom WorkSpaces directory, you can manage users and groups with Microsoft Entra ID or your Identity Providers. Administer users 277 Amazon WorkSpaces To edit user information 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 a user and choose Actions, Edit users. 4. Update First name, Last name, and Email as needed. 5. Choose Update. Add or delete users You can create users from the Amazon WorkSpaces console only during the process of launching a WorkSpace, and you cannot delete users through the Amazon WorkSpaces console. Most user management tasks, including managing user groups, must be performed through your directory. To add or delete users and groups To add, delete, or otherwise manage users and groups, you must do this through your directory. You'll perform most administrative tasks for your WorkSpaces directory using directory management tools, such as the Active Directory Administration Tools. For more information, see Set up Active Directory Administration Tools for WorkSpaces Personal. Important Before you can remove a user, you must delete the WorkSpace assigned to that user. For more information, see Delete a WorkSpace in WorkSpaces Personal. The process you use for managing users and groups depends on which type of directory you're using. • If you're using AWS Managed Microsoft AD, see Manage Users and Groups in AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. • If you're using Simple AD, see Manage Users and Groups in Simple AD in the AWS Directory Service Administration Guide. • If you use Microsoft Active Directory through AD Connector or a trust relationship, you can manage users and groups by using the Active Directory module. Manage users 278 Amazon WorkSpaces Send an invitation email Administration Guide You can send an invitation email to a user manually if needed. Note If you're using AD Connector or a trusted domain, invitation emails aren't automatically sent to your users, so you must send them manually. Invitation emails also aren't sent automatically if the user already exists in Active Directory. To resend an invitation email 1. Open the
workspaces-ag-087	workspaces-ag.pdf	87	AWS Directory Service Administration Guide. • If you use Microsoft Active Directory through AD Connector or a trust relationship, you can manage users and groups by using the Active Directory module. Manage users 278 Amazon WorkSpaces Send an invitation email Administration Guide You can send an invitation email to a user manually if needed. Note If you're using AD Connector or a trusted domain, invitation emails aren't automatically sent to your users, so you must send them manually. Invitation emails also aren't sent automatically if the user already exists in Active Directory. To resend an invitation email 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. In the navigation pane, choose WorkSpaces. 3. On the WorkSpaces page, use the search box to search for the user 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. 4. Choose Actions, Invite users. 5. On the Invite users to the WorkSpace page, choose Send invite. Create multiple WorkSpaces for a user in WorkSpaces Personal By default, you can create only one WorkSpace per user per directory. However, if needed, you can create more than one WorkSpace for a user, depending on your directory setup. • If you have only one directory for your WorkSpaces, create multiple usernames for the user. For example, a user named Mary Major can have mmajor1, mmajor2, and so on as usernames. Each username is associated with a diﬀerent WorkSpace in the same directory, but the WorkSpaces have the same registration code, as long as the WorkSpaces are all created in the same directory in the same AWS Region. • If you have multiple directories for your WorkSpaces, create the WorkSpaces for the user in separate directories. You can use the same username in the directories, or you can use diﬀerent usernames in the directories. The WorkSpaces will have diﬀerent registration codes. Create multiple WorkSpaces for a user 279 Amazon WorkSpaces Tip Administration Guide So that you can easily locate all the WorkSpaces that you've created for a user, use the same base username for each WorkSpace. For example, if you have a user named Mary Major with the Active Directory username mmajor, create WorkSpaces for her with usernames such as mmajor, mmajor1, mmajor2, mmajor3, or other variants, such as mmajor_windows or mmajor_linux. As long as all the WorkSpaces have the same starting base username (mmajor), you can sort on the username in your WorkSpaces console to group all of the WorkSpaces for that user together. Important • A user can have both a PCoIP and a DCV WorkSpace as long as the two WorkSpaces are located in separate directories. The same user cannot have a PCoIP and a DCV WorkSpace in the same directory. • If you are setting up multiple WorkSpaces for use with cross-Region redirection, you must set up the WorkSpaces in diﬀerent directories in diﬀerent AWS Regions, and you must use the same usernames in each directory. For more information about cross-Region redirection, see Cross-Region redirection for WorkSpaces Personal. To switch between the WorkSpaces, the user logs in with the username and registration code associated with a particular Workspace. If the user is using a 3.0+ version of the WorkSpaces client applications for Windows, macOS, or Linux, the user can assign diﬀerent names to the WorkSpaces by going to Settings, Manage Login Information in the client application. Customize how users log in to their WorkSpaces in WorkSpaces Personal Customize your users' access to WorkSpaces by using uniform resource identiﬁers (URIs) to provide a simpliﬁed login experience that integrates with existing workﬂows in your organization. For example, you can automatically generate login URIs that register your users by using their WorkSpaces registration code. As a result: • Users can bypass the manual registration process. Customize how users log in to their WorkSpaces 280 Amazon WorkSpaces Administration Guide • Their usernames are automatically entered on their WorkSpaces client login page. • If multi-factor authentication (MFA) is used in your organization, their usernames and MFA codes are automatically entered on their client login page. URI access works with both Region-based registration codes (for example, WSpdx +ABC12D) and fully qualiﬁed domain name (FQDN) based registration codes (for example, desktop.example.com). For more information about creating and using FQDN-based registration codes, see Cross-Region redirection for WorkSpaces Personal. You can conﬁgure URI access to WorkSpaces for client applications on the following supported devices: • Windows computers • macOS computers • Ubuntu Linux 18.04, 20.04, and 22.04 computers • iPads • Android devices To use URIs to access their WorkSpaces, users must ﬁrst install the client application for their device by opening https://clients.amazonworkspaces.com/ and following the directions. URI access is supported on the Firefox and Chrome browsers on Windows and macOS computers, on the Firefox browser on
workspaces-ag-088	workspaces-ag.pdf	88	based registration codes (for example, desktop.example.com). For more information about creating and using FQDN-based registration codes, see Cross-Region redirection for WorkSpaces Personal. You can conﬁgure URI access to WorkSpaces for client applications on the following supported devices: • Windows computers • macOS computers • Ubuntu Linux 18.04, 20.04, and 22.04 computers • iPads • Android devices To use URIs to access their WorkSpaces, users must ﬁrst install the client application for their device by opening https://clients.amazonworkspaces.com/ and following the directions. URI access is supported on the Firefox and Chrome browsers on Windows and macOS computers, on the Firefox browser on Ubuntu Linux 18.04, 20.04, and 22.04 computers, and on the Internet Explorer and Microsoft Edge browsers on Windows computers. For more information about WorkSpaces clients, see WorkSpaces Clients in the Amazon WorkSpaces User Guide. Note On Android devices, URI access works only with the Firefox browser, not with the Google Chrome browser. To conﬁgure URI access to WorkSpaces, use any of the URI formats described in the following table. Customize how users log in to their WorkSpaces 281 Amazon WorkSpaces Note Administration Guide If the data component of your URI includes any of the following reserved characters, we recommend that you use percent-encoding in the data component to avoid ambiguity: @ : / ? & = For example, if you have usernames that include any of these characters, you should percent-encode those usernames in your URI. For more information, see Uniform Resource Identiﬁer (URI): Generic Syntax. Supported syntax Description workspaces:// Opens the WorkSpaces client application. (Note: Using workspaces:// by itself is not currently supported in the Linux client application.) workspaces://@registrationcode Registers a user by using their WorkSpaces registration code. Also displays the client login page. workspaces://username@regis trationcode Registers a user by using their WorkSpaces registration code. Also automatically enters the username in the username ﬁeld on the client login page. workspaces://username@regis trationcode?MFACode=mfa workspaces://@registrationcode? MFACode=mfa Registers a user by using their WorkSpaces registrat ion code. Also automatically enters the username in the username ﬁeld and the multi-factor authentication (MFA) code in the MFA code ﬁeld on the client login page. Registers a user by using their WorkSpaces registrat ion code. Also automatically enters the multi-factor authentication (MFA) code in the MFA code ﬁeld on the client login page. Customize how users log in to their WorkSpaces 282 Amazon WorkSpaces Note Administration Guide If users open a URI link when they are already connected to a WorkSpace from a Windows client, a new WorkSpaces session opens and their original WorkSpaces session remains open. If users open a URI link when they are connected to a WorkSpace from a macOS, iPad, or Android client, no new session opens; only their original WorkSpaces session remains open. Enable self-service WorkSpaces management capabilities for your users in WorkSpaces Personal In WorkSpaces, you can enable self-service WorkSpace management capabilities for your users to provide them with more control over their experience. It can also reduce your IT support staﬀ workload for WorkSpaces. When you enable self-service capabilities, users can perform one or more of the following tasks directly from their WorkSpaces client: • Cache their credentials on their client. This lets them reconnect to their WorkSpace without re- entering their credentials. • Restart (reboot) their WorkSpace. • Increase the size of the root and user volumes on their WorkSpace. • Change the compute type (bundle) for their WorkSpace. • Switch the running mode of their WorkSpace. • Rebuild their WorkSpace. Supported clients • Android, running on Android or Android-compatible Chrome OS systems • Linux • macOS • Windows To enable self-service management capabilities for your users 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. Enable self-service WorkSpaces management capabilities 283 Amazon WorkSpaces Administration Guide 2. In the navigation pane, choose Directories. 3. Choose the directory you want to enable self-service management capabilities. 4. Scroll down to Self-service permissions and choose Edit. Enable or disable the following options as required to determine the WorkSpace management tasks that users can perform from their client: • Remember me — Users can choose whether to cache their credentials on their client by selecting the Remember Me or Keep me logged in check box on the login screen. The credentials are cached in RAM only. When users choose to cache their credentials, they can reconnect to their WorkSpaces without re-entering their credentials. To control how long users can cache their credentials, see Set the maximum lifetime for a Kerberos ticket. • Restart WorkSpace from client — Users can restart (reboot) their WorkSpace. Restarting disconnects the user from their WorkSpace, shuts it down, and reboots it. The user data, operating system, and system settings are not aﬀected. • Increase volume size — Users can expand the root and user volumes on their WorkSpace to a speciﬁed size without contacting IT support. Users can increase
workspaces-ag-089	workspaces-ag.pdf	89	RAM only. When users choose to cache their credentials, they can reconnect to their WorkSpaces without re-entering their credentials. To control how long users can cache their credentials, see Set the maximum lifetime for a Kerberos ticket. • Restart WorkSpace from client — Users can restart (reboot) their WorkSpace. Restarting disconnects the user from their WorkSpace, shuts it down, and reboots it. The user data, operating system, and system settings are not aﬀected. • Increase volume size — Users can expand the root and user volumes on their WorkSpace to a speciﬁed size without contacting IT support. Users can increase the size of the root volume (for Windows, the C: drive; for Linux, /) up to 175 GB, and the size of the user volume (for Windows, the D: drive; for Linux, /home) up to 100 GB. 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]. For more information, see Modify a WorkSpace in WorkSpaces Personal. For a newly created WorkSpace, users must wait 6 hours before they can increase the size of these drives. After that, they can do so only once in a 6-hour period. While a volume size increase is in progress, users can perform most tasks on their WorkSpace. The tasks that they can't perform are: changing their WorkSpace compute type, switching their WorkSpace running mode, restarting their WorkSpace, or rebuilding their WorkSpace. When the process is ﬁnished, the WorkSpace must be rebooted for the changes to take eﬀect. This process might take up to an hour. Note If users increase the volume size on their WorkSpace, this increases the billing rate for their WorkSpace. • Change compute type — Users can switch their WorkSpace between compute types (bundles). For a newly created WorkSpace, users must wait 6 hours before they can switch Enable self-service WorkSpaces management capabilities 284 Amazon WorkSpaces Administration Guide to a diﬀerent bundle. After that, they can switch to a larger bundle only once in a 6-hour period, or to a smaller bundle once in a 30-day period. 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. This process might take up to an hour. Note If users change their WorkSpace compute type, this changes the billing rate for their WorkSpace. • Switch running mode — Users can switch their WorkSpace between the AlwaysOn and AutoStop running modes. For more information, see Manage the running mode in WorkSpaces Personal. Note If users switch the running mode of their WorkSpace, this changes the billing rate for their WorkSpace. • Rebuild WorkSpace from client — Users can rebuild the operating system of a WorkSpace to its original state. When a WorkSpace is rebuilt, the user volume (D: drive) is recreated from the latest backup. Because backups are completed every 12 hours, users' data might be up to 12 hours old. For a newly created WorkSpace, users must wait 12 hours before they can rebuild their WorkSpace. When a WorkSpace rebuild is in progress, users are disconnected from their WorkSpace, and they can't use or make changes to their WorkSpace. This process might take up to an hour. • Diagnostic log uploads — Users can upload WorkSpaces client log ﬁles directly to WorkSpaces to troubleshoot issues without interrupting use of the WorkSpaces client. If you enable diagnostic log uploads for your users, or let your users do so themselves, the log ﬁles are sent to WorkSpaces automatically. You can enable diagnostic log uploads before or during a WorkSpaces streaming session. 5. Choose Save. Enable self-service WorkSpaces management capabilities 285 Amazon WorkSpaces Administration Guide Enable Amazon Connect audio optimization for your users in WorkSpaces Personal In the WorkSpaces management console, you can enable Amazon Connect Contact Control Panel (CCP) audio optimization for your WorkSpaces ﬂeets to enhance security and to enable native- quality audio. After enabling CCP audio optimization, the CCP audio will be processed by the client endpoints, while WorkSpaces users can interact with the CCP from within their WorkSpaces. Amazon Connect Contact Control Panel (CCP) audio optimization works with: • The WorkSpaces Windows client. • Amazon Linux and Windows WorkSpaces. • WorkSpaces using PCoIP or DCV. Requirements • You must be set up with Amazon Connect. • You must build a custom CCP with the Amazon Connect Stream API by creating a CCP with no media for call signaling. This way, the media is handled on the local desktop using standard CCP, and the signaling and call controls are handled on the remote connection with the CCP with no media. For more information about the Amazon Connect
workspaces-ag-090	workspaces-ag.pdf	90	their WorkSpaces. Amazon Connect Contact Control Panel (CCP) audio optimization works with: • The WorkSpaces Windows client. • Amazon Linux and Windows WorkSpaces. • WorkSpaces using PCoIP or DCV. Requirements • You must be set up with Amazon Connect. • You must build a custom CCP with the Amazon Connect Stream API by creating a CCP with no media for call signaling. This way, the media is handled on the local desktop using standard CCP, and the signaling and call controls are handled on the remote connection with the CCP with no media. For more information about the Amazon Connect streams API, see the GitHub repository at https://github.com/aws/amazon-connect-streams. The custom CCP that you build is the CCP your Amazon Connect agents will use within their WorkSpaces. • You must have a web browser installed onto WorkSpaces client endpoints that's supported by Amazon Connect. For the list of supported browsers, see Browsers supported by Amazon Connect. Note If your users use browsers that are not supported, they will be asked to download a supported browser when they attempt to log in to the CCP. Enable Amazon Connect audio optimization To enable Amazon Connect audio optimization for your users: Enable Amazon Connect audio optimization 286 Amazon WorkSpaces Administration Guide 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select your directory, and choose Actions, Update Details. Expand Amazon Connect Audio Optimization. Note Before conﬁguring with Amazon Connect, choose Update to save any unsaved changes made previously in the management console. 5. Choose Conﬁgure Amazon Connect. 6. Enter an Amazon Connect Contact Control Panel (CCP) name. Note The name that you give your CCP will be used in the user add-in menu. Choose a name that will be meaningful to your users. 7. Enter the Amazon Connect Contact Control Panel URL that's generated by Amazon Connect. See Provide access to the Contact Control Panel for more information on getting the URL. 8. Choose Create Amazon Connect. Update directory's Amazon Connect audio optimization details To update a directory's Amazon Connect audio optimization details: 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select your directory, and choose Actions, Update Details. Expand Amazon Connect Audio Optimization. Note Before conﬁguring with Amazon Connect, choose Update to save any unsaved changes made previously in the management console. Enable Amazon Connect audio optimization 287 Amazon WorkSpaces Administration Guide 5. Choose Conﬁgure Amazon Connect. 6. Choose Edit. 7. Select your directory, and choose Actions, Update Details. 8. Update the Amazon Connect Contact Control Panel name and URL. 9. Choose Save. Delete directory's Amazon Connect audio optimization To delete a directory’s Amazon Connect audio optimization: 1. Open the WorkSpaces console at https://console.aws.amazon.com/workspaces/v2/home. 2. 3. 4. In the navigation pane, choose Directories. Select your directory, and choose Actions, Update Details. Expand Amazon Connect Audio Optimization. Note Before conﬁguring with Amazon Connect, choose Update to save any unsaved changes made previously in the management console. 5. Choose Conﬁgure Amazon Connect. 6. Choose Delete Amazon Connect. See the Agent training guide for more information. Enable diagnostic log uploads in WorkSpaces Personal To troubleshoot WorkSpaces client issues, enable automatic diagnostic log uploads. This is currently supported for Windows, macOS, Linux, and Web Access clients. Note The WorkSpaces client diagnostic log uploads feature is currently unavailable in the AWS GovCloud (US-West) Region. Enable diagnostic log uploads 288 Amazon WorkSpaces Diagnostic log uploads Administration Guide With Diagnostic log uploads, you can upload WorkSpaces client log ﬁles directly to WorkSpaces to troubleshoot issues without interrupting use of the WorkSpaces client. If you enable diagnostic log uploads for your users, or let your users do so themselves, the log ﬁles are sent to WorkSpaces automatically. You can enable diagnostic log uploads before or during a WorkSpaces streaming session. To automatically upload diagnostic logs from managed devices, install a WorkSpaces client that supports diagnostic uploads. Log uploading is enabled by default. You can modify the settings in either of the following ways: Option 1: Using the AWS console 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 name that you want to enable diagnostic logging for. 4. Scroll down to Self-service permission. 5. Choose View details 6. Choose Edit. 7. Choose Diagnostic log uploads. 8. Choose Save. Option 2: Using an API call You can edit the directory settings to enable or disable the WorkSpaces Windows, macOS, and Linux client to upload diagnostic logs automatically using an API call. If enabled, when a client issue occurs, the logs are sent to WorkSpaces without user interaction. For more information, see the WorkSpaces API reference. You can also let your users choose whether to enable automatic diagnostic log uploads after client installation. For more information, see WorkSpaces Windows
workspaces-ag-091	workspaces-ag.pdf	91	4. Scroll down to Self-service permission. 5. Choose View details 6. Choose Edit. 7. Choose Diagnostic log uploads. 8. Choose Save. Option 2: Using an API call You can edit the directory settings to enable or disable the WorkSpaces Windows, macOS, and Linux client to upload diagnostic logs automatically using an API call. If enabled, when a client issue occurs, the logs are sent to WorkSpaces without user interaction. For more information, see the WorkSpaces API reference. You can also let your users choose whether to enable automatic diagnostic log uploads after client installation. For more information, see WorkSpaces Windows client application , WorkSpaces macOS client application, and WorkSpaces Linux client application. Enable diagnostic log uploads 289 Amazon WorkSpaces Note Administration Guide • Diagnostic logs don't contain sensitive information. You can disable automatic diagnostic log uploads for your users at the directory level, or allow your users to disable these features themselves. • To access the diagnostic log uploads feature, you need to install the following versions of the WorkSpaces clients: • 5.4.0 or later of the Windows client • 5.8.0 or later of the macOS client • 2023.1 of the Ubuntu 22.04 client • 2023.1 of the Ubuntu 20.04 client • You can also access the diagnostic log upload feature with the Web Access client Administer WorkSpaces Personal You can administer your WorkSpaces using the WorkSpaces console. To perform directory administration tasks, see the section called “Set up Directory Administration”. Note • 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 EC2Conﬁg, 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 EC2Conﬁg and EC2Launch. Contents • Manage your Windows WorkSpaces in WorkSpaces Personal • Manage your Amazon Linux 2 WorkSpaces in WorkSpaces Personal • Manage your Ubuntu WorkSpaces in WorkSpaces Personal Administer WorkSpaces Personal 290 Amazon WorkSpaces Administration Guide • Manage your Rocky Linux WorkSpaces • Manage your Red Hat Enterprise Linux WorkSpaces • Optimize WorkSpaces for real-time communication in WorkSpaces Personal • Manage the running mode in WorkSpaces Personal • Manage applications in WorkSpaces Personal • Modify a WorkSpace in WorkSpaces Personal • Customize branding in WorkSpaces Personal • Tag resources in WorkSpaces Personal • Maintenance in WorkSpaces Personal • Encrypted WorkSpaces in WorkSpaces Personal • Reboot a WorkSpace in WorkSpaces Personal • Rebuild a WorkSpace in WorkSpaces Personal • Restore a WorkSpace in WorkSpaces Personal • Microsoft 365 Bring Your Own License (BYOL) in WorkSpaces Personal • Upgrade Windows BYOL WorkSpaces in WorkSpaces Personal • Migrate a WorkSpace in WorkSpaces Personal • Delete a WorkSpace in WorkSpaces Personal Manage your Windows WorkSpaces in WorkSpaces Personal You can use Group Policy Objects (GPOs) to apply settings to manage Windows WorkSpaces or users that are part of your Windows WorkSpaces directory. Note • If you use Microsoft Entra ID or Custom WorkSpaces directory, you can manage users and groups with Microsoft Entra ID or your Identity Providers. For more inforamtion, see Create a dedicated Microsoft Entra ID directory with WorkSpaces Personal. • Linux instances do not adhere to Group Policy. For information about managing Amazon Linux WorkSpaces, see Manage your Amazon Linux 2 WorkSpaces in WorkSpaces Personal. Manage Windows WorkSpaces 291 Amazon WorkSpaces Administration Guide We recommend that you create an organizational unit for your WorkSpaces Computer Objects and an organizational unit for your WorkSpaces User Objects. To use the Group Policy settings that are speciﬁc to Amazon WorkSpaces, you must install the Group Policy administrative template for the protocol or protocols that you are using, either PCoIP or DCV. Warning Group Policy settings can aﬀect the experience of your WorkSpace users as follows: • Implementing an interactive logon message to display a logon banner prevents users from being able to access their WorkSpaces. The interactive logon message Group Policy setting is not currently supported by PCoIP WorkSpaces. The logon message is supported on DCV WorkSpaces, and users have to login again after accepting the logon banner. Logon messages are not supported when Certiﬁcate-Based Logon is enabled. • Disabling removable storage through Group Policy settings causes a login failure that results in users being logged in to temporary user proﬁles with no access to drive D. • Removing users from the Remote Desktop Users local group through Group Policy settings prevents those users from being able to authenticate through the WorkSpaces client applications. For more information about this Group Policy setting, see Allow log on through Remote Desktop Services in the Microsoft documentation. • If you
workspaces-ag-092	workspaces-ag.pdf	92	and users have to login again after accepting the logon banner. Logon messages are not supported when Certiﬁcate-Based Logon is enabled. • Disabling removable storage through Group Policy settings causes a login failure that results in users being logged in to temporary user proﬁles with no access to drive D. • Removing users from the Remote Desktop Users local group through Group Policy settings prevents those users from being able to authenticate through the WorkSpaces client applications. For more information about this Group Policy setting, see Allow log on through Remote Desktop Services in the Microsoft documentation. • If you remove the built-in Users group from the Allow log on locally security policy, your PCoIP WorkSpaces users won't be able to connect to their WorkSpaces through the WorkSpaces client applications. Your PCoIP WorkSpaces also won't receive updates to the PCoIP agent software. PCoIP agent updates might contain security and other ﬁxes, or they might enable new features for your WorkSpaces. For more information about working with this security policy, see Allow log on locally in the Microsoft documentation. • Group Policy settings can be used to restrict drive access. If you conﬁgure Group Policy settings to restrict access to drive C or to drive D, users can't access their WorkSpaces. To prevent this issue from occurring, make sure that your users can access drive C and drive D. • The WorkSpaces audio-in feature requires local logon access inside the WorkSpace. The audio-in feature is enabled by default for Windows WorkSpaces. However, if you have a Group Policy setting that restricts users' local logon in their WorkSpaces, audio- in won't work on your WorkSpaces. If you remove that Group Policy setting, the audio-in Manage Windows WorkSpaces 292 Amazon WorkSpaces Administration Guide feature is enabled after the next reboot of the WorkSpace. For more information about this Group Policy setting, see Allow log on locally in the Microsoft documentation. For more information about enabling or disabling audio-in redirection, see Enable or disable audio-in redirection for PCoIP or Enable or disable audio-in redirection for DCV. • Using Group Policy to set the Windows power plan to Balanced or Power saver might cause your WorkSpaces to sleep when they're left idle. We strongly recommend using Group Policy to set the Windows power plan to High performance. For more information, see My Windows WorkSpace goes to sleep when it's left idle. • Some Group Policy settings force users to log oﬀ when they are disconnected from a session. Any applications that users have open on their WorkSpaces are closed. • "Set time limit for active but idle Remote Desktop Services sessions" is currently not supported on DCV WorkSpaces. Avoid using it during DCV sessions as it causes a disconnect even when there is activity and the session is not idle. For information about using the Active Directory administration tools to work with GPOs, see Set up Active Directory Administration Tools for WorkSpaces Personal. Contents • Install the Group Policy administrative template ﬁles for DCV • Manage Group Policy settings for DCV • Install the Group Policy administrative template for PCoIP • Manage Group Policy settings for PCoIP • Set the maximum lifetime for a Kerberos ticket • Conﬁgure device proxy server settings for internet access • Proxying desktop traﬃc • Recommendation on the use of proxy servers • Enable Amazon WorkSpaces for Zoom Meeting Media Plugin support • Enable Zoom Meeting Media Plugin for DCV • Prerequisites • Before you begin • Installing the Zoom components • Enable Zoom Meeting Media Plugin for PCoIP Manage Windows WorkSpaces 293 Amazon WorkSpaces • Prerequisites • Create the registry key on a Windows WorkSpaces host • Troubleshooting Administration Guide Install the Group Policy administrative template ﬁles for DCV To use the Group Policy settings that are speciﬁc to WorkSpaces when using DCV, you must add the Group Policy administrative template wsp.admx and wsp.adml ﬁles for DCV to the Central Store of the domain controller for your WorkSpaces directory. For more information about .admx and .adml ﬁles, see How to create and manage the Central Store for Group Policy Administrative Templates in Windows. The following procedure describes how to create the Central Store and add the administrative template ﬁles to it. Perform the following procedure on a directory administration WorkSpace or Amazon EC2 instance that is joined to your WorkSpaces directory. To install the Group Policy administrative template ﬁles for DCV 1. From a running Windows WorkSpace, make a copy of the wsp.admx and wsp.adml ﬁles in the C:\Program Files\Amazon\WSP directory. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open Windows File Explorer, and in the address bar, enter your organization's fully qualiﬁed domain name (FQDN), such as \\example.com. 3. Open the sysvol folder. 4. Open the folder with
workspaces-ag-093	workspaces-ag.pdf	93	to it. Perform the following procedure on a directory administration WorkSpace or Amazon EC2 instance that is joined to your WorkSpaces directory. To install the Group Policy administrative template ﬁles for DCV 1. From a running Windows WorkSpace, make a copy of the wsp.admx and wsp.adml ﬁles in the C:\Program Files\Amazon\WSP directory. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open Windows File Explorer, and in the address bar, enter your organization's fully qualiﬁed domain name (FQDN), such as \\example.com. 3. Open the sysvol folder. 4. Open the folder with the FQDN name. 5. Open the Policies folder. You should now be in \\FQDN\sysvol\FQDN\Policies. 6. If it doesn't already exist, create a folder named PolicyDefinitions. 7. Open the PolicyDefinitions folder. 8. Copy the wsp.admx ﬁle into the \\FQDN\sysvol\FQDN\Policies\PolicyDefinitions folder. 9. Create a folder named en-US in the PolicyDefinitions folder. 10. Open the en-US folder. 11. Copy the wsp.adml ﬁle into the \\FQDN\sysvol\FQDN\Policies\PolicyDefinitions \en-US folder. Manage Windows WorkSpaces 294 Amazon WorkSpaces Administration Guide To verify that the administrative template ﬁles are correctly installed 1. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 2. 3. 4. 5. 6. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. Note If the domain backing the WorkSpaces is an AWS Managed Microsoft AD directory, you cannot use the Default Domain Policy to create your GPO. Instead, you must create and link the GPO under the domain container that has delegated privileges. When you create a directory with AWS Managed Microsoft AD, AWS Directory Service creates a yourdomainname organizational unit (OU) under the domain root. The name of this OU is based on the NetBIOS name that you typed when you created your directory. If you didn't specify a NetBIOS name, it will default to the ﬁrst part of your Directory DNS name (for example, in the case of corp.example.com, the NetBIOS name is corp). To create your GPO, instead of selecting Default Domain Policy, select the yourdomainname OU (or any OU under that one), open the context (right-click) menu, and choose Create a GPO in this domain, and Link it here. For more information about the yourdomainname OU, see What Gets Created in the AWS Directory Service Administration Guide. 7. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 8. You can now use this DCV Group Policy object to modify the Group Policy settings that are speciﬁc to WorkSpaces when using DCV. Manage Windows WorkSpaces 295 Amazon WorkSpaces Administration Guide Manage Group Policy settings for DCV To use Group Policy settings to manage your Windows WorkSpaces that use DCV 1. Make sure that the most recent WorkSpaces Group Policy administrative template for DCV is installed in the Central Store of the domain controller for your WorkSpaces directory. 2. Verify the administrative template ﬁles are correctly installed. For more information, see To verify that the administrative template ﬁles are correctly installed. Conﬁgure printer support for DCV By default, WorkSpaces enables Basic remote printing, which oﬀers limited printing capabilities because it uses a generic printer driver on the host side to ensure compatible printing. Advanced remote printing for Windows clients (not available for DCV) lets you use speciﬁc features of your printer, such as double-sided printing, but it requires installation of the matching printer driver on the host side. Remote printing is implemented as a virtual channel. If virtual channels are disabled, remote printing does not function. For Windows WorkSpaces, you can use Group Policy settings to conﬁgure printer support as needed. To conﬁgure printer support 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure remote printing setting. 3. In the Conﬁgure remote printing dialog box, do one of the following: • • To enable local printer redirection, choose Enabled, and then for Printing options, choose Basic. To automatically use the client computer's current default printer, select Map local default printer to the remote host. To disable printing, choose Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: Manage Windows WorkSpaces 296 Amazon WorkSpaces Administration Guide • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Conﬁgure clipboard redirection (copy/paste) for DCV By default, WorkSpaces supports two-way (copy/paste) clipboard redirection. For Windows WorkSpaces, you can use Group Policy
workspaces-ag-094	workspaces-ag.pdf	94	host. To disable printing, choose Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: Manage Windows WorkSpaces 296 Amazon WorkSpaces Administration Guide • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Conﬁgure clipboard redirection (copy/paste) for DCV By default, WorkSpaces supports two-way (copy/paste) clipboard redirection. For Windows WorkSpaces, you can use Group Policy settings to disable this feature or conﬁgure the direction where clipboard redirection is allowed. To conﬁgure clipboard redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure clipboard redirection setting. 3. In the Conﬁgure clipboard redirection dialog box, choose Enabled or Disabled. When Conﬁgure clipboard redirection is Enabled, the following Clipboard redirection options will become available: • Choose Copy and Paste to allow two-way clipboard copy and paste redirection. • Choose Copy Only to allow copying data from the server clipboard to the client clipboard only. • Choose Paste Only to allow pasting data from the client clipboard to the server clipboard only. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Known limitation Manage Windows WorkSpaces 297 Amazon WorkSpaces Administration Guide With clipboard redirection enabled on the WorkSpace, if you copy content that is larger than 890 KB from a Microsoft Oﬃce application, the application might become slow or unresponsive for up to 5 seconds. Set the session resume timeout for DCV When you lose network connectivity, your active WorkSpaces client session is disconnected. WorkSpaces client applications for Windows and macOS attempt to reconnect the session automatically if network connectivity is restored within a certain amount of time. The default session resume timeout is 20 minutes (1200 seconds), but you can modify that value for WorkSpaces that are controlled by your domain's Group Policy settings. To set the automatic session resume timeout value 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable automatic reconnect setting. 3. In the Enable/disable automatic reconnect dialog box, choose Enabled, and then set Reconnect timeout (seconds) to the desired timeout in seconds. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable or disable video-in redirection for DCV By default, WorkSpaces supports redirecting data from a local camera. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To enable or disable video-in redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable video-in redirection setting. Manage Windows WorkSpaces 298 Amazon WorkSpaces Administration Guide 3. In the Enable/disable video-in redirection dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable or disable audio-in redirection for DCV By default, WorkSpaces supports redirecting data from a local microphone. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To enable or disable audio-in redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable audio-in redirection setting. 3. In the Enable/disable audio-in redirection dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force.
workspaces-ag-095	workspaces-ag.pdf	95	WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable audio-in redirection setting. 3. In the Enable/disable audio-in redirection dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable or disable audio-out redirection for DCV By default, WorkSpaces redirects data to a local speaker. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. Manage Windows WorkSpaces 299 Amazon WorkSpaces Administration Guide To enable or disable audio-out redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable audio-out redirection setting. 3. In the Enable/disable audio-out redirection dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace. In the Amazon WorkSpaces console, select the WorkSpace, then choose Actions > Reboot WorkSpaces. • In an administrative command prompt, enter gpupdate /force. Disable time zone redirection for DCV 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 oﬀ time zone direction for various reasons. For example: • 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 speciﬁc time zone. • Your users who travel a lot want to keep their WorkSpaces in one time zone for consistency and personal preference. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To disable time zone redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable time zone redirection setting. 3. In the Enable/disable time zone redirection dialog box, choose Disabled. Manage Windows WorkSpaces 300 Amazon WorkSpaces 4. Choose OK. Administration Guide 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. 6. Set the time zone for the WorkSpaces to the desired time zone. The time zone of the WorkSpaces is now static and no longer mirrors the time zone of the client machines. Conﬁgure DCV security settings For DCV, data in transit is encrypted using TLS 1.2 encryption. By default, all of the following ciphers are allowed for encryption, and the client and server negotiate which cipher to use: • ECDHE-RSA-AES128-GCM-SHA256 • ECDHE-ECDSA-AES128-GCM-SHA256 • ECDHE-RSA-AES256-GCM-SHA384 • ECDHE-ECDSA-AES256-GCM-SHA384 • ECDHE-RSA-AES128-SHA256 • ECDHE-RSA-AES256-SHA384 For Windows WorkSpaces, you can use Group Policy settings to modify the TLS Security Mode and to add new or block certain cipher suites. A detailed explanation of these settings and the supported cipher suites is provided in the Conﬁgure security settings Group Policy dialog box. To conﬁgure DCV security settings 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open Conﬁgure security settings. Manage Windows WorkSpaces 301 Amazon WorkSpaces Administration Guide 3. In the Conﬁgure security settings dialog box, choose Enabled. Add cipher suites that you want to allow and remove cipher suites that you want to block. For more information about these settings, see the descriptions provided in the Conﬁgure security settings dialog box. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace, and after you restart the WorkSpace session. To apply the Group Policy changes, do one of the following: • To reboot the WorkSpace, in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces. • In an administrative command prompt, enter gpupdate /force. Conﬁgure extensions for DCV By default, support for WorkSpaces extensions is disabled. If needed, you can conﬁgure your WorkSpace to use extensions in the following ways: • Server and client – Enable extensions
workspaces-ag-096	workspaces-ag.pdf	96	dialog box. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace, and after you restart the WorkSpace session. To apply the Group Policy changes, do one of the following: • To reboot the WorkSpace, in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces. • In an administrative command prompt, enter gpupdate /force. Conﬁgure extensions for DCV By default, support for WorkSpaces extensions is disabled. If needed, you can conﬁgure your WorkSpace to use extensions in the following ways: • Server and client – Enable extensions for both server and client • Server only – Enable extensions for server only • Client only – Enable extensions for client only For Windows WorkSpaces, you can use Group Policy settings to conﬁgure the use of extensions. To conﬁgure extensions for DCV 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure extensions setting. 3. In the Conﬁgure extensions dialog box, choose Enabled and then set the desired support option. Choose Client Only, Server and Client, or Server only. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after you restart the WorkSpace session. To apply the Group Policy changes, do one of the following: Manage Windows WorkSpaces 302 Amazon WorkSpaces Administration Guide • Reboot the WorkSpace. In the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces. • In an administrative command prompt, enter gpupdate /force. Enable or disable smart card redirection for DCV By default, Amazon WorkSpaces are not enabled to support the use of smart cards for either pre- session authentication or in-session authentication. Pre-session authentication refers to smart card authentication that's performed while users are logging in to their WorkSpaces. In-session authentication refers to authentication that's performed after logging in. If needed, you can enable pre-session and in-session authentication for Windows WorkSpaces by using Group Policy settings. Pre-session authentication must also be enabled through your AD Connector directory settings by using the EnableClientAuthentication API action or the enable-client-authentication AWS CLI command. For more information, see Enable Smart Card Authentication for AD Connector in the AWS Directory Service Administration Guide. Note To enable the use of smart cards with Windows WorkSpaces, additional steps are required. For more information, see Use smart cards for authentication in WorkSpaces Personal. To enable or disable smart card redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable smart card redirection setting. 3. In the Enable/disable smart card redirection dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy change, reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). Manage Windows WorkSpaces 303 Amazon WorkSpaces Administration Guide Enable or disable WebAuthn (FIDO2) redirection for DCV By default, Amazon WorkSpaces enables the use of WebAuthn authenticators for in-session authentication. In-session authentication refers to WebAuthn authentication that's performed after logging in and requested by the web applications running within the session. Requirements WebAuthn (FIDO2) redirection for DCV requires the following: • DCV host agent version 2.0.0.1425 or higher • WorkSpaces clients: • Linux Ubuntu 22.04 2023.3 or higher • Windows 5.19.0 or higher • Mac client 5.19.0 or higher • Web browsers installed on your WorkSpaces running the Amazon DCV WebAuthn Redirection Extension: • Google Chrome 116+ • Microsoft Edge 116+ Enabling or disabling WebAuthn (FIDO2) redirection for Windows WorkSpaces If needed, you can enable or disable support for in-session authentication with WebAuthn authenticators for Windows WorkSpaces by using Group Policy settings. If you enable or do not conﬁgure this setting, WebAuthn redirection will be enabled and users can utilize local authenticators within the remote WorkSpace. When feature is enabled, all WebAuthn requests from the browser in the session are redirected to the local client. Users can use Windows Hello or locally attached security devices like YubiKey or other FIDO2 compliant authenticators to complete the authentication process. To enable or disable WebAuthn (FIDO2) redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable WebAuthn redirection setting. 3. In the Enable/disable WebAuthn redirection dialog box, choose Enabled or Disabled. Manage Windows WorkSpaces 304 Amazon WorkSpaces 4. Choose OK. Administration Guide 5. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Installing the Amazon DCV WebAuthn Redirection Extension Users
workspaces-ag-097	workspaces-ag.pdf	97	disable WebAuthn (FIDO2) redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable WebAuthn redirection setting. 3. In the Enable/disable WebAuthn redirection dialog box, choose Enabled or Disabled. Manage Windows WorkSpaces 304 Amazon WorkSpaces 4. Choose OK. Administration Guide 5. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Installing the Amazon DCV WebAuthn Redirection Extension Users will need install the Amazon DCV WebAuthn Redirection Extension to use WebAuthn after the feature is enabled by doing either of the following: • Your users will be prompted to enable the browser extension in their browser. Note This is a one-time browser prompt. Your users will get the notiﬁcation when you update the DCV agent version to 2.0.0.1425 or higher. If your end users don’t need the WebAuthn redirection, they can just remove the extension from the browser. You can also block the WebAuthn Redirection Extension installation prompt using below GPO policy. • You can force install the redirection extension for your users using below GPO policy. If you enable the GPO policy, the extension will automatically be installed when your users launch the supported browsers with internet access. • Your users can install the extension manually with Microsoft Edge Add-ons or the Chrome Web Store. Understanding WebAuthn Redirection Extension Native Messaging WebAuthn redirection in Chrome and Edge browsers utilizes a browser extension and a native messaging host. The native messaging host is a component that allows communication between the extension and the host application. In a typical conﬁguration, all native messaging hosts are permitted by the browser by default. However, you can choose to use a native messaging blocklist, where the value of * means that all native messaging hosts are denied unless explicitly allowed. In this case, you need to enable the Amazon DCV WebAuthn Redirection native messaging host by explicitly specifying the value com.dcv.webauthnredirection.nativemessagehost in the allow list. For more information, follow the guidance for your browser: Manage Windows WorkSpaces 305 Amazon WorkSpaces Administration Guide • For Google Chrome, see Native Messaging allowed hosts. • For Microsoft Edge, see Native Messaging. Manage and install the browser extension using Group Policy You can install the Amazon DCV WebAuthn Redirection Extension using Group Policy, either centrally from your domain for session hosts that are joined to an Active Directory (AD) domain or using the Local Group Policy Editor for each session host. This process will change depending on which browser you're using. For Microsoft Edge 1. Download and install the Microsoft Edge administrative template. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 3. 4. 5. 6. 7. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. 8. Choose Computer Conﬁguration , Administrative Templates, Microsoft Edge, and Extensions 9. Open Conﬁgure extension management settings and set it to Enabled. 10. Under Conﬁgure extension management settings, enter the following: {"ihejeaahjpbegmaaegiikmlphghlfmeh": {"installation_mode":"force_installed","update_url":"https://edge.microsoft.com/ extensionwebstorebase/v1/crx"}} 11. Choose OK. 12. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Manage Windows WorkSpaces 306 Amazon WorkSpaces Note Administration Guide You can block the installation of the extension by applying the following conﬁguration management setting: {"ihejeaahjpbegmaaegiikmlphghlfmeh": {"installation_mode":"blocked","update_url":"https://edge.microsoft.com/ extensionwebstorebase/v1/crx"}} For Google Chrome 1. Download and install the Google Chrome administrative template. For more information, see Set Chrome Browser policies on managed PCs. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 3. 4. 5. 6. 7. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. 8. Choose Computer Conﬁguration , Administrative Templates, Google Chrome, and Extensions 9. Open Conﬁgure extension management settings and set it to Enabled. 10. Under Conﬁgure extension management settings, enter the following: {"mmiioagbgnbojdbcjoddlefhmcocfpmn": { "installation_mode":"force_installed","update_url":"https://clients2.google.com/ service/update2/crx"}} 11. Choose OK. 12. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Manage Windows WorkSpaces 307 Amazon WorkSpaces Note Administration Guide You can block the installation of the extension by applying the following conﬁguration management setting: {"mmiioagbgnbojdbcjoddlefhmcocfpmn":
workspaces-ag-098	workspaces-ag.pdf	98	Computer Conﬁguration , Administrative Templates, Google Chrome, and Extensions 9. Open Conﬁgure extension management settings and set it to Enabled. 10. Under Conﬁgure extension management settings, enter the following: {"mmiioagbgnbojdbcjoddlefhmcocfpmn": { "installation_mode":"force_installed","update_url":"https://clients2.google.com/ service/update2/crx"}} 11. Choose OK. 12. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Manage Windows WorkSpaces 307 Amazon WorkSpaces Note Administration Guide You can block the installation of the extension by applying the following conﬁguration management setting: {"mmiioagbgnbojdbcjoddlefhmcocfpmn": { "installation_mode":"blocked","update_url":"https://clients2.google.com/ service/update2/crx"}} Enable or disable WebRTC redirection for DCV WebRTC redirection enhances real-time communication by oﬄoading audio and video processing from WorkSpaces to your local client, which improves performance and reduces latency. However, WebRTC redirection isn't universal and requires third-party application vendors to develop speciﬁc integrations with WorkSpaces. By default, WebRTC redirection isn't enabled on WorkSpaces. To use WebRTC redirection, ensure the following: • Third-party application vendor integration • WorkSpaces extensions are enabled through Group Policy settings • WebRTC redirection is enabled • WebRTC redirection Browser extension is installed and enabled Note This redirection is implemented as an extension and requires you to enable support for WorkSpaces extensions using Group Policy settings. If the extensions are disabled, WebRTC redirection will not function. Requirements WebRTC redirection for DCV requires the following: • DCV host agent version 2.0.0.1622 or higher • WorkSpaces clients: • Windows 5.21.0 or higher Manage Windows WorkSpaces 308 Amazon WorkSpaces • Web client Administration Guide • Web browsers installed on your WorkSpaces running the Amazon DCV WebRTC Redirection Extension: • Google Chrome 116+ • Microsoft Edge 116+ Enabling or disabling WebRTC redirection for Windows WorkSpaces If needed, you can enable or disable support for WebRTC redirection for Windows WorkSpaces by using Group Policy settings. If you disable or don't conﬁgure this setting, WebRTC redirection will be disabled. When feature is enabled, web applications that have integration with Amazon WorkSpaces will be able to redirect WebRTC API calls to the local client. To enable or disable WebRTC redirection for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure WebRTC Redirection setting. 3. In the Conﬁgure WebRTC Redirection dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Installing the Amazon DCV WebRTC Redirection Extension Users install the Amazon DCV WebRTC Redirection Extension to use WebRTC redirection after the feature is enabled by doing either of the following: • Users will be prompted to enable the browser extension in their browser. Manage Windows WorkSpaces 309 Amazon WorkSpaces Note Administration Guide As a one-time browser prompt, users will get the notiﬁcation when you enable WebRTC redirection. • You can force install the redirection extension for users using the following GPO policy. If you enable the GPO policy, the extension will automatically be installed when users launch the supported browsers with internet access. • Users can install the extension manually with Microsoft Edge Add-ons or the Chrome Web Store. Manage and install the browser extension using Group Policy You can install the Amazon DCV WebRTC Redirection Extension using Group Policy, either centrally from your domain, for session hosts joined to an Active Directory (AD) domain, or using the Local Group Policy Editor for each session host. This process will be diﬀerent depending on which browser you're using. For Microsoft Edge 1. Download and install the Microsoft Edge administrative template. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 3. 4. 5. 6. 7. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. 8. Choose Computer Conﬁguration , Administrative Templates, Microsoft Edge, and Extensions 9. Open Conﬁgure extension management settings and set it to Enabled. 10. Under Conﬁgure extension management settings, enter the following: {"kjbbkjjiecchbcdoollhgffghfjnbhef": {"installation_mode":"force_installed","update_url":"https://edge.microsoft.com/ extensionwebstorebase/v1/crx"}} Manage Windows WorkSpaces 310 Amazon WorkSpaces 11. Choose OK. Administration Guide 12. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Note You can block the installation of the extension by applying the following conﬁguration management setting: {"kjbbkjjiecchbcdoollhgffghfjnbhef": {"installation_mode":"blocked","update_url":"https://edge.microsoft.com/ extensionwebstorebase/v1/crx"}} For Google Chrome 1. Download and install the Google Chrome administrative template. For more information, see Set Chrome Browser policies
workspaces-ag-099	workspaces-ag.pdf	99	Under Conﬁgure extension management settings, enter the following: {"kjbbkjjiecchbcdoollhgffghfjnbhef": {"installation_mode":"force_installed","update_url":"https://edge.microsoft.com/ extensionwebstorebase/v1/crx"}} Manage Windows WorkSpaces 310 Amazon WorkSpaces 11. Choose OK. Administration Guide 12. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Note You can block the installation of the extension by applying the following conﬁguration management setting: {"kjbbkjjiecchbcdoollhgffghfjnbhef": {"installation_mode":"blocked","update_url":"https://edge.microsoft.com/ extensionwebstorebase/v1/crx"}} For Google Chrome 1. Download and install the Google Chrome administrative template. For more information, see Set Chrome Browser policies on managed PCs. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 3. 4. 5. 6. 7. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. 8. Choose Computer Conﬁguration , Administrative Templates, Google Chrome, and Extensions 9. Open Conﬁgure extension management settings and set it to Enabled. 10. Under Conﬁgure extension management settings, enter the following: {"diilpfplcnhehakckkpmcmibmhbingnd": { "installation_mode":"force_installed","update_url":"https://clients2.google.com/ service/update2/crx"}} Manage Windows WorkSpaces 311 Amazon WorkSpaces 11. Choose OK. Administration Guide 12. The Group Policy setting change takes eﬀect after the WorkSpace session is restarted. To apply the Group Policy changes, reboot the WorkSpace by going to the Amazon WorkSpaces console and selecting the WorkSpace. Then, choose Actions, Reboot WorkSpaces). Note You can block the installation of the extension by applying the following conﬁguration management setting: {"diilpfplcnhehakckkpmcmibmhbingnd": { "installation_mode":"blocked","update_url":"https://clients2.google.com/ service/update2/crx"}} Enable or disable disconnect session on screen lock for DCV If needed, you can disconnect users' WorkSpaces sessions when the Windows 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. This Group Policy setting is disabled by default. If needed, you can enable disconnecting the session when the Windows lock screen is detected for Windows WorkSpaces by using Group Policy settings. Note • This Group Policy setting applies to both password-authenticated and smart card- authenticated sessions. • To enable the use of smart cards with Windows WorkSpaces, additional steps are required. For more information, see Use smart cards for authentication in WorkSpaces Personal. Manage Windows WorkSpaces 312 Amazon WorkSpaces Administration Guide To enable or disable disconnect session on screen lock for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable/disable disconnect session on screen lock setting. 3. In the Enable/disable disconnect session on screen lock dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable or disable Indirect Display Driver (IDD) for DCV By default, WorkSpaces supports supports using Indirect Display Driver (IDD). If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To enable or disable Indirect Display Driver (IDD) for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable the AWS Indirect Display Driver setting. 3. In the Enable the AWS Indirect Display Driver dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: a. Reboot the WorkSpace (in the WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). b. In an administrative command prompt, enter gpupdate /force. Manage Windows WorkSpaces 313 Amazon WorkSpaces Administration Guide Conﬁgure display settings for DCV WorkSpaces allows you to conﬁgure several diﬀerent display settings, including the maximum frame rate, minimum image quality, maximum image quality, and YUV encoding. Adjust these settings based on the image quality, responsiveness, and color accuracy that you need. By default, the maximum frame rate value is 25. The maximum frame rate value speciﬁes the maximum allowed frames per second (fps). A value of 0 means no limit. By default, the minimum image quality value is 30. The minimum image quality can be optimized for best image responsiveness, or best image quality. For best responsiveness, reduce the minimum quality. For best quality, increase the minimum quality. • Ideal values for best responsiveness are between 30 and 90. • Ideal values
workspaces-ag-100	workspaces-ag.pdf	100	quality, and YUV encoding. Adjust these settings based on the image quality, responsiveness, and color accuracy that you need. By default, the maximum frame rate value is 25. The maximum frame rate value speciﬁes the maximum allowed frames per second (fps). A value of 0 means no limit. By default, the minimum image quality value is 30. The minimum image quality can be optimized for best image responsiveness, or best image quality. For best responsiveness, reduce the minimum quality. For best quality, increase the minimum quality. • Ideal values for best responsiveness are between 30 and 90. • Ideal values for best quality are between 60 and 90. By default, the maximum image quality value is 80. The maximum image quality doesn't aﬀect the image responsiveness or quality, but sets a maximum to limit network usage. By default, image encoding is set to YUV420. Selecting Enable YUV444 encoding enables YUV444 encoding for high color accuracy. For Windows WorkSpaces, you can use Group Policy settings to conﬁgure the maximum frame rate, minimum image quality, and maximum image quality values. To conﬁgure display settings for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure display settings setting. 3. In the Conﬁgure display settings dialog box, choose Enabled and then set the Maximum frame rate (fps), minimum image quality, and maximum image quality values to the desired levels. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after you restart the WorkSpace session. To apply the Group Policy changes, do one of the following: Manage Windows WorkSpaces 314 Amazon WorkSpaces Administration Guide • Reboot the WorkSpace. the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces • In an administrative command prompt, enter gpupdate /force. Enable or disable VSync for the AWS Virtual Display-Only Driver for DCV By default, WorkSpaces supports using the VSync feature for the AWS Virtual Display-Only Driver. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To enable or disable VSync for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Enable VSync feature of the AWS Virtual Display Only Driver setting. 3. In the Enable VSync feature of the AWS Virtual Display Only Driver dialog box, choose Enabled or Disabled. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do the following: a. Restart the WorkSpace by doing the either of the following: i. Option 1 — In the WorkSpaces console, choose the WorkSpace you want to reboot. Then, choose Actions, Reboot WorkSpaces. ii. Option 2 — In an administrative command prompt, enter gpupdate /force. b. Reconnect to the WorkSpace in order to apply the setting. c. Reboot the Workspace again. Conﬁgure log verbosity for DCV By default, the log verbosity level for DCV WorkSpaces is set to Info. You can set log levels to verbosity levels ranging from least verbose to most verbose, as detailed here: • Error – least verbose • Warning Manage Windows WorkSpaces 315 Amazon WorkSpaces • Info – default • Debug – most verbose Administration Guide For Windows WorkSpaces, you can use Group Policy settings to conﬁgure the log verbosity levels. To conﬁgure log verbosity levels for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure log verbosity setting. 3. In the Conﬁgure log verbosity dialog box, choose Enabled and then set the log verbosity level to debug, error, info, or warning. 4. Choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after you restart the WorkSpace session. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace. In the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces. • In an administrative command prompt, enter gpupdate /force. Conﬁgure idle disconnect timeout for DCV WorkSpaces allows you to conﬁgure how long a user can be inactive, while connected to a WorkSpace, before they are disconnected. Examples of user activity input include the following: • Keyboard events • Mouse events (cursor movement, scrolling, clicking) • Stylus events • Touch events (tapping touchscreens, tablets) • Gamepad events • File storage operations (uploads, downloads, directory creation, list items) • Webcam streaming Audio in, audio out, and pixels changing don't qualify as user activity. Manage Windows WorkSpaces 316 Amazon WorkSpaces Administration Guide When enabling idle disconnect timeout, you can optionally notify your user that their session will
workspaces-ag-101	workspaces-ag.pdf	101	DCV WorkSpaces allows you to conﬁgure how long a user can be inactive, while connected to a WorkSpace, before they are disconnected. Examples of user activity input include the following: • Keyboard events • Mouse events (cursor movement, scrolling, clicking) • Stylus events • Touch events (tapping touchscreens, tablets) • Gamepad events • File storage operations (uploads, downloads, directory creation, list items) • Webcam streaming Audio in, audio out, and pixels changing don't qualify as user activity. Manage Windows WorkSpaces 316 Amazon WorkSpaces Administration Guide When enabling idle disconnect timeout, you can optionally notify your user that their session will disconnect within the conﬁgured time unless they engage. By default, idle disconnect timeout is disabled, the timeout value is set to 0 minutes, and the notiﬁcation is disabled. If you enable this policy setting, the idle disconnect timeout value defaults to 60 minutes and the idle disconnect warning value defaults to 60 seconds. For Windows WorkSpaces, you can use Group Policy settings to conﬁgure this feature. To conﬁgure idle disconnect timeout for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure Idle Disconnect Timeout setting. 3. In the Conﬁgure Idle Disconnect Timeout dialog box, choose Enabled and then set the desired disconnect timeout value (in minutes), and optionally the warning timer value (in seconds). 4. Choose Apply, OK. 5. The Group Policy setting change takes eﬀect immediately after you apply the change. Conﬁgure ﬁle transfer for DCV By default, Amazon WorkSpaces disables the ﬁle transfer function. You can enable it to allow users to upload and download ﬁles between their local computer and WorkSpaces session. The ﬁles will be saved in a My Storage folder on the WorkSpaces session. To enable ﬁle transfer for Windows WorkSpaces 1. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Amazon, and DCV. 2. Open the Conﬁgure session storage setting. 3. 4. In the Conﬁgure Session Storage dialog box, choose Enabled. (Optional) Specify a folder for session storage (for example, c:/session-storage). If not speciﬁed, the default folder for session storage will be the home folder. 5. You can conﬁgure your WorkSpaces with one of the following ﬁle transfer options: • Choose Download and Upload to allow two-way ﬁle transfer. Manage Windows WorkSpaces 317 Amazon WorkSpaces Administration Guide • Choose Upload Only to only allow ﬁle uploads from a local computer to your WorkSpaces session. • Choose Download Only to only allow ﬁle downloads from your WorkSpaces session to a local computer. 6. Choose OK. 7. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after you restart the WorkSpace session. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace. In the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces. • In an administrative command prompt, enter gpupdate /force. Install the Group Policy administrative template for PCoIP To use the Group Policy settings that are speciﬁc to Amazon WorkSpaces when using the PCoIP protocol, you must add the Group Policy administrative template that is appropriate to the version of the PCoIP agent (either 32-bit or 64-bit) that is being used for your WorkSpaces. Note If you have a mix of WorkSpaces with 32-bit and 64-bit agents, you can use the Group Policy administrative templates for 32-bit agents, and your Group Policy settings will be applied to both 32-bit and 64-bit agents. When all of your WorkSpaces are using the 64-bit agent, you can switch to using the administrative template for 64-bit agents. To determine whether your WorkSpaces have the 32-bit agent or the 64-bit agent 1. 2. Log in to a WorkSpace, and then open the Task Manager by choosing View, Send Ctrl + Alt + Delete or by right-clicking the task bar and choosing Task Manager. In the Task Manager, go to the Details tab, right-click the column headers, and choose Select Columns. 3. In the Select Columns dialog box, select Platform, and then choose OK. Manage Windows WorkSpaces 318 Amazon WorkSpaces Administration Guide 4. On the Details tab, ﬁnd pcoip_agent.exe, and then check its value in the Platform column to determine if the PCoIP agent is 32-bit or 64-bit. (You might see a mix of 32-bit and 64-bit WorkSpaces components; this is normal.) Install the Group Policy administrative template for PCoIP (32-Bit) To use the Group Policy settings that are speciﬁc to WorkSpaces when using the PCoIP protocol with the 32-bit PCoIP agent, you must install the Group Policy administrative template for PCoIP. Perform the following procedure on a directory administration WorkSpace or Amazon EC2 instance that is joined to your directory. For more information about working with .adm ﬁles, see Recommendations for managing Group Policy administrative template (.adm) ﬁles
workspaces-ag-102	workspaces-ag.pdf	102	determine if the PCoIP agent is 32-bit or 64-bit. (You might see a mix of 32-bit and 64-bit WorkSpaces components; this is normal.) Install the Group Policy administrative template for PCoIP (32-Bit) To use the Group Policy settings that are speciﬁc to WorkSpaces when using the PCoIP protocol with the 32-bit PCoIP agent, you must install the Group Policy administrative template for PCoIP. Perform the following procedure on a directory administration WorkSpace or Amazon EC2 instance that is joined to your directory. For more information about working with .adm ﬁles, see Recommendations for managing Group Policy administrative template (.adm) ﬁles in the Microsoft documentation. To install the Group Policy administrative template for PCoIP 1. From a running Windows WorkSpace, make a copy of the pcoip.adm ﬁle in the C:\Program Files (x86)\Teradici\PCoIP Agent\configuration directory. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to the organizational unit in your domain that contains your WorkSpaces machine accounts. 3. Open the context (right-click) menu for the machine account organizational unit and choose Create a GPO in this domain, and link it here. 4. In the New GPO dialog box, enter a descriptive name for the GPO, such as WorkSpaces Machine Policies, and leave Source Starter GPO set to (none). Choose OK. 5. Open the context (right-click) menu for the new GPO and choose Edit. 6. 7. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, and Administrative Templates. Choose Action, Add/Remove Templates from the main menu. In the Add/Remove Templates dialog box, choose Add, select the pcoip.adm ﬁle copied previously, and then choose Open, Close. 8. Close the Group Policy Management Editor. You can now use this GPO to modify the Group Policy settings that are speciﬁc to WorkSpaces. Manage Windows WorkSpaces 319 Amazon WorkSpaces Administration Guide To verify that the administrative template ﬁle is correctly installed 1. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to and select the WorkSpaces GPO for your WorkSpaces machine accounts. Choose Action, Edit in the main menu. 2. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, Classic Administrative Templates, and PCoIP Session Variables. 3. You can now use this PCoIP Session Variables Group Policy object to modify the Group Policy settings that are speciﬁc to Amazon WorkSpaces when using PCoIP. Note To allow the user to override your settings, choose Overridable Administrator Settings; otherwise, choose Not Overridable Administrator Settings. Install the Group Policy administrative template for PCoIP (64-Bit) To use the Group Policy settings that are speciﬁc to WorkSpaces when using the PCoIP protocol, you must add the Group Policy administrative template PCoIP.admx and PCoIP.adml ﬁles for PCoIP to the Central Store of the domain controller for your WorkSpaces directory. For more information about .admx and .adml ﬁles, see How to create and manage the Central Store for Group Policy Administrative Templates in Windows. The following procedure describes how to create the Central Store and add the administrative template ﬁles to it. Perform the following procedure on a directory administration WorkSpace or Amazon EC2 instance that is joined to your WorkSpaces directory. To install the Group Policy administrative template ﬁles for PCoIP 1. From a running Windows WorkSpace, make a copy of the PCoIP.admx and PCoIP.adml ﬁles in the C:\Program Files\Teradici\PCoIP Agent\configuration \policyDefinitions directory. The PCoIP.adml ﬁle is in the en-US subfolder of that directory. 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open Windows File Explorer, and in the address bar, enter your organization's fully qualiﬁed domain name (FQDN), such as \\example.com. Manage Windows WorkSpaces 320 Amazon WorkSpaces 3. Open the sysvol folder. 4. Open the folder with the FQDN name. Administration Guide 5. Open the Policies folder. You should now be in \\FQDN\sysvol\FQDN\Policies. 6. If it doesn't already exist, create a folder named PolicyDefinitions. 7. Open the PolicyDefinitions folder. 8. Copy the PCoIP.admx ﬁle into the \\FQDN\sysvol\FQDN\Policies \PolicyDefinitions folder. 9. Create a folder named en-US in the PolicyDefinitions folder. 10. Open the en-US folder. 11. Copy the PCoIP.adml ﬁle into the \\FQDN\sysvol\FQDN\Policies \PolicyDefinitions\en-US folder. To verify that the administrative template ﬁles are correctly installed 1. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 2. 3. 4. 5. 6. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. Note If the domain backing the WorkSpaces is an AWS Managed Microsoft AD directory, you cannot use the Default Domain Policy
workspaces-ag-103	workspaces-ag.pdf	103	folder. 11. Copy the PCoIP.adml ﬁle into the \\FQDN\sysvol\FQDN\Policies \PolicyDefinitions\en-US folder. To verify that the administrative template ﬁles are correctly installed 1. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc). 2. 3. 4. 5. 6. Expand the forest (Forest:FQDN). Expand Domains. Expand your FQDN (for example, example.com). Expand Group Policy Objects. Select Default Domain Policy, open the context (right-click) menu, and choose Edit. Note If the domain backing the WorkSpaces is an AWS Managed Microsoft AD directory, you cannot use the Default Domain Policy to create your GPO. Instead, you must create and link the GPO under the domain container that has delegated privileges. When you create a directory with AWS Managed Microsoft AD, AWS Directory Service creates a yourdomainname organizational unit (OU) under the domain root. The name of this OU is based on the NetBIOS name that you typed when you created your directory. If you didn't specify a NetBIOS name, it will default to the ﬁrst part of your Directory DNS name (for example, in the case of corp.example.com, the NetBIOS name is corp). Manage Windows WorkSpaces 321 Amazon WorkSpaces Administration Guide To create your GPO, instead of selecting Default Domain Policy, select the yourdomainname OU (or any OU under that one), open the context (right-click) menu, and choose Create a GPO in this domain, and Link it here. For more information about the yourdomainname OU, see What Gets Created in the AWS Directory Service Administration Guide. 7. In the Group Policy Management Editor, choose Computer Conﬁguration, Policies, Administrative Templates, and PCoIP Session Variables. 8. You can now use this PCoIP Session Variables Group Policy object to modify the Group Policy settings that are speciﬁc to WorkSpaces when using PCoIP. Note To allow the user to override your settings, choose Overridable Administrator Settings; otherwise, choose Not Overridable Administrator Settings. Manage Group Policy settings for PCoIP Use Group Policy settings to manage your Windows WorkSpaces that use PCoIP. Conﬁgure printer support for PCoIP By default, WorkSpaces enables Basic remote printing, which oﬀers limited printing capabilities because it uses a generic printer driver on the host side to ensure compatible printing. Advanced remote printing for Windows clients lets you use speciﬁc features of your printer, such as double-sided printing, but it requires installation of the matching printer driver on the host side. Remote printing is implemented as a virtual channel. If virtual channels are disabled, remote printing does not function. For Windows WorkSpaces, you can use Group Policy settings to conﬁgure printer support as needed. To conﬁgure printer support 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). Manage Windows WorkSpaces 322 Amazon WorkSpaces Administration Guide 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure remote printing setting. 4. In the Conﬁgure remote printing dialog box, do one of the following: • • To enable Advanced remote printing, choose Enabled, and then under Options, Conﬁgure remote printing, choose Basic and Advanced printing for Windows clients. To automatically use the client computer's current default printer, select Automatically set default printer. To disable printing, choose Enabled, and then under Options, Conﬁgure remote printing, choose Printing disabled. 5. Choose OK. 6. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. By default, local printer auto-redirection is disabled. You can use Group Policy settings to enable this feature so that your local printer is set as the default printer every time that you connect to your WorkSpace. Note Local printer redirection is not available for Amazon Linux WorkSpaces. To enable local printer auto-redirection 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). Manage Windows WorkSpaces 323 Amazon WorkSpaces Administration Guide 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure remote printing setting. 4. Choose Enabled, and then under Options, Conﬁgure remote printing, choose one of the following: 5. 6. • Basic and Advanced printing for Windows clients • Basic printing Select Automatically set default printer, and then choose OK. The
workspaces-ag-104	workspaces-ag.pdf	104	Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). Manage Windows WorkSpaces 323 Amazon WorkSpaces Administration Guide 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure remote printing setting. 4. Choose Enabled, and then under Options, Conﬁgure remote printing, choose one of the following: 5. 6. • Basic and Advanced printing for Windows clients • Basic printing Select Automatically set default printer, and then choose OK. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable or disable clipboard redirection (copy/paste) for PCoIP By default, WorkSpaces supports clipboard redirection. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To enable or disable clipboard redirection 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure clipboard redirection setting. 4. In the Conﬁgure clipboard redirection dialog box, choose Enabled and then choose one of the following settings to determine the direction in which clipboard redirection is allowed. When you're done, choose OK. Manage Windows WorkSpaces 324 Amazon WorkSpaces Administration Guide • Disabled in both directions • Enabled agent to client only (WorkSpace to local computer) • Enabled client to agent only (local computer to WorkSpace) • Enabled in both directions 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Known limitation With clipboard redirection enabled on the WorkSpace, if you copy content that is larger than 890 KB from a Microsoft Oﬃce application, the application might become slow or unresponsive for up to 5 seconds. Set the session resume timeout for PCoIP When you lose network connectivity, your active WorkSpaces client session is disconnected. WorkSpaces client applications for Windows and macOS attempt to reconnect the session automatically if network connectivity is restored within a certain amount of time. The default session resume timeout is 20 minutes, but you can modify that value for WorkSpaces that are controlled by your domain's Group Policy settings. To set the automatic session resume timeout value 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure Session Automatic Reconnection Policy setting. Manage Windows WorkSpaces 325 Amazon WorkSpaces Administration Guide 4. In the Conﬁgure Session Automatic Reconnection Policy dialog box, choose Enabled, set the Conﬁgure Session Automatic Reconnection Policy option to the desired timeout, in minutes, and choose OK. 5. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable or disable audio-in redirection for PCoIP By default, Amazon WorkSpaces supports redirecting data from a local microphone. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. Note If you have a Group Policy setting that restricts users' local logon in their WorkSpaces, audio-in won't work on your WorkSpaces. If you remove that Group Policy setting, the audio-in feature is enabled after the next reboot of the WorkSpace. For more information about this Group Policy setting, see Allow logon locally in the Microsoft documentation. To enable or disable audio-in redirection 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that
workspaces-ag-105	workspaces-ag.pdf	105	If you have a Group Policy setting that restricts users' local logon in their WorkSpaces, audio-in won't work on your WorkSpaces. If you remove that Group Policy setting, the audio-in feature is enabled after the next reboot of the WorkSpace. For more information about this Group Policy setting, see Allow logon locally in the Microsoft documentation. To enable or disable audio-in redirection 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Enable/disable audio in the PCoIP session setting. 4. In the Enable/disable audio in the PCoIP session dialog box, choose Enabled or Disabled. 5. Choose OK. Manage Windows WorkSpaces 326 Amazon WorkSpaces Administration Guide 6. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Disable time zone redirection for PCoIP 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 oﬀ time zone direction for various reasons: • 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 speciﬁc time zone. • Your users who travel a lot want to keep their WorkSpaces in one time zone for consistency and personal preference. If needed for Windows WorkSpaces, you can use Group Policy settings to disable this feature. To disable time zone redirection 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure timezone redirection setting. 4. In the Conﬁgure timezone redirection dialog box, choose Disabled. 5. Choose OK. Manage Windows WorkSpaces 327 Amazon WorkSpaces Administration Guide 6. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. 7. Set the time zone for the WorkSpaces to the desired time zone. The time zone of the WorkSpaces is now static and no longer mirrors the time zone of the client machines. Conﬁgure PCoIP security settings For PCoIP, data in transit is encrypted using TLS 1.2 encryption and SigV4 request signing. The PCoIP protocol uses encrypted UDP traﬃc, with AES encryption, for streaming pixels. The streaming connection, using port 4172 (TCP and UDP), is encrypted by using AES-128 and AES-256 ciphers, but the encryption defaults to 128-bit. You can change this default to 256-bit by using the Conﬁgure PCoIP Security Settings Group Policy setting. You can also use this Group Policy setting to modify the TLS Security Mode and to block certain cipher suites. A detailed explanation of these settings and the supported cipher suites is provided in the Conﬁgure PCoIP Security Settings Group Policy dialog box. To conﬁgure PCoIP security settings 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure PCoIP Security Settings setting. 4. In the Conﬁgure PCoIP Security Settings dialog box, choose Enabled. To set the default encryption for streaming traﬃc to 256-bit, go to the PCoIP Data Encryption Ciphers option, and select AES-256-GCM only. Manage Windows WorkSpaces 328 Amazon WorkSpaces Administration Guide 5. (Optional) Adjust the TLS Security Mode setting, and then list any cipher suites that you want to block. For more information about these settings, see the descriptions provided in the Conﬁgure PCoIP Security Settings dialog box. 6. Choose OK. 7. The
workspaces-ag-106	workspaces-ag.pdf	106	Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Conﬁgure PCoIP Security Settings setting. 4. In the Conﬁgure PCoIP Security Settings dialog box, choose Enabled. To set the default encryption for streaming traﬃc to 256-bit, go to the PCoIP Data Encryption Ciphers option, and select AES-256-GCM only. Manage Windows WorkSpaces 328 Amazon WorkSpaces Administration Guide 5. (Optional) Adjust the TLS Security Mode setting, and then list any cipher suites that you want to block. For more information about these settings, see the descriptions provided in the Conﬁgure PCoIP Security Settings dialog box. 6. Choose OK. 7. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. Enable USB redirection for YubiKey U2F Note Amazon WorkSpaces currently supports USB redirection only for YubiKey U2F. Other types of USB devices might be redirected but they are not supported and might not work properly. To enable USB redirection for YubiKey U2F 1. Make sure that you've installed the most recent WorkSpaces Group Policy administrative template for PCoIP (32-Bit) or WorkSpaces Group Policy administrative template for PCoIP (64-Bit). 2. On a directory administration WorkSpace or an Amazon EC2 instance that is joined to your WorkSpaces directory, open the Group Policy Management tool (gpmc.msc) and navigate to PCoIP Session Variables. 3. Open the Enable/disable USB in the PCOIP session setting. 4. Choose Enabled, and then choose OK. 5. Open the Conﬁgure PCoIP USB allowed and unallowed device rules setting. 6. Choose Enabled, and under Enter the USB authorization table (maximum ten rules), conﬁgure your USB device allow list rules. Manage Windows WorkSpaces 329 Amazon WorkSpaces Administration Guide • Authorization rule - 110500407. This value is a combination of a Vendor ID (VID) and a Product ID (PID). The format for a VID/PID combination is 1xxxxyyyy, where xxxx is the VID in hexadecimal format and yyyy is the PID in hexadecimal format. For this example, 1050 is the VID, and 0407 is the PID. For more YubiKey USB values, see YubiKey USB ID Values. 7. Under Enter the USB authorization table (maximum ten rules), conﬁgure your USB device block list rules. • For Unauthorization Rule, set an empty string. This means that only USB devices in the authorization list are allowed. Note You can deﬁne a maximum of 10 USB authorization rules and a maximum of 10 USB unauthorization rules. Use the vertical bar (\|) character to separate multiple rules. For detailed information about the authorization/unauthorization rules, see Teradici PCoIP Standard Agent for Windows. 8. Choose OK. 9. The Group Policy setting change takes eﬀect after the next Group Policy update for the WorkSpace and after the WorkSpace session is restarted. To apply the Group Policy changes, do one of the following: • Reboot the WorkSpace (in the Amazon WorkSpaces console, select the WorkSpace, then choose Actions, Reboot WorkSpaces). • In an administrative command prompt, enter gpupdate /force. After the setting takes eﬀect, all supported USB devices can redirect to WorkSpaces unless restrictions are conﬁgured through the USB device rules setting. Set the maximum lifetime for a Kerberos ticket If you have not disabled the Remember Me feature of your Windows WorkSpaces, your WorkSpace users can use the Remember Me or Keep me logged in check box in their WorkSpaces client application to save their credentials. This feature allows users to easily connect to their WorkSpaces Manage Windows WorkSpaces 330 Amazon WorkSpaces Administration Guide while the client application remains running. Their credentials are securely cached up to the maximum lifetime of their Kerberos tickets. If your WorkSpace uses an AD Connector directory, you can modify the maximum lifetime of the Kerberos tickets for your WorkSpaces users through Group Policy by following the steps in Maximum Lifetime for a User Ticket in the Microsoft Windows documentation. To enable or disable the Remember Me feature, see Enable self-service WorkSpaces management capabilities for your users in WorkSpaces Personal. Conﬁgure device proxy server settings for internet access By default, the WorkSpaces client applications use the proxy server that’s speciﬁed in the device operating system settings for HTTPS (port 443) traﬃc. 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 conﬁgure the device proxy server settings for your Windows WorkSpaces through Group Policy by following the steps in Conﬁgure device proxy and internet connectivity settings in the Microsoft documentation. For more information about conﬁguring the proxy settings in the WorkSpaces Windows client application, see Proxy Server in the Amazon

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.