aws-sdk-v1 1.52.0

data/lib/aws/ec2/elastic_ip_collection.rb

@@ -0,0 +1,93 @@
+# 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.
+      #
+      # @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
+
+      # @api 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
+
+      # @api 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

data/lib/aws/ec2/export_task_collection.rb

@@ -0,0 +1,67 @@
+# 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
+
+    # # Getting Export Tasks
+    #
+    # Allows you to enumerate export tasks.
+    #
+    #     ec2.export_tasks.each do |task|
+    #       # yield ExportTask objects
+    #     end
+    #
+    # You can also get an export task by id
+    #
+    #     task = ec2.export_tasks['export-task-id']
+    #
+    # # Creating Export Tasks
+    #
+    # To create an export task you start with the {Instance}:
+    #
+    #     task = ec2.instances['i-12345678'].export_to_s3('bucket-name')
+    #
+    # See {Instance#export_to_s3} for more options.
+    #
+    class ExportTaskCollection < Collection
+
+      include Core::Collection::Simple
+
+      # @param [String] export_task_id
+      # @return [ExportTask] Returns reference to the export task with the
+      #   given export task id.
+      def [] export_task_id
+        ExportTask.new(export_task_id, :config => config)
+      end
+
+      protected
+
+      def _each_item options = {}, &block
+        resp = filtered_request(:describe_export_tasks, options, &block)
+        resp.data[:export_task_set].each do |details|
+
+          task = ExportTask.new_from(
+            :describe_export_tasks,
+            details,
+            details[:export_task_id],
+            :config => config)
+
+          yield(task)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/filtered_collection.rb

@@ -0,0 +1,87 @@
+# 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 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
+
+      # @api 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
+
+      # @api private
+      protected
+      def preserved_options
+        { :config => config, :filters => @filters }
+      end
+
+      # @api 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-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
+
+    # 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