aws-sdk 1.8.5 → 1.9.0

data/lib/aws/ec2/route_table_collection.rb

@@ -24,7 +24,7 @@ module AWS
       # @param [Hash] options
       #
       # @option options [VPC,String] :vpc The vpc or vpc id of where you want
-      #   to create the route table. 
+      #   to create the route table.
       #
       # @return [RouteTable]
       #
@@ -32,7 +32,7 @@ module AWS
 
         client_opts = {}
         client_opts[:vpc_id] = vpc_id_option(options)
-        
+
         resp = client.create_route_table(client_opts)
 
         RouteTable.new_from(:create_route_table, resp.route_table,
@@ -59,7 +59,7 @@ module AWS
         response = filtered_request(:describe_route_tables, options, &block)
         response.route_table_set.each do |t|
 
-          route_table = RouteTable.new_from(:describe_route_tables, t, 
+          route_table = RouteTable.new_from(:describe_route_tables, t,
             t.route_table_id, :config => config)
 
           yield(route_table)

data/lib/aws/ec2/security_group.rb

@@ -29,12 +29,10 @@ module AWS
     #
     class SecurityGroup < Resource
 
-      AWS.register_autoloads(self, 'aws/ec2/security_group') do
-        autoload :IpPermission,                  'ip_permission'
-        autoload :IpPermissionCollection,        'ip_permission_collection'
-        autoload :IngressIpPermissionCollection, 'ip_permission_collection'
-        autoload :EgressIpPermissionCollection,  'ip_permission_collection'
-      end
+      autoload :IpPermission, 'aws/ec2/security_group/ip_permission'
+      autoload :IpPermissionCollection, 'aws/ec2/security_group/ip_permission_collection'
+      autoload :IngressIpPermissionCollection, 'aws/ec2/security_group/ip_permission_collection'
+      autoload :EgressIpPermissionCollection, 'aws/ec2/security_group/ip_permission_collection'
 
       include TaggedItem
 
@@ -155,14 +153,14 @@ module AWS
       # This example grants the whole internet (0.0.0.0/0) access to port 80
       # over TCP (HTTP web traffic).
       #
-      #   security_group.authorize_ingress(:tcp, 80)
+      #     security_group.authorize_ingress(:tcp, 80)
       #
       # You can specify port ranges as well:
       #
-      #   # ftp
-      #   security_group.authorize_ingress(:tcp, 20..21)
+      #     # ftp
+      #     security_group.authorize_ingress(:tcp, 20..21)
       #
-      # == Sources
+      # ## Sources
       #
       # Security groups accept ingress trafic from:
       #
@@ -170,60 +168,60 @@ module AWS
       # * security groups
       # * load balancers
       #
-      # === Ip Addresses
+      # ### Ip Addresses
       #
       # In the following example allow incoming SSH from a list of
       # IP address ranges.
       #
-      #   security_group.authorize_ingress(:tcp, 22,
-      #     '111.111.111.111/0', '222.222.222.222/0')
+      #     security_group.authorize_ingress(:tcp, 22,
+      #       '111.111.111.111/0', '222.222.222.222/0')
       #
-      # === Security Groups
+      # ### Security Groups
       #
       # To autohrize ingress traffic from all EC2 instance in another
       # security group, just pass the security group:
       #
-      #   web = security_groups.create('webservers')
-      #   db = security_groups.create('database')
-      #   db.authorize_ingress(:tcp, 3306, web)
+      #     web = security_groups.create('webservers')
+      #     db = security_groups.create('database')
+      #     db.authorize_ingress(:tcp, 3306, web)
       #
       # You can also pass a hash of security group details instead of
       # a {SecurityGroup} object.
       #
-      #   # by security group name
-      #   sg.authorize_ingress(:tcp, 80, { :group_name => 'other-group' })
+      #     # by security group name
+      #     sg.authorize_ingress(:tcp, 80, { :group_name => 'other-group' })
       #
-      #   # by security group id
-      #   sg.authorize_ingress(:tcp, 80, { :group_id => 'sg-1234567' })
+      #     # by security group id
+      #     sg.authorize_ingress(:tcp, 80, { :group_id => 'sg-1234567' })
       #
       # If the security group belongs to a different account, just make
       # sure it has the correct owner ID populated:
       #
-      #   not_my_sg = SecurityGroup.new('sg-1234567', :owner_id => 'abcxyz123')
-      #   my_sg.authorize_ingress(:tcp, 80, not_my_sg)
+      #     not_my_sg = SecurityGroup.new('sg-1234567', :owner_id => 'abcxyz123')
+      #     my_sg.authorize_ingress(:tcp, 80, not_my_sg)
       #
-      # You can do the same with a hash as well (with either +:group_id+
-      # or +:group_name+):
+      # You can do the same with a hash as well (with either `:group_id`
+      # or `:group_name`):
       #
-      #   sg.authorize_ingress(:tcp, 21..22, { :group_id => 'sg-id', :user_id => 'abcxyz123' })
+      #     sg.authorize_ingress(:tcp, 21..22, { :group_id => 'sg-id', :user_id => 'abcxyz123' })
       #
-      # === Load Balancers
+      # ### Load Balancers
       #
       # If you use ELB to manage load balancers, then you need to add
       # ingress permissions to the security groups they route traffic into.
       # You can do this by passing the {ELB::LoadBalancer} into
       # authorize_ingress:
       #
-      #   load_balancer = AWS::ELB.new.load_balancers['web-load-balancer']
+      #     load_balancer = AWS::ELB.new.load_balancers['web-load-balancer']
       #
-      #   sg.authorize_ingress(:tcp, 80, load_balancer)
+      #     sg.authorize_ingress(:tcp, 80, load_balancer)
       #
-      # === Multiple Sources
+      # ### Multiple Sources
       #
       # You can provide multiple sources each time you call authorize
       # ingress, and you can mix and match the source types:
       #
-      #   sg.authorize_ingress(:tcp, 80, other_sg, '1.2.3.4/0', load_balancer)
+      #     sg.authorize_ingress(:tcp, 80, other_sg, '1.2.3.4/0', load_balancer)
       #
       # @param [String, Symbol] protocol Should be :tcp, :udp or :icmp
       #   or the string equivalent.
@@ -236,10 +234,10 @@ module AWS
       #   security groups, or load balancers.  Security groups
       #   can be specified as hashes.
       #
-      #   A security group hash must provide either +:group_id+ or
-      #   +:group_name+ for the security group.  If the security group
+      #   A security group hash must provide either `:group_id` or
+      #   `:group_name` for the security group.  If the security group
       #   does not belong to you aws account then you must also
-      #   provide +:user_id+ (which can be an AWS account ID or alias).
+      #   provide `:user_id` (which can be an AWS account ID or alias).
       #
       # @return [nil]
       #
@@ -269,12 +267,12 @@ module AWS
 
       # Authorize egress (outbound) traffic for a VPC security group.
       #
-      #   # allow traffic for all protocols/ports from the given sources
-      #   security_group.authorize_egress('10.0.0.0/16', '10.0.0.1/16')
+      #     # allow traffic for all protocols/ports from the given sources
+      #     security_group.authorize_egress('10.0.0.0/16', '10.0.0.1/16')
       #
-      #   # allow tcp traffic outband via port 80
-      #   security_group.authorize_egress('10.0.0.0/16',
-      #     :protocol => :tcp, :ports => 80..80)
+      #     # allow tcp traffic outband via port 80
+      #     security_group.authorize_egress('10.0.0.0/16',
+      #       :protocol => :tcp, :ports => 80..80)
       #
       # @note Calling this method on a non-VPC security group raises an error.
       #
@@ -288,7 +286,7 @@ module AWS
       #
       #   @option options [Symbol] :protocol (:any) The protocol name or number
       #     to authorize egress traffic for.  For a complete list of protocols
-      #     see: {http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml}
+      #     see: [protocol-numbers.xml](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml)
       #
       #   @option options [Range<Integer>,Integer] :ports (nil) An optional
       #     port or range of ports.  This option is required depending on
@@ -386,7 +384,7 @@ module AWS
             # hashes at the end of egress methods could be a hash intedned
             # to be a source, like:
             #
-            #   { :group_id => ..., :user_id => ... }
+            #     { :group_id => ..., :user_id => ... }
             #
             options = args.pop
           else

data/lib/aws/ec2/security_group_collection.rb

@@ -19,15 +19,15 @@ module AWS
 
       include TaggedCollection
 
-      # Creates a new 
+      # Creates a new
       # @param [String] name The name of the security group to create.
       # @param [Hash] options
-      # @option options [String] :description An informal description 
+      # @option options [String] :description An informal description
       #   of this security group.  Accepts alphanumeric characters, spaces,
       #   dashes, and underscores. If left blank the description will be set
       #   to the name.
       #
-      # @option options [VPC,String] :vpc (nil) A VPC or VPC id string to 
+      # @option options [VPC,String] :vpc (nil) A VPC or VPC id string to
       #   create the security group in.  When specified a VPC security
       #   group is created.
       #
@@ -68,41 +68,41 @@ module AWS
       # A subsequent call to #each will limit the security groups returned
       # by the set of filters.
       #
-      # If you supply multiple values to #filter then these values are 
+      # If you supply multiple values to #filter then these values are
       # treated as an OR condition.  To return security groups named
       # 'test' or 'fake':
       #
-      #   security_groups.filter('group-name', 'test', 'fake')
+      #     security_groups.filter('group-name', 'test', 'fake')
       #
       # If you want to and conditions together you need to chain calls to
       # filter.  To limit security groups to those with a name like
       # 'test' and like 'ruby':
       #
-      #   security_groups.
-      #     filter('group-name', '*test*').
-      #     filter('group-name', '*ruby*').each do |group|
-      #     #...
-      #   end
-      #  
+      #     security_groups.
+      #       filter('group-name', '*test*').
+      #       filter('group-name', '*ruby*').each do |group|
+      #       #...
+      #     end
+      #
       # Note that * matches one or more characters and ? matches any one
       # character.
       #
-      # === Valid Filters
+      # ### Valid Filters
       #
       # * description - Description of the security group.
       # * group-id - ID of the security group.
       # * group-name - Name of the security group.
-      # * ip-permission.cidr - CIDR range that has been granted the 
+      # * ip-permission.cidr - CIDR range that has been granted the
       #   permission.
-      # * ip-permission.from-port - Start of port range for the TCP and UDP 
+      # * ip-permission.from-port - Start of port range for the TCP and UDP
       #    protocols, or an ICMP type number.
-      # * ip-permission.group-name - Name of security group that has been 
+      # * ip-permission.group-name - Name of security group that has been
       #   granted the permission.
-      # * ip-permission.protocol - IP protocol for the permission. Valid 
+      # * ip-permission.protocol - IP protocol for the permission. Valid
       #   values include 'tcp', 'udp', 'icmp' or a protocol number.
-      # * ip-permission.to-port - End of port range for the TCP and UDP 
+      # * ip-permission.to-port - End of port range for the TCP and UDP
       #   protocols, or an ICMP code.
-      # * ip-permission.user-id - ID of AWS account that has been granted 
+      # * ip-permission.user-id - ID of AWS account that has been granted
       #   the permission.
       # * owner-id - AWS account ID of the owner of the security group.
       # * tag-key - Key of a tag assigned to the security group.
@@ -110,8 +110,6 @@ module AWS
       #
       # @return [SecurityGroupCollection] A new collection that represents
       #   a subset of the security groups associated with this account.
-
-      # Yields once for each security group in this account. 
       #
       # @yield [group]
       # @yieldparam [SecurityGroup] group
@@ -121,7 +119,7 @@ module AWS
         response = filtered_request(:describe_security_groups)
         response.security_group_info.each do |info|
 
-          group = SecurityGroup.new_from(:describe_security_groups, info, 
+          group = SecurityGroup.new_from(:describe_security_groups, info,
             info.group_id, :config => config)
 
           yield(group)

data/lib/aws/ec2/snapshot.rb

@@ -31,9 +31,9 @@ module AWS
     # @attr_reader [Symbol] status The status of the snapshot.
     #   Possible values:
     #
-    #   * +:pending+
-    #   * +:completed+
-    #   * +:error+
+    #     * `:pending`
+    #     * `:completed`
+    #     * `:error`
     #
     # @attr_reader [Time] start_time The time at which the snapshot
     #   was initiated.

data/lib/aws/ec2/snapshot_collection.rb

@@ -19,14 +19,14 @@ module AWS
     # {EC2#snapshots}.
     #
     # @example Create a snapshot from a volume
-    #  ec2.snapshots.create(:volume => ec2.volumes["vol-123"],
-    #                       :description => "my snapshot")
-    #  # or:
-    #  ec2.volumes["vol-123"].create_snapshot("my snapshot")
+    #   ec2.snapshots.create(:volume => ec2.volumes["vol-123"],
+    #                        :description => "my snapshot")
+    #   # or:
+    #   ec2.volumes["vol-123"].create_snapshot("my snapshot")
     #
     # @example Get a snapshot by ID
-    #  snapshot = ec2.snapshots["vol-123"]
-    #  snapshot.exists?
+    #   snapshot = ec2.snapshots["vol-123"]
+    #   snapshot.exists?
     #
     # @example Get a map of snapshot IDs to snapshot status
     #   ec2.snapshots.inject({}) { |m, s| m[i.id] = s.status; m }
@@ -60,7 +60,7 @@ module AWS
 
       # @return [SnapshotCollection] A new collection that only
       #   includes snapshots owned by one or more of the specified AWS
-      #   accounts.  The IDs +:amazon+ and +:self+ can be used to
+      #   accounts.  The IDs `:amazon` and `:self` can be used to
       #   include snapshots owned by Amazon or AMIs owned by you,
       #   respectively.
       #
@@ -72,9 +72,9 @@ module AWS
 
       # @return [ImageCollection] A new collection that only includes
       #   images for which the specified user ID has explicit launch
-      #   permissions. The user ID can be an AWS account ID, +:self+
+      #   permissions. The user ID can be an AWS account ID, `:self`
       #   to return AMIs for which the sender of the request has
-      #   explicit launch permissions, or +:all+ to return AMIs with
+      #   explicit launch permissions, or `:all` to return AMIs with
       #   public launch permissions.
       #
       # @param [Array of Strings] users The AWS account IDs by which
@@ -87,13 +87,12 @@ module AWS
       # Amazon S3. You can use snapshots for backups, to make
       # identical copies of instance devices, and to save data
       # before shutting down an instance. For more information about
-      # Amazon EBS, go to the {Amazon Elastic Compute Cloud User
-      # Guide}[http://docs.amazonwebservices.com/AWSEC2/latest/UserGuide/index.html?using-ebs.html].
+      # Amazon EBS, go to the [Amazon Elastic Compute Cloud User Guide](http://docs.amazonwebservices.com/AWSEC2/latest/UserGuide/index.html?using-ebs.html).
       #
       # @return [Snapshot] An object representing the new snapshot.
       #
       # @param [Hash] opts Options for creating the snapshot.
-      #   Either +:volume+ or +:volume_id+ is required.
+      #   Either `:volume` or `:volume_id` is required.
       #
       # @option opts [Volume] :volume The Amazon EBS volume of which
       #   to take a snapshot.

data/lib/aws/ec2/subnet.rb

@@ -82,7 +82,7 @@ module AWS
         associations.first{|a| a.subnet == self }
       end
 
-      # @return [RouteTable] Returns the route table currently associated 
+      # @return [RouteTable] Returns the route table currently associated
       #   with this subnet.
       def route_table
         route_table_association.route_table
@@ -111,7 +111,7 @@ module AWS
         if assoc.main?
           client_opts[:subnet_id] = subnet_id
           response = client.associate_route_table(client_opts)
-          association_id = response.association_id 
+          association_id = response.association_id
         else
           client_opts[:association_id] = assoc.association_id
           resp = client.replace_route_table_association(client_opts)

data/lib/aws/ec2/subnet_collection.rb

@@ -19,32 +19,32 @@ module AWS
     # all your VPCs).  You can also get a subnet collection that represents
     # subnets within a single vpc.
     #
-    #   # represents all subnets
-    #   subnets = ec2.subnets
+    #     # represents all subnets
+    #     subnets = ec2.subnets
     #
-    #   # represents subnets within the named vpc
-    #   subnets = ec2.vpcs['vpc-12345'].subnets
+    #     # represents subnets within the named vpc
+    #     subnets = ec2.vpcs['vpc-12345'].subnets
     #
-    # == Creating a Subnet
+    # ## Creating a Subnet
     #
     # To create a subnet, call {#create} on a subnet collection, passing in
     # a suitable CIDR block.
     #
-    #   subnet = subnets.create('10.0.0.0/20')
+    #     subnet = subnets.create('10.0.0.0/20')
     #
     # You can optionally pass the availability zone you want the subnet
     # created in.
     #
-    # == Getting a Subnet
+    # ## Getting a Subnet
     #
     # If you know the subnet id, you can get a subnet using {#[]}.
     #
-    #   subnet = subnets['subnet-id-here']
+    #     subnet = subnets['subnet-id-here']
     #
-    # You can filter subnets as well.  See the EC2 API documentation 
+    # You can filter subnets as well.  See the EC2 API documentation
     # (http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSubnets.html) for a complete list of accepted filters.
     #
-    #   subnet = subnets.filter('state', 'available').first
+    #     subnet = subnets.filter('state', 'available').first
     #
     class SubnetCollection < Collection
 
@@ -53,7 +53,7 @@ module AWS
 
       # Creates a Subnet.  Subnets require a valid CIDR block and
       # are created inside a VPC.  If this collection does not
-      # have a 
+      # have a
       #
       # @param [String] cidr_block The CIDR block you want the subnet to
       #   cover (e.g., 10.0.0.0/24).
@@ -63,8 +63,8 @@ module AWS
       # @option options [VPC,String] :vpc The VPC (or VPC id string) to
       #   create the subnet in.
       #
-      # @option options [String,AvailabilityZone] :availability_zone 
-      #   The Availability Zone you want the subnet in. 
+      # @option options [String,AvailabilityZone] :availability_zone
+      #   The Availability Zone you want the subnet in.
       #   AWS selects a default zone for you (recommended).
       #
       # @return [Subnet]
@@ -74,12 +74,12 @@ module AWS
         client_opts = {}
         client_opts[:vpc_id] = vpc_id_option(options)
         client_opts[:cidr_block] = cidr_block
-        client_opts[:availability_zone] = az_option(options) if 
+        client_opts[:availability_zone] = az_option(options) if
           options[:availability_zone]
 
         resp = client.create_subnet(client_opts)
 
-        Subnet.new_from(:create_subnet, resp.subnet, 
+        Subnet.new_from(:create_subnet, resp.subnet,
           resp.subnet.subnet_id, :config => config)
 
       end
@@ -93,7 +93,7 @@ module AWS
       protected
       def az_option options
         options[:availability_zone].is_a?(AvailabilityZone) ?
-          options[:availability_zone].name : 
+          options[:availability_zone].name :
           options[:availability_zone]
       end
 
@@ -102,7 +102,7 @@ module AWS
         response = filtered_request(:describe_subnets, options, &block)
         response.subnet_set.each do |s|
 
-          subnet = Subnet.new_from(:describe_subnets, 
+          subnet = Subnet.new_from(:describe_subnets,
             s, s.subnet_id, :config => config)
 
           yield(subnet)