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

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::Image

Includes:

Structure

Defined in:

lib/aws-sdk-appstream/types.rb

Overview

Describes an image.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #applications ⇒ Array<Types::Application>

  The applications associated with the image.

• #appstream_agent_version ⇒ String

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

• #arn ⇒ String

  The ARN of the image.

• #base_image_arn ⇒ String

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

• #created_time ⇒ Time

  The time the image was created.

• #description ⇒ String

  The description to display.

• #display_name ⇒ String

  The image name to display.

• #image_builder_supported ⇒ Boolean

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

• #image_permissions ⇒ Types::ImagePermissions

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

• #name ⇒ String

  The name of the image.

• #platform ⇒ String

  The operating system platform of the image.

• #public_base_image_released_date ⇒ Time

  The release date of the public base image.

• #state ⇒ String

  The image starts in the ‘PENDING` state.

• #state_change_reason ⇒ Types::ImageStateChangeReason

  The reason why the last state change occurred.

• #visibility ⇒ String

  Indicates whether the image is public or private.

Instance Attribute Details

#applications ⇒ Array<Types::Application>

The applications associated with the image.

Returns:

• (Array<Types::Application>)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#appstream_agent_version ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#arn ⇒ String

The ARN of the image.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#base_image_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#created_time ⇒ Time

The time the image was created.

Returns:

• (Time)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#description ⇒ String

The description to display.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#display_name ⇒ String

The image name to display.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#image_builder_supported ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#image_permissions ⇒ Types::ImagePermissions

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

Returns:

• (Types::ImagePermissions)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#name ⇒ String

The name of the image.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#platform ⇒ String

The operating system platform of the image.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#public_base_image_released_date ⇒ Time

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)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#state ⇒ String

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)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#state_change_reason ⇒ Types::ImageStateChangeReason

The reason why the last state change occurred.

Returns:

• (Types::ImageStateChangeReason)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end

#visibility ⇒ String

Indicates whether the image is public or private.

Returns:

• (String)

# File 'lib/aws-sdk-appstream/types.rb', line 1972

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,
  :appstream_agent_version,
  :image_permissions)
  include Aws::Structure
end