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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::CreateUpdatedImageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appstream/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image.

• #existing_image_name ⇒ String

  The name of the image to update.

• #new_image_description ⇒ String

  The description to display for the new image.

• #new_image_display_name ⇒ String

  The name to display for the new image.

• #new_image_name ⇒ String

  The name of the new image.

• #new_image_tags ⇒ Hash<String,String>

  The tags to associate with the new image.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

# File '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_name ⇒ String

The name of the image to update.

Returns:

• (String)

# File '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_description ⇒ String

The description to display for the new image.

Returns:

• (String)

# File '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_name ⇒ String

The name to display for the new image.

Returns:

• (String)

# File '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_name ⇒ String

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

Returns:

• (String)

# File '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_tags ⇒ Hash<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*.

[1]: docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html

Returns:

• (Hash<String,String>)

# File '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