grempe-amazon-ec2 0.4.8 → 0.5.0

data/lib/EC2/instances.rb

@@ -1,216 +0,0 @@
-#--
-# Amazon Web Services EC2 Query API Ruby library
-#
-# Ruby Gem Name::  amazon-ec2
-# Author::    Glenn Rempe  (mailto:glenn@rempe.us)
-# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
-# License::   Distributes under the same terms as Ruby
-# Home::      http://github.com/grempe/amazon-ec2/tree/master
-#++
-
-module EC2
-
-  class Base
-
-    #Amazon Developer Guide Docs:
-    #
-    # The RunInstances operation launches a specified number of instances.
-    #
-    # Note : The Query version of RunInstances only allows instances of a single AMI to be launched in
-    # one call. This is different from the SOAP API call of the same name but similar to the
-    # ec2-run-instances command line tool.
-    #
-    # If Amazon EC2 cannot launch the minimum number AMIs you request, no instances launch. If there
-    # is insufficient capacity to launch the maximum number of AMIs you request, Amazon EC2 launches
-    # as many as possible to satisfy the requested maximum values.
-    #
-    # Every instance is launched in a security group. If you do not specify a security group at
-    # launch, the instances start in the default security group.
-    #
-    # An optional instance type can be specified.  Currently supported types are 'm1.small', 'm1.large',
-    # 'm1.xlarge' and the high CPU types 'c1.medium' and 'c1.xlarge'.  'm1.small' is the default
-    # if no instance_type is specified.
-    #
-    # You can provide an optional key pair ID for each image in the launch request. All instances
-    # that are created from images that use this key pair will have access to the associated public
-    # key at boot. You can use this key to provide secure access to an instance of an image on a
-    # per-instance basis. Amazon EC2  public images use this feature to provide secure access
-    # without passwords.
-    #
-    # Important!  Launching public images without a key pair ID will leave them inaccessible.
-    #
-    # The public key material is made available to the instance at boot time by placing it in a file named
-    # openssh_id.pub on a logical device that is exposed to the instance as /dev/sda2 (the ephemeral
-    # store). The format of this file is suitable for use as an entry within ~/.ssh/authorized_keys (the
-    # OpenSSH format). This can be done at boot time (as part of rclocal, for example) allowing for secure
-    # password-less access.
-    #
-    # Optional user data can be provided in the launch request. All instances comprising the launch
-    # request have access to this data (see Instance Metadata for details).
-    #
-    # If any of the AMIs have product codes attached for which the user has not subscribed,
-    # the RunInstances call will fail.
-    #
-    #Required Arguments:
-    #
-    # :image_id => String (Default : "")
-    # :min_count => Integer (default : 1 )
-    # :max_count => Integer (default : 1 )
-    #
-    #Optional Arguments:
-    #
-    # :key_name => String (default : nil)
-    # :group_id => Array (default : [])
-    # :user_data => String (default : nil)
-    # :addressing_type => String (default : "public")
-    # :instance_type => String (default : "m1.small")
-    # :kernel_id => String (default : nil)
-    # :availability_zone => String (default : nil)
-    # :base64_encoded => Boolean (default : false)
-    #
-    def run_instances( options = {} )
-
-      options = { :image_id => "",
-                  :min_count => 1,
-                  :max_count => 1,
-                  :key_name => nil,
-                  :group_id => [],
-                  :user_data => nil,
-                  :addressing_type => "public",
-                  :instance_type => "m1.small",
-                  :kernel_id => nil,
-                  :availability_zone => nil,
-                  :base64_encoded => false }.merge(options)
-
-      # Do some validation on the arguments provided
-      raise ArgumentError, ":image_id must be provided" if options[:image_id].nil? || options[:image_id].empty?
-      raise ArgumentError, ":min_count is not valid" unless options[:min_count].to_i > 0
-      raise ArgumentError, ":max_count is not valid" unless options[:max_count].to_i > 0
-      raise ArgumentError, ":addressing_type must be 'direct' or 'public'" unless options[:addressing_type] == "public" || options[:addressing_type] == "direct"
-      raise ArgumentError, ":instance_type must be 'm1.small', 'm1.large', 'm1.xlarge', 'c1.medium', or 'c1.xlarge'" unless options[:instance_type] == "m1.small" || options[:instance_type] == "m1.large" || options[:instance_type] == "m1.xlarge" || options[:instance_type] == "c1.medium" || options[:instance_type] == "c1.xlarge"
-      raise ArgumentError, ":base64_encoded must be 'true' or 'false'" unless options[:base64_encoded] == true || options[:base64_encoded] == false
-
-      user_data = extract_user_data(options)
-
-      params = {
-        "ImageId"  => options[:image_id],
-        "MinCount" => options[:min_count].to_s,
-        "MaxCount" => options[:max_count].to_s,
-      }.merge(pathlist("SecurityGroup", options[:group_id]))
-
-      params["KeyName"] = options[:key_name] unless options[:key_name].nil?
-      params["UserData"] = user_data unless user_data.nil?
-      params["AddressingType"] = options[:addressing_type]
-      params["InstanceType"] = options[:instance_type]
-      params["KernelId"] = options[:kernel_id] unless options[:kernel_id].nil?
-      params["Placement.AvailabilityZone"] = options[:availability_zone] unless options[:availability_zone].nil?
-
-      return response_generator(:action => "RunInstances", :params => params)
-
-    end
-    
-    # If :user_data is passed in then URL escape and Base64 encode it
-    # as needed.  Need for URL Escape + Base64 encoding is determined
-    # by :base64_encoded param.
-    def extract_user_data(options)
-      return unless options[:user_data]
-      if options[:user_data]
-        if options[:base64_encoded]
-          Base64.encode64(options[:user_data]).gsub(/\n/,"").strip()
-        else
-          options[:user_data]
-        end
-      end
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The DescribeInstances operation returns information about instances owned by the user
-    # making the request.
-    #
-    # An optional list of instance IDs may be provided to request information for those instances only. If no
-    # instance IDs are provided, information of all relevant instances information will be returned. If an
-    # instance is specified that does not exist a fault is returned. If an instance is specified that exists but is not
-    # owned by the user making the request, then that instance will not be included in the returned results.
-    #
-    # Recently terminated instances will be included in the returned results for a small interval subsequent to
-    # their termination. This interval is typically of the order of one hour
-    #
-    #Required Arguments:
-    #
-    # none
-    #
-    #Optional Arguments:
-    #
-    # :instance_id => Array (default : [])
-    #
-    def describe_instances( options = {} )
-
-      options = { :instance_id => [] }.merge(options)
-
-      params = pathlist("InstanceId", options[:instance_id])
-
-      return response_generator(:action => "DescribeInstances", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The RebootInstances operation requests a reboot of one or more instances. This operation is
-    # asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed
-    # provided the instances are valid and belong to the user. Terminated instances will be ignored.
-    #
-    #Required Arguments:
-    #
-    # :instance_id => Array (default : [])
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def reboot_instances( options = {} )
-
-      # defaults
-      options = { :instance_id => [] }.merge(options)
-
-      raise ArgumentError, "No instance IDs provided" if options[:instance_id].nil? || options[:instance_id].empty?
-
-      params = pathlist("InstanceId", options[:instance_id])
-
-      return response_generator(:action => "RebootInstances", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The TerminateInstances operation shuts down one or more instances. This operation is idempotent
-    # and terminating an instance that is in the process of shutting down (or already terminated) will succeed.
-    # Terminated instances remain visible for a short period of time (approximately one hour) after
-    # termination, after which their instance ID is invalidated.
-    #
-    #Required Arguments:
-    #
-    # :instance_id => Array (default : [])
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def terminate_instances( options = {} )
-
-      options = { :instance_id => [] }.merge(options)
-
-      raise ArgumentError, "No :instance_id provided" if options[:instance_id].nil? || options[:instance_id].empty?
-
-      params = pathlist("InstanceId", options[:instance_id])
-
-      return response_generator(:action => "TerminateInstances", :params => params)
-
-    end
-
-  end
-
-end

data/lib/EC2/keypairs.rb

@@ -1,94 +0,0 @@
-#--
-# Amazon Web Services EC2 Query API Ruby library
-#
-# Ruby Gem Name::  amazon-ec2
-# Author::    Glenn Rempe  (mailto:glenn@rempe.us)
-# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
-# License::   Distributes under the same terms as Ruby
-# Home::      http://github.com/grempe/amazon-ec2/tree/master
-#++
-
-module EC2
-
-  class Base
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The CreateKeyPair operation creates a new 2048 bit RSA keypair and returns a unique ID that can be
-    # used to reference this keypair when launching new instances.
-    #
-    #Required Arguments:
-    #
-    # :key_name => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def create_keypair( options = {} )
-
-      # defaults
-      options = { :key_name => "" }.merge(options)
-
-      raise ArgumentError, "No :key_name provided" if options[:key_name].nil? || options[:key_name].empty?
-
-      params = { "KeyName" => options[:key_name] }
-
-      return response_generator(:action => "CreateKeyPair", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The DescribeKeyPairs operation returns information about keypairs available for use by the user
-    # making the request. Selected keypairs may be specified or the list may be left empty if information for
-    # all registered keypairs is required.
-    #
-    #Required Arguments:
-    #
-    # :key_name => Array (default : [])
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def describe_keypairs( options = {} )
-
-      options = { :key_name => [] }.merge(options)
-
-      params = pathlist("KeyName", options[:key_name] )
-
-      return response_generator(:action => "DescribeKeyPairs", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The DeleteKeyPair operation deletes a keypair.
-    #
-    #Required Arguments:
-    #
-    # :key_name => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def delete_keypair( options = {} )
-
-      options = { :key_name => "" }.merge(options)
-
-      raise ArgumentError, "No :key_name provided" if options[:key_name].nil? || options[:key_name].empty?
-
-      params = { "KeyName" => options[:key_name] }
-
-      return response_generator(:action => "DeleteKeyPair", :params => params)
-
-    end
-
-  end
-
-end

data/lib/EC2/products.rb

@@ -1,43 +0,0 @@
-#--
-# Amazon Web Services EC2 Query API Ruby library
-#
-# Ruby Gem Name::  amazon-ec2
-# Author::    Glenn Rempe  (mailto:glenn@rempe.us)
-# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
-# License::   Distributes under the same terms as Ruby
-# Home::      http://github.com/grempe/amazon-ec2/tree/master
-#++
-
-module EC2
-
-  class Base
-
-    #Amazon Developer Guide Docs:
-    #
-    # The ConfirmProductInstance operation returns true if the given product code is attached to the instance
-    # with the given instance id. False is returned if the product code is not attached to the instance.
-    #
-    #Required Arguments:
-    #
-    # :product_code => String (default : "")
-    # :instance_id => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def confirm_product_instance( options ={} )
-
-      options = {:product_code => "", :instance_id => ""}.merge(options)
-
-      raise ArgumentError, "No product code provided" if options[:product_code].nil? || options[:product_code].empty?
-      raise ArgumentError, "No instance ID provided" if options[:instance_id].nil? || options[:instance_id].empty?
-
-      params = { "ProductCode" => options[:product_code], "InstanceId" => options[:instance_id] }
-
-      return response_generator(:action => "ConfirmProductInstance", :params => params)
-
-    end
-  end
-
-end

data/lib/EC2/security_groups.rb

@@ -1,232 +0,0 @@
-#--
-# Amazon Web Services EC2 Query API Ruby library
-#
-# Ruby Gem Name::  amazon-ec2
-# Author::    Glenn Rempe  (mailto:glenn@rempe.us)
-# Copyright:: Copyright (c) 2007-2008 Glenn Rempe
-# License::   Distributes under the same terms as Ruby
-# Home::      http://github.com/grempe/amazon-ec2/tree/master
-#++
-
-module EC2
-
-  class Base
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The CreateSecurityGroup operation creates a new security group. Every instance is launched
-    # in a security group. If none is specified as part of the launch request then instances
-    # are launched in the default security group. Instances within the same security group have
-    # unrestricted network access to one another. Instances will reject network access attempts from other
-    # instances in a different security group. As the owner of instances you may grant or revoke specific
-    # permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations.
-    #
-    #Required Arguments:
-    #
-    # :group_name => String (default : "")
-    # :group_description => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def create_security_group( options = {} )
-
-      options = {:group_name => "",
-                 :group_description => ""
-                 }.merge(options)
-
-      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
-      raise ArgumentError, "No :group_description provided" if options[:group_description].nil? || options[:group_description].empty?
-
-      params = {
-        "GroupName" => options[:group_name],
-        "GroupDescription" => options[:group_description]
-      }
-
-      return response_generator(:action => "CreateSecurityGroup", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The DescribeSecurityGroups operation returns information about security groups owned by the
-    # user making the request.
-    #
-    # An optional list of security group names may be provided to request information for those security
-    # groups only. If no security group names are provided, information of all security groups will be
-    # returned. If a group is specified that does not exist a fault is returned.
-    #
-    #Required Arguments:
-    #
-    # none
-    #
-    #Optional Arguments:
-    #
-    # :group_name => Array (default : [])
-    #
-    def describe_security_groups( options = {} )
-
-      options = { :group_name => [] }.merge(options)
-
-      params = pathlist("GroupName", options[:group_name] )
-
-      return response_generator(:action => "DescribeSecurityGroups", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The DeleteSecurityGroup operation deletes a security group.
-    #
-    # If an attempt is made to delete a security group and any instances exist that are members of that group a
-    # fault is returned.
-    #
-    #Required Arguments:
-    #
-    # :group_name => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # none
-    #
-    def delete_security_group( options = {} )
-
-      options = { :group_name => "" }.merge(options)
-
-      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
-
-      params = { "GroupName" => options[:group_name] }
-
-      return response_generator(:action => "DeleteSecurityGroup", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The AuthorizeSecurityGroupIngress operation adds permissions to a security group.
-    #
-    # Permissions are specified in terms of the IP protocol (TCP, UDP or ICMP), the source of the request (by
-    # IP range or an Amazon EC2 user-group pair), source and destination port ranges (for TCP and UDP),
-    # and ICMP codes and types (for ICMP). When authorizing ICMP, -1 may be used as a wildcard in the
-    # type and code fields.
-    #
-    # Permission changes are propagated to instances within the security group being modified as quickly as
-    # possible. However, a small delay is likely, depending on the number of instances that are members of
-    # the indicated group.
-    #
-    # When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and
-    # SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission,
-    # GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified. Mixing these two types
-    # of parameters is not allowed.
-    #
-    #Required Arguments:
-    #
-    # :group_name => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # :ip_protocol => String (default : nil) : Required when authorizing CIDR IP permission
-    # :from_port => Integer (default : nil) : Required when authorizing CIDR IP permission
-    # :to_port => Integer (default : nil) : Required when authorizing CIDR IP permission
-    # :cidr_ip => String (default : nil): Required when authorizing CIDR IP permission
-    # :source_security_group_name => String (default : nil) : Required when authorizing user group pair permissions
-    # :source_security_group_owner_id => String (default : nil) : Required when authorizing user group pair permissions
-    #
-    def authorize_security_group_ingress( options = {} )
-
-      # defaults
-      options = { :group_name => nil,
-                  :ip_protocol => nil,
-                  :from_port => nil,
-                  :to_port => nil,
-                  :cidr_ip => nil,
-                  :source_security_group_name => nil,
-                  :source_security_group_owner_id => nil }.merge(options)
-
-      # lets not validate the rest of the possible permutations of required params and instead let
-      # EC2 sort it out on the server side.  We'll only require :group_name as that is always needed.
-      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
-
-      params = { "GroupName" => options[:group_name],
-                 "IpProtocol" => options[:ip_protocol],
-                 "FromPort" => options[:from_port].to_s,
-                 "ToPort" => options[:to_port].to_s,
-                 "CidrIp" => options[:cidr_ip],
-                 "SourceSecurityGroupName" => options[:source_security_group_name],
-                 "SourceSecurityGroupOwnerId" => options[:source_security_group_owner_id]
-                 }
-
-      return response_generator(:action => "AuthorizeSecurityGroupIngress", :params => params)
-
-    end
-
-
-    #Amazon Developer Guide Docs:
-    #
-    # The RevokeSecurityGroupIngress operation revokes existing permissions that were previously
-    # granted to a security group. The permissions to revoke must be specified using the same values
-    # originally used to grant the permission.
-    #
-    # Permissions are specified in terms of the IP protocol (TCP, UDP or ICMP), the source of the request (by
-    # IP range or an Amazon EC2 user-group pair), source and destination port ranges (for TCP and UDP),
-    # and ICMP codes and types (for ICMP). When authorizing ICMP, -1 may be used as a wildcard in the
-    # type and code fields.
-    #
-    # Permission changes are propagated to instances within the security group being modified as quickly as
-    # possible. However, a small delay is likely, depending on the number of instances that are members of
-    # the indicated group.
-    #
-    # When revoking a user/group pair permission, GroupName, SourceSecurityGroupName and
-    # SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission,
-    # GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified. Mixing these two types
-    # of parameters is not allowed.
-    #
-    #Required Arguments:
-    #
-    # :group_name => String (default : "")
-    #
-    #Optional Arguments:
-    #
-    # :ip_protocol => String (default : nil) : Required when revoking CIDR IP permission
-    # :from_port => Integer (default : nil) : Required when revoking CIDR IP permission
-    # :to_port => Integer (default : nil) : Required when revoking CIDR IP permission
-    # :cidr_ip => String (default : nil): Required when revoking CIDR IP permission
-    # :source_security_group_name => String (default : nil) : Required when revoking user group pair permissions
-    # :source_security_group_owner_id => String (default : nil) : Required when revoking user group pair permissions
-    #
-    def revoke_security_group_ingress( options = {} )
-
-      # defaults
-      options = { :group_name => nil,
-                  :ip_protocol => nil,
-                  :from_port => nil,
-                  :to_port => nil,
-                  :cidr_ip => nil,
-                  :source_security_group_name => nil,
-                  :source_security_group_owner_id => nil }.merge(options)
-
-      # lets not validate the rest of the possible permutations of required params and instead let
-      # EC2 sort it out on the server side.  We'll only require :group_name as that is always needed.
-      raise ArgumentError, "No :group_name provided" if options[:group_name].nil? || options[:group_name].empty?
-
-      params = { "GroupName" => options[:group_name],
-                 "IpProtocol" => options[:ip_protocol],
-                 "FromPort" => options[:from_port].to_s,
-                 "ToPort" => options[:to_port].to_s,
-                 "CidrIp" => options[:cidr_ip],
-                 "SourceSecurityGroupName" => options[:source_security_group_name],
-                 "SourceSecurityGroupOwnerId" => options[:source_security_group_owner_id]
-                 }
-
-      return response_generator(:action => "RevokeSecurityGroupIngress", :params => params)
-
-    end
-
-  end
-
-end