Class: Aws::WorkSpaces::Types::ImportWorkspaceImageRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-workspaces/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applicationsArray<String>

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].

<note markdown=“1”> * Although this parameter is an array, only one item is allowed at

this time.
  • Windows 11 only supports ‘Microsoft_Office_2019`.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html

Returns:

  • (Array<String>)


2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
# File 'lib/aws-sdk-workspaces/types.rb', line 2571

class ImportWorkspaceImageRequest < Struct.new(
  :ec2_image_id,
  :ingestion_process,
  :image_name,
  :image_description,
  :tags,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_image_idString

The identifier of the EC2 image.

Returns:

  • (String)


2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
# File 'lib/aws-sdk-workspaces/types.rb', line 2571

class ImportWorkspaceImageRequest < Struct.new(
  :ec2_image_id,
  :ingestion_process,
  :image_name,
  :image_description,
  :tags,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#image_descriptionString

The description of the WorkSpace image.

Returns:

  • (String)


2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
# File 'lib/aws-sdk-workspaces/types.rb', line 2571

class ImportWorkspaceImageRequest < Struct.new(
  :ec2_image_id,
  :ingestion_process,
  :image_name,
  :image_description,
  :tags,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#image_nameString

The name of the WorkSpace image.

Returns:

  • (String)


2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
# File 'lib/aws-sdk-workspaces/types.rb', line 2571

class ImportWorkspaceImageRequest < Struct.new(
  :ec2_image_id,
  :ingestion_process,
  :image_name,
  :image_description,
  :tags,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_processString

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, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, 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.

<note markdown=“1”> 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].

</note>

[1]: aws.amazon.com/workspaces/core/

Returns:

  • (String)


2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
# File 'lib/aws-sdk-workspaces/types.rb', line 2571

class ImportWorkspaceImageRequest < Struct.new(
  :ec2_image_id,
  :ingestion_process,
  :image_name,
  :image_description,
  :tags,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
# File 'lib/aws-sdk-workspaces/types.rb', line 2571

class ImportWorkspaceImageRequest < Struct.new(
  :ec2_image_id,
  :ingestion_process,
  :image_name,
  :image_description,
  :tags,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end