aws-sdk 1.8.5 → 1.9.0

data/lib/aws/ec2/config.rb

@@ -13,6 +13,6 @@
 
 AWS::Core::Configuration.module_eval do
 
-  add_service 'EC2', 'ec2', 'ec2.amazonaws.com'
+  add_service 'EC2', 'ec2', 'ec2.%s.amazonaws.com'
 
 end

data/lib/aws/ec2/customer_gateway.rb

@@ -14,16 +14,16 @@
 module AWS
   class EC2
 
-    # @attr_reader [Symbol] state Returns the gateway state (e.g. 
+    # @attr_reader [Symbol] state Returns the gateway state (e.g.
     #   :pending, :available, :deleting, :deleted)
     #
-    # @attr_reader [String] type The type of VPN connection the customer 
+    # @attr_reader [String] type The type of VPN connection the customer
     #   gateway supports (e.g. 'ipsec.1').
     #
-    # @attr_reader [String] ip_address The Internet-routable IP address of 
+    # @attr_reader [String] ip_address The Internet-routable IP address of
     #   the customer gateway's outside interface.
     #
-    # @attr_reader [Integer] bgp_asn The customer gateway's Border Gateway 
+    # @attr_reader [Integer] bgp_asn The customer gateway's Border Gateway
     #   Protocol (BGP) Autonomous System Number (ASN).
     #
     class CustomerGateway < Resource
@@ -40,7 +40,7 @@ module AWS
       attr_reader :customer_gateway_id
 
       alias_method :id, :customer_gateway_id
-    
+
       attribute :state, :to_sym => true
 
       attribute :vpn_type, :static => true
@@ -54,7 +54,7 @@ module AWS
       end
 
       populates_from(:describe_customer_gateways) do |resp|
-        resp.customer_gateway_set.find do |gateway| 
+        resp.customer_gateway_set.find do |gateway|
           gateway.customer_gateway_id == customer_gateway_id
         end
       end

data/lib/aws/ec2/customer_gateway_collection.rb

@@ -19,15 +19,15 @@ module AWS
       include TaggedCollection
       include Core::Collection::Simple
 
-      # @param [Integer] bgp_asn The customer gateway's Border Gateway 
+      # @param [Integer] bgp_asn The customer gateway's Border Gateway
       #   Protocol (BGP) Autonomous System Number (ASN).
       #
-      # @param [String] ip_address The Internet-routable IP address for the 
+      # @param [String] ip_address The Internet-routable IP address for the
       #   customer gateway's outside interface. The address must be static.
       #
       # @param [Hash] options
-      # 
-      # @option options [String] :vpn_type ('ipsec.1') The type of VPN 
+      #
+      # @option options [String] :vpn_type ('ipsec.1') The type of VPN
       #   connection this customer gateway supports.
       #
       # @return [CustomerGateway]
@@ -41,7 +41,7 @@ module AWS
 
         resp = client.create_customer_gateway(client_opts)
 
-        CustomerGateway.new_from(:create_customer_gateway, 
+        CustomerGateway.new_from(:create_customer_gateway,
           resp.customer_gateway,
           resp.customer_gateway.customer_gateway_id,
           :config => config)
@@ -60,7 +60,7 @@ module AWS
         response = filtered_request(:describe_customer_gateways, options, &block)
         response.customer_gateway_set.each do |g|
 
-          gateway = CustomerGateway.new_from(:describe_customer_gateways, g, 
+          gateway = CustomerGateway.new_from(:describe_customer_gateways, g,
             g.customer_gateway_id, :config => config)
 
           yield(gateway)

data/lib/aws/ec2/dhcp_options.rb

@@ -32,13 +32,13 @@ module AWS
       attribute :dhcp_configuration_set, :static => true
 
       protected :dhcp_configuration_set
-    
+
       populates_from(:create_dhcp_options) do |resp|
         resp.dhcp_options if resp.dhcp_options.dhcp_options_id == id
       end
 
       populates_from(:describe_dhcp_options) do |resp|
-        resp.dhcp_options_set.find do |dhcp_options| 
+        resp.dhcp_options_set.find do |dhcp_options|
           dhcp_options.dhcp_options_id == dhcp_options_id
         end
       end
@@ -78,7 +78,7 @@ module AWS
         client.delete_dhcp_options(client_opts)
         nil
       end
-      
+
       # @return [VPCCollection] Returns a collection that represents
       #   all VPCs currently using this dhcp options.
       def vpcs

data/lib/aws/ec2/dhcp_options_collection.rb

@@ -25,20 +25,20 @@ module AWS
       #   choice (e.g., example.com).
       #
       # @option options [Array<String>] :domain_name_servers
-      #   The IP addresses of domain name servers. You can specify up to 
+      #   The IP addresses of domain name servers. You can specify up to
       #   four addresses.
       #
-      # @option options [Array<String>] :ntp_servers 
-      #   The IP addresses of Network Time Protocol (NTP) servers. You can 
+      # @option options [Array<String>] :ntp_servers
+      #   The IP addresses of Network Time Protocol (NTP) servers. You can
       #   specify up to four addresses.
       #
-      # @option options [Array<String>] :netbios_name_servers 
-      #   The IP addresses of NetBIOS name servers. You can specify up to 
+      # @option options [Array<String>] :netbios_name_servers
+      #   The IP addresses of NetBIOS name servers. You can specify up to
       #   four addresses.
       #
-      # @option options [String] :netbios_node_type Value indicating the 
-      #   NetBIOS node type (1, 2, 4, or 8). For more information about the 
-      #   values, go to RFC 2132. We recommend you only use 2 at this time 
+      # @option options [String] :netbios_node_type Value indicating the
+      #   NetBIOS node type (1, 2, 4, or 8). For more information about the
+      #   values, go to RFC 2132. We recommend you only use 2 at this time
       #   (broadcast and multicast are currently not supported).
       #
       def create options = {}
@@ -55,7 +55,7 @@ module AWS
 
         resp = client.create_dhcp_options(client_opts)
 
-        DHCPOptions.new_from(:create_dhcp_options, 
+        DHCPOptions.new_from(:create_dhcp_options,
           resp.dhcp_options,
           resp.dhcp_options.dhcp_options_id,
           :config => config)
@@ -74,7 +74,7 @@ module AWS
         response = filtered_request(:describe_dhcp_options, options, &block)
         response.dhcp_options_set.each do |opts|
 
-          options = DHCPOptions.new_from(:describe_dhcp_options, opts, 
+          options = DHCPOptions.new_from(:describe_dhcp_options, opts,
             opts.dhcp_options_id, :config => config)
 
           yield(options)

data/lib/aws/ec2/elastic_ip.rb

@@ -14,23 +14,23 @@
 module AWS
   class EC2
 
-    # @attr_reader [String,nil] instance_id Returns the instance id if 
+    # @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 
+    #   The ID representing the allocation of the address for use with Amazon
     #   VPC.
     #
-    # @attr_reader [String] domain Indicates whether this elastic ip address 
+    # @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 
+    # @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 
+    # @attr_reader [String,nil] network_interface_id The ID of the network
     #   interface (VPC only).
     #
-    # @attr_reader [String,nil] network_interface_owner_id 
+    # @attr_reader [String,nil] network_interface_owner_id
     #   The ID of the AWS account that owns the network interface (VPC only).
     #
     class ElasticIp < Resource
@@ -47,7 +47,7 @@ module AWS
 
       attribute :instance_id
 
-      ## vpc related attributes
+      # vpc related attributes
 
       attribute :allocation_id, :static => true
 
@@ -85,7 +85,7 @@ module AWS
       end
 
       # @return [NetworkInterface,nil] Returns the network interface this
-      #   elastic ip is associated with.  Returns +nil+ if this is not
+      #   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
@@ -95,7 +95,7 @@ module AWS
 
       # Releases the elastic IP address.
       #
-      # (For non-VPC elastic ips) Releasing an IP address automatically 
+      # (For non-VPC elastic ips) Releasing an IP address automatically
       # disassociates it from any instance it's associated with.
       #
       # @return [nil]
@@ -110,19 +110,19 @@ module AWS
       alias_method :release, :delete
 
       # Associates this elastic IP address with an instance or a network
-      # interface.  You may provide +:instance+ or +:network_interface+
+      # interface.  You may provide `:instance` or `:network_interface`
       # but not both options.
       #
-      #   # associate with an instance
-      #   eip.associate :instance => 'i-12345678'
+      #     # associate with an instance
+      #     eip.associate :instance => 'i-12345678'
       #
-      #   # associate with a network interface
-      #   eip.associate :network_interface => 'ni-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.  
+      #   or an {Instance} object.
       #
       # @option options [String,NetworkInterface] :network_interface The id
       #   of a network interface or a {NetworkInterface} object.

data/lib/aws/ec2/elastic_ip_collection.rb

@@ -17,7 +17,7 @@ module AWS
 
       # @param [Hash] options
       #
-      # @option options [Boolean] :vpc (false) When true, the elastic ip 
+      # @option options [Boolean] :vpc (false) When true, the elastic ip
       #   address will be allocated to your VPC.
       #
       # @return [ElasticIp]
@@ -44,31 +44,27 @@ module AWS
       # 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.
+      #   * 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.
       #
-      # * '*' matches one or more characters and '?' matches any one
-      #   character.
+      # ### Valid Filters
       #
-      # === Valid Filters
-      #
-      # * domain - Whether the address is a EC2 address, or a VPC address. 
+      # * 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 
+      # * allocation-id - Allocation ID for the address. For VPC addresses
       #   only.
-      # * association-id - Association ID for the address. For VPC addresses 
+      # * 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

data/lib/aws/ec2/export_task.rb

@@ -20,15 +20,15 @@ module AWS
     # @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 
+    # @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 
+    # @attr_reader [String] target_environment The target virtualization
     #   environment.
     #
-    # @attr_reader [String] disk_image_format The format for the exported 
+    # @attr_reader [String] disk_image_format The format for the exported
     #   image.
     #
     # @attr_reader [String] container_format The container format used to
@@ -59,7 +59,7 @@ module AWS
 
       attribute :status_message
 
-      attribute :instance_id, 
+      attribute :instance_id,
         :from => [:instance_export, :instance_id],
         :static => true
 

data/lib/aws/ec2/export_task_collection.rb

@@ -14,26 +14,26 @@
 module AWS
   class EC2
 
-    # = Getting Export Tasks
+    # # Getting Export Tasks
     #
     # Allows you to enumerate export tasks.
     #
-    #   ec2.export_tasks.each do |task|
-    #     # yield ExportTask objects
-    #   end
+    #     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']
+    #     task = ec2.export_tasks['export-task-id']
     #
-    # = Creating Export Tasks
+    # # Creating Export Tasks
     #
     # To create an export task you start with the {Instance}:
     #
-    #   task = ec2.instances['i-12345678'].export_to_s3('bucket-name')
+    #     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
@@ -50,11 +50,11 @@ module AWS
       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, 
+            :describe_export_tasks,
             details,
-            details[:export_task_id], 
+            details[:export_task_id],
             :config => config)
 
           yield(task)

data/lib/aws/ec2/filtered_collection.rb

@@ -25,14 +25,12 @@ module AWS
       # 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.
+      #   * 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

data/lib/aws/ec2/image.rb

@@ -24,24 +24,27 @@ module AWS
     # @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
+    #   state is `:available`, the image is successfully registered
     #   and available for launching.  Valid values:
-    #   * +:available+
-    #   * +:pending+
-    #   * +:failed+
+    #
+    #     * `: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.
+    #   `"amazon"`) or AWS account ID that owns the AMI.
+    #
+    # @attr_reader [Symbol] architecture The architecture of the
+    #   image (e.g. `:i386`).
     #
-    # @attr_reader [Symbol] architecture The architecture of the 
-    #   image (e.g. +:i386+).
+    # @attr_reader [Symbol] type The type of image.
+    #   Valid values are:
     #
-    # @attr_reader [Symbol] type The type of image.  Valid values are:
-    #   * +:machine+
-    #   * +:kernel+
-    #   * +:ramdisk+
+    #     * `:machine`
+    #     * `:kernel`
+    #     * `:ramdisk`
     #
     # @attr_reader [String] kernel_id The kernel ID associated with
     #   the image, if any. Only applicable for machine images.
@@ -49,34 +52,36 @@ module AWS
     # @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
+    # @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.
+    #     * `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+
+    #
+    #     * `:ebs`
+    #     * `:instance_store`
     #
     # @attr_reader [String] root_device_name The root device name
-    #   (e.g., +"/dev/sda1"+, or +"xvda"+).
+    #   (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.  
+    #     * `:paravirtual`
+    #     * `:hvm`
+    #
+    # @attr_reader [Symbol] hypervisor The image's hypervisor type.
     #   Possible values are:
-    #   * +:ovm+
-    #   * +:xen+
+    #
+    #     * `:ovm`
+    #     * `:xen`
     #
     # @attr_reader [Array<String>] product_codes Returns an array of
     #   product codes attached to this instance.
@@ -86,14 +91,16 @@ module AWS
       include TaggedItem
       include HasPermissions
 
-      # @private
-      def initialize id, options = {}
-        @id = id
+      # @param [String] image_id
+      def initialize image_id, options = {}
+        @image_id = image_id
         super
       end
 
       # @return [String] The ID of the AMI.
-      attr_reader :id
+      attr_reader :image_id
+
+      alias_method :id, :image_id
 
       attribute :name, :static => true
 
@@ -146,17 +153,16 @@ module AWS
       # @note This method will not return data for ephemeral volumes.
       # @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
+      #   the device name (e.g. `"/dev/sda1"`) and the value is an
       #   hash with the following keys 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).
+      #     * `: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.
       #
-      #   [:volume_size] The size of the volume, in GiBs.
-      #
-      #   [:delete_on_termination] True if the Amazon EBS volume is
-      #                           deleted on instance termination.
       # @see {#block_devices}
       def block_device_mappings
         (block_device_mapping || []).inject({}) do |h, mapping|
@@ -183,7 +189,7 @@ module AWS
 
       alias_method :delete, :deregister
 
-      # Runs a single instance of this image.  
+      # Runs a single instance of this image.
       #
       # @param [Hash] options
       # @option (see InstanceCollection#create)
@@ -208,7 +214,7 @@ module AWS
         run_instance(options.merge(:count => count))
       end
 
-      # @return [Boolean] Returns +true+ if the AMI exists (is returned by
+      # @return [Boolean] Returns `true` if the AMI exists (is returned by
       #   the DescribeImages action).
       def exists?
         resp = client.describe_images(:filters => [
@@ -235,13 +241,13 @@ module AWS
 
       # Adds one or more product codes:
       #
-      #   image.add_product_codes 'ABCXYZ', 'MNOPQR'
+      #     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 
+      #     image.add_product_codes ['ABCXYZ', 'MNOPQR']
+      #
+      # @param [Array<String>] product_codes
       #
       # @return [nil]
       #