grempe-amazon-ec2 0.2.9

data/lib/EC2/console.rb

@@ -0,0 +1,44 @@
+#--
+# Amazon Web Services EC2 Query API Ruby library
+#
+# Ruby Gem Name::  amazon-ec2
+# Author::    Glenn Rempe  (mailto:grempe@rubyforge.org)
+# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
+# License::   Distributes under the same terms as Ruby
+# Home::      http://amazon-ec2.rubyforge.org
+#++
+
+module EC2
+
+  class Base
+
+    #Amazon Developer Guide Docs:
+    #
+    # The GetConsoleOutput operation retrieves console output that has been posted for the specified instance.
+    #
+    # Instance console output is buffered and posted shortly after instance boot, reboot and once the instance
+    # is terminated. Only the most recent 64 KB of posted output is available. Console output is available for
+    # at least 1 hour after the most recent post.
+    #
+    #Required Arguments:
+    #
+    # :instance_id => String (default : "")
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def get_console_output( options ={} )
+
+      options = {:instance_id => ""}.merge(options)
+
+      raise ArgumentError, "No instance ID provided" if options[:instance_id].nil? || options[:instance_id].empty?
+
+      params = { "InstanceId" => options[:instance_id] }
+
+      return response_generator(:action => "GetConsoleOutput", :params => params)
+
+    end
+  end
+
+end

data/lib/EC2/elastic_ips.rb

@@ -0,0 +1,153 @@
+#--
+# Amazon Web Services EC2 Query API Ruby library
+#
+# Ruby Gem Name::  amazon-ec2
+# Author::    Glenn Rempe  (mailto:grempe@rubyforge.org)
+# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
+# License::   Distributes under the same terms as Ruby
+# Home::      http://amazon-ec2.rubyforge.org
+#++
+
+module EC2
+
+  class Base
+
+
+    #Amazon Developer Guide Docs:
+    #
+    # The AllocateAddress operation acquires an elastic IP address for use with your account.
+    #
+    #Required Arguments:
+    #
+    # none
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def allocate_address
+
+      return response_generator(:action => "AllocateAddress")
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The DescribeAddresses operation lists elastic IP addresses assigned to your account.
+    #
+    #Required Arguments:
+    #
+    # :public_ip => Array (default : [], can be empty)
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def describe_addresses( options = {} )
+
+      options = { :public_ip => [] }.merge(options)
+
+      params = pathlist("PublicIp", options[:public_ip])
+
+      return response_generator(:action => "DescribeAddresses", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The ReleaseAddress operation releases an elastic IP address associated with your account.
+    #
+    # If you run this operation on an elastic IP address that is already released, the address
+    # might be assigned to another account which will cause Amazon EC2 to return an error.
+    #
+    # Note : Releasing an IP address automatically disassociates it from any instance
+    # with which it is associated. For more information, see DisassociateAddress.
+    #
+    # Important! After releasing an elastic IP address, it is released to the IP
+    # address pool and might no longer be available to your account. Make sure
+    # to update your DNS records and any servers or devices that communicate
+    # with the address.
+    #
+    #Required Arguments:
+    #
+    # :public_ip => String (default : '')
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def release_address( options = {} )
+
+      options = { :public_ip => '' }.merge(options)
+
+      raise ArgumentError, "No ':public_ip' provided" if options[:public_ip].nil? || options[:public_ip].empty?
+
+      params = { "PublicIp" => options[:public_ip] }
+
+      return response_generator(:action => "ReleaseAddress", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The AssociateAddress operation associates an elastic IP address with an instance.
+    #
+    # If the IP address is currently assigned to another instance, the IP address
+    # is assigned to the new instance. This is an idempotent operation. If you enter
+    # it more than once, Amazon EC2 does not return an error.
+    #
+    #Required Arguments:
+    #
+    # :instance_id  => String (default : '')
+    # :public_ip    => String (default : '')
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def associate_address( options = {} )
+
+      options = { :instance_id => '', :public_ip => '' }.merge(options)
+
+      raise ArgumentError, "No ':instance_id' provided" if options[:instance_id].nil? || options[:instance_id].empty?
+      raise ArgumentError, "No ':public_ip' provided" if options[:public_ip].nil? || options[:public_ip].empty?
+
+      params = {
+        "InstanceId" => options[:instance_id],
+        "PublicIp" => options[:public_ip]
+      }
+
+      return response_generator(:action => "AssociateAddress", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The DisassociateAddress operation disassociates the specified elastic IP
+    # address from the instance to which it is assigned. This is an idempotent
+    # operation. If you enter it more than once, Amazon EC2 does not return
+    # an error.
+    #
+    #Required Arguments:
+    #
+    # :public_ip    => String (default : '')
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def disassociate_address( options = {} )
+
+      options = { :public_ip => '' }.merge(options)
+
+      raise ArgumentError, "No ':public_ip' provided" if options[:public_ip].nil? || options[:public_ip].empty?
+
+      params = { "PublicIp" => options[:public_ip] }
+
+      return response_generator(:action => "DisassociateAddress", :params => params)
+
+    end
+
+  end
+
+end

data/lib/EC2/exceptions.rb

@@ -0,0 +1,136 @@
+#--
+# Amazon Web Services EC2 Query API Ruby library
+#
+# Ruby Gem Name::  amazon-ec2
+# Author::    Glenn Rempe  (mailto:grempe@rubyforge.org)
+# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
+# License::   Distributes under the same terms as Ruby
+# Home::      http://amazon-ec2.rubyforge.org
+#++
+
+module EC2
+
+  # OUR CUSTOM ERROR CODES
+
+  # All of our errors are superclassed by Error < RuntimeError
+  class Error < RuntimeError #:nodoc:
+  end
+
+  # A client side only argument error
+  class ArgumentError < Error #:nodoc:
+  end
+
+
+  # AWS EC2 CLIENT ERROR CODES
+
+  # AWS EC2 can throw error exceptions that contain a '.' in them.
+  # since we can't name an exception class with that '.' I compressed
+  # each class name into the non-dot version.  This allows us to retain
+  # the granularity of the exception.
+
+  # User not authorized.
+  class AuthFailure < Error #:nodoc:
+  end
+
+  # Specified AMI has an unparsable manifest.
+  class InvalidManifest < Error #:nodoc:
+  end
+
+  # Specified AMI ID is not valid.
+  class InvalidAMIIDMalformed < Error #:nodoc:
+  end
+
+  # Specified AMI ID does not exist.
+  class InvalidAMIIDNotFound < Error #:nodoc:
+  end
+
+  # Specified AMI ID has been deregistered and is no longer available.
+  class InvalidAMIIDUnavailable < Error #:nodoc:
+  end
+
+  # Specified instance ID is not valid.
+  class InvalidInstanceIDMalformed < Error #:nodoc:
+  end
+
+  # Specified instance ID does not exist.
+  class InvalidInstanceIDNotFound < Error #:nodoc:
+  end
+
+  # Specified keypair name does not exist.
+  class InvalidKeyPairNotFound < Error #:nodoc:
+  end
+
+  # Attempt to create a duplicate keypair.
+  class InvalidKeyPairDuplicate < Error #:nodoc:
+  end
+
+  # Specified group name does not exist.
+  class InvalidGroupNotFound < Error #:nodoc:
+  end
+
+  # Attempt to create a duplicate group.
+  class InvalidGroupDuplicate < Error #:nodoc:
+  end
+
+  # Specified group can not be deleted because it is in use.
+  class InvalidGroupInUse < Error #:nodoc:
+  end
+
+  # Specified group name is a reserved name.
+  class InvalidGroupReserved < Error #:nodoc:
+  end
+
+  # Attempt to authorize a permission that has already been authorized.
+  class InvalidPermissionDuplicate < Error #:nodoc:
+  end
+
+  # Specified permission is invalid.
+  class InvalidPermissionMalformed < Error #:nodoc:
+  end
+
+  # Specified reservation ID is invalid.
+  class InvalidReservationIDMalformed < Error #:nodoc:
+  end
+
+  # Specified reservation ID does not exist.
+  class InvalidReservationIDNotFound < Error #:nodoc:
+  end
+
+  # User has reached max allowed concurrent running instances.
+  class InstanceLimitExceeded < Error #:nodoc:
+  end
+
+  # An invalid set of parameters were passed as arguments
+  # e.g. RunInstances was called with minCount and maxCount set to 0 or minCount > maxCount.
+  class InvalidParameterCombination < Error #:nodoc:
+  end
+
+  # An unknown parameter was passed as an argument
+  class UnknownParameter < Error #:nodoc:
+  end
+
+  # The user ID is neither in the form of an AWS account ID or one
+  # of the special values accepted by the owner or executableBy flags
+  # in the DescribeImages call.
+  class InvalidUserIDMalformed < Error #:nodoc:
+  end
+
+  # The value of an item added to, or removed from, an image attribute is invalid.
+  class InvalidAMIAttributeItemValue < Error #:nodoc:
+  end
+
+  # AWS EC2 SERVER ERROR CODES
+
+  # Internal AWS EC2 Error.
+  class InternalError < Error #:nodoc:
+  end
+
+  # There are not enough available instances to satify your minimum request.
+  class InsufficientInstanceCapacity < Error #:nodoc:
+  end
+
+  # The server is overloaded and cannot handle request.
+  class Unavailable < Error #:nodoc:
+  end
+
+end

data/lib/EC2/image_attributes.rb

@@ -0,0 +1,166 @@
+#--
+# Amazon Web Services EC2 Query API Ruby library
+#
+# Ruby Gem Name::  amazon-ec2
+# Author::    Glenn Rempe  (mailto:grempe@rubyforge.org)
+# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
+# License::   Distributes under the same terms as Ruby
+# Home::      http://amazon-ec2.rubyforge.org
+#++
+
+module EC2
+
+  class Base
+
+    #Amazon Developer Guide Docs:
+    #
+    # The ModifyImageAttribute operation modifies an attribute of an AMI.  The following attributes may
+    # currently be modified:
+    #
+    # 'launchPermission' : Controls who has permission to launch the AMI. Launch permissions can be
+    # granted to specific users by adding userIds. The AMI can be made public by adding the 'all' group.
+    #
+    # 'productCodes' : Associates product codes with AMIs. This allows a developer to charge a user extra
+    # for using the AMIs. productCodes is a write once attribute - once it has been set it can not be
+    # changed or removed.  Currently only one product code is supported per AMI.
+    #
+    #Required Arguments:
+    #
+    # :image_id => String (default : "")
+    # :attribute => String ('launchPermission' or 'productCodes', default : "launchPermission")
+    # :operation_type => String (default : "")
+    #
+    #Optional Arguments:
+    #
+    # :user_id => Array (default : [])
+    # :group => Array (default : [])
+    # :product_code => Array (default : [])
+    #
+    def modify_image_attribute( options = {} )
+
+      # defaults
+      options = { :image_id => "",
+                  :attribute => "launchPermission",
+                  :operation_type => "",
+                  :user_id => [],
+                  :group => [],
+                  :product_code => [] }.merge(options)
+
+      raise ArgumentError, "No ':image_id' provided" if options[:image_id].nil? || options[:image_id].empty?
+      raise ArgumentError, "No ':attribute' provided" if options[:attribute].nil? || options[:attribute].empty?
+
+      # OperationType is not required if modifying a product code.
+      unless options[:attribute] == 'productCodes'
+        raise ArgumentError, "No ':operation_type' provided" if options[:operation_type].nil? || options[:operation_type].empty?
+      end
+
+      params = {
+        "ImageId" => options[:image_id],
+        "Attribute" => options[:attribute],
+        "OperationType" => options[:operation_type]
+      }
+
+      # test options provided and make sure they are valid
+      case options[:attribute]
+      when "launchPermission"
+
+        unless options[:operation_type] == "add" || options[:operation_type] == "remove"
+          raise ArgumentError, ":operation_type was #{options[:operation_type].to_s} but must be either 'add' or 'remove'"
+        end
+
+        if (options[:user_id].nil? || options[:user_id].empty?) && (options[:group].nil? || options[:group].empty?)
+          raise ArgumentError, "Option :attribute=>'launchPermission' requires ':user_id' or ':group' options to also be specified"
+        end
+        params.merge!(pathlist("UserId", options[:user_id])) unless options[:user_id].nil?
+        params.merge!(pathlist("Group", options[:group])) unless options[:group].nil?
+      when "productCodes"
+        if (options[:product_code].nil? || options[:product_code].empty?)
+          raise ArgumentError, "Option :attribute=>'productCodes' requires ':product_code' to be specified"
+        end
+        params.merge!(pathlist("ProductCode", options[:product_code])) unless options[:product_code].nil?
+      else
+        raise ArgumentError, "attribute : #{options[:attribute].to_s} is not an known attribute."
+      end
+
+      return response_generator(:action => "ModifyImageAttribute", :params => params)
+
+    end
+
+    #Amazon Developer Guide Docs:
+    #
+    # The DescribeImageAttribute operation returns information about an attribute of an AMI.
+    #
+    #Required Arguments:
+    #
+    # :image_id => String (default : "")
+    # :attribute => String ("launchPermission" or "productCodes", default : "launchPermission")
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def describe_image_attribute( options = {} )
+
+      # defaults
+      options = {:image_id => "",
+                 :attribute => "launchPermission"
+                 }.merge(options)
+
+      raise ArgumentError, "No ':image_id' provided" if options[:image_id].nil? || options[:image_id].empty?
+      raise ArgumentError, "No ':attribute' provided" if options[:attribute].nil? || options[:attribute].empty?
+
+      params = { "ImageId" => options[:image_id], "Attribute" => options[:attribute] }
+
+      # test options provided and make sure they are valid
+      case options[:attribute]
+      when "launchPermission", "productCodes"
+        # these args are ok
+      else
+        raise ArgumentError, "attribute : #{options[:attribute].to_s} is not an known attribute."
+      end
+
+      return response_generator(:action => "DescribeImageAttribute", :params => params)
+
+    end
+
+
+    #Amazon Developer Guide Docs:
+    #
+    # The ResetImageAttribute operation resets an attribute of an AMI to its default value.
+    #
+    #Required Arguments:
+    #
+    # :image_id => String (default : "")
+    # :attribute => String (default : "launchPermission")
+    #
+    #Optional Arguments:
+    #
+    # none
+    #
+    def reset_image_attribute( options = {} )
+
+      # defaults
+      options = {:image_id => "",
+                 :attribute => "launchPermission"}.merge(options)
+
+      raise ArgumentError, "No ':image_id' provided" if options[:image_id].nil? || options[:image_id].empty?
+      raise ArgumentError, "No ':attribute' provided" if options[:attribute].nil? || options[:attribute].empty?
+
+      params = {"ImageId" => options[:image_id],
+                "Attribute" => options[:attribute] }
+
+      # test options provided and make sure they are valid
+      case options[:attribute]
+      when "launchPermission"
+        # these args are ok
+      else
+        raise ArgumentError, "attribute : #{options[:attribute].to_s} is not an known attribute."
+      end
+
+      return response_generator(:action => "ResetImageAttribute", :params => params)
+
+    end
+
+  end
+
+end