Create a custom WorkSpaces image and bundle for WorkSpaces Personal

1. On the WorkSpace that you're using to create your custom image, open C:\ProgramData\Amazon\EC2-Windows\Launch\Sysprep\Unattend.xml in Notepad or another text editor. For more information about working with the Unattend.xml file, see Answer files (unattend.xml) in the Microsoft documentation.

   Note

   To access the C: drive from the Windows File Explorer on your WorkSpace, enter C:\ in the address bar.

2. In the <settings pass="specialize"> section, make sure that <ComputerName> is set to an asterisk (*). If <ComputerName> is set to any other value, your custom computer name settings will be ignored. For more information about the <ComputerName> setting, see ComputerName in the Microsoft documentation.

3. In the <settings pass="specialize"> section, set <RegisteredOrganization> and <RegisteredOwner> to your preferred values.

   During Sysprep, the values that you specify for <RegisteredOwner> and <RegisteredOrganization> are concatenated together, and the first 7 characters of the combined string are used to create the computer name. For example, if you specify Amazon.com for <RegisteredOrganization> and EC2 for <RegisteredOwner>. For Windows 10-based images, the computer names for the WorkSpaces using custom bundles will start with EC2AMAZ-xxxxxxx. For Windows 11 based images, the computer names for the WorkSpaces using custom bundles will start with WORKSPA-xxxxxxx.

   Note

   • The <RegisteredOrganization> and <RegisteredOwner> values in the <settings pass="oobeSystem"> section are ignored by Sysprep.

   • Both <RegisteredOrganization> and <RegisteredOwner> are required values.

4. Save your changes to the Unattend.xml file.

1. If you are using Windows 10, open C:\Program Files\Amazon\Ec2ConfigService\Sysprep2008.xml in Notepad or another text editor. If you are using Windows 11, open C:\ProgramData\Amazon\EC2Launch\sysprep\OOBE_unattend.xml.

2. In the <settings pass="specialize"> section, if you're using Windows 10, uncomment <ComputerName>*</ComputerName>. If you're using Windows 11, you won't need to uncomment this section. Make sure that <ComputerName> is set to an asterisk (*). If <ComputerName> is set to any other value, your custom computer name settings will be ignored. For more information about the <ComputerName> setting, see ComputerName in the Microsoft documentation.

3. In the <settings pass="specialize"> section, the <RegisteredOrganization> field will be present for Windows 10 and Windows 11. The <RegisteredOwner> tag will only be present in Windows 10 by default. If you're using Windows 11, you will need to add this tag. Set <RegisteredOrganization> and <RegisteredOwner> to your preferred values.

   During Sysprep, the values that you specify for <RegisteredOwner> and <RegisteredOrganization> are concatenated together, and the first 7 characters of the combined string are used to create the computer name. For example, if you specify Amazon.com for <RegisteredOrganization> and EC2 for <RegisteredOwner>, the computer names for the WorkSpaces created from your custom bundle will start with EC2AMAZ-xxxxxxx.

   Note

   • The <RegisteredOrganization> and <RegisteredOwner> values in the <settings pass="oobeSystem"> section are ignored by Sysprep.

   • Both <RegisteredOrganization> and <RegisteredOwner> are required values.

4. If you are using Windows 10, save your changes to the Sysprep2008.xml file. If you are using Windows 11, save your changes to OOBE_unattend.xml

To run services under a local account

1. Open C:\Program Files\Amazon\ImageChecker_yyyyMMddhhmmss.log and find the list of services that are running under a domain account.

2. In the Windows search box, enter services.msc to open the Windows Services Manager.

3. Under Log On As, look for the services that are running under domain accounts. (Services running as Local System, Local Service, or Network Service do not interfere with image creation.)

4. Select a service that is running under a domain account, and then choose Action, Properties.

5. Open the Log On tab. Under Log on as, choose Local System account.

6. Choose OK.

To set all network adapters to use DHCP

1. In the Windows search box, enter control panel to open the Control Panel.

2. Choose Network and Internet.

3. Choose Network and Sharing Center.

4. Choose Change adapter settings, and select an adapter.

5. Choose Change settings of this connection.

6. On the Networking tab, select Internet Protocol Version 4 (TCP/IPv4), and then choose Properties.

7. In the Internet Protocol Version 4 (TCP/IPv4) Properties dialog box, select Obtain an IP address automatically.

8. Choose OK.

9. Repeat this process for all network adapters on the WorkSpace.

To enable Remote Desktop Services

1. In the Windows search box, enter services.msc to open the Windows Services Manager.

2. In the Name column, find Remote Desktop Services.

3. Select Remote Desktop Services, and then choose Action, Properties.

4. On the General tab, for Startup type, choose Manual or Automatic.

5. Choose OK.

To configure your environment variable path

1. In the Windows search box, enter environment variables and then choose Edit the system environment variables.

2. In the System Properties dialog box, open the Advanced tab, and choose Environment Variables.

3. In the Environment Variables dialog box, under System variables, select the Path entry and then choose Edit.

4. Choose New, and add the following path:

   C:\Windows\System32

5. Choose New again, and add the following path:

   C:\Windows\System32\WindowsPowerShell\v1.0\

6. Choose OK.

7. Restart the WorkSpace.

   Tip

   The order in which items appear in the environment variable path matters. To determine the correct order, you might want to compare the environment variable path of your WorkSpace with one from a newly created WorkSpace or a new Windows instance.

To enable the Windows Modules Installer service

1. In the Windows search box, enter services.msc to open the Windows Services Manager.

2. In the Name column, find Windows Modules Installer.

3. Select Windows Modules Installer, and then choose Action, Properties.

4. On the General tab, for Startup type, choose Manual or Automatic.

5. Choose OK.

To disable the Amazon SSM Agent service

1. In the Windows search box, enter services.msc to open the Windows Services Manager.

2. In the Name column, find Amazon SSM Agent.

3. Select Amazon SSM Agent, and then choose Action, Properties.

4. On the General tab, for Startup type, choose Disabled.

5. Choose OK.

To delete a user profile

1. To access the advanced system properties, do one of the following:

   • Press the Windows key+Pause Break, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box.

   • In the Windows search box, enter control panel. In the Control Panel, choose System and Security, then choose System, and then choose Advanced system settings in the left pane of the Control Panel > System and Security > System dialog box.

2. In the System Properties dialog box, on the Advanced tab, choose Settings under User Profiles.

3. If any profile is listed other than the Administrator profile, the Default Profile, and the profile of the intended WorkSpaces user, select that additional profile and choose Delete.

4. When asked if you want to delete the profile, choose Yes.

5. If necessary, repeat Steps 3 and 4 to remove any other profiles that don't belong on the WorkSpace.

6. Choose OK twice and close the Control Panel.

7. Restart the WorkSpace.

To remove all staged AppX packages

1. In the Windows search box, enter powershell. Choose Run as Administrator.

2. When asked "Do you want to allow this app to make changes to your device?", choose Yes.

3. In the Windows PowerShell window, enter the following commands to list all staged AppX packages, and press Enter after each one.

   $workSpaceUserName = $env:username

   $allAppxPackages = Get-AppxPackage -AllUsers

   $packages = $allAppxPackages |    Where-Object { `
                                   (($_.PackageUserInformation -like "*S-1-5-18*" -and !($_.PackageUserInformation -like "*$workSpaceUserName*")) -and `
                                   ($_.PackageUserInformation -like "*Staged*" -or $_.PackageUserInformation -like "*Installed*")) -or `
                                   ((!($_.PackageUserInformation -like "*S-1-5-18*") -and $_.PackageUserInformation -like "*$workSpaceUserName*") -and `
                                   $_.PackageUserInformation -like "*Staged*")
                                   }

4. Enter the following command to remove all staged AppX packages, and press Enter.

   $packages | Remove-AppxPackage -ErrorAction SilentlyContinue

5. Run the Image Checker again. If this test still fails, enter the following commands to remove all AppX packages, and press Enter after each one.

   Get-AppxProvisionedPackage -Online | Remove-AppxProvisionedPackage -Online -ErrorAction SilentlyContinue

   Get-AppxPackage -AllUsers | Remove-AppxPackage -ErrorAction SilentlyContinue

To check the Windows rearm count

1. On the Windows Start menu, choose Windows System, then choose Command Prompt.

2. In the Command Prompt window, enter the following command, and then press Enter.

   cscript C:\Windows\System32\slmgr.vbs /dlv