aws-sdk-euca 1.8.5

data/lib/aws/ec2/elastic_ip.rb

@@ -0,0 +1,208 @@
+# Copyright 2011-2013 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] domain Indicates whether this elastic ip address 
+    #   is for EC2 instances ('standard') or VPC instances ('vpc').
+    #
+    # @attr_reader [String,nil] association_id The ID of the association 
+    #   between this elastic ip address and an EC2 VPC instance (VPC only).
+    #
+    # @attr_reader [String,nil] network_interface_id 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 associated
+      #   with an EC2 instance or a network interface.
+      def associated?
+        !!(instance_id || association_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
+
+      # @return [NetworkInterface,nil] Returns the network interface this
+      #   elastic ip is associated with.  Returns +nil+ if this is not
+      #   associated with an elastic ip address.
+      def network_interface
+        if nid = network_interface_id
+          NetworkInterface.new(nid, :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
+
+      # Associates this elastic IP address with an instance or a network
+      # interface.  You may provide +:instance+ or +:network_interface+
+      # but not both options.
+      #
+      #   # associate with an instance
+      #   eip.associate :instance => 'i-12345678'
+      #
+      #   # associate with a network interface
+      #   eip.associate :network_interface => 'ni-12345678'
+      #
+      # @param [Hash] options
+      #
+      # @option options [String,Instance] :instance The id of an instance
+      #   or an {Instance} object.  
+      #
+      # @option options [String,NetworkInterface] :network_interface The id
+      #   of a network interface or a {NetworkInterface} object.
+      #
+      # @return [String] Returns the resulting association id.
+      #
+      def associate options
+
+        client_opts = {}
+
+        [:instance,:network_interface].each do |opt|
+          if value = options[opt]
+            client_opts[:"#{opt}_id"] = value.is_a?(Resource) ? value.id : value
+          end
+        end
+
+        if vpc?
+          client_opts[:allocation_id] = allocation_id
+        else
+          client_opts[:public_ip] = public_ip
+        end
+
+        resp = client.associate_address(client_opts)
+        resp.data[:association_id]
+
+      end
+
+      # 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-2013 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-2013 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/export_task.rb

@@ -0,0 +1,120 @@
+# Copyright 2011-2013 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] description
+    #   Description of the resource being exported.
+    #
+    # @attr_reader [Symbol] state State of the conversion task.
+    #   Valid values :active, :cancelling, :cancelled and :completed.
+    #
+    # @attr_reader [String] status_message Status message related to the 
+    #   export task.
+    #
+    # @attr_reader [String] instance_id ID of instance being exported.
+    #
+    # @attr_reader [String] target_environment The target virtualization 
+    #   environment.
+    #
+    # @attr_reader [String] disk_image_format The format for the exported 
+    #   image.
+    #
+    # @attr_reader [String] container_format The container format used to
+    #   combine disk images with metadata (such as OVF).
+    #
+    # @attr_reader [String] s3_bucket The name of the Amazon S3 bucket
+    #   the image will be exported to.
+    #
+    # @attr_reader [String] s3_key The key of the Amazon S3 object
+    #   the image will be exported to.
+    #
+    class ExportTask < Resource
+
+      # @private
+      def initialize export_task_id, options = {}
+        @export_task_id = export_task_id
+        super
+      end
+
+      # @return [String]
+      attr_reader :export_task_id
+
+      alias_method :id, :export_task_id
+
+      attribute :description, :static => true
+
+      attribute :state, :to_sym => true
+
+      attribute :status_message
+
+      attribute :instance_id, 
+        :from => [:instance_export, :instance_id],
+        :static => true
+
+      attribute :target_environment,
+        :from => [:instance_export, :target_environment],
+        :static => true
+
+      attribute :disk_image_format,
+        :from => [:export_to_s3, :disk_image_format],
+        :static => true
+
+      attribute :container_format,
+        :from => [:export_to_s3, :container_format],
+        :static => true
+
+      attribute :s3_bucket_name,
+        :from => [:export_to_s3, :s3_bucket],
+        :static => true
+
+      attribute :s3_key,
+        :from => [:export_to_s3, :s3_key],
+        :static => true
+
+      populates_from(:create_instance_export_task) do |resp|
+        resp[:export_task] if resp[:export_task][:export_task_id] == id
+      end
+
+      populates_from(:describe_export_tasks) do |resp|
+        resp[:export_task_set].find do |task|
+          task[:export_task_id] == id
+        end
+      end
+
+      # @return [Instance]
+      def instance
+        Instance.new(instance_id, :config => config)
+      end
+
+      # @return [S3::Bucket]
+      def s3_bucket
+        S3::Bucket.new(s3_bucket_name, :config => config)
+      end
+
+      # @return [S3::S3Object]
+      def s3_object
+        s3_bucket.objects[s3_key]
+      end
+
+      # Cancels the export task.
+      # @return [nil]
+      def cancel
+        client.cancel_export_task(:export_task_id => export_task_id)
+        nil
+      end
+
+    end
+  end
+end