aws-sdk-v1 1.52.0

data/lib/aws/ec2/network_interface/attachment.rb

@@ -0,0 +1,100 @@
+# 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.
+
+require 'aws/ec2/network_interface/attachment'
+
+module AWS
+  class EC2
+    class NetworkInterface < Resource
+      class Attachment
+
+        def initialize network_interface, details
+          @network_interface = network_interface
+          @attachment_id = details[:attachment_id]
+          @instance = Instance.new(details[:instance_id],
+            :owner_id => details[:instance_owner_id],
+            :config => network_interface.config)
+          @instance_owner_id = details[:instance_owner_id]
+          @device_index = details[:device_index]
+          @status = details[:status].to_sym
+          @attach_time = details[:attach_time]
+          @delete_on_termination = details[:delete_on_termination]
+        end
+
+        # @return [String] Returns the attachment id.
+        attr_reader :attachment_id
+
+        alias_method :id, :attachment_id
+
+        # @return [NetworkInterface] Returns the network interface this
+        #   is an attachment for.
+        attr_reader :network_interface
+
+        # @return [Instance] Returns the instance the network interface
+        #   is attached to.
+        attr_reader :instance
+
+        # @return [String] Returns the instance owner id.
+        attr_reader :instance_owner_id
+
+        # @return [Integer] The index of the device for the network
+        #   interface attachment on the instance.
+        attr_reader :device_index
+
+        # @return [Symbol] Returns the attachment status.
+        attr_reader :status
+
+        # @return [Time]
+        attr_reader :attach_time
+
+        # @return [Boolean]
+        attr_reader :delete_on_termination
+
+        alias_method :delete_on_termination?, :delete_on_termination
+
+        # Allows you to toggle the delete on termination state.
+        #
+        #     network_interface.attachment.delete_on_termination = false
+        #
+        # @param [Boolean] state
+        #
+        def delete_on_termination= state
+          opts = {}
+          opts[:network_interface_id] = network_interface.id
+          opts[:attachment] = {}
+          opts[:attachment][:attachment_id] = id
+          opts[:attachment][:delete_on_termination] = state
+          network_interface.client.modify_network_interface_attribute(opts)
+        end
+
+        # Detaches the network interface from the instance.
+        #
+        # @param [Hash] options
+        #
+        # @option options [Boolean] :force (false) Set true to force
+        #   a detachment.
+        #
+        # @return [nil]
+        #
+        def detach options = {}
+          client_opts = {}
+          client_opts[:attachment_id] = attachment_id
+          client_opts[:force] = options[:force] == true
+          network_interface.client.detach_network_interface(client_opts)
+        end
+        alias_method :delete, :detach
+
+      end
+    end
+  end
+end

data/lib/aws/ec2/network_interface_collection.rb

@@ -0,0 +1,103 @@
+# 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 NetworkInterfaceCollection < Collection
+
+      include TaggedCollection
+      include Core::Collection::Simple
+
+      # Creates a network interface.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Subnet,String] :subnet The subnet or subnet id
+      #   to associate with the network interface.
+      #
+      # @option options [String] :private_ip_address The private IP address
+      #   of the network interface.
+      #
+      # @option options [String] :description The description of the
+      #   network interface.
+      #
+      # @option options [Array<SecurityGroup>,Array<String>] :security_groups
+      #   A list of security groups (or security group id strings) that
+      #   should be used by this network interface.
+      #
+      # @return [NetworkInterface]
+      #
+      def create options = {}
+
+        client_opts = {}
+
+        client_opts[:subnet_id] = subnet_id_option(options)
+
+        client_opts[:private_ip_address] = options[:private_ip_address] if
+          options.key?(:private_ip_address)
+
+        client_opts[:description] = options[:description] if
+          options.key?(:description)
+
+        groups = groups_options(options)
+        client_opts[:groups] = groups if groups
+
+        resp = client.create_network_interface(client_opts)
+
+        NetworkInterface.new_from(:create_network_interface,
+          resp.network_interface,
+          resp.network_interface.network_interface_id,
+          :config => config)
+
+      end
+
+      # @param [String] network_interface_id
+      # @return [NetworkInterface]
+      def [] network_interface_id
+        NetworkInterface.new(network_interface_id, :config => config)
+      end
+
+      protected
+      def groups_options options
+
+        # accept this option a variety of different ways
+        groups = options[:security_groups]
+        groups ||= options[:security_group_ids]
+        groups ||= options[:security_group]
+        groups ||= options[:security_group_id]
+
+        if groups
+          [groups].flatten.map{|sg| sg.is_a?(SecurityGroup) ? sg.id : sg }
+        else
+          nil
+        end
+
+      end
+
+      protected
+      def _each_item options = {}, &block
+        resp = filtered_request(:describe_network_interfaces, options, &block)
+        resp.network_interface_set.each do |n|
+
+          network_interface = NetworkInterface.new_from(
+            :describe_network_interfaces, n,
+            n.network_interface_id, :config => config)
+
+          yield(network_interface)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/permission_collection.rb

@@ -0,0 +1,174 @@
+# 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 permissions for an EC2 resource.
+    # Each permission is a string containing the AWS account ID of a
+    # user who has permission to use the resource in question.  The
+    # {Image} and {Snapshot} classes are currently the only ones
+    # that use this interface.
+    class PermissionCollection
+
+      include Core::Model
+      include Enumerable
+
+      # @api private
+      def initialize(resource, opts = {})
+        @resource = resource
+        super(opts)
+      end
+
+      # @yield [user_id] Each user ID that has explicit
+      #   permissions to launch this AMI.
+      def each(&block)
+        resp = client.send(describe_call, describe_params)
+        resp.send(inflected_permissions_attribute).each do |permission|
+          if permission[:user_id]
+            user_id = permission[:user_id]
+            yield(user_id)
+          end
+        end
+      end
+
+      # @return [Integer] The number of users that have explicit
+      #   permissions to launch this AMI.
+      def size
+        inject(0) { |sum, i| sum + 1 }
+      end
+
+      # @return [Boolean] True if the collection is empty.
+      def empty?
+        size == 0
+      end
+
+      # @return [Boolean] True if the resource is public.
+      def public?
+        resp = client.send(describe_call, describe_params)
+        resp.send(inflected_permissions_attribute).any? do |permission|
+          permission[:group] and permission[:group] == "all"
+        end
+      end
+
+      # @return [Boolean] True if the resource is private (i.e. not
+      #   public).
+      def private?
+        !public?
+      end
+
+      # Sets whether the resource is public or not.  This has no
+      # effect on the explicit AWS account IDs that may already have
+      # permissions to use the resource.
+      #
+      # @param [Boolean] value If true, the resource is made public,
+      #   otherwise the resource is made private.
+      # @return [nil]
+      def public= value
+        params = value ?
+          { :add => [{ :group => "all" }] } :
+          { :remove => [{ :group => "all" }] }
+        client.send(modify_call, modify_params(params))
+        nil
+      end
+
+      # Adds permissions for specific users to launch this AMI.
+      #
+      # @param [Array of Strings] users The AWS account IDs of the
+      #   users that should be able to launch this AMI.
+      # @return [nil]
+      def add(*users)
+        modify(:add, *users)
+      end
+
+      # Removes permissions for specific users to launch this AMI.
+      # @param [Array of Strings] users The AWS account IDs of the
+      #   users that should no longer be able to launch this AMI.
+      # @return [nil]
+      def remove(*users)
+        modify(:remove, *users)
+      end
+
+      # Resets the launch permissions to their default state.
+      # @return [nil]
+      def reset
+        client.send(reset_call, reset_params)
+      end
+
+      # @api private
+      private
+      def describe_call
+        "describe_#{resource_name}_attribute"
+      end
+
+      # @api private
+      private
+      def modify_call
+        "modify_#{resource_name}_attribute"
+      end
+
+      # @api private
+      private
+      def reset_call
+        "reset_#{resource_name}_attribute"
+      end
+
+      # @api private
+      private
+      def describe_params
+        Hash[[["#{resource_name}_id".to_sym, @resource.send(:__resource_id__)],
+              [:attribute, permissions_attribute]]]
+      end
+      alias_method :reset_params, :describe_params
+
+      # @api private
+      private
+      def inflected_permissions_attribute
+        Core::Inflection.ruby_name(permissions_attribute).to_sym
+      end
+
+      # @api private
+      private
+      def permissions_attribute
+        @resource.__permissions_attribute__
+      end
+
+      # @api private
+      private
+      def resource_name
+        @resource.send(:inflected_name)
+      end
+
+      # @api private
+      private
+      def modify(action, *users)
+        return if users.empty?
+        opts = modify_params(Hash[[[action,
+                                    users.map do |user_id|
+                                      { :user_id => user_id }
+                                    end]]])
+        client.send(modify_call, opts)
+        nil
+      end
+
+      # @api private
+      private
+      def modify_params(modifications)
+        Hash[[["#{resource_name}_id".to_sym, @resource.send(:__resource_id__)],
+              [inflected_permissions_attribute, modifications]]]
+      end
+
+    end
+
+  end
+end

data/lib/aws/ec2/region.rb

@@ -0,0 +1,106 @@
+# 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 region.  You can use this to find the
+    # endpoint for a given region:
+    #
+    #     ec2.regions["us-west-1"].endpoint
+    #
+    # Region also responds to all of the methods of {EC2} except
+    # {EC2#regions}; for example, to list instance IDs by region,
+    # you can do:
+    #
+    #     ec2.regions.inject({}) do |h,region|
+    #       h[region.name] = region.instances.map(&:id)
+    #       h
+    #     end
+    #
+    # @attr_reader [String] endpoint The endpoint to use for this region
+    #   (e.g. "ec2.eu-west-1.amazonaws.com").
+    #
+    class Region
+
+      def initialize name, options = {}
+        @name = name
+        @endpoint = options[:endpoint] || "ec2.#{name}.amazonaws.com"
+        @client = Client.new(options.merge(:endpoint => endpoint))
+        @config = @client.config
+      end
+
+      # @return [String] The name of the region (e.g. "us-west-2").
+      attr_reader :name
+
+      # @return [String]
+      attr_reader :endpoint
+
+      # @return [Client]
+      attr_reader :client
+
+      # @return [Core::Configuration]
+      attr_reader :config
+
+      # @return [Boolean] True if the region is available for this
+      #   account.
+      def exists?
+        client.describe_regions(:region_names => [name])
+        true
+      rescue Errors::InvalidParameterValue
+        false
+      end
+
+      # @param [Region] other
+      # @return [Boolean]
+      def eql? other
+        other.is_a?(Region) and
+        other.name == name and
+        other.endpoint == endpoint
+      end
+      alias_method :==, :eql?
+
+      PROXIED_METHODS = [
+        :instances,
+        :security_groups,
+        :key_pairs,
+        :elastic_ips,
+        :tags,
+        :availability_zones,
+        :images,
+        :volumes,
+        :snapshots,
+        :reserved_instances,
+        :reserved_instances_offerings,
+        :vpcs,
+        :subnets,
+        :network_acls,
+        :route_tables,
+        :network_interfaces,
+        :internet_gateways,
+        :customer_gateways,
+        :vpn_gateways,
+        :dhcp_options,
+        :vpn_connections,
+        :export_tasks,
+      ]
+
+      PROXIED_METHODS.each do |method|
+        define_method(method) do
+          EC2.new(:config => config).send(method)
+        end
+      end
+
+    end
+  end
+end