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

Describes an image.

Instance Attribute Summary collapse

Instance Attribute Details

#applicationsArray<Types::Application>

The applications associated with the image.

Returns:



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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 of the image.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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 ARN of the image from which this image was created.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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 the image was created.

Returns:

  • (Time)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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

The description displayed to end users.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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 image name displayed to end users.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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

Indicates whether an image builder can be launched from this image.

Returns:

  • (Boolean)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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 name of the image.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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 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)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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, the state is AVAILABLE. If image creation fails, the state is FAILED.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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.



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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

Indicates whether the image is public or private.

Returns:

  • (String)


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1224

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