aws-sdk 1.8.5 → 1.9.0

data/lib/aws/auto_scaling/launch_configuration.rb

@@ -37,7 +37,7 @@ module AWS
     # @attr_reader [String,nil] user_data
     #
     # @attr_reader [Array<Hash>] block_device_mappings
-    # 
+    #
     # @attr_reader [String] iam_instance_profile
     #
     # @attr_reader [String] spot_price
@@ -88,8 +88,8 @@ module AWS
         translates_output{|mappings| mappings.map(&:to_hash) }
       end
 
-      attribute :security_group_details, 
-        :from => :security_groups, 
+      attribute :security_group_details,
+        :from => :security_groups,
         :static => true
 
       protected :security_group_details

data/lib/aws/auto_scaling/launch_configuration_collection.rb

@@ -21,7 +21,7 @@ module AWS
 
       # Creates an Auto Scaling launch configuration.
       #
-      #   auto_scaling.launch_configurations.create('name', 'ami-12345', 'm1.small')
+      #     auto_scaling.launch_configurations.create('name', 'ami-12345', 'm1.small')
       #
       # @param [String] name The name of the launch configuration to create.
       #

data/lib/aws/auto_scaling/notification_configuration.rb

@@ -40,8 +40,8 @@ module AWS
 
       # Updates the notification configuration with a new list of types:
       #
-      #   config = auto_scaling_group.notification_configurations.first
-      #   config.notification_types = %w(autoscaling:EC2_INSTANCE_LAUNCH)
+      #     config = auto_scaling_group.notification_configurations.first
+      #     config.notification_types = %w(autoscaling:EC2_INSTANCE_LAUNCH)
       #
       # @return [nil]
       #

data/lib/aws/auto_scaling/notification_configuration_collection.rb

@@ -16,39 +16,38 @@ module AWS
 
     # Allows you to enumerate and create notification configurations.#
     #
-    # == Enumerating Notification Configurations
+    # ## Enumerating Notification Configurations
     #
     # You can enumerated *ALL* configurations from the AWS::AutoScaling class.
     #
-    #   auto_scaling = AWS::AutoScaling.new
-    #   auto_scaling.notification_configurations.each do |config|
-    #     # ...
-    #   end
+    #     auto_scaling = AWS::AutoScaling.new
+    #     auto_scaling.notification_configurations.each do |config|
+    #       # ...
+    #     end
     #
     # You can also limit them to a single Auto Scaling group:
     #
-    #   group = auto_scaling.groups['group-name']
-    #   group.notification_configurations.each do |config|
-    #     # ...
-    #   end
-    # 
-    # == Creating Notification Configurations
+    #     group = auto_scaling.groups['group-name']
+    #     group.notification_configurations.each do |config|
+    #       # ...
+    #     end
+    #
+    # ## Creating Notification Configurations
     #
     # You can create a notification configuration like so:
     #
-    #   auto_scaling.notification_configurations.create(
-    #     :group => 'auto-scaling-group-name',
-    #     :topic => 'sns-topic-arn')
+    #     auto_scaling.notification_configurations.create(
+    #       :group => 'auto-scaling-group-name',
+    #       :topic => 'sns-topic-arn')
     #
     # Just like with enumeration, you can create them from the Auto
     # Scaling group:
     #
-    #   group.notification_configurations.create(:topic => 'sns-topic-arn')
-    #
+    #     group.notification_configurations.create(:topic => 'sns-topic-arn')
     class NotificationConfigurationCollection
 
       include Core::Collection::WithLimitAndNextToken
-      
+
       # @private
       def initialize options = {}
         @group = options[:group]
@@ -68,32 +67,32 @@ module AWS
       # Creates a new notification configuration. To create a notification
       # configuration you need an {SNS::Topic} and an Auto Scaling {Group}.
       #
-      #   auto_scaling.notification_configurations.create(
-      #     :group => 'auto-scaling-group-name', 
-      #     :topic => 'sns-topic-arn')
+      #     auto_scaling.notification_configurations.create(
+      #       :group => 'auto-scaling-group-name',
+      #       :topic => 'sns-topic-arn')
       #
       # You can also create notification configurations from an Auto Scaling
-      # group and omit the +:group+ option.
+      # group and omit the `:group` option.
       #
-      #   auto_scaling_group.notification_configurations.create(
-      #     :topic => 'sns-topic-arn')
+      #     auto_scaling_group.notification_configurations.create(
+      #       :topic => 'sns-topic-arn')
       #
-      # You may also pass a list of notification types to publish to the 
+      # You may also pass a list of notification types to publish to the
       # topic.  If you omit this option, then all notification types
       # will be configured.
       #
-      #   # publish only these two specific notification types
-      #   auto_scaling_group.notification_configurations.create(
-      #     :topic => 'sns-topic-arn',
-      #     :types => [
-      #       'autoscaling:EC2_INSTANCE_LAUNCH',
-      #       'autoscaling:EC2_INSTANCE_TERMINATE',
-      #     ]
-      #   )
+      #     # publish only these two specific notification types
+      #     auto_scaling_group.notification_configurations.create(
+      #       :topic => 'sns-topic-arn',
+      #       :types => [
+      #         'autoscaling:EC2_INSTANCE_LAUNCH',
+      #         'autoscaling:EC2_INSTANCE_TERMINATE',
+      #       ]
+      #     )
       #
       # @param [Hash] options
       #
-      # @option options [required,SNS::Topic,String] :topic An {SNS::Topic} 
+      # @option options [required,SNS::Topic,String] :topic An {SNS::Topic}
       #   object or a topic arn string.  Notifications will be published
       #   to this topic.
       #
@@ -107,8 +106,8 @@ module AWS
       # @return [NotificationConfiguration]
       #
       def create options = {}
-        
-        topic_arn = options[:topic].is_a?(SNS::Topic) ? 
+
+        topic_arn = options[:topic].is_a?(SNS::Topic) ?
           options[:topic].arn : options[:topic]
 
         unless group = @group
@@ -130,7 +129,7 @@ module AWS
       end
       alias_method :put, :create
 
-      # @yield [notification_config] 
+      # @yield [notification_config]
       # @yieldparam [NotificationConfiguration] notification_config
       def each &block
 
@@ -143,7 +142,7 @@ module AWS
         # rest in the next page.
         #
         # So instead we will request and group them all before yielding.
-        # 
+        #
 
         next_token = nil
 
@@ -169,7 +168,7 @@ module AWS
 
         groups.each_pair do |group_name, topics|
           topics.each_pair do |topic_arn, types|
-            
+
             notification_config = NotificationConfiguration.new(
               Group.new(group_name, :config => config), topic_arn, types)
 

data/lib/aws/auto_scaling/scaling_policy.rb

@@ -14,7 +14,7 @@
 module AWS
   class AutoScaling
 
-    # 
+    #
     # @attr_reader [String] arn
     #
     # @attr_reader [String] adjustment_type
@@ -66,7 +66,7 @@ module AWS
       attribute :min_adjustment_step
 
       populates_from(:describe_policies) do |resp|
-        resp.scaling_policies.find do |p| 
+        resp.scaling_policies.find do |p|
           p.policy_name == name and
           p.auto_scaling_group_name == group.name
         end
@@ -89,7 +89,7 @@ module AWS
       # @param [Hash] options
       #
       # @option options [Boolean] :honor_cooldown (false) Set to true if you
-      #   want Auto Scaling to reject this request when the Auto Scaling 
+      #   want Auto Scaling to reject this request when the Auto Scaling
       #   group is in cooldown.
       #
       # @raise [Errors::ScalingActivityInProgress]

data/lib/aws/auto_scaling/scaling_policy_collection.rb

@@ -17,7 +17,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
       include ScalingPolicyOptions
-      
+
       def initialize auto_scaling_group, options = {}
         @group = auto_scaling_group
         super
@@ -28,7 +28,7 @@ module AWS
 
       alias_method :auto_scaling_group, :group
 
-    
+
       # @param [String] name The name of the policy you want to create or update.
       # @param (see ScalingPolicyOptions#scaling_policy_options)
       # @option (see ScalingPolicyOptions#scaling_policy_options)
@@ -45,7 +45,7 @@ module AWS
       def [] policy_name
         ScalingPolicy.new(group, policy_name)
       end
-      
+
       protected
 
       def _each_item next_token, limit, options = {}, &block
@@ -56,13 +56,13 @@ module AWS
 
         resp = client.describe_policies(options)
         resp.scaling_policies.each do |details|
-          
+
           scaling_policy = ScalingPolicy.new_from(
-            :describe_policies, details, 
+            :describe_policies, details,
             group, details.policy_name)
 
           yield(scaling_policy)
-          
+
         end
         resp.data[:next_token]
       end

data/lib/aws/auto_scaling/scaling_policy_options.rb

@@ -25,19 +25,20 @@ module AWS
       # @option options [required,String] :adjustment_type Specifies whether
       #   the adjustment is an absolute number or a percentage of the current
       #   capacity.  Valid values are:
-      #   * 'ChangeInCapacity'
-      #   * 'ExactCapacity'
-      #   * 'PercentChangeInCapacity'
+      #
+      #     * 'ChangeInCapacity'
+      #     * 'ExactCapacity'
+      #     * 'PercentChangeInCapacity'
       #
       # @option options [required,Integer] :scaling_adjustment The number of
-      #   instances by which to scale. +:adjustment_type+ determines the 
+      #   instances by which to scale. `:adjustment_type` determines the
       #   interpretation of this umber (e.g., as an absolute number or as a
-      #   percentage of the existing Auto Scaling group size). A positive 
-      #   increment adds to the current capacity and a negative value 
+      #   percentage of the existing Auto Scaling group size). A positive
+      #   increment adds to the current capacity and a negative value
       #   removes from the current capacity.
       #
       # @option options [Integer] :cooldown The amount of time, in seconds,
-      #   after a scaling activity completes before any further 
+      #   after a scaling activity completes before any further
       #   trigger-related scaling activities can start.
       #
       # @option options [Integer] :min_adjustment_step

data/lib/aws/auto_scaling/scheduled_action.rb

@@ -71,7 +71,7 @@ module AWS
       end
 
       # Updates the scheduled action.  If you omit an option,
-      # the corresponding value remains unchanged in the Auto 
+      # the corresponding value remains unchanged in the Auto
       # Scaling group.
       #
       # @param [Hash] options
@@ -96,7 +96,7 @@ module AWS
         client_opts[:scheduled_action_name] = name
         client_opts[:auto_scaling_group_name] = auto_scaling_group_name
 
-        # convert these options to timestamps 
+        # convert these options to timestamps
         [:start_time, :end_time].each do |opt|
           if client_opts[opt].is_a?(Time)
             client_opts[opt] = client_opts[opt].iso8601
@@ -112,7 +112,7 @@ module AWS
 
       # @return [Boolean]
       def exists?
-        client_opts = {}  
+        client_opts = {}
         client_opts[:scheduled_action_names] = [name]
         resp = client.describe_scheduled_actions(client_opts)
         !resp.scheduled_update_group_actions.empty?

data/lib/aws/auto_scaling/scheduled_action_collection.rb

@@ -19,26 +19,26 @@ module AWS
     class ScheduledActionCollection
 
       include Core::Collection::WithLimitAndNextToken
-      
+
       # @private
       def initialize options = {}
         @filters = options[:filters] || {}
         super
       end
 
-      # Creates a scheduled scaling action for an Auto Scaling group. 
+      # Creates a scheduled scaling action for an Auto Scaling group.
       # If you leave a parameter unspecified, the corresponding attribute
       # remains unchanged in the group.
       #
       # You must specify an Auto Scaling group.  This can be implicit
       # or explicit:
       #
-      #   # given explicitly
-      #   auto_scaling.scheduled_actions.create('action-name', :group => 'group-name')
+      #     # given explicitly
+      #     auto_scaling.scheduled_actions.create('action-name', :group => 'group-name')
       #
-      #   # implied by the group
-      #   group = auto_scaling.groups.first
-      #   group.scheduled_actions.create('action-name')
+      #     # implied by the group
+      #     group = auto_scaling.groups.first
+      #     group.scheduled_actions.create('action-name')
       #
       # @param [String] name
       #
@@ -55,14 +55,14 @@ module AWS
       # @option options [String] :recurrence
       #
       # @option options [Time] :start_time
-      # 
+      #
       # @option options [Time] :end_time
       #
       # @return [ScheduledAction]
       #
       def create name, options = {}
-        
-        scheduled_action = ScheduledAction.new(name, 
+
+        scheduled_action = ScheduledAction.new(name,
           :auto_scaling_group_name => auto_scaling_group_name_opt(options),
           :config => config)
 
@@ -86,37 +86,37 @@ module AWS
       # Returns a new {ScheduledActionCollection} filtered
       # by the given options.
       #
-      #   auto_scaling.scheduled_actions.filter(:end_time => Time.now).each do |a|
-      #      # ...
-      #   end
+      #     auto_scaling.scheduled_actions.filter(:end_time => Time.now).each do |a|
+      #        # ...
+      #     end
       #
       # You can chain filter calls:
       #
-      #   actions = auto_scaling.scheduled_actions.
-      #      filter(:group => 'auto-scaling-group-name').
-      #      filter(:start_time => Time.now - 3600).
-      #      filter(:end_time => Time.now)
+      #     actions = auto_scaling.scheduled_actions.
+      #        filter(:group => 'auto-scaling-group-name').
+      #        filter(:start_time => Time.now - 3600).
+      #        filter(:end_time => Time.now)
+      #
+      #     actions.each {|scheduled_action| ... }
       #
-      #   actions.each {|scheduled_action| ... }
-      # 
       # @param [Hash] filters
       #
       # @option filters [Group,String] :group
       #
       # @option filters [Array<String>] :scheduled_actions
-      #    A list of scheduled actions to be described. If this list is 
-      #    omitted, all scheduled actions are described. The list of 
-      #    requested scheduled actions cannot contain more than 50 items. 
-      #    If an Auto Scaling group name is provided, 
-      #    the results are limited to that group. If unknown scheduled 
+      #    A list of scheduled actions to be described. If this list is
+      #    omitted, all scheduled actions are described. The list of
+      #    requested scheduled actions cannot contain more than 50 items.
+      #    If an Auto Scaling group name is provided,
+      #    the results are limited to that group. If unknown scheduled
       #    actions are requested, they are ignored with no error.
       #
       # @option options [Time,String] :start_time The earliest scheduled
-      #   start time to return. If +:scheduled_actions+ is provided, 
+      #   start time to return. If `:scheduled_actions` is provided,
       #   this field will be ignored.  Should be a Time object or
       #   an iso8601 string.
       #
-      # @option filters [Time,String] :end_time 
+      # @option filters [Time,String] :end_time
       #
       # @return [ScheduledActionCollection] Returns a scheduled action
       #   collection that will filter the actions returned by the
@@ -175,7 +175,7 @@ module AWS
 
         resp = client.describe_scheduled_actions(options.merge(@filters))
         resp.scheduled_update_group_actions.each do |details|
-          
+
           scheduled_action = ScheduledAction.new_from(
             :describe_scheduled_actions,
             details,
@@ -183,7 +183,7 @@ module AWS
             :config => config)
 
           yield(scheduled_action)
-          
+
         end
 
         resp.data[:next_token]

data/lib/aws/auto_scaling/tag_collection.rb

@@ -16,47 +16,47 @@ module AWS
 
     # Provides an interface for enumerating tags defined in Auto Scaling.
     #
-    #   auto_scaling = AWS::AutoScaling.new
-    #   auto_scaling.tags.each do |tag|
-    #      puts "#{tag.key}:#{tag.value}"
-    #   end
+    #     auto_scaling = AWS::AutoScaling.new
+    #     auto_scaling.tags.each do |tag|
+    #        puts "#{tag.key}:#{tag.value}"
+    #     end
     #
-    # == Filters
+    # ## Filters
     #
     # You can filter the tags returned using {#filter}:
     #
-    #   # returns tags with the key "role"
-    #   auto_scaling.filter(:key, 'role').to_a
+    #     # returns tags with the key "role"
+    #     auto_scaling.filter(:key, 'role').to_a
     #
-    #   # returns tags with the key "role" and value "webserver"
-    #   auto_scaling.filter(:key, 'role').filter(:value, 'webserver')to_a
+    #     # returns tags with the key "role" and value "webserver"
+    #     auto_scaling.filter(:key, 'role').filter(:value, 'webserver')to_a
     #
-    #   # returns tags with the Auto Scaling group name "group1"
-    #   auto_scaling.filter(:auto_scaling_group, 'group1').to_a
+    #     # returns tags with the Auto Scaling group name "group1"
+    #     auto_scaling.filter(:auto_scaling_group, 'group1').to_a
     #
-    #   # returns all tags that propagate at launch
-    #   auto_scaling.filter(:propagate_at_launch, true).to_a
+    #     # returns all tags that propagate at launch
+    #     auto_scaling.filter(:propagate_at_launch, true).to_a
     #
-    # == Creating Tags
+    # ## Creating Tags
     #
     # You can create Auto Scaling tags when you:
     #
     # * [create]{GroupCollection#create} an Auto Scaling group
     # * [update]{Group#update} an Auto Scaling group
     #
-    # Both of these methods accept a +:tags+ option.
+    # Both of these methods accept a `:tags` option.
     #
-    #   tags = [
-    #     { :key => 'auto-scaling-instance' },       # tag name only
-    #     { :key => 'role', :value => 'webserver' }, # tag name and value
-    #   ]
+    #     tags = [
+    #       { :key => 'auto-scaling-instance' },       # tag name only
+    #       { :key => 'role', :value => 'webserver' }, # tag name and value
+    #     ]
     #
-    #   # creating a group with tags
-    #   group = auto_scaling.groups.create('group-name', :tags => tags, ...)
+    #     # creating a group with tags
+    #     group = auto_scaling.groups.create('group-name', :tags => tags, ...)
+    #
+    #     # updating a group's tags
+    #     group.update(:tags => tags)
     #
-    #   # updating a group's tags
-    #   group.update(:tags => tags)
-    # 
     class TagCollection
 
       include Core::Collection::WithLimitAndNextToken
@@ -66,12 +66,14 @@ module AWS
         @filters = options.delete(:filters) || []
         super
       end
-      
+
       # Filters the tags by the given filter name and value(s).
       #
-      #   # return tags with the key "role" and the value "webserver"
-      #   auto_scaling.tags.filter(:key, 'role').filer(:value, 'webserver')
-      # 
+      # ``
+      # # return tags with the key "role" and the value "webserver"
+      # auto_scaling.tags.filter(:key, 'role').filer(:value, 'webserver')
+      # ``
+      #
       # @param [Symbol] name Valid filter names include:
       #
       #   * :key