aws-sdk-autoscaling 1.2.0 → 1.3.0

data/lib/aws-sdk-autoscaling/load_balancer.rb

@@ -59,7 +59,7 @@ module Aws::AutoScaling
     #   load balancer.
     # @return [String]
     def state
-      data.state
+      data[:state]
     end
 
     # @!endgroup
@@ -92,6 +92,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values

data/lib/aws-sdk-autoscaling/notification_configuration.rb

@@ -78,6 +78,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values

data/lib/aws-sdk-autoscaling/scaling_policy.rb

@@ -35,19 +35,19 @@ module Aws::AutoScaling
     # policy.
     # @return [String]
     def auto_scaling_group_name
-      data.auto_scaling_group_name
+      data[:auto_scaling_group_name]
     end
 
     # The Amazon Resource Name (ARN) of the policy.
     # @return [String]
     def policy_arn
-      data.policy_arn
+      data[:policy_arn]
     end
 
     # The policy type. Valid values are `SimpleScaling` and `StepScaling`.
     # @return [String]
     def policy_type
-      data.policy_type
+      data[:policy_type]
     end
 
     # The adjustment type, which specifies how `ScalingAdjustment` is
@@ -55,14 +55,14 @@ module Aws::AutoScaling
     # `PercentChangeInCapacity`.
     # @return [String]
     def adjustment_type
-      data.adjustment_type
+      data[:adjustment_type]
     end
 
     # Available for backward compatibility. Use `MinAdjustmentMagnitude`
     # instead.
     # @return [Integer]
     def min_adjustment_step
-      data.min_adjustment_step
+      data[:min_adjustment_step]
     end
 
     # The minimum number of instances to scale. If the value of
@@ -71,7 +71,7 @@ module Aws::AutoScaling
     # this many instances. Otherwise, the error is `ValidationError`.
     # @return [Integer]
     def min_adjustment_magnitude
-      data.min_adjustment_magnitude
+      data[:min_adjustment_magnitude]
     end
 
     # The amount by which to scale, based on the specified adjustment type.
@@ -79,47 +79,47 @@ module Aws::AutoScaling
     # removes from the current capacity.
     # @return [Integer]
     def scaling_adjustment
-      data.scaling_adjustment
+      data[:scaling_adjustment]
     end
 
     # The amount of time, in seconds, after a scaling activity completes
     # before any further dynamic scaling activities can start.
     # @return [Integer]
     def cooldown
-      data.cooldown
+      data[:cooldown]
     end
 
     # A set of adjustments that enable you to scale based on the size of the
     # alarm breach.
     # @return [Array<Types::StepAdjustment>]
     def step_adjustments
-      data.step_adjustments
+      data[:step_adjustments]
     end
 
     # The aggregation type for the CloudWatch metrics. Valid values are
     # `Minimum`, `Maximum`, and `Average`.
     # @return [String]
     def metric_aggregation_type
-      data.metric_aggregation_type
+      data[:metric_aggregation_type]
     end
 
     # The estimated time, in seconds, until a newly launched instance can
     # contribute to the CloudWatch metrics.
     # @return [Integer]
     def estimated_instance_warmup
-      data.estimated_instance_warmup
+      data[:estimated_instance_warmup]
     end
 
     # The CloudWatch alarms related to the policy.
     # @return [Array<Types::Alarm>]
     def alarms
-      data.alarms
+      data[:alarms]
     end
 
     # A target tracking policy.
     # @return [Types::TargetTrackingConfiguration]
     def target_tracking_configuration
-      data.target_tracking_configuration
+      data[:target_tracking_configuration]
     end
 
     # @!endgroup
@@ -157,6 +157,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values
@@ -227,9 +322,9 @@ module Aws::AutoScaling
 
     # @return [AutoScalingGroup, nil]
     def group
-      if data.auto_scaling_group_name
+      if data[:auto_scaling_group_name]
         AutoScalingGroup.new(
-          name: data.auto_scaling_group_name,
+          name: data[:auto_scaling_group_name],
           client: @client
         )
       else

data/lib/aws-sdk-autoscaling/scheduled_action.rb

@@ -34,19 +34,19 @@ module Aws::AutoScaling
     # The name of the group.
     # @return [String]
     def auto_scaling_group_name
-      data.auto_scaling_group_name
+      data[:auto_scaling_group_name]
     end
 
     # The Amazon Resource Name (ARN) of the scheduled action.
     # @return [String]
     def scheduled_action_arn
-      data.scheduled_action_arn
+      data[:scheduled_action_arn]
     end
 
     # This parameter is deprecated.
     # @return [Time]
     def time
-      data.time
+      data[:time]
     end
 
     # The date and time that the action is scheduled to begin. This date and
@@ -56,38 +56,38 @@ module Aws::AutoScaling
     # form the boundaries of when the recurring action will start and stop.
     # @return [Time]
     def start_time
-      data.start_time
+      data[:start_time]
     end
 
     # The date and time that the action is scheduled to end. This date and
     # time can be up to one month in the future.
     # @return [Time]
     def end_time
-      data.end_time
+      data[:end_time]
     end
 
     # The recurring schedule for the action.
     # @return [String]
     def recurrence
-      data.recurrence
+      data[:recurrence]
     end
 
     # The minimum size of the group.
     # @return [Integer]
     def min_size
-      data.min_size
+      data[:min_size]
     end
 
     # The maximum size of the group.
     # @return [Integer]
     def max_size
-      data.max_size
+      data[:max_size]
     end
 
     # The number of instances you prefer to maintain in the group.
     # @return [Integer]
     def desired_capacity
-      data.desired_capacity
+      data[:desired_capacity]
     end
 
     # @!endgroup
@@ -125,6 +125,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values
@@ -146,9 +241,9 @@ module Aws::AutoScaling
 
     # @return [AutoScalingGroup, nil]
     def group
-      if data.auto_scaling_group_name
+      if data[:auto_scaling_group_name]
         AutoScalingGroup.new(
-          name: data.auto_scaling_group_name,
+          name: data[:auto_scaling_group_name],
           client: @client
         )
       else