Step 8: Create a BYOL image using the WorkSpaces console - Amazon WorkSpaces
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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 Amazon 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 specific 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 Amazon Web Services Support Center to get your account added to the allow list. After your account is on the allow list, you can use the Amazon 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 Amazon CLI Command Reference.

To create an image from the Windows VM

  1. Open the WorkSpaces console at https://console.amazonaws.cn/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:

    • 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 identifier 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.

    • (Optional) For Select applications, choose which version of Microsoft Office you want to subscribe to. For more information, see Step 7: Add Microsoft Office 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 Office 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.

    Note

    During the BYOL import process, offending 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.