aws-sdk-rds 1.1.0 → 1.2.0

data/lib/aws-sdk-rds/reserved_db_instance.rb

@@ -34,85 +34,85 @@ module Aws::RDS
     # The offering identifier.
     # @return [String]
     def reserved_db_instances_offering_id
-      data.reserved_db_instances_offering_id
+      data[:reserved_db_instances_offering_id]
     end
 
     # The DB instance class for the reserved DB instance.
     # @return [String]
     def db_instance_class
-      data.db_instance_class
+      data[:db_instance_class]
     end
 
     # The time the reservation started.
     # @return [Time]
     def start_time
-      data.start_time
+      data[:start_time]
     end
 
     # The duration of the reservation in seconds.
     # @return [Integer]
     def duration
-      data.duration
+      data[:duration]
     end
 
     # The fixed price charged for this reserved DB instance.
     # @return [Float]
     def fixed_price
-      data.fixed_price
+      data[:fixed_price]
     end
 
     # The hourly price charged for this reserved DB instance.
     # @return [Float]
     def usage_price
-      data.usage_price
+      data[:usage_price]
     end
 
     # The currency code for the reserved DB instance.
     # @return [String]
     def currency_code
-      data.currency_code
+      data[:currency_code]
     end
 
     # The number of reserved DB instances.
     # @return [Integer]
     def db_instance_count
-      data.db_instance_count
+      data[:db_instance_count]
     end
 
     # The description of the reserved DB instance.
     # @return [String]
     def product_description
-      data.product_description
+      data[:product_description]
     end
 
     # The offering type of this reserved DB instance.
     # @return [String]
     def offering_type
-      data.offering_type
+      data[:offering_type]
     end
 
     # Indicates if the reservation applies to Multi-AZ deployments.
     # @return [Boolean]
     def multi_az
-      data.multi_az
+      data[:multi_az]
     end
 
     # The state of the reserved DB instance.
     # @return [String]
     def state
-      data.state
+      data[:state]
     end
 
     # The recurring price charged to run this reserved DB instance.
     # @return [Array<Types::RecurringCharge>]
     def recurring_charges
-      data.recurring_charges
+      data[:recurring_charges]
     end
 
     # The Amazon Resource Name (ARN) for the reserved DB instance.
     # @return [String]
     def reserved_db_instance_arn
-      data.reserved_db_instance_arn
+      data[:reserved_db_instance_arn]
     end
 
     # @!endgroup
@@ -150,13 +150,108 @@ module Aws::RDS
       !!@data
     end
 
+    # @deprecated Use [Aws::RDS::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 Associations
 
     # @return [ReservedDBInstancesOffering, nil]
     def offering
-      if data.reserved_db_instances_offering_id
+      if data[:reserved_db_instances_offering_id]
         ReservedDBInstancesOffering.new(
-          id: data.reserved_db_instances_offering_id,
+          id: data[:reserved_db_instances_offering_id],
           client: @client
         )
       else

data/lib/aws-sdk-rds/reserved_db_instances_offering.rb

@@ -34,55 +34,55 @@ module Aws::RDS
     # The DB instance class for the reserved DB instance.
     # @return [String]
     def db_instance_class
-      data.db_instance_class
+      data[:db_instance_class]
     end
 
     # The duration of the offering in seconds.
     # @return [Integer]
     def duration
-      data.duration
+      data[:duration]
     end
 
     # The fixed price charged for this offering.
     # @return [Float]
     def fixed_price
-      data.fixed_price
+      data[:fixed_price]
     end
 
     # The hourly price charged for this offering.
     # @return [Float]
     def usage_price
-      data.usage_price
+      data[:usage_price]
     end
 
     # The currency code for the reserved DB instance offering.
     # @return [String]
     def currency_code
-      data.currency_code
+      data[:currency_code]
     end
 
     # The database engine used by the offering.
     # @return [String]
     def product_description
-      data.product_description
+      data[:product_description]
     end
 
     # The offering type.
     # @return [String]
     def offering_type
-      data.offering_type
+      data[:offering_type]
     end
 
     # Indicates if the offering applies to Multi-AZ deployments.
     # @return [Boolean]
     def multi_az
-      data.multi_az
+      data[:multi_az]
     end
 
     # The recurring price charged to run this reserved DB instance.
     # @return [Array<Types::RecurringCharge>]
     def recurring_charges
-      data.recurring_charges
+      data[:recurring_charges]
     end
 
     # @!endgroup
@@ -120,6 +120,101 @@ module Aws::RDS
       !!@data
     end
 
+    # @deprecated Use [Aws::RDS::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-rds/resource_pending_maintenance_action_list.rb

@@ -35,7 +35,7 @@ module Aws::RDS
     # the resource.
     # @return [Array<Types::PendingMaintenanceAction>]
     def pending_maintenance_action_details
-      data.pending_maintenance_action_details
+      data[:pending_maintenance_action_details]
     end
 
     # @!endgroup
@@ -68,16 +68,111 @@ module Aws::RDS
       !!@data
     end
 
+    # @deprecated Use [Aws::RDS::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 Associations
 
     # @return [PendingMaintenanceAction::Collection]
     def pending_maintenance_actions
       batch = []
-      data.pending_maintenance_action_details.each do |p|
+      data[:pending_maintenance_action_details].each do |d|
         batch << PendingMaintenanceAction.new(
           target_arn: @arn,
-          name: p.action,
-          data: p,
+          name: d[:action],
+          data: d,
           client: @client
         )
       end