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:



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#appstream_agent_versionString

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#arnString

The ARN of the image.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#base_image_arnString

The ARN of the image from which this image was created.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#created_timeTime

The time the image was created.

Returns:

  • (Time)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#descriptionString

The description to display.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#display_nameString

The image name to display.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#image_builder_nameString

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#image_builder_supportedBoolean

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

Returns:

  • (Boolean)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#image_permissionsTypes::ImagePermissions

The permissions to provide to the destination AWS account for the specified image.



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#nameString

The name of the image.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#platformString

The operating system platform of the image.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions)
  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)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions)
  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)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#state_change_reasonTypes::ImageStateChangeReason

The reason why the last state change occurred.



2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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

#visibilityString

Indicates whether the image is public or private.

Returns:

  • (String)


2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 2399

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