aws_sdk 3.1.5

data/lib/aws/ec2/elastic_ip.rb

@@ -0,0 +1,157 @@
+# Copyright 2011-2012 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
+
+    # @attr_reader [String,nil] instance_id Returns the instance id if 
+    #   assigned to an EC2 instance, nil otherwise.
+    #
+    # @attr_reader [String,nil] allocation_id
+    #   The ID representing the allocation of the address for use with Amazon 
+    #   VPC.
+    #
+    # @attr_reader [String] Indicates whether this elastic ip address is for 
+    #   EC2 instances ('standard') or VPC instances ('vpc').
+    #
+    # @attr_reader [String,nil] The ID of the association between this elastic
+    #   ip address and an EC2 VPC instance (VPC only).
+    #
+    # @attr_reader [String,nil] The ID of the network interface (VPC only).
+    #
+    # @attr_reader [String,nil] network_interface_owner_id 
+    #   The ID of the AWS account that owns the network interface (VPC only).
+    #
+    class ElasticIp < Resource
+
+      def initialize public_ip, options = {}
+        @public_ip = public_ip
+        super
+      end
+
+      # @return [String] The public IP address.
+      attr_reader :public_ip
+
+      alias_method :ip_address, :public_ip
+
+      attribute :instance_id
+
+      ## vpc related attributes
+
+      attribute :allocation_id, :static => true
+
+      attribute :domain, :static => true
+
+      attribute :association_id
+
+      attribute :network_interface_id
+
+      attribute :network_interface_owner_id
+
+      populates_from(:describe_addresses) do |resp|
+        resp.address_index[public_ip]
+      end
+
+      # @return [Boolean] Returns true if this is an EC2 VPC Elastic IP.
+      def vpc?
+        domain == 'vpc'
+      end
+
+      # @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
+        if instance_id = self.instance_id
+          Instance.new(instance_id, :config => config)
+        end
+      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 [nil]
+      def delete
+        if vpc?
+          client.release_address(:allocation_id => allocation_id)
+        else
+          client.release_address(:public_ip => public_ip)
+        end
+        nil
+      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 [nil]
+      def disassociate
+        if vpc?
+          client.disassociate_address(:association_id => association_id)
+        else
+          client.disassociate_address(:public_ip => public_ip)
+        end
+        nil
+      end
+
+      # @return [Boolean] Returns true the elastic ip address exists in
+      #   your account.
+      def exists?
+        begin
+          get_resource
+          true
+        rescue Errors::InvalidAddress::NotFound
+          false
+        end
+      end
+
+      # @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 describe_call_name
+        :describe_addresses
+      end
+
+      # @private
+      protected
+      def self.describe_call_name
+        :describe_addresses
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/elastic_ip_collection.rb

@@ -0,0 +1,97 @@
+# Copyright 2011-2012 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
+    class ElasticIpCollection < Collection
+
+      # @param [Hash] options
+      #
+      # @option options [Boolean] :vpc (false) When true, the elastic ip 
+      #   address will be allocated to your VPC.
+      #
+      # @return [ElasticIp]
+      #
+      def create options = {}
+
+        client_opts = {}
+        client_opts[:domain] = 'vpc' if options[:vpc]
+
+        response = client.allocate_address(client_opts)
+
+        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_from(
+            :describe_addresses,
+            address,
+            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,32 @@
+# Copyright 2011-2012 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
+    module Errors
+
+      # @private
+      GRAMMAR = Core::XML::Grammar.customize do
+        element "Errors" do
+          ignore
+          element "Error" do
+            ignore
+          end
+        end
+      end
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/ec2/filtered_collection.rb

@@ -0,0 +1,90 @@
+# Copyright 2011-2012 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
+
+      protected
+      def vpc_id_option options
+        vpc_id = options[:vpc]
+        vpc_id ||= options[:vpc_id]
+        vpc_id ||= filter_value_for('vpc-id')
+        vpc_id = vpc_id.id if vpc_id.is_a?(VPC)
+        vpc_id
+      end
+
+      protected
+      def subnet_id_option options
+        subnet_id = options.delete(:subnet)
+        subnet_id ||= options[:subnet_id]
+        subnet_id ||= filter_value_for('subnet-id')
+        subnet_id = subnet_id.id if subnet_id.is_a?(Subnet)
+        subnet_id
+      end
+
+      protected
+      def filter_value_for filter_name
+        @filters.each do |filter|
+          return filter[:values].first if filter[:name] == filter_name
+        end
+        nil
+      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,44 @@
+# Copyright 2011-2012 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
+
+    # 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,254 @@
+# Copyright 2011-2012 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
+
+    # Represents an Amazon Machine Image (AMI).
+    #
+    # @attr_reader [String] name The name of the AMI that was provided
+    #   during image creation.
+    #
+    # @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 The AWS account ID of the image owner.
+    #
+    # @attr_reader [String] owner_alias The AWS account alias (e.g.,
+    #   +"amazon"+) or AWS account ID that owns the AMI.
+    #
+    # @attr_reader [Symbol] architecture The architecture of the 
+    #   image (e.g. +:i386+).
+    #
+    # @attr_reader [Symbol] type The type of image.  Valid values are:
+    #   * +: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 [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 [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 are:
+    #   * +:ovm+
+    #   * +:xen+
+    #
+    # @attr_reader [Array<String>] product_codes Returns an array of
+    #   product codes attached to this instance.
+    #
+    class Image < Resource
+
+      include TaggedItem
+      include HasPermissions
+
+      # @private
+      def initialize id, options = {}
+        @id = id
+        super
+      end
+
+      # @return [String] The ID of the AMI.
+      attr_reader :id
+
+      attribute :name, :static => true
+
+      mutable_attribute :description
+
+      attribute :location, :as => :image_location, :static => true
+
+      attribute :state, :as => :image_state, :to_sym => true
+
+      attribute :owner_id, :as => :image_owner_id, :static => true
+
+      attribute :owner_alias, :as => :image_owner_alias, :static => true
+
+      attribute :architecture, :to_sym => true, :static => true
+
+      attribute :type, :as => :image_type, :to_sym => true, :static => true
+
+      attribute :kernel_id, :static => true
+
+      attribute :ramdisk_id, :static => true
+
+      attribute :platform, :static => true
+
+      attribute :state_reason
+
+      attribute :root_device_type, :to_sym => true, :static => true
+
+      attribute :root_device_name, :static => true
+
+      attribute :virtualization_type, :to_sym => true, :static => true
+
+      attribute :hypervisor, :to_sym => true, :static => true
+
+      attribute :block_device_mapping
+
+      protected :block_device_mapping
+
+      attribute :product_codes, :static => true do
+        translates_output do |list|
+          (list || []).collect{|item| item.product_code }
+        end
+      end
+
+      populates_from(:describe_images) do |resp|
+        resp.image_index[id]
+      end
+
+      alias_method :launch_permissions, :permissions
+
+      # @return [Hash] Returns 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.
+      def block_device_mappings
+        (block_device_mapping || []).inject({}) do |h,mapping|
+          h[mapping.device_name] = mapping.ebs
+          h
+        end
+      end
+
+      # Deregisters this AMI. Once deregistered, the AMI cannot be
+      # used to launch new instances.
+      # @return [nil]
+      def deregister
+        client.deregister_image(:image_id => id)
+        nil
+      end
+
+      alias_method :delete, :deregister
+
+      # Runs a single instance of this image.  
+      #
+      # @param [Hash] options
+      # @option (see InstanceCollection#create)
+      # @return (see InstanceCollection#create)
+      def run_instance options = {}
+        instances = InstanceCollection.new(:config => config)
+        instances.create(options.merge(:image => self))
+      end
+
+      # Runs multiple instances of this image.
+      #
+      # @param [Integer] 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] options
+      # @option (see InstanceCollection#create)
+      # @return [Array<Instance>] An array containing an {Instance} object for
+      #   each instance that was run.
+      def run_instances count, options = {}
+        run_instance(options.merge(:count => count))
+      end
+
+      # @return [Boolean] Returns +true+ if the AMI exists (is returned by
+      #   the DescribeImages action).
+      def exists?
+        resp = client.describe_images(:filters => [
+          { :name => "image-id", :values => [id] }
+        ])
+        !resp.images_set.empty?
+      end
+
+      # @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
+
+      # @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
+
+      # Adds one or more product codes:
+      #
+      #   image.add_product_codes 'ABCXYZ', 'MNOPQR'
+      #
+      # You can also pass an array of product codes:
+      # 
+      #   image.add_product_codes ['ABCXYZ', 'MNOPQR']
+      #
+      # @param [Array<String>] product_codes 
+      #
+      # @return [nil]
+      #
+      def add_product_codes *product_codes
+        client_opts = {}
+        client_opts[:image_id] = self.id
+        client_opts[:product_codes] = product_codes.flatten
+        client.modify_image_attribute(client_opts)
+        nil
+      end
+
+      # @private
+      def __permissions_attribute__
+        "launchPermission"
+      end
+
+    end
+
+  end
+end