aws-sdk 1.0.0

data/lib/aws/ec2/attachment.rb

@@ -0,0 +1,149 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/model'
+require 'aws/cacheable'
+
+module AWS
+  class EC2
+
+    # Represents an attachment of an Amazon EBS volume to an instance.
+    #
+    # @example Create an empty 15GiB volume and attach it to an instance
+    #  volume = ec2.volumes.create(:size => 15,
+    #                              :availability_zone => "us-east-1a")
+    #  attachment = volume.attach_to(ec2.instances["i-123"], "/dev/sdf")
+    #  sleep 1 until attachment.status != :attaching
+    #
+    # @example Remove all attachments from a volume and then delete it
+    #  volume.attachments.each do |attachment|
+    #    attachment.delete(:force => true)
+    #  end
+    #  sleep 1 until volume.status == :available
+    #  volume.delete
+    class Attachment
+
+      include Model
+      include Cacheable
+
+      attr_reader :volume
+      attr_reader :instance
+      attr_reader :device
+
+      # @private
+      def initialize(volume, instance, device, opts = {})
+        @volume = volume
+        @instance = instance
+        @device = device
+        super(opts)
+      end
+
+      # (see Volume#detach_from)
+      def delete(opts = {})
+        client.detach_volume(opts.merge(:volume_id => volume.id,
+                                        :instance_id => instance.id,
+                                        :device => device))
+      end
+
+      # @return [Symbol] The attachment status.  Possible values:
+      #   * +:attaching+
+      #   * +:attached+
+      #   * +:detaching+
+      #   * +:detached+
+      def status
+        retrieve_attribute(:status) { describe_call }
+      end
+
+      # @return [Time] The time at which this attachment was created.
+      def attach_time
+        retrieve_attribute(:attach_time) { describe_call }
+      end
+
+      # @return [Boolean] True if the volume will be deleted on
+      #   instance termination.
+      def delete_on_termination?
+        retrieve_attribute(:delete_on_termination?) { describe_call }
+      end
+
+      # @return [Boolean] True if the attachment exists.
+      def exists?
+        !describe_attachment.nil?
+      end
+
+      # @return [Boolean] True if the attachments are the same.
+      #
+      # @param [Object] other The object to compare with.
+      def ==(other)
+        other.kind_of?(Attachment) and
+          other.volume == volume and
+          other.instance == instance and
+          other.device == device
+      end
+      alias_method :eql?, :==
+
+      populate_from :describe_volumes do |resp|
+        if volume = resp.volume_index[self.volume.id] and
+            attachments = volume.attachment_set and
+            attachment = attachments.find do |att|
+            att.instance_id == self.instance.id &&
+              att.volume_id == self.volume.id &&
+              att.device == self.device
+          end
+
+          attributes_from_response_object(attachment)
+        end
+      end
+
+      [:attach_volume,
+       :detach_volume].each do |op|
+        populate_from op do |resp|
+          attributes_from_response_object(resp) if
+            resp.volume_id == volume.id and
+            resp.instance_id == instance.id and
+            resp.device == device
+        end
+      end
+
+      protected
+      def attributes_from_response_object(attachment)
+        atts = {}
+        atts[:status] = (attachment.status.to_sym if
+                         attachment.respond_to?(:status))
+        atts[:attach_time] = (attachment.attach_time if
+                              attachment.respond_to?(:attach_time))
+        atts[:delete_on_termination?] = (attachment.delete_on_termination? if
+                                         attachment.respond_to?(:delete_on_termination?))
+        atts
+      end
+
+      protected
+      def describe_call
+        client.describe_volumes(:volume_ids => [self.volume.id])
+      end
+
+      private
+      def describe_attachment
+        (resp = describe_call and
+         volume = resp.volume_index[self.volume.id] and
+         attachments = volume.attachment_set and
+         attachment = attachments.find do |att|
+           att.instance_id == self.instance.id &&
+             att.volume_id == self.volume.id &&
+             att.device == self.device
+         end) or nil
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/attachment_collection.rb

@@ -0,0 +1,57 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/model'
+require 'aws/ec2/volume'
+require 'aws/ec2/instance'
+require 'aws/ec2/attachment'
+
+module AWS
+  class EC2
+
+    # Represents the collection of attachments for an Amazon EBS
+    # volume.
+    #
+    # @see Volume
+    class AttachmentCollection
+
+      include Model
+      include Enumerable
+
+      attr_reader :volume
+
+      # @private
+      def initialize(volume, opts = {})
+        @volume = volume
+        super(opts)
+      end
+
+      # @yield [attachment] Each attachment of the volume as an
+      #   {Attachment} object.
+      # @return [nil]
+      def each(&block)
+        volume.attachment_set.each do |att|
+          instance = Instance.new(att.instance_id, :config => config)
+          attachment = Attachment.new(self.volume,
+                                      instance,
+                                      att.device,
+                                      :config => config)
+          yield(attachment)
+        end
+        nil
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/availability_zone.rb

@@ -0,0 +1,80 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/ec2/resource'
+
+module AWS
+  class EC2
+
+    # Represents an EC2 availability zone.  You can use this class
+    # to get information about the state of an availability zone
+    # that is available to your account.
+    class AvailabilityZone < Resource
+
+      # @return [String] Returns the name of the availability zone,
+      #   e.g. "us-east-1a".
+      attr_reader :name
+
+      alias_method :to_s, :name
+      alias_method :to_str, :name
+
+      # @param [String] name The name of the availability zone.
+      def initialize(name, opts = {})
+        @name = name
+        @region = opts[:region]
+        super(opts)
+      end
+
+      # @return [Region] The region of this availability zone.
+      def region; end
+      describe_call_attribute :region_name, :getter => :region, :memoize => true do
+        translate_output do |value|
+          Region.new(value, :config => config) if value
+        end
+      end
+
+      # @return [Symbol] The state of the availability zone,
+      #   e.g. +:available+.
+      def state; end
+      describe_call_attribute :zone_state, :getter => :state, :to_sym => true
+
+      # @return [Array] A list of messages about the Availability
+      #   Zone.
+      def messages; end
+      describe_call_attribute :message_set, :getter => :messages do
+        translate_output { |set| set.map { |m| m.message } if set }
+      end
+
+      protected
+      def inflected_name
+        "zone"
+      end
+
+      protected
+      def find_in_response(resp)
+        resp.availability_zone_info.find { |az| az.zone_name == name }
+      end
+
+      # @private
+      private
+      def get_attribute(name)
+        resp = client.describe_availability_zones(:zone_names =>
+                                                  [self.name])
+        az = resp.availability_zone_info.first
+        az.send(name)
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/availability_zone_collection.rb

@@ -0,0 +1,47 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/ec2/collection'
+require 'aws/ec2/availability_zone'
+
+module AWS
+  class EC2
+
+    # Represents all EC2 availability zones that are currently
+    # available to your account.
+    class AvailabilityZoneCollection < Collection
+
+      # Yields each of the EC2 availability zones.
+      # @return [nil]
+      def each &block
+        resp = filtered_request(:describe_availability_zones)
+        resp.availability_zone_info.each do |az|
+          zone = AvailabilityZone.new(az.zone_name,
+            :region => Region.new(az.region_name, :config => config),
+            :config => config
+          )
+          yield(zone)
+        end
+        nil
+      end
+
+      # @private
+      protected
+      def member_class
+        AvailabilityZone
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/block_device_mappings.rb

@@ -0,0 +1,53 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class EC2
+
+    # @private
+    module BlockDeviceMappings
+
+      # @private
+      private
+      def translate_block_device_mappings(mapping)
+        raise ArgumentError.new("block_device_mappings must be a hash") unless
+          mapping.kind_of?(Hash)
+        mapping.map do |device, dest|
+          raise ArgumentError.new("keys of block_device_mappings must be strings") unless
+            device.kind_of?(String)
+          entry = { :device_name => device }
+          case dest
+          when :no_device
+            # for some reason EC2 rejects boolean values for this seemingly boolean option
+            entry[:no_device] = ""
+          when Symbol
+            raise ArgumentError.new("unrecognized block device mapping: #{dest}")
+          when String
+            entry[:virtual_name] = dest
+          when Hash
+            if snapshot = dest.delete(:snapshot)
+              dest[:snapshot_id] = snapshot.id
+            end
+            entry[:ebs] = dest
+          else
+            raise ArgumentError.new("values of block_device_mappings must "+
+                                    "be strings, symbols, or hashes")
+          end
+          entry
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/client.rb

@@ -0,0 +1,54 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/base_client'
+require 'aws/configured_client_methods'
+require 'aws/ec2/request'
+require 'aws/ec2/client/xml'
+require 'aws/ec2/errors'
+require 'aws/inflection'
+
+module AWS
+  class EC2
+
+    # @private
+    class Client < BaseClient
+
+      include ConfiguredClientMethods
+
+      API_VERSION = '2011-02-28'
+
+      REQUEST_CLASS = EC2::Request
+
+      # @private
+      CACHEABLE_REQUESTS = Set[:describe_instances,
+                               :describe_instance_attribute,
+                               :describe_images,
+                               :describe_image_attribute,
+                               :describe_volumes,
+                               :describe_security_groups,
+                               :describe_addresses,
+                               :describe_key_pairs,
+                               :describe_regions,
+                               :describe_availability_zones,
+                               :describe_reserved_instances,
+                               :describe_reserved_instances_offerings,
+                               :describe_snapshots,
+                               :describe_snapshot_attribute,
+                               :describe_tags]
+
+      configure_client
+
+    end
+  end
+end

data/lib/aws/ec2/client/xml.rb

@@ -0,0 +1,127 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/configured_xml_grammars'
+
+module AWS
+  class EC2
+    class Client < BaseClient
+      module XML
+
+        include ConfiguredXmlGrammars
+
+        BaseError = XmlGrammar.customize do
+          element "Errors" do
+            ignore
+            element("Error") { ignore }
+          end
+        end
+
+        define_configured_grammars
+
+        CustomizedDescribeSecurityGroups = DescribeSecurityGroups.customize do
+          element "securityGroupInfo" do
+            element "item" do
+              index(:security_group_index) { |i| i.group_id }
+
+              element "ipPermissions" do
+                list "item"
+                element "item" do
+                  element("ipProtocol") { symbol_value }
+                  element("fromPort") { integer_value }
+                  element("toPort") { integer_value }
+                  element("groups") { list "item" }
+                  element("ipRanges") { list "item" }
+                end
+              end
+            end
+          end
+        end
+
+        CustomizedDescribeInstances = DescribeInstances.customize do
+          element "reservationSet" do
+            element "item" do
+              index :reservation_index do |r|
+                r.instances_set.map { |i| i.instance_id }
+              end
+
+              element "instancesSet" do
+                element "item" do
+                  index(:instance_index) { |i| i.instance_id }
+                end
+              end
+            end
+          end
+        end
+
+        CustomizedDescribeImages = DescribeImages.customize do
+          element "imagesSet" do
+            element "item" do
+              index(:image_index) { |i| i.image_id }
+            end
+          end
+        end
+
+        CustomizedDescribeVolumes = DescribeVolumes.customize do
+          element "volumeSet" do
+            element "item" do
+              index(:volume_index) { |v| v.volume_id }
+            end
+          end
+        end
+
+        CustomizedDescribeSnapshots = DescribeSnapshots.customize do
+          element "snapshotSet" do
+            element "item" do
+              index(:snapshot_index) { |s| s.snapshot_id }
+            end
+          end
+        end
+
+        CustomizedDescribeAddresses = DescribeAddresses.customize do
+          element "addressesSet" do
+            element "item" do
+              index(:address_index) { |a| a.public_ip }
+              element "instanceId" do
+                force
+              end
+            end
+          end
+        end
+
+        CustomizedDescribeKeyPairs = DescribeKeyPairs.customize do
+          element "keySet" do
+            element "item" do
+              index(:key_index) { |k| k.key_name }
+            end
+          end
+        end
+
+        CustomizedDescribeTags = DescribeTags.customize do
+          element "tagSet" do
+            element "item" do
+              element("resourceType") { force }
+              element("resourceId") { force }
+              element("key") { force }
+              index(:tag_index) do |t|
+                "#{t.resource_type}:#{t.resource_id}:#{t.key}"
+              end
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end