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 AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.

Returns:

  • (Boolean)


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1884

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)


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1884

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)


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1884

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)


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1884

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)


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1884

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 AppStream 2.0 Administration Guide.

Returns:

  • (Hash<String,String>)


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1884

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