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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#architecture ⇒ String

The architecture of the image.

Possible values:

  • i386
  • x86_64
  • arm64

Returns:

  • (String) —

    The architecture of the image.

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

Any block device mapping entries.

Returns:

#creation_date ⇒ String

The date and time the image was created.

Returns:

  • (String) —

    The date and time the image was created.

#description ⇒ String

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_support ⇒ Boolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean) —

    Specifies whether enhanced networking with ENA is enabled.

#hypervisor ⇒ String

The hypervisor type of the image.

Possible values:

  • ovm
  • xen

Returns:

  • (String) —

    The hypervisor type of the image.

#image_id ⇒ String

The ID of the AMI.

Returns:

  • (String) —

    The ID of the AMI.

#image_location ⇒ String

The location of the AMI.

Returns:

  • (String) —

    The location of the AMI.

#image_owner_alias ⇒ String

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_type ⇒ String

The type of image.

Possible values:

  • machine
  • kernel
  • ramdisk

Returns:

  • (String) —

    The type of image.

#kernel_id ⇒ String

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

Returns:

  • (String) —

    The kernel associated with the image, if any.

#name ⇒ String

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_id ⇒ String

The AWS account ID of the image owner.

Returns:

  • (String) —

    The AWS account ID of the image owner.

#platform ⇒ String

This value is set to windows for Windows AMIs; otherwise, it is blank.

Possible values:

  • Windows

Returns:

  • (String) —

    This value is set to windows for Windows AMIs; otherwise, it is blank.

#platform_details ⇒ String

The platform details associated with the billing code of the AMI. For more information, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String) —

    The platform details associated with the billing code of the AMI.

#product_codes ⇒ Array<Types::ProductCode>

Any product codes associated with the AMI.

Returns:

#public ⇒ Boolean

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_id ⇒ String

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_name ⇒ String

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_type ⇒ String

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_support ⇒ String

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.

#state ⇒ String

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_reason ⇒ Types::StateReason

The reason for the state change.

Returns:

#tags ⇒ Array<Types::Tag>

Any tags assigned to the image.

Returns:

  • (Array<Types::Tag>) —

    Any tags assigned to the image.

#usage_operation ⇒ String

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your AWS Cost and Usage Report and in the AWS Price List API. For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String) —

    The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.

#virtualization_type ⇒ String

The type of virtualization of the AMI.

Possible values:

  • hvm
  • paravirtual

Returns:

  • (String) —

    The type of virtualization of the AMI.