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

Class: Aws::EC2::Types::Image

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

Overview

Describes an image.

Instance Attribute Summary collapse

Instance Attribute Details

#architectureString

The architecture of the image.

Possible values:

  • i386
  • x86_64

Returns:

  • (String)

    The architecture of the image.

#block_device_mappingsArray<Types::BlockDeviceMapping>

Any block device mapping entries.

Returns:

#creation_dateString

The date and time the image was created.

Returns:

  • (String)

    The date and time the image was created.

#descriptionString

The description of the AMI that was provided during image creation.

Returns:

  • (String)

    The description of the AMI that was provided during image creation.

#ena_supportBoolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean)

    Specifies whether enhanced networking with ENA is enabled.

#hypervisorString

The hypervisor type of the image.

Possible values:

  • ovm
  • xen

Returns:

  • (String)

    The hypervisor type of the image.

#image_idString

The ID of the AMI.

Returns:

  • (String)

    The ID of the AMI.

#image_locationString

The location of the AMI.

Returns:

  • (String)

    The location of the AMI.

#image_owner_aliasString

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

Returns:

  • (String)

    The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

#image_typeString

The type of image.

Possible values:

  • machine
  • kernel
  • ramdisk

Returns:

  • (String)

    The type of image.

#kernel_idString

The kernel associated with the image, if any. Only applicable for machine images.

Returns:

  • (String)

    The kernel associated with the image, if any.

#nameString

The name of the AMI that was provided during image creation.

Returns:

  • (String)

    The name of the AMI that was provided during image creation.

#owner_idString

The AWS account ID of the image owner.

Returns:

  • (String)

    The AWS account ID of the image owner.

#platformString

The value is Windows for Windows AMIs; otherwise blank.

Possible values:

  • Windows

Returns:

  • (String)

    The value is Windows for Windows AMIs; otherwise blank.

#product_codesArray<Types::ProductCode>

Any product codes associated with the AMI.

Returns:

#publicBoolean

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

Returns:

  • (Boolean)

    Indicates whether the image has public launch permissions.

#ramdisk_idString

The RAM disk associated with the image, if any. Only applicable for machine images.

Returns:

  • (String)

    The RAM disk associated with the image, if any.

#root_device_nameString

The device name of the root device volume (for example, /dev/sda1).

Returns:

  • (String)

    The device name of the root device volume (for example, /dev/sda1).

#root_device_typeString

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

Possible values:

  • ebs
  • instance-store

Returns:

  • (String)

    The type of root device used by the AMI.

#sriov_net_supportString

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Returns:

  • (String)

    Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

#stateString

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Possible values:

  • pending
  • available
  • invalid
  • deregistered
  • transient
  • failed
  • error

Returns:

  • (String)

    The current state of the AMI.

#state_reasonTypes::StateReason

The reason for the state change.

Returns:

#tagsArray<Types::Tag>

Any tags assigned to the image.

Returns:

  • (Array<Types::Tag>)

    Any tags assigned to the image.

#virtualization_typeString

The type of virtualization of the AMI.

Possible values:

  • hvm
  • paravirtual

Returns:

  • (String)

    The type of virtualization of the AMI.