aws-sdk 1.0.0

data/lib/aws/ec2/collection.rb

@@ -0,0 +1,39 @@
+# 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/filtered_collection'
+
+module AWS
+  class EC2
+
+    # @private
+    class Collection
+
+      include Model
+      include Enumerable
+      include FilteredCollection
+
+      def [] id
+        member_class.new(id.to_s, :config => config)
+      end
+
+      protected
+      def member_class
+        raise NotImplementedError
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/config_transform.rb

@@ -0,0 +1,63 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+module AWS
+  class EC2
+
+    # @private
+    class ConfigTransform
+
+      class << self
+
+        def transform(api_config)
+          ["RunInstances",
+           "DetachVolume",
+           "AttachVolume",
+           "CreateSnapshot",
+           "CreateVolume",
+           "DescribeImageAttribute",
+           "DescribeInstanceAttribute"].each do |(op, wrapper)|
+            if op_config = api_config[:operations][op]
+              op_config[:output] = op_config[:output].first.values.first
+            end
+          end
+
+          api_config[:operations].each do |op, op_config|
+            op_config[:input] =
+              capitalize_input_structure(op_config[:input])
+          end
+
+          api_config
+        end
+
+        private
+        def capitalize_input_structure(struct)
+          struct.inject({}) do |m, (name, desc)|
+
+            name = name[0,1].upcase + name[1..-1]
+            m[name] = capitalize_input_descriptors(desc)
+            m
+          end
+        end
+
+        private
+        def capitalize_input_descriptors(desc)
+          desc.map do |d|
+            case
+            when d.kind_of?(Hash) && d.key?(:structure)
+              d.merge(:structure =>
+                      capitalize_input_structure(d[:structure]))
+            when d.kind_of?(Hash) && d.key?(:list)
+              d.merge(:list =>
+                      capitalize_input_descriptors(d[:list]))
+            else
+              d
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/elastic_ip.rb

@@ -0,0 +1,107 @@
+# 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
+    class ElasticIp < Resource
+
+      def initialize public_ip, options = {}
+        @public_ip = public_ip
+        @instance_id = options[:instance_id]
+        super
+      end
+
+      # @private
+      def self.describe_call_name; :describe_addresses; end
+
+      # @private
+      def describe_call_name; self.class.describe_call_name; end
+
+      # @return [String] The public IP address.
+      attr_reader :public_ip
+
+      alias_method :ip_address, :public_ip
+
+      # @return [String,nil] Returns the instance id if assigned to an
+      #   EC2 instance
+      def instance_id; end
+      describe_call_attribute :instance_id
+
+      # @return [Boolean] Returns true if this IP address is attached to
+      #   an EC2 instance.
+      def associated?
+        !!instance_id
+      end
+      alias_method :attached?, :associated?
+
+      # @return [Instance,nil] If associated, returns the {Instance} this
+      #   elastic IP address is associated to, nil otherwise.
+      def instance
+        associated? ? Instance.new(instance_id, :config => config) : nil
+      end
+
+      # Releases the elastic IP address.
+      #
+      # (For non-VPC elastic ips) Releasing an IP address automatically 
+      # disassociates it from any instance it's associated with.
+      #
+      # @return [true]
+      def delete
+        client.release_address(:public_ip => public_ip)
+        true
+      end
+
+      alias_method :release, :delete
+
+      # Disassociates this elastic IP address from an EC2 instance.
+      # Raises an exception if this elastic IP is not currently
+      # associated with an instance.
+      # @return [true]
+      def disassociate
+        client.disassociate_address(:public_ip => public_ip)
+        true
+      end
+
+      # @private
+      # @return [String] Returns the public IP address
+      def to_s
+        public_ip.to_s
+      end
+
+      # @private
+      protected
+      def resource_id_method
+        :public_ip
+      end
+
+      # @private
+      protected
+      def response_id_method
+        :public_ip
+      end
+
+      # @private
+      protected
+      def find_in_response(resp)
+        resp.address_index[public_ip]
+      end
+
+      # @private
+      protected
+      def __resource_id__; public_ip; end
+
+    end
+  end
+end

data/lib/aws/ec2/elastic_ip_collection.rb

@@ -0,0 +1,85 @@
+# 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/collection'
+require 'aws/ec2/elastic_ip'
+
+module AWS
+  class EC2
+    class ElasticIpCollection < Collection
+
+      def create 
+        response = client.allocate_address
+        ElasticIp.new(response.public_ip, :config => config)
+      end
+
+      alias_method :allocate, :create
+
+      # @param [String] public_ip The public IP address of an elastic ip.
+      # @return [ElasticIp] The elastic IP with the given address.
+      def [] public_ip
+        super
+      end
+
+      # Specify one or more criteria to filter elastic IP addresses by.
+      # A subsequent call to #each will limit the resutls returned
+      # by provided filters.
+      # 
+      # * Chain multiple calls of #filter together to AND multiple conditions
+      #   together.
+      #
+      # * Supply multiple values to a singler #filter call to OR those 
+      #   value conditions together.
+      #
+      # * '*' matches one or more characters and '?' matches any one
+      #   character.
+      #
+      # === Valid Filters
+      #
+      # * domain - Whether the address is a EC2 address, or a VPC address. 
+      #   Valid values include 'standard' and 'vpc'
+      # * instance-id - Instance the address is associated with (if any).
+      # * public-ip - The Elastic IP address.
+      # * allocation-id - Allocation ID for the address. For VPC addresses 
+      #   only.
+      # * association-id - Association ID for the address. For VPC addresses 
+      #   only.
+      #
+      # @return [ElasticIpCollection] A new collection that represents
+      #   a subset of the elastic IP addresses associated with this account.
+      
+      # Yields once for each elastic IP address.
+      #
+      # @yield [elastic_ip]
+      # @yieldparam [ElasticIp] elastic_ip
+      def each &block
+        response = filtered_request(:describe_addresses)
+        response.addresses_set.each do |address|
+
+          elastic_ip = ElasticIp.new(address.public_ip,
+                                     :config => config)
+
+          yield(elastic_ip)
+
+        end
+      end
+
+      protected
+      def member_class
+        ElasticIp
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/errors.rb

@@ -0,0 +1,29 @@
+# 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/lazy_error_classes'
+require 'aws/ec2/client/xml'
+
+module AWS
+  class EC2
+
+    # @private
+    module Errors
+
+      BASE_ERROR_GRAMMAR = Client::XML::BaseError
+
+      include LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/ec2/filtered_collection.rb

@@ -0,0 +1,65 @@
+# 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 FilteredCollection
+
+      def initialize options = {}
+        @filters = options[:filters] || []
+        super
+      end
+
+      # Specify one or more criteria to filter elastic IP addresses by.
+      # A subsequent call to #each will limit the results returned
+      # by provided filters.
+      # 
+      # * Chain multiple calls of #filter together to AND multiple conditions
+      #   together.
+      #
+      # * Supply multiple values to a singler #filter call to OR those 
+      #   value conditions together.
+      #
+      # * '*' matches one or more characters and '?' matches any one
+      #   character.
+      #
+      def filter filter_name, *values
+        filters = @filters.dup
+        filters << { :name => filter_name, :values => values.flatten }
+        collection_with(:filters => filters)
+      end
+
+      # @private
+      def filtered_request client_method, options = {}, &block
+        options[:filters] = @filters unless @filters.empty?
+        client.send(client_method, options)
+      end
+
+      # @private
+      protected
+      def preserved_options
+        { :config => config,
+          :filters => @filters }
+      end
+
+      # @private
+      protected
+      def collection_with(options = {})
+        self.class.new(preserved_options.merge(options))
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/has_permissions.rb

@@ -0,0 +1,46 @@
+# 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/permission_collection'
+
+module AWS
+  class EC2
+
+    # Helper methods for managing EC2 resource permissions.  See
+    # {Image} and {Snapshot} for usage examples.
+    module HasPermissions
+
+      # (see PermissionCollection#public?)
+      def public?
+        permissions.public?
+      end
+
+      # (see PermissionCollection#private?)
+      def private?
+        permissions.private?
+      end
+
+      # (see PermissionCollection#public=)
+      def public=(value)
+        permissions.public = value
+      end
+
+      # @return [PermissionCollection] An object to manage the
+      #   collection of permissions for this resource.
+      def permissions
+        PermissionCollection.new(self, :config => config)
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/image.rb

@@ -0,0 +1,245 @@
+# 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'
+require 'aws/ec2/tagged_item'
+require 'aws/ec2/has_permissions'
+require 'aws/ec2/instance_collection'
+
+module AWS
+  class EC2
+
+    # Represents an Amazon Machine Image (AMI).
+    #
+    # @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 AWS account ID of the image
+    #   owner.
+    #
+    # @attr_reader [Symbol] architecture The architecture of the
+    #   image (e.g. +:i386+).
+    #
+    # @attr_reader [Symbol] type The type of image.  Valid values:
+    #
+    #   * +: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 [String] owner_alias The AWS account alias (e.g.,
+    #   +"amazon"+) or AWS account ID that owns the AMI.
+    #
+    # @attr_reader [String] name The name of the AMI that was
+    #   provided during image creation.
+    #
+    # @attr [String] description A free-form description of the AMI.
+    #   May contain up to 255 characters.
+    #
+    # @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 [Hash] block_device_mappings 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.
+    #
+    # @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:
+    #
+    #   * +:ovm+
+    #   * +:xen+
+    class Image < Resource
+
+      include TaggedItem
+      include HasPermissions
+      alias_method :launch_permissions, :permissions
+
+      # The ID of the AMI.
+      attr_reader :id
+
+      # @private
+      def initialize(id, opts = {})
+        @id = id
+        super(opts)
+      end
+
+      # Deregisters this AMI. Once deregistered, the AMI cannot be
+      # used to launch new instances.
+      def deregister
+        client.deregister_image(:image_id => id)
+      end
+      alias_method :delete, :deregister
+
+      # Runs a single instance of this image.
+      #
+      # @param [Hash] opts Additional options for running the
+      #   instance.  See {InstanceCollection#create} for a full list
+      #   of supported options.
+      #
+      # @return [Instance] An object representing the new instance.
+      def run_instance(opts = {})
+        InstanceCollection.new(:config => config).
+          create(opts.merge(:image => self))
+      end
+
+      # Runs multiple instances of this image.
+      #
+      # @param 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] opts Additional options for running the
+      #   instance.  See {InstanceCollection#create} for a full list
+      #   of supported options.
+      #
+      # @return [Array] An array containing an {Instance} object for
+      #   each instance that was run.
+      def run_instances(count, opts = {})
+        InstanceCollection.new(:config => config).
+          create(opts.merge(:image => self,
+                            :count => count))
+      end
+
+      # @return [Boolean] +true+ if the AMI exists (is returned by
+      # the DescribeImages action).
+      def exists?
+        resp = client.describe_images(:filters =>
+                                      [{ :name => "image-id",
+                                         :values => [id] }]) and
+          !resp.images_set.empty?
+      end
+
+      mutable_attribute :description
+      # use describe_images to get it, so it will work with public images
+      describe_call_attribute :description
+
+      describe_call_attribute :name, :memoize => true
+      describe_call_attribute(:image_location,
+                              :getter => :location,
+                              :memoize => true)
+      describe_call_attribute :image_state, :getter => :state, :to_sym => true
+      describe_call_attribute(:image_owner_id,
+                              :getter => :owner_id,
+                              :memoize => true)
+      describe_call_attribute(:image_owner_alias,
+                              :getter => :owner_alias,
+                              :memoize => true)
+      describe_call_attribute(:architecture,
+                              :to_sym => true,
+                              :memoize => true)
+      describe_call_attribute(:image_type,
+                              :getter => :type,
+                              :to_sym => true,
+                              :memoize => true)
+
+      describe_call_attribute :kernel_id, :memoize => true
+
+      # @return [Image] The kernel associated with the image, if
+      #   any. Only applicable for machine images.
+      def kernel
+        if id = kernel_id
+          Image.new(id, :config => config)
+        end
+      end
+
+      describe_call_attribute :ramdisk_id, :memoize => true
+
+      # @return [Image] The RAM disk associated with the image, if
+      #   any. Only applicable for machine images.
+      def ramdisk
+        if id = ramdisk_id
+          Image.new(id, :config => config)
+        end
+      end
+
+      describe_call_attribute :platform, :memoize => true
+      describe_call_attribute :state_reason
+      describe_call_attribute(:root_device_type,
+                              :to_sym => true,
+                              :memoize => true)
+      describe_call_attribute :root_device_name
+      describe_call_attribute :virtualization_type, :to_sym => true
+      describe_call_attribute :hypervisor, :to_sym => true
+      describe_call_attribute(:block_device_mapping,
+                              :getter => :block_device_mappings) do
+        translate_output do |mappings|
+          (mappings || []).inject({}) do |h, mapping|
+            h[mapping.device_name] = mapping.ebs
+            h
+          end
+        end
+      end
+
+      # @private
+      def __permissions_attribute__
+        "launchPermission"
+      end
+
+      protected
+      def find_in_response(resp)
+        resp.image_index[id]
+      end
+
+    end
+
+  end
+end