You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppStream::Types::Image

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

Overview

New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.

Instance Attribute Summary collapse

Instance Attribute Details

#applicationsArray<Types::Application>

The applications associated with an image.

Returns:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#arnString

The ARN for the image.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#base_image_arnString

The source image ARN from which this image was created.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#created_timeTime

The time stamp when the image was created.

Returns:

  • (Time)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#descriptionString

A meaningful description for the image.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#display_nameString

The display name for the image.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#image_builder_supportedBoolean

Whether an image builder can be launched from this image.

Returns:

  • (Boolean)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#nameString

The unique identifier for the image.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#platformString

The operating system platform of the image.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#public_base_image_released_dateTime

The AWS release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

Returns:

  • (Time)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#stateString

The image starts in the PENDING state. If image creation succeeds, it moves to AVAILABLE. If image creation fails, it moves to FAILED.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#state_change_reasonTypes::ImageStateChangeReason

The reason why the last state change occurred.



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end

#visibilityString

The visibility of an image to the user; images can be public or private.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1012

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date)
  include Aws::Structure
end