class AWS::EC2::Image

Represents an Amazon Machine Image (AMI).

@attr_reader [String] name The name of the AMI that was provided

during image creation.

@attr [String] description A description of the image.

@attr_reader [String] location The location of the AMI.

@attr_reader [Symbol] state Current state of the AMI. If the

state is +:available+, the image is successfully registered
and available for launching.  Valid values:
* +:available+
* +:pending+
* +:failed+

@attr_reader [String] owner_id The AWS account ID of the image owner.

@attr_reader [String] owner_alias The AWS account alias (e.g.,

+"amazon"+) or AWS account ID that owns the AMI.

@attr_reader [Symbol] architecture The architecture of the

image (e.g. +:i386+).

@attr_reader [Symbol] type The type of image. Valid values are:

* +:machine+
* +:kernel+
* +:ramdisk+

@attr_reader [String] kernel_id The kernel ID associated with

the image, if any. Only applicable for machine images.

@attr_reader [String] ramdisk_id The RAM disk ID associated

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

@attr_reader [String] platform Value is windows for Windows

AMIs; otherwise blank.

@attr_reader [Object] state_reason The reason for the image’s

most recent state change.  The return value is an object with
the following methods:

[code] Reason code for the state change.

[message] A textual description of the state change.

@attr_reader [Symbol] root_device_type The root device type

used by the AMI. Possible values:
* +:ebs+
* +:instance_store+

@attr_reader [String] root_device_name The root device name

(e.g., +"/dev/sda1"+, or +"xvda"+).

@attr_reader [Symbol] virtualization_type The type of

virtualization of the AMI.  Possible values:
* +:paravirtual+
* +:hvm+

@attr_reader [Symbol] hypervisor The image’s hypervisor type.

Possible values are:
* +:ovm+
* +:xen+

@attr_reader [Array<String>] product_codes Returns an array of

product codes attached to this instance.

Attributes

id[R]

@return [String] The ID of the AMI.

Public Class Methods

new(id, options = {}) click to toggle source

@private

# File lib/aws/ec2/image.rb, line 90
def initialize id, options = {}
  @id = id
  super
end

Public Instance Methods

__permissions_attribute__() click to toggle source

@private

# File lib/aws/ec2/image.rb, line 244
def __permissions_attribute__
  "launchPermission"
end

add_product_codes(*product_codes) click to toggle source

Adds one or more product codes:

image.add_product_codes 'ABCXYZ', 'MNOPQR'

You can also pass an array of product codes:

image.add_product_codes ['ABCXYZ', 'MNOPQR']

@param [Array<String>] product_codes @return [nil]

# File lib/aws/ec2/image.rb, line 235
def add_product_codes *product_codes
  opts = {}
  opts[:image_id] = self.id
  opts[:product_codes] = product_codes.flatten
  client.modify_image_attribute(opts)
  nil
end

block_device_mappings() click to toggle source

@return [Hash] Returns a hash of block

device mappings for the image.  In each entry, the key is
the device name (e.g. +"/dev/sda1"+) and the value is an
object with the following methods that return information
about the block device:

[snapshot_id] The ID of the snapshot that will be used to
              create this device (may be nil).

[volume_size] The size of the volume, in GiBs.

[delete_on_termination] True if the Amazon EBS volume is
                        deleted on instance termination.

# File lib/aws/ec2/image.rb, line 158
def block_device_mappings
  (block_device_mapping || []).inject({}) do |h,mapping|
    h[mapping.device_name] = mapping.ebs
    h
  end
end

delete() click to toggle source

Alias for: deregister

deregister() click to toggle source

Deregisters this AMI. Once deregistered, the AMI cannot be used to launch new instances. @return [nil]

# File lib/aws/ec2/image.rb, line 168
def deregister
  client.deregister_image(:image_id => id)
  nil
end

Also aliased as: delete

exists?() click to toggle source

@return [Boolean] Returns true if the AMI exists (is returned by

the DescribeImages action).

# File lib/aws/ec2/image.rb, line 202
def exists?
  resp = client.describe_images(:filters => [
    { :name => "image-id", :values => [id] }
  ])
  !resp.images_set.empty?
end

kernel() click to toggle source

@return [Image] The kernel associated with the image, if

any. Only applicable for machine images.

# File lib/aws/ec2/image.rb, line 211
def kernel
  if id = kernel_id
    Image.new(id, :config => config)
  end
end

ramdisk() click to toggle source

@return [Image] The RAM disk associated with the image, if

any. Only applicable for machine images.

# File lib/aws/ec2/image.rb, line 219
def ramdisk
  if id = ramdisk_id
    Image.new(id, :config => config)
  end
end

run_instance(options = {}) click to toggle source

Runs a single instance of this image.

@param [Hash] options @option (see AWS::EC2::InstanceCollection#create) @return (see AWS::EC2::InstanceCollection#create)

# File lib/aws/ec2/image.rb, line 180
def run_instance options = {}
  instances = InstanceCollection.new(:config => config)
  instances.create(options.merge(:image => self))
end

run_instances(count, options = {}) click to toggle source

Runs multiple instances of this image.

@param [Integer] count How many instances to request. You can specify

this either as an integer or as a Range, to indicate the
minimum and maximum number of instances to run.  Note that
for a new account you can request at most 20 instances at
a time.

@param [Hash] options @option (see AWS::EC2::InstanceCollection#create) @return [Array<Instance>] An array containing an {Instance} object for

each instance that was run.

# File lib/aws/ec2/image.rb, line 196
def run_instances count, options = {}
  run_instance(options.merge(:count => count))
end