Class: Aws::AppStream::Types::CreateUpdatedImageRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Indicates whether to display the status of image update availability before WorkSpaces Applications initiates the process of creating a new updated image. If this value is set to true, WorkSpaces Applications displays whether image updates are available. If this value is set to false, WorkSpaces Applications initiates the process of creating a new updated image without displaying whether image updates are available.

Returns:

  • (Boolean)


2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2528

class CreateUpdatedImageRequest < Struct.new(
  :existing_image_name,
  :new_image_name,
  :new_image_description,
  :new_image_display_name,
  :new_image_tags,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#existing_image_nameString

The name of the image to update.

Returns:

  • (String)


2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2528

class CreateUpdatedImageRequest < Struct.new(
  :existing_image_name,
  :new_image_name,
  :new_image_description,
  :new_image_display_name,
  :new_image_tags,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#new_image_descriptionString

The description to display for the new image.

Returns:

  • (String)


2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2528

class CreateUpdatedImageRequest < Struct.new(
  :existing_image_name,
  :new_image_name,
  :new_image_description,
  :new_image_display_name,
  :new_image_tags,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#new_image_display_nameString

The name to display for the new image.

Returns:

  • (String)


2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2528

class CreateUpdatedImageRequest < Struct.new(
  :existing_image_name,
  :new_image_name,
  :new_image_description,
  :new_image_display_name,
  :new_image_tags,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#new_image_nameString

The name of the new image. The name must be unique within the AWS account and Region.

Returns:

  • (String)


2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2528

class CreateUpdatedImageRequest < Struct.new(
  :existing_image_name,
  :new_image_name,
  :new_image_description,
  :new_image_display_name,
  :new_image_tags,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#new_image_tagsHash<String,String>

The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.

Returns:

  • (Hash<String,String>)


2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2528

class CreateUpdatedImageRequest < Struct.new(
  :existing_image_name,
  :new_image_name,
  :new_image_description,
  :new_image_display_name,
  :new_image_tags,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end