Package software.amazon.awssdk.services.workspaces.model

Interface ImportWorkspaceImageRequest.Builder

    • Method Detail

      • ec2ImageId

        ImportWorkspaceImageRequest.Builder ec2ImageId​(String ec2ImageId)

        The identifier of the EC2 image.

        Parameters:
        ec2ImageId - The identifier of the EC2 image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ingestionProcess

        ImportWorkspaceImageRequest.Builder ingestionProcess​(String ingestionProcess)

        The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WSP, or bring your own protocol (BYOP). To use DCV, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

        For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

        The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

        Parameters:
        ingestionProcess - The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WSP, or bring your own protocol (BYOP). To use DCV, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

        For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

        The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        WorkspaceImageIngestionProcess, WorkspaceImageIngestionProcess

      • ingestionProcess

        ImportWorkspaceImageRequest.Builder ingestionProcess​(WorkspaceImageIngestionProcess ingestionProcess)

        The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WSP, or bring your own protocol (BYOP). To use DCV, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

        For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

        The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

        Parameters:
        ingestionProcess - The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WSP, or bring your own protocol (BYOP). To use DCV, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

        For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

        The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        WorkspaceImageIngestionProcess, WorkspaceImageIngestionProcess

      • imageName

        ImportWorkspaceImageRequest.Builder imageName​(String imageName)

        The name of the WorkSpace image.

        Parameters:
        imageName - The name of the WorkSpace image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • imageDescription

        ImportWorkspaceImageRequest.Builder imageDescription​(String imageDescription)

        The description of the WorkSpace image.

        Parameters:
        imageDescription - The description of the WorkSpace image.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ImportWorkspaceImageRequest.Builder tags​(Collection<Tag> tags)

        The tags. Each WorkSpaces resource can have a maximum of 50 tags.

        Parameters:
        tags - The tags. Each WorkSpaces resource can have a maximum of 50 tags.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ImportWorkspaceImageRequest.Builder tags​(Tag... tags)

        The tags. Each WorkSpaces resource can have a maximum of 50 tags.

        Parameters:
        tags - The tags. Each WorkSpaces resource can have a maximum of 50 tags.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ImportWorkspaceImageRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags. Each WorkSpaces resource can have a maximum of 50 tags.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • applicationsWithStrings

        ImportWorkspaceImageRequest.Builder applicationsWithStrings​(Collection<String> applications)

        If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Parameters:
        applications - If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • applicationsWithStrings

        ImportWorkspaceImageRequest.Builder applicationsWithStrings​(String... applications)

        If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Parameters:
        applications - If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • applications

        ImportWorkspaceImageRequest.Builder applications​(Collection<Application> applications)

        If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Parameters:
        applications - If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • applications

        ImportWorkspaceImageRequest.Builder applications​(Application... applications)

        If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Parameters:
        applications - If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

        • Although this parameter is an array, only one item is allowed at this time.

        • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.