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:

Instance Attribute Summary collapse

Instance Attribute Details

#applicationsArray<Types::Application>

The applications associated with the image.

Returns:

#appstream_agent_versionString

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.

#arnString

The ARN of the image.

Returns:

  • (String)

    The ARN of the image.

#base_image_arnString

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_timeTime

The time the image was created.

Returns:

  • (Time)

    The time the image was created.

#descriptionString

The description for display.

Returns:

  • (String)

    The description for display.

#display_nameString

The image name for display.

Returns:

  • (String)

    The image name for display.

#image_builder_supportedBoolean

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

Returns:

  • (Boolean)

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

#nameString

The name of the image.

Returns:

  • (String)

    The name of the image.

#platformString

The operating system platform of the image.

Possible values:

  • WINDOWS

Returns:

  • (String)

    The operating system platform of the image.

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

    The release date of the public base image.

#stateString

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
  • DELETING

Returns:

  • (String)

    The image starts in the PENDING state.

#state_change_reasonTypes::ImageStateChangeReason

The reason why the last state change occurred.

Returns:

#visibilityString

Indicates whether the image is public or private.

Possible values:

  • PUBLIC
  • PRIVATE

Returns:

  • (String)

    Indicates whether the image is public or private.