aws-sdk-v1 1.52.0

data/lib/aws/ec2/attachment.rb

@@ -0,0 +1,135 @@
+# 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
+
+    # 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-west-2a")
+    #   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 < Resource
+
+      # @api private
+      def initialize volume, instance, device, options = {}
+        @volume = volume
+        @instance = instance
+        @device = device
+        super
+      end
+
+      # @return [Volume] Returns the volume that is attached.
+      attr_reader :volume
+
+      # @return [Instance] Returns the EC2 instance the volume is attached to.
+      attr_reader :instance
+
+      # @return [String] Returns how the device is exposed to the instance
+      #   (e.g. '/dev/sdh')
+      attr_reader :device
+
+      # @overload status
+      # Returns the attachment status.  Possible values are:
+      #
+      #   * `:attaching`
+      #   * `:attached`
+      #   * `:detaching`
+      #   * `:detached`
+      # @return [Symbol] Returns the attachment status.
+      attribute :status, :to_sym => true
+
+      # @overload attach_time
+      # @return [Time] Returns the time at which this attachment was created.
+      attribute :attach_time
+
+      # @overload delete_on_termination?
+      # @return [Boolean] Returns `true` if the volume will be deleted
+      #   on instance termination.
+      attribute :delete_on_termination, :boolean => true
+
+      populates_from(:describe_volumes) do |resp|
+        find_attachment(resp)
+      end
+
+      populates_from(:attach_volume, :detach_volume) do |resp|
+        if
+          resp.volume_id == volume.id and
+          resp.instance_id == instance.id and
+          resp.device == device
+        then
+          resp
+        end
+      end
+
+      # @return [Boolean] Returns true if the attachment exists.
+      def exists?
+        !describe_attachment.nil?
+      end
+
+      # Detaches the volume from its instance.
+      # @option options [Boolean] :force Forces detachment if the
+      #   previous detachment attempt did not occur cleanly (logging
+      #   into an instance, unmounting the volume, and detaching
+      #   normally). This option can lead to data loss or a
+      #   corrupted file system. Use this option only as a last
+      #   resort to detach a volume from a failed instance. The
+      #   instance will not have an opportunity to flush file system
+      #   caches or file system metadata. If you use this option,
+      #   you must perform file system check and repair procedures.
+      def delete options = {}
+        client.detach_volume(options.merge(resource_options))
+      end
+
+      protected
+      def resource_identifiers
+        [
+          [:volume_id, volume.id],
+          [:instance_id, instance.id],
+          [:device, device],
+        ]
+      end
+
+      protected
+      def describe_call
+        client.describe_volumes(:volume_ids => [self.volume.id])
+      end
+
+      private
+      def describe_attachment
+        find_attachment(describe_call)
+      end
+
+      def find_attachment(resp)
+        vol = resp.volume_index[volume.id] and
+        attachments = vol.attachment_set and
+        attachments.find do |att|
+          att.instance_id == instance.id &&
+            att.volume_id == volume.id &&
+            att.device == device
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/attachment_collection.rb

@@ -0,0 +1,54 @@
+# 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
+
+    # Represents the collection of attachments for an Amazon EBS
+    # volume.
+    #
+    # @see Volume
+    class AttachmentCollection
+
+      include Core::Model
+      include Enumerable
+
+      attr_reader :volume
+
+      # @api private
+      def initialize volume, options = {}
+        @volume = volume
+        super
+      end
+
+      # @yield [attachment] Each attachment of the volume as an
+      #   {Attachment} object.
+      # @return [nil]
+      def each &block
+        volume.attachment_set.each do |item|
+
+          instance = Instance.new(item.instance_id, :config => config)
+
+          attachment = Attachment.new(self.volume, instance, item.device,
+            :config => config)
+
+          yield(attachment)
+
+        end
+        nil
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/availability_zone.rb

@@ -0,0 +1,86 @@
+# 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
+
+    # 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.
+    #
+    # @attr_reader [String,nil] region_name Returns the region name
+    #   of the availability zone.
+    #
+    # @attr_reader [Symbol] state Returns the state of the availability
+    #   zone, e.g. `:available`.
+    #
+    # @attr_reader [Array<String>] messages Returns a list of messages about the
+    #   Availability Zone.
+    #
+    class AvailabilityZone < Resource
+
+      # @param [String] name The name of the availability zone.
+      def initialize name, options = {}
+        @name = name
+        if options[:region]
+          options[:region_name] = options[:region].name
+        end
+        super
+      end
+
+      # @return [String] Returns the name of the availability zone,
+      #   e.g. "us-west-2a".
+      attr_reader :name
+
+      alias_method :to_s, :name
+
+      alias_method :to_str, :name
+
+      attribute :region_name, :static => true
+
+      attribute :state, :from => :zone_state, :to_sym => true
+
+      attribute :messages, :from => :message_set do
+        translates_output do |messages|
+          messages ? messages.collect{|m| m.message } : []
+        end
+      end
+
+      populates_from(:describe_availability_zones) do |resp|
+        resp.availability_zone_info.find {|az| az.zone_name == name }
+      end
+
+      # @return [Region] Returns the region of this availability zone.
+      def region
+        Region.new(self.region_name, :config => config)
+      end
+
+      protected
+      def describe_call_name
+        :describe_availability_zones
+      end
+
+      protected
+      def inflected_name
+        self.class.inflected_name
+      end
+
+      protected
+      def self.inflected_name
+        "zone"
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/availability_zone_collection.rb

@@ -0,0 +1,43 @@
+# 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
+
+    # 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_name => az.region_name,
+            :config => config)
+          yield(zone)
+        end
+        nil
+      end
+
+      # @api private
+      protected
+      def member_class
+        AvailabilityZone
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/block_device_mappings.rb

@@ -0,0 +1,53 @@
+# 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
+
+    # @api private
+    module BlockDeviceMappings
+
+      # @api 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,154 @@
+# 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
+
+    # Client class for Amazon Elastic Compute Cloud (EC2).
+    class Client < Core::QueryClient
+
+      API_VERSION = '2014-05-01'
+
+      signature_version :Version4, 'ec2'
+
+      def retryable_error?(response)
+        if response.error.is_a?(Errors::InsufficientInstanceCapacity)
+          false
+        else
+          super
+        end
+      end
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[
+        :describe_addresses,
+        :describe_availability_zones,
+        :describe_bundle_tasks,
+        :describe_customer_gateways,
+        :describe_dhcp_options,
+        :describe_image_attribute,
+        :describe_images,
+        :describe_instances,
+        :describe_key_pairs,
+        :describe_regions,
+        :describe_reserved_instances,
+        :describe_reserved_instances_offerings,
+        :describe_security_groups,
+        :describe_snapshot_attribute,
+        :describe_snapshots,
+        :describe_subnets,
+        :describe_volume_status,
+        :describe_volumes,
+        :describe_vpcs,
+        :describe_vpn_connections,
+        :describe_vpn_gateways,
+        :describe_instance_attribute,
+        :describe_spot_instance_requests,
+        :describe_spot_price_history,
+        :describe_spot_datafeed_subscription,
+        :describe_licenses,
+        :describe_placement_groups,
+        :describe_tags,
+        :describe_internet_gateways,
+        :describe_route_tables,
+        :describe_network_acls,
+        :describe_instance_status,
+        :describe_conversion_tasks,
+        :describe_network_interfaces,
+        :describe_network_interface_attribute,
+      ]
+
+      protected
+
+      # @return [Core::Signers::Version2]
+      def v2_signer
+        @v2_signer ||= Core::Signers::Version2.new(credential_provider)
+      end
+
+      # @return [Core::Signers::Version4]
+      def v4_signer
+        @v4_signer ||=
+          Core::Signers::Version4.new(credential_provider, 'ec2', @region)
+      end
+
+    end
+
+    class Client::V20130815 < Client
+      define_client_methods('2013-08-15')
+    end
+
+    class Client::V20131001 < Client
+      define_client_methods('2013-10-01')
+    end
+
+    class Client::V20131015 < Client
+      define_client_methods('2013-10-15')
+    end
+
+    class Client::V20140201 < Client
+      define_client_methods('2014-02-01')
+    end
+
+    class Client::V20140501 < Client
+
+      define_client_methods('2014-05-01')
+
+      alias basic_copy_snapshot copy_snapshot
+
+      def copy_snapshot(params = {})
+        # Adding logic to auto-compute the destination group and presigned
+        # url params for the copy snapshot operation.  This is necessary
+        # when calling copy snapshot on snapshots for encrypted volumes.
+        # This addition should be transparent to the API user.
+        params = params.dup
+        params[:destination_region] = @region
+        params[:presigned_url] = presigned_copy_snapshot_url(params)
+        basic_copy_snapshot(params)
+      end
+
+      private
+
+      def presigned_copy_snapshot_url(params)
+        token = credential_provider.session_token
+
+        client = self.with_options(:ec2_region => params[:source_region])
+
+        req = client.build_request(:copy_snapshot, params)
+
+        now = req.remove_param("Timestamp").value
+        now = Time.parse(now).strftime("%Y%m%dT%H%M%SZ")
+
+        req.add_param("X-Amz-Algorithm", "AWS4-HMAC-SHA256")
+        req.add_param("X-Amz-Date", now)
+        req.add_param("X-Amz-SignedHeaders", 'host')
+        req.add_param("X-Amz-Expires", "3600")
+        req.add_param('X-Amz-Security-Token', token) if token
+        req.add_param("X-Amz-Credential", client.v4_signer.credential(now))
+
+        req.http_method = 'GET'
+        req.uri = '/?' + req.url_encoded_params
+        req.body = ''
+        req.headers.clear
+        req.headers['host'] = client.config.ec2_endpoint
+
+        key = client.v4_signer.derive_key(now)
+        sig = client.v4_signer.signature(req, key, now, client.v4_signer.class::EMPTY_DIGEST)
+
+        req.add_param('X-Amz-Signature', sig)
+
+        req.endpoint + '/?' + req.url_encoded_params
+      end
+
+    end
+  end
+end