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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an image.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#applications ⇒ Array<Types::Application>

The applications associated with the image.

Returns:

#appstream_agent_version ⇒ String

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

Returns:

  • (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.

Returns:

  • (String) —

    The ARN of the image.

#base_image_arn ⇒ String

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

Returns:

  • (String) —

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

#created_time ⇒ Time

The time the image was created.

Returns:

  • (Time) —

    The time the image was created.

#description ⇒ String

The description to display.

Returns:

  • (String) —

    The description to display.

#display_name ⇒ String

The image name to display.

Returns:

  • (String) —

    The image name to display.

#image_builder_name ⇒ String

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

    The name of the image builder that was used to create the private image.

#image_builder_supported ⇒ Boolean

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

Returns:

  • (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.

Returns:

#name ⇒ String

The name of the image.

Returns:

  • (String) —

    The name of the image.

#platform ⇒ String

The operating system platform of the image.

Possible values:

  • WINDOWS
  • WINDOWS_SERVER_2016
  • WINDOWS_SERVER_2019

Returns:

  • (String) —

    The operating system platform of the image.

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

    The release date of the public base image.

#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.

Possible values:

  • PENDING
  • AVAILABLE
  • FAILED
  • COPYING
  • DELETING

Returns:

  • (String) —

    The image starts in the PENDING state.

#state_change_reason ⇒ Types::ImageStateChangeReason

The reason why the last state change occurred.

Returns:

#visibility ⇒ String

Indicates whether the image is public or private.

Possible values:

  • PUBLIC
  • PRIVATE
  • SHARED

Returns:

  • (String) —

    Indicates whether the image is public or private.