aws-sdk 1.8.5 → 1.9.0

data/lib/aws/dynamo_db/table_collection.rb

@@ -17,14 +17,14 @@ module AWS
     # Represents the tables in your account.  Each table is
     # represented by an instance of the {Table} class.
     #
-    # == Schemas
+    # ## Schemas
     #
     # Before you can operate on items in a table you must specify the schema.
     # You do this by calling #hash_key= (and optionally #range_key=) on
     # a table.
     #
-    #   table = dynamo_db.tables['mytable']
-    #   table.hash_key = [:id, :string]
+    #     table = dynamo_db.tables['mytable']
+    #     table.hash_key = [:id, :string]
     #
     # @example Creating a Table
     #   table = dynamo_db.tables.create('mytable', 10, 10, :hash_key => { :id => :string })
@@ -41,12 +41,12 @@ module AWS
 
       # Creates a new table.
       #
-      #   table = dynamo_db.tables.create('mytable', 25, 25,
-      #     :hash_key => { :id => :string })
+      #     table = dynamo_db.tables.create('mytable', 25, 25,
+      #       :hash_key => { :id => :string })
       #
       # @note Creating a table is an eventualy consistent operation.  You
       #   can not interact with the table until its status
-      #   ({Table#status}) is +:active+.
+      #   ({Table#status}) is `:active`.
       #
       # @param [String] name The name of the table.
       #
@@ -63,22 +63,22 @@ module AWS
       #   hash key on the string attribute username you would call #create
       #   with:
       #
-      #      :hash_key => { :username => :string }
+      #       :hash_key => { :username => :string }
       #
-      #   The other supported types are +:number+ and +:binary+.  If you
+      #   The other supported types are `:number` and `:binary`.  If you
       #   wanted to set the hash key on a numeric (integer) attribute then you
       #   could call #create with:
       #
-      #      :hash_key => { :id => :number }
+      #       :hash_key => { :id => :number }
       #
-      #   All tables require a hash key.  If +:hash_key+ is not provided
+      #   All tables require a hash key.  If `:hash_key` is not provided
       #   then a default hash key will be provided.  The default hash
       #   key is:
       #
-      #      :hash_key => { :id => :string }
+      #       :hash_key => { :id => :string }
       #
       # @option options [String] :range_key You can setup a table to use
-      #   composite keys by providing a +:range_key+.  Range keys are
+      #   composite keys by providing a `:range_key`.  Range keys are
       #   configured the same way as hash keys.  They are useful
       #   for ordering items that share the same hash key.
       #
@@ -103,7 +103,7 @@ module AWS
 
       # References a table by name.
       #
-      #   dynamo_db.tables["MyTable"]
+      #     dynamo_db.tables["MyTable"]
       #
       # @param [String] name
       # @return [Table] Returns the table with the given name.

data/lib/aws/ec2.rb

@@ -18,40 +18,40 @@ module AWS
 
   # Provides an expressive, object-oriented interface to Amazon EC2.
   #
-  # == Credentials
+  # ## Credentials
   #
   # You can setup default credentials for all AWS services via
   # AWS.config:
   #
-  #   AWS.config(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
   # Or you can set them directly on the EC2 interface:
   #
-  #   ec2 = AWS::EC2.new(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     ec2 = AWS::EC2.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
-  # == Instances
+  # ## Instances
   #
   # EC2 uses instances to run your software.
   #
   # To run an instance:
   #
-  #   ec2.instances.create(:image_id => "ami-8c1fece5")
+  #     ec2.instances.create(:image_id => "ami-8c1fece5")
   #
   # To get an instance by ID:
   #
-  #   i = ec2.instances["i-12345678"]
-  #   i.exists?
+  #     i = ec2.instances["i-12345678"]
+  #     i.exists?
   #
   # To get a list of instances:
   #
-  #   ec2.instances.inject({}) { |m, i| m[i.id] = i.status; m }
-  #   # => { "i-12345678" => :running, "i-87654321" => :shutting_down }
+  #     ec2.instances.inject({}) { |m, i| m[i.id] = i.status; m }
+  #     # => { "i-12345678" => :running, "i-87654321" => :shutting_down }
   #
-  # == Security Groups
+  # ## Security Groups
   #
   # A security group is a named collection of access rules. These access
   # rules specify which ingress (i.e., incoming) network traffic should be
@@ -59,40 +59,40 @@ module AWS
   #
   # To create a security group:
   #
-  #   websvr = ec2.security_groups.create('webservers')
+  #     websvr = ec2.security_groups.create('webservers')
   #
   # Then you can add ingress authorizations.  In the following example
   # we add a rule that allows web traffic from the entire internet.
   #
-  #   # web traffic
-  #   websvr.authorize_ingress(:tcp, 80)
+  #     # web traffic
+  #     websvr.authorize_ingress(:tcp, 80)
   #
   # You can also specify a port range.  Here we are opening FTP traffic:
   #
-  #   # ftp traffic
-  #   websvr.authorize_ingress(:tcp, 20..21)
+  #     # ftp traffic
+  #     websvr.authorize_ingress(:tcp, 20..21)
   #
   # If you want to limit an authorization to a particular CIDR IP address or
   # list of address, just add them to the #authorize_ingress call.
   #
-  #   # ssh access
-  #   websrvr.authorize_ingress(:tcp, 22, '1.1.1.1/0', '2.2.2.2/0')
+  #     # ssh access
+  #     websrvr.authorize_ingress(:tcp, 22, '1.1.1.1/0', '2.2.2.2/0')
   #
   # You can also provide another security group instead of CIDR IP addresses.
   # This allows incoming traffic from EC2 instances in the given security
   # group(s).
   #
-  #   # get two existing security groups
-  #   dbsvrs = ec2.security_groups.filter('group-name', 'db-servers').first
-  #   websvrs = ec2.security_groups.filter('group-name', 'web-servers').first
+  #     # get two existing security groups
+  #     dbsvrs = ec2.security_groups.filter('group-name', 'db-servers').first
+  #     websvrs = ec2.security_groups.filter('group-name', 'web-servers').first
   #
-  #   # allow instances in the 'web-servers' security group to connect
-  #   # to instances in the 'db-servers' security group over tcp port 3306
-  #   dbsvrs.authorize_ingress(:tcp, 3306, websvrs)
+  #     # allow instances in the 'web-servers' security group to connect
+  #     # to instances in the 'db-servers' security group over tcp port 3306
+  #     dbsvrs.authorize_ingress(:tcp, 3306, websvrs)
   #
   # There are a few handy shortcuts for allowing pings:
   #
-  #   wbsvrs.allow_ping
+  #     wbsvrs.allow_ping
   #
   # Just like with authorize_ingress you can pass a security group or a list
   # of CIDR IP addresses to allow ping to limit where you can ping from.
@@ -100,32 +100,32 @@ module AWS
   # You can also use the same parameters from the examples above to
   # {SecurityGroup#revoke_ingress} and {SecurityGroup#disallow_ping}.
   #
-  # You can specify other protocols than +:tcp+, like :udp and :icmp.
+  # You can specify other protocols than `:tcp`, like :udp and :icmp.
   #
-  # == Elastic IPs
+  # ## Elastic IPs
   #
   # You can allocate up to 5 elastic IP addresses for each account.
   # You can associate those elastic IP addresses with EC2 instances:
   #
-  #   instance = ec2.instances['i-12345678']
-  #   ip = ec2.elastic_ips.allocate
+  #     instance = ec2.instances['i-12345678']
+  #     ip = ec2.elastic_ips.allocate
   #
-  #   instance.ip_address                # 1.1.1.1
-  #   ip.ip_address                      # 2.2.2.2
+  #     instance.ip_address                # 1.1.1.1
+  #     ip.ip_address                      # 2.2.2.2
   #
-  #   instance.associate_elastic_ip(ip)
-  #   instance.ip_address                # 2.2.2.2
+  #     instance.associate_elastic_ip(ip)
+  #     instance.ip_address                # 2.2.2.2
   #
-  #   instance.disassociate_elastic_ip
-  #   instance.ip_address                # 1.1.1.1
+  #     instance.disassociate_elastic_ip
+  #     instance.ip_address                # 1.1.1.1
   #
   # When you are done with an elastic IP address you should release it.
-  # In the following example we release all elastic IP addresses that are 
+  # In the following example we release all elastic IP addresses that are
   # not currently associated with an instance:
   #
-  #   ec2.select{|ip| !ip.associated? }.each(&:release)
+  #     ec2.select{|ip| !ip.associated? }.each(&:release)
   #
-  # == Key Pairs
+  # ## Key Pairs
   #
   # Public Amazon Machine Image (AMI) instances have no password, and you need a
   # public/private key pair to log in to them. The public key half
@@ -135,36 +135,35 @@ module AWS
   # You can generate a key pair yourself and then send the public
   # part to EC2 using {KeyPairCollection#import}.  For example:
   #
-  #   key_pair =
-  #     ec2.key_pairs.import("mykey", File.read("~/.ssh/identity.pub"))
+  #     key_pair = ec2.key_pairs.import("mykey", File.read("~/.ssh/identity.pub"))
   #
   # You can also ask EC2 to generate a key pair for you.  For
   # example:
   #
-  #   key_pair = ec2.key_pairs.create("mykey")
-  #   File.open("~/.ssh/ec2", "w") do |f|
-  #     f.write(key_pair.private_key)
-  #   end
+  #     key_pair = ec2.key_pairs.create("mykey")
+  #     File.open("~/.ssh/ec2", "w") do |f|
+  #       f.write(key_pair.private_key)
+  #     end
   #
-  # == Filtering and Tagging
+  # ## Filtering and Tagging
   #
   # Any of the collections in the interface may be filtered by a
   # number of different parameters.  For example, to get all the
   # windows images owned by amazon where the description includes
   # the string "linux", you can do this:
   #
-  #   ec2.images.with_owner("amazon").
-  #     filter("platform", "windows").
-  #     filter("description", "*linux*")
+  #     ec2.images.with_owner("amazon").
+  #       filter("platform", "windows").
+  #       filter("description", "*linux*")
   #
   # Similarly, you can tag images, instances, security groups,
   # snapshots, and volumes with free-form key-value metadata and
   # filter on that metadata.  For example:
   #
-  #   ec2.images["ami-123"].tags << "myapp"
-  #   ec2.images.tagged("myapp")             # will include ami-123
+  #     ec2.images["ami-123"].tags << "myapp"
+  #     ec2.images.tagged("myapp")             # will include ami-123
   #
-  # == Regions
+  # ## Regions
   #
   # Amazon has data centers in different areas of the world (e.g.,
   # North America, Europe, Asia, etc.). Correspondingly, EC2 is
@@ -172,29 +171,20 @@ module AWS
   # separate Regions, you can design your application to be closer
   # to specific customers or to meet legal or other
   # requirements. Prices for Amazon EC2 usage vary by Region (for
-  # more information about pricing by Region, go to the {Amazon EC2
-  # Pricing page}[http://aws.amazon.com/ec2/pricing]).  You can use
-  # the Ruby SDK to see which regions are available for your
+  # more information about pricing by Region, go to the
+  # [Amazon EC2 Pricing page](http://aws.amazon.com/ec2/pricing)).
+  # You can use the Ruby SDK to see which regions are available for your
   # account:
   #
-  #  ec2.regions.map(&:name)            # => ["us-east-1", ...]
+  #     ec2.regions.map(&:name)            # => ["us-east-1", ...]
   #
-  # The default region is +us-east-1+; you can access other regions
+  # The default region is `us-east-1`; you can access other regions
   # like this:
   #
-  #  ec2_us_west = ec2.regions["us-west-1"]
-  #  # starts an instance in eu-west-1
-  #  ec2_us_west.instances.create(:image_id => 'ami-3bc9997e')
+  #     ec2 = AWS::EC2.new(:region => "us-west-1")
+  #     ec2.instances.create(:image_id => 'ami-3bc9997e')
   #
-  # This makes a call to EC2's DescribeRegions API to find the
-  # endpoint for "us-west-1" -- if you just want to configure a
-  # different endpoint without making a call to EC2, you can do it
-  # like this:
-  #
-  #  ec2 = AWS::EC2.new(:ec2_endpoint =>
-  #                             "ec2.us-west-1.amazonaws.com")
-  #
-  # == Availability Zones
+  # ## Availability Zones
   #
   # Each Region contains multiple distinct locations called
   # Availability Zones. Each Availability Zone is engineered to be
@@ -208,9 +198,9 @@ module AWS
   # about the available zones available to your account.  For
   # example:
   #
-  #  ec2.availability_zones.map(&:name)   # => ["us-east-1a", ...]
+  #     ec2.availability_zones.map(&:name)   # => ["us-east-1a", ...]
   #
-  # == Images
+  # ## Images
   #
   # An Amazon Machine Image (AMI) contains all information necessary
   # to boot instances of your software. For example, an AMI might
@@ -222,85 +212,85 @@ module AWS
   # You can use the {#images} collection to get information about
   # the images available to your account.  For example:
   #
-  #  ec2.images.with_owner("amazon").map(&:name)
+  #     ec2.images.with_owner("amazon").map(&:name)
   #
   # You can also use the images collection to create new images:
   #
-  #  ec2.images.create(:image_location => "mybucket/manifest.xml",
-  #                    :name => "my-image")
+  #     ec2.images.create(
+  #      :image_location => "mybucket/manifest.xml",
+  #      :name => "my-image")
   #
   # @!attribute [r] client
   #   @return [Client] the low-level EC2 client object
   class EC2
 
-    AWS.register_autoloads(self) do
-      autoload :Attachment, 'attachment'
-      autoload :AttachmentCollection, 'attachment_collection'
-      autoload :AvailabilityZone, 'availability_zone'
-      autoload :AvailabilityZoneCollection, 'availability_zone_collection'
-      autoload :BlockDeviceMappings, 'block_device_mappings'
-      autoload :Client, 'client'
-      autoload :Collection, 'collection'
-      autoload :ConfigTransform, 'config_transform'
-      autoload :CustomerGateway, 'customer_gateway'
-      autoload :CustomerGatewayCollection, 'customer_gateway_collection'
-      autoload :DHCPOptions, 'dhcp_options'
-      autoload :DHCPOptionsCollection, 'dhcp_options_collection'
-      autoload :ElasticIp, 'elastic_ip'
-      autoload :ElasticIpCollection, 'elastic_ip_collection'
-      autoload :Errors, 'errors'
-      autoload :ExportTask, 'export_task'
-      autoload :ExportTaskCollection, 'export_task_collection'
-      autoload :FilteredCollection, 'filtered_collection'
-      autoload :HasPermissions, 'has_permissions'
-      autoload :Image, 'image'
-      autoload :ImageCollection, 'image_collection'
-      autoload :Instance, 'instance'
-      autoload :InstanceCollection, 'instance_collection'
-      autoload :InternetGateway, 'internet_gateway'
-      autoload :InternetGatewayCollection, 'internet_gateway_collection'
-      autoload :KeyPair, 'key_pair'
-      autoload :KeyPairCollection, 'key_pair_collection'
-      autoload :NetworkACL, 'network_acl'
-      autoload :NetworkACLCollection, 'network_acl_collection'
-      autoload :NetworkInterface, 'network_interface'
-      autoload :NetworkInterfaceCollection, 'network_interface_collection'
-      autoload :PermissionCollection, 'permission_collection'
-      autoload :Region, 'region'
-      autoload :RegionCollection, 'region_collection'
-      autoload :Request, 'request'
-      autoload :ReservedInstances, 'reserved_instances'
-      autoload :ReservedInstancesCollection, 'reserved_instances_collection'
-      autoload :ReservedInstancesOffering, 'reserved_instances_offering'
-      autoload :ReservedInstancesOfferingCollection, 
-        'reserved_instances_offering_collection'
-      autoload :Resource, 'resource'
-      autoload :ResourceObject, 'tag_collection'
-      autoload :ResourceTagCollection, 'resource_tag_collection'
-      autoload :RouteTable, 'route_table'
-      autoload :RouteTableCollection, 'route_table_collection'
-      autoload :SecurityGroup, 'security_group'
-      autoload :SecurityGroupCollection, 'security_group_collection'
-      autoload :Snapshot, 'snapshot'
-      autoload :SnapshotCollection, 'snapshot_collection'
-      autoload :Subnet, 'subnet'
-      autoload :SubnetCollection, 'subnet_collection'
-      autoload :Tag, 'tag'
-      autoload :TagCollection, 'tag_collection'
-      autoload :TaggedCollection, 'tagged_collection'
-      autoload :TaggedItem, 'tagged_item'
-      autoload :Volume, 'volume'
-      autoload :VolumeCollection, 'volume_collection'
-      autoload :VPC, 'vpc'
-      autoload :VPCCollection, 'vpc_collection'
-      autoload :VPNConnection, 'vpn_connection'
-      autoload :VPNConnectionCollection, 'vpn_connection_collection'
-      autoload :VPNGateway, 'vpn_gateway'
-      autoload :VPNGatewayCollection, 'vpn_gateway_collection'
-    end
+    autoload :Attachment, 'aws/ec2/attachment'
+    autoload :AttachmentCollection, 'aws/ec2/attachment_collection'
+    autoload :AvailabilityZone, 'aws/ec2/availability_zone'
+    autoload :AvailabilityZoneCollection, 'aws/ec2/availability_zone_collection'
+    autoload :BlockDeviceMappings, 'aws/ec2/block_device_mappings'
+    autoload :Client, 'aws/ec2/client'
+    autoload :Collection, 'aws/ec2/collection'
+    autoload :ConfigTransform, 'aws/ec2/config_transform'
+    autoload :CustomerGateway, 'aws/ec2/customer_gateway'
+    autoload :CustomerGatewayCollection, 'aws/ec2/customer_gateway_collection'
+    autoload :DHCPOptions, 'aws/ec2/dhcp_options'
+    autoload :DHCPOptionsCollection, 'aws/ec2/dhcp_options_collection'
+    autoload :ElasticIp, 'aws/ec2/elastic_ip'
+    autoload :ElasticIpCollection, 'aws/ec2/elastic_ip_collection'
+    autoload :Errors, 'aws/ec2/errors'
+    autoload :ExportTask, 'aws/ec2/export_task'
+    autoload :ExportTaskCollection, 'aws/ec2/export_task_collection'
+    autoload :FilteredCollection, 'aws/ec2/filtered_collection'
+    autoload :HasPermissions, 'aws/ec2/has_permissions'
+    autoload :Image, 'aws/ec2/image'
+    autoload :ImageCollection, 'aws/ec2/image_collection'
+    autoload :Instance, 'aws/ec2/instance'
+    autoload :InstanceCollection, 'aws/ec2/instance_collection'
+    autoload :InternetGateway, 'aws/ec2/internet_gateway'
+    autoload :InternetGatewayCollection, 'aws/ec2/internet_gateway_collection'
+    autoload :KeyPair, 'aws/ec2/key_pair'
+    autoload :KeyPairCollection, 'aws/ec2/key_pair_collection'
+    autoload :NetworkACL, 'aws/ec2/network_acl'
+    autoload :NetworkACLCollection, 'aws/ec2/network_acl_collection'
+    autoload :NetworkInterface, 'aws/ec2/network_interface'
+    autoload :NetworkInterfaceCollection, 'aws/ec2/network_interface_collection'
+    autoload :PermissionCollection, 'aws/ec2/permission_collection'
+    autoload :Region, 'aws/ec2/region'
+    autoload :RegionCollection, 'aws/ec2/region_collection'
+    autoload :Request, 'aws/ec2/request'
+    autoload :ReservedInstances, 'aws/ec2/reserved_instances'
+    autoload :ReservedInstancesCollection, 'aws/ec2/reserved_instances_collection'
+    autoload :ReservedInstancesOffering, 'aws/ec2/reserved_instances_offering'
+    autoload :ReservedInstancesOfferingCollection, 'aws/ec2/reserved_instances_offering_collection'
+    autoload :Resource, 'aws/ec2/resource'
+    autoload :ResourceObject, 'aws/ec2/tag_collection'
+    autoload :ResourceTagCollection, 'aws/ec2/resource_tag_collection'
+    autoload :RouteTable, 'aws/ec2/route_table'
+    autoload :RouteTableCollection, 'aws/ec2/route_table_collection'
+    autoload :SecurityGroup, 'aws/ec2/security_group'
+    autoload :SecurityGroupCollection, 'aws/ec2/security_group_collection'
+    autoload :Snapshot, 'aws/ec2/snapshot'
+    autoload :SnapshotCollection, 'aws/ec2/snapshot_collection'
+    autoload :Subnet, 'aws/ec2/subnet'
+    autoload :SubnetCollection, 'aws/ec2/subnet_collection'
+    autoload :Tag, 'aws/ec2/tag'
+    autoload :TagCollection, 'aws/ec2/tag_collection'
+    autoload :TaggedCollection, 'aws/ec2/tagged_collection'
+    autoload :TaggedItem, 'aws/ec2/tagged_item'
+    autoload :Volume, 'aws/ec2/volume'
+    autoload :VolumeCollection, 'aws/ec2/volume_collection'
+    autoload :VPC, 'aws/ec2/vpc'
+    autoload :VPCCollection, 'aws/ec2/vpc_collection'
+    autoload :VPNConnection, 'aws/ec2/vpn_connection'
+    autoload :VPNConnectionCollection, 'aws/ec2/vpn_connection_collection'
+    autoload :VPNGateway, 'aws/ec2/vpn_gateway'
+    autoload :VPNGatewayCollection, 'aws/ec2/vpn_gateway_collection'
 
     include Core::ServiceInterface
 
+    endpoint_prefix 'ec2'
+
     # @return [InstanceCollection] A collection representing all instances
     def instances
       InstanceCollection.new(:config => config)
@@ -371,7 +361,7 @@ module AWS
       SnapshotCollection.new(:config => config)
     end
 
-    # @return [VPCCollection] A collection representing 
+    # @return [VPCCollection] A collection representing
     #   all VPCs in your account.
     def vpcs
       VPCCollection.new(:config => config)