right_aws 2.0.0 → 2.1.0

data/lib/ec2/right_ec2_images.rb

@@ -35,32 +35,28 @@ module RightAws
     #     'Owner'        => ['self', ..., 'userN'],
     #     'ExecutableBy' => ['self', 'all', ..., 'userN']
     #   }
-    def ec2_describe_images(params={}, image_type=nil, cache_for=nil) #:nodoc:
+    def ec2_describe_images(params={}, options={}, cache_for=nil) #:nodoc:
       request_hash = {}
-      params.each do |list_by, list|
-        request_hash.merge! amazonize_list(list_by, Array(list))
-      end
-      request_hash['ImageType'] = image_type if image_type
+      params.each { |list_by, list| request_hash.merge! amazonize_list(list_by, Array(list)) }
+      request_hash.merge!(amazonize_list(['Filter.?.Name', 'Filter.?.Value.?'], options[:filters])) unless options[:filters].right_blank?
       link = generate_request("DescribeImages", request_hash)
       request_cache_or_info cache_for, link,  QEc2DescribeImagesParser, @@bench, cache_for
     rescue Exception
       on_exception
     end
 
-    # Retrieve a list of images. Returns array of hashes describing the images or an exception:
-    # +image_type+ = 'machine' || 'kernel' || 'ramdisk'
+    # Retrieve a list of images.
+    #
+    # Accepts a list of images and/or a set of filters as the last parameter.
+    # 
+    # Filters: architecture, block-device-mapping.delete-on-termination block-device-mapping.device-name,
+    # block-device-mapping.snapshot-id, block-device-mapping.volume-size, description, image-id, image-type,
+    # is-public, kernel-id, manifest-location, name, owner-alias, owner-id, platform, product-code,
+    # ramdisk-id, root-device-name, root-device-type, state, state-reason-code, state-reason-message,
+    # tag-key, tag-value, tag:key, virtualization-type
     #
     #  ec2.describe_images #=>
-    #    [{:aws_id=>"ami-b0a1f7a6",
-    #      :aws_image_type=>"machine",
-    #      :root_device_name=>"/dev/sda1",
-    #      :image_class=>"static",
-    #      :aws_owner=>"826693181925",
-    #      :aws_location=>"bucket_for_k_dzreyev/image_bundles/kd__CentOS_1_10_2009_10_21_13_30_43_MSD/image.manifest.xml",
-    #      :aws_state=>"available",
-    #      :aws_is_public=>false,
-    #      :aws_architecture=>"i386"},
-    #     {:description=>"EBS backed Fedora core 8 i386",
+    #    [{:description=>"EBS backed Fedora core 8 i386",
     #      :aws_architecture=>"i386",
     #      :aws_id=>"ami-c2a3f5d4",
     #      :aws_image_type=>"machine",
@@ -75,43 +71,79 @@ module RightAws
     #         :device_name=>"/dev/sda1"}],
     #      :name=>"EBS backed FC8 i386",
     #      :aws_is_public=>true}, ... ]
-    #      
-    # If +list+ param is set, then retrieve information about the listed images only:
     #
-    #  ec2.describe_images(['ami-5aa1f74c'])
+    #  ec2.describe_images(:filters => { 'image-type' => 'kernel', 'state' => 'available', 'tag:MyTag' => 'MyValue'})
+    #
+    #  ec2.describe_images("ari-fda54b94", "ami-2ee80247", "aki-00896a69",
+    #                      :filters => { 'image-type' => 'kernel', 'state' => 'available' }) #=>
+    #    [{:root_device_type=>"instance-store",
+    #      :aws_id=>"aki-00896a69",
+    #      :aws_image_type=>"kernel",
+    #      :aws_location=>
+    #       "karmic-kernel-zul/ubuntu-kernel-2.6.31-300-ec2-i386-20091002-test-04.manifest.xml",
+    #      :virtualization_type=>"paravirtual",
+    #      :aws_state=>"available",
+    #      :aws_owner=>"099720109477",
+    #      :tags=>{},
+    #      :aws_is_public=>true,
+    #      :aws_architecture=>"i386"}]
+    #
+    # P.S. filters: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-DescribeImages.html
     #
-    def describe_images(images=[], image_type=nil)
-      images = Array(images)
-      cache_for = images.empty? && !image_type ? :describe_images : nil
-      ec2_describe_images({ 'ImageId' => images }, image_type, cache_for)
+    def describe_images(*list_and_options)
+      list, options = AwsUtils::split_items_and_params(list_and_options)
+      cache_for     = (list.right_blank? && options[:filters].right_blank?) ? :describe_images : nil
+      ec2_describe_images( {'ImageId'=>list}, options, cache_for)
     end
 
-    #  Example:
+    # Retrieve a list of images by image owner.
+    #
+    # Accepts a list of images and/or a set of filters as the last parameter.
+    # 
+    # Filters: architecture, block-device-mapping.delete-on-termination block-device-mapping.device-name,
+    # block-device-mapping.snapshot-id, block-device-mapping.volume-size, description, image-id, image-type,
+    # is-public, kernel-id, manifest-location, name, owner-alias, owner-id, platform, product-code,
+    # ramdisk-id, root-device-name, root-device-type, state, state-reason-code, state-reason-message,
+    # tag-key, tag-value, tag:key, virtualization-type
     #
     #   ec2.describe_images_by_owner('522821470517')
-    #   ec2.describe_images_by_owner('self')
+    #   ec2.describe_images_by_owner('self', :filters => { 'block-device-mapping.delete-on-termination' => 'false' })
     #
-    def describe_images_by_owner(owners=['self'], image_type=nil)
-      owners = Array(owners)
-      cache_for = (owners == ['self']) && (!image_type ? :describe_images_by_owner : nil)
-      ec2_describe_images({ 'Owner' => owners }, image_type, cache_for)
+    # P.S. filters: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-DescribeImages.html
+    #
+    def describe_images_by_owner(*list_and_options)
+      list, options = AwsUtils::split_items_and_params(list_and_options)
+      list          = ['self'] if list.right_blank?
+      cache_for     = (list==['self'] && options[:filters].right_blank?) ? :describe_images_by_owner : nil
+      ec2_describe_images( {'Owner'=>list}, options, cache_for)
     end
 
-    #  Example:
+    # Retrieve a list of images by image executable by.
+    # 
+    # Accepts a list of images and/or a set of filters as the last parameter.
+    # 
+    # Filters: architecture, block-device-mapping.delete-on-termination block-device-mapping.device-name,
+    # block-device-mapping.snapshot-id, block-device-mapping.volume-size, description, image-id, image-type,
+    # is-public, kernel-id, manifest-location, name, owner-alias, owner-id, platform, product-code,
+    # ramdisk-id, root-device-name, root-device-type, state, state-reason-code, state-reason-message,
+    # tag-key, tag-value, tag:key, virtualization-type
     #
     #   ec2.describe_images_by_executable_by('522821470517')
     #   ec2.describe_images_by_executable_by('self')
-    #   ec2.describe_images_by_executable_by('all')
+    #   ec2.describe_images_by_executable_by('all', :filters => { 'architecture' => 'i386' })
+    #
+    # P.S. filters: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-DescribeImages.html
     #
-    def describe_images_by_executable_by(executable_by=['self'], image_type=nil)
-      executable_by = Array(executable_by)
-      cache_for = (executable_by==['self']) && (!image_type ? :describe_images_by_executable_by : nil)
-      ec2_describe_images({ 'ExecutableBy' => executable_by }, image_type, cache_for)
+    def describe_images_by_executable_by(*list_and_options)
+      list, options = AwsUtils::split_items_and_params(list_and_options)
+      list          = ['self'] if list.right_blank?
+      cache_for     = (list==['self'] && options[:filters].right_blank?) ? :describe_images_by_executable_by : nil
+      ec2_describe_images( {'ExecutableBy'=>list}, options, cache_for)
     end
 
-
     # Register new image at Amazon.
-    # Options: :image_location, :name, :description, :architecture, :kernel_id, :ramdisk_id, :root_device_name, :block_device_mappings.
+    # Options: :image_location, :name, :description, :architecture, :kernel_id, :ramdisk_id,
+    #          :root_device_name, :block_device_mappings, :virtualizationt_type(hvm|paravirtual)
     #
     # Returns new image id.
     #
@@ -148,6 +180,7 @@ module RightAws
       params['KernelId']       = options[:kernel_id]        if options[:kernel_id]
       params['RamdiskId']      = options[:ramdisk_id]       if options[:ramdisk_id]
       params['RootDeviceName'] = options[:root_device_name] if options[:root_device_name]
+      params['VirtualizationType'] = options[:virtualization_type] if options[:virtualization_type] 
 #      params['SnapshotId']     = options[:snapshot_id]      if options[:snapshot_id]
       params.merge!(amazonize_block_device_mappings(options[:block_device_mappings]))
       link = generate_request("RegisterImage", params)
@@ -269,8 +302,8 @@ module RightAws
     #
     def create_image(instance_aws_id, options={})
       params = { 'InstanceId' => instance_aws_id }
-      params['Name']        = options[:name]            unless options[:name].blank?
-      params['Description'] = options[:description]     unless options[:description].blank?
+      params['Name']        = options[:name]            unless options[:name].right_blank?
+      params['Description'] = options[:description]     unless options[:description].right_blank?
       params['NoReboot']    = options[:no_reboot].to_s  unless options[:no_reboot].nil?
       link = generate_request("CreateImage", params)
       request_info(link, QEc2RegisterImageParser.new(:logger => @logger))
@@ -283,10 +316,13 @@ module RightAws
     class QEc2DescribeImagesParser < RightAWSParser #:nodoc:
       def tagstart(name, attributes)
         case full_tag_name
-        when %r{/imagesSet/item$}          then @item = {}
+        when %r{/imagesSet/item$}
+          @item = { :tags => {} }
         when %r{/blockDeviceMapping/item$}
           @item[:block_device_mappings] ||= []
           @block_device_mapping = {}
+        when %r{/tagSet/item$}
+          @aws_tag = {}
         end
       end
       def tagend(name)
@@ -308,6 +344,7 @@ module RightAws
         when 'rootDeviceType'  then @item[:root_device_type]  = @text
         when 'rootDeviceName'  then @item[:root_device_name]  = @text
         when 'imageClass'      then @item[:image_class]       = @text
+        when 'virtualizationType' then @item[:virtualization_type] = @text
         else
           case full_tag_name
           when %r{/stateReason/code$}    then @item[:state_reason_code]    = @text.to_i
@@ -321,7 +358,10 @@ module RightAws
             when 'deleteOnTermination' then @block_device_mapping[:ebs_delete_on_termination]  = @text == 'true' ? true : false
             when 'item'                then @item[:block_device_mappings]                    << @block_device_mapping
             end
-          when %r{/imagesSet/item$}    then @result << @item
+          when %r{/tagSet/item/key$}   then @aws_tag[:key]               = @text
+          when %r{/tagSet/item/value$} then @aws_tag[:value]             = @text
+          when %r{/tagSet/item$}       then @item[:tags][@aws_tag[:key]] = @aws_tag[:value]
+          when %r{/imagesSet/item$}    then @result                     << @item
           end
         end
       end

data/lib/ec2/right_ec2_instances.rb

@@ -47,8 +47,18 @@ module RightAws
       on_exception
     end
 
-    # Retrieve information about EC2 instances. If +list+ is omitted then returns the
-    # list of all instances.
+    # Retrieve information about EC2 instances.
+    #
+    # Accepts a list of instances and/or a set of filters as the last parameter.
+    # 
+    # Filters: architecture, availability-zone, block-device-mapping.attach-time, block-device-mapping.delete-on-termination,
+    # block-device-mapping.device-name, block-device-mapping.status, block-device-mapping.volume-id, client-token, dns-name,
+    # group-id, image-id, instance-id, instance-lifecycle, instance-state-code, instance-state-name, instance-type, ip-address,
+    # kernel-id, key-name, launch-index, launch-time, monitoring-state, owner-id, placement-group-name, platform,
+    # private-dns-name, private-ip-address, product-code, ramdisk-id, reason, requester-id, reservation-id, root-device-name,
+    # root-device-type, spot-instance-request-id, state-reason-code, state-reason-message, subnet-id, tag-key, tag-value,
+    # tag:key, virtualization-type, vpc-id,
+    #
     #
     #  ec2.describe_instances #=>
     #    [{:private_ip_address=>"10.240.7.99",
@@ -84,14 +94,15 @@ module RightAws
     #         :ebs_volume_id=>"vol-f900f990"}],
     #      :aws_instance_id=>"i-8ce84ae4"} , ... ]
     #
-    def describe_instances(*instances)
-      instances = instances.flatten
-      link = generate_request("DescribeInstances", amazonize_list('InstanceId', instances))
-      request_cache_or_info(:describe_instances, link,  QEc2DescribeInstancesParser, @@bench, instances.blank?) do |parser|
+    #   ec2.describe_instances("i-8ce84ae6", "i-8ce84ae8", "i-8ce84ae0")
+    #   ec2.describe_instances(:filters => { 'availability-zone' => 'us-east-1a', 'instance-type' => 'c1.medium' })
+    #
+    # P.S. filters: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-DescribeInstances.html
+    #
+    def describe_instances(*list_and_options)
+      describe_resources_with_list_and_options('DescribeInstances', 'InstanceId', QEc2DescribeInstancesParser, list_and_options) do |parser|
         get_desc_instances(parser.result)
       end
-    rescue Exception
-      on_exception
     end
 
     # Return the product code attached to instance or +nil+ otherwise.
@@ -131,7 +142,8 @@ module RightAws
                       addressing_type = nil, instance_type = nil,
                       kernel_id = nil, ramdisk_id = nil, availability_zone = nil,
                       monitoring_enabled = nil, subnet_id = nil, disable_api_termination = nil,
-                      instance_initiated_shutdown_behavior = nil, block_device_mappings = nil)
+                      instance_initiated_shutdown_behavior = nil, block_device_mappings = nil,
+                      placement_group_name = nil, client_token = nil)
  	    launch_instances(image_id, { :min_count                            => min_count,
  	                                 :max_count                            => max_count,
  	                                 :user_data                            => user_data,
@@ -146,14 +158,16 @@ module RightAws
                                    :subnet_id                            => subnet_id,
                                    :disable_api_termination              => disable_api_termination,
                                    :instance_initiated_shutdown_behavior => instance_initiated_shutdown_behavior,
-                                   :block_device_mappings                =>  block_device_mappings
+                                   :block_device_mappings                => block_device_mappings,
+                                   :placement_group_name                 => placement_group_name,
+                                   :client_token                         => client_token
                                  })
     end
 
     # Launch new EC2 instances.
     # Options: :image_id, :addressing_type, :min_count, max_count, :key_name, :kernel_id, :ramdisk_id,
     # :availability_zone, :monitoring_enabled, :subnet_id, :disable_api_termination, :instance_initiated_shutdown_behavior,
-    # :block_device_mappings
+    # :block_device_mappings, :placement_group_name, :license_pool
     # 
     # Returns a list of launched instances or an exception.
     #
@@ -191,12 +205,12 @@ module RightAws
     #      :aws_instance_id=>"i-8ce84ae4"}]
     #
     def launch_instances(image_id, options={})
-      @logger.info("Launching instance of image #{image_id} for #{@aws_access_key_id}, " +
-                   "key: #{options[:key_name]}, groups: #{Array(options[:group_ids]).join(',')}")
       options[:image_id]    = image_id
       options[:min_count] ||= 1
       options[:max_count] ||= options[:min_count]
       params = prepare_instance_launch_params(options)
+      # Log debug information
+      @logger.info("Launching instance of image #{image_id}. Options: #{params.inspect}")
       link = generate_request("RunInstances", params)
       instances = request_info(link, QEc2DescribeInstancesParser.new(:logger => @logger))
       get_desc_instances(instances)
@@ -207,30 +221,32 @@ module RightAws
     def prepare_instance_launch_params(options={}) # :nodoc:
       params = amazonize_list('SecurityGroup', Array(options[:group_ids]))
       params['InstanceType']                      = options[:instance_type] || DEFAULT_INSTANCE_TYPE
-      params['ImageId']                           = options[:image_id]                             unless options[:image_id].blank?
-      params['AddressingType']                    = options[:addressing_type]                      unless options[:addressing_type].blank?
-      params['MinCount']                          = options[:min_count]                            unless options[:min_count].blank?
-      params['MaxCount']                          = options[:max_count]                            unless options[:max_count].blank?
-      params['KeyName']                           = options[:key_name]                             unless options[:key_name].blank?
-      params['KernelId']                          = options[:kernel_id]                            unless options[:kernel_id].blank?
-      params['RamdiskId']                         = options[:ramdisk_id]                           unless options[:ramdisk_id].blank?
-      params['Placement.AvailabilityZone']        = options[:availability_zone]                    unless options[:availability_zone].blank?
+      params['ImageId']                           = options[:image_id]                             unless options[:image_id].right_blank?
+      params['AddressingType']                    = options[:addressing_type]                      unless options[:addressing_type].right_blank?
+      params['MinCount']                          = options[:min_count]                            unless options[:min_count].right_blank?
+      params['MaxCount']                          = options[:max_count]                            unless options[:max_count].right_blank?
+      params['KeyName']                           = options[:key_name]                             unless options[:key_name].right_blank?
+      params['KernelId']                          = options[:kernel_id]                            unless options[:kernel_id].right_blank?
+      params['RamdiskId']                         = options[:ramdisk_id]                           unless options[:ramdisk_id].right_blank?
+      params['Placement.AvailabilityZone']        = options[:availability_zone]                    unless options[:availability_zone].right_blank?
       params['Monitoring.Enabled']                = options[:monitoring_enabled].to_s              if     options[:monitoring_enabled]
-      params['SubnetId']                          = options[:subnet_id]                            unless options[:subnet_id].blank?
-      params['AdditionalInfo']                    = options[:additional_info]                      unless options[:additional_info].blank?
+      params['SubnetId']                          = options[:subnet_id]                            unless options[:subnet_id].right_blank?
+      params['AdditionalInfo']                    = options[:additional_info]                      unless options[:additional_info].right_blank?
       params['DisableApiTermination']             = options[:disable_api_termination].to_s         unless options[:disable_api_termination].nil?
-      params['InstanceInitiatedShutdownBehavior'] = options[:instance_initiated_shutdown_behavior] unless options[:instance_initiated_shutdown_behavior].blank?
-#     params['VolumeId']                          = options[:volume_id]                            unless options[:volume_id].blank?
-#     params['RootDeviceName']                    = options[:root_device_name]                     unless options[:root_device_name].blank?
-#     params['RootDeviceType']                    = options[:root_device_type]                     unless options[:root_device_type].blank?
+      params['InstanceInitiatedShutdownBehavior'] = options[:instance_initiated_shutdown_behavior] unless options[:instance_initiated_shutdown_behavior].right_blank?
+      params['Placement.GroupName']               = options[:placement_group_name]                 unless options[:placement_group_name].right_blank?
+      params['License.Pool']                      = options[:license_pool]                         unless options[:license_pool].right_blank?
+      params['ClientToken']                       = options[:client_token] || AwsUtils::generate_unique_token
       params.merge!(amazonize_block_device_mappings(options[:block_device_mappings]))
-      unless options[:user_data].blank?
-        options[:user_data].strip!
-          # Do not use CGI::escape(encode64(...)) as it is done in Amazons EC2 library.
-          # Amazon 169.254.169.254 does not like escaped symbols!
-          # And it doesn't like "\n" inside of encoded string! Grrr....
-          # Otherwise, some of UserData symbols will be lost...
-        params['UserData'] = Base64.encode64(options[:user_data]).delete("\n") unless options[:user_data].blank?
+      # KD: https://github.com/rightscale/right_aws/issues#issue/11
+      # Do not modify user data and pass it as is: one may pass there a hex-binary data
+      options[:user_data] = options[:user_data].to_s
+      unless options[:user_data].empty?
+        # Do not use CGI::escape(encode64(...)) as it is done in Amazons EC2 library.
+        # Amazon 169.254.169.254 does not like escaped symbols!
+        # And it doesn't like "\n" inside of encoded string! Grrr....
+        # Otherwise, some of UserData symbols will be lost...
+        params['UserData'] = Base64.encode64(options[:user_data]).delete("\n")
       end
       params
     end
@@ -429,7 +445,7 @@ module RightAws
       link = generate_request('GetPasswordData',
                               'InstanceId' => instance_id )
       response = request_info(link, QEc2GetPasswordDataParser.new(:logger => @logger))
-      if response[:password_data].blank?
+      if response[:password_data].right_blank?
         raise AwsError.new("Initial password is not yet created for #{instance_id}")
       else
         OpenSSL::PKey::RSA.new(private_key).private_decrypt(Base64.decode64(response[:password_data]))
@@ -483,9 +499,13 @@ module RightAws
     end
 
     # Describe the status of the Windows AMI bundlings.
-    # If +list+ is omitted the returns the whole list of tasks.
     #
-    #  ec2.describe_bundle_tasks(['bun-4fa74226']) #=>
+    # Accepts a list of tasks and/or a set of filters as the last parameter.
+    #
+    # Filters" bundle-id, error-code, error-message, instance-id, progress, s3-aws-access-key-id, s3-bucket, s3-prefix,
+    # start-time, state, update-time
+    #
+    #  ec2.describe_bundle_tasks('bun-4fa74226') #=>
     #    [{:s3_bucket         => "my-awesome-bucket"
     #      :aws_id            => "bun-0fa70206",
     #      :s3_prefix         => "win1pr",
@@ -497,12 +517,12 @@ module RightAws
     #      :aws_state         => "failed",
     #      :aws_instance_id   => "i-e3e24e8a"}]
     #
-    def describe_bundle_tasks(*tasks)
-      tasks = tasks.flatten
-      link = generate_request("DescribeBundleTasks", amazonize_list('BundleId', tasks))
-      request_info(link, QEc2DescribeBundleTasksParser.new)
-    rescue Exception
-      on_exception
+    #   ec2.describe_bundle_tasks(:filters => { 'state' => 'pending' })
+    #
+    # P.S. filters: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeBundleTasks.html
+    #
+    def describe_bundle_tasks(*list_and_options)
+      describe_resources_with_list_and_options('DescribeBundleTasks', 'BundleId', QEc2DescribeBundleTasksParser, list_and_options)
     end
 
     # Cancel an in‐progress or pending bundle task by id.
@@ -545,10 +565,13 @@ module RightAws
                     :ami_launch_index => '',
                     :ssh_key_name     => '',
                     :aws_state        => '',
-                    :aws_product_codes => [] }
+                    :aws_product_codes => [],
+                    :tags              => {} }
         when %r{blockDeviceMapping/item$}
           @item[:block_device_mappings] ||= []
           @block_device_mapping = {}
+        when %r{/tagSet/item$}
+          @aws_tag = {}
         end
       end
       def tagend(name)
@@ -581,6 +604,9 @@ module RightAws
         when 'instanceLifecycle'     then @item[:instance_lifecycle]       = @text
         when 'spotInstanceRequestId' then @item[:spot_instance_request_id] = @text
         when 'requesterId'           then @item[:requester_id]             = @text
+        when 'groupName'             then @item[:placement_group_name]     = @text 
+        when 'virtualizationType'    then @item[:virtualization_type]      = @text
+        when 'clientToken'           then @item[:client_token]     = @text
         else
           case full_tag_name
           when %r{/stateReason/code$}    then @item[:state_reason_code]    = @text
@@ -588,6 +614,7 @@ module RightAws
           when %r{/instanceState/code$}  then @item[:aws_state_code]       = @text.to_i
           when %r{/instanceState/name$}  then @item[:aws_state]            = @text
           when %r{/monitoring/state$}    then @item[:monitoring_state]     = @text
+          when %r{/license/pool$}        then @item[:license_pool]         = @text
           when %r{/blockDeviceMapping/item} # no trailing $
             case name
             when 'deviceName'          then @block_device_mapping[:device_name]                = @text
@@ -599,6 +626,9 @@ module RightAws
             when 'item'                then @item[:block_device_mappings]                     << @block_device_mapping
             end
           when %r{/instancesSet/item$} then @reservation[:instances_set] << @item
+          when %r{/tagSet/item/key$}   then @aws_tag[:key]               = @text
+          when %r{/tagSet/item/value$} then @aws_tag[:value]             = @text
+          when %r{/tagSet/item$}       then @item[:tags][@aws_tag[:key]] = @aws_tag[:value]
           when 'DescribeInstancesResponse/reservationSet/item',
                'RunInstancesResponse'
             @result << @reservation

data/lib/ec2/right_ec2_placement_groups.rb

@@ -0,0 +1,108 @@
+#
+# Copyright (c) 2010 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+module RightAws
+
+  class Ec2
+
+    #-----------------------------------------------------------------
+    #      Placement Groups
+    #-----------------------------------------------------------------
+
+    # Describe placement groups.
+    #
+    # Accepts a list of placement groups and/or a set of filters as the last parameter.
+    #
+    # Filters: group-name, state, strategy
+    #
+    # If you don’t specify a particular placement group, the response includes
+    # information about all of them. The information includes the group name, the strategy,
+    # and the group state (e.g., pending, available, etc.).
+    #
+    #  ec2.describe_placement_groups #=>
+    #    [{:state=>"available", :strategy=>"cluster", :group_name=>"kd_first"},
+    #     {:state=>"available", :strategy=>"cluster", :group_name=>"kd_second"}]
+    #
+    #  ec2.describe_placement_groups('kd_second') #=>
+    #    [{:strategy=>"cluster", :group_name=>"kd_second", :state=>"available"}]
+    #
+    # P.S. filters: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference_query_DescribePlacementGroups.html
+    #
+    def describe_placement_groups(*list_and_options)
+      describe_resources_with_list_and_options('DescribePlacementGroups', 'GroupName', QEc2DescribePlacementGroupsParser, list_and_options)
+    end
+
+    # Create placement group creates a placement group (i.e. logical cluster group)
+    # into which you can then launch instances. You must provide a name for the group
+    # that is unique within the scope of your account. You must also provide a strategy
+    # value. Currently the only value accepted is cluster.
+    #
+    #   ec2.create_placement_group('kd_second') #=> true
+    #
+    def create_placement_group(placement_group_name, strategy = 'cluster')
+      link = generate_request('CreatePlacementGroup',
+                              'GroupName' => placement_group_name.to_s,
+                              'Strategy'  => strategy.to_s)
+      request_info(link, RightBoolResponseParser.new(:logger => @logger))
+    rescue Exception
+      on_exception
+    end
+
+    # Delete placement group deletes a placement group that you own. The group must not
+    # contain any instances.
+    #
+    #   ec2.delete_placement_group('kd_second') #=> true
+    #
+    def delete_placement_group(placement_group_name)
+      link = generate_request('DeletePlacementGroup',
+                              'GroupName' => placement_group_name.to_s)
+      request_info(link, RightBoolResponseParser.new(:logger => @logger))
+    rescue Exception
+      on_exception
+    end
+
+    #-----------------------------------------------------------------
+    #      PARSERS: Placement Groups
+    #-----------------------------------------------------------------
+
+    class QEc2DescribePlacementGroupsParser < RightAWSParser #:nodoc:
+      def tagstart(name, attributes)
+        case name
+        when 'item' then @item = {}
+        end
+      end
+      def tagend(name)
+        case name
+        when 'groupName' then @item[:group_name] = @text
+        when 'strategy'  then @item[:strategy]   = @text
+        when 'state'     then @item[:state]      = @text
+        when 'item'      then @result           << @item
+        end
+      end
+      def reset
+        @result = []
+      end
+    end
+
+  end
+end