aws-sdk-rds 1.1.0 → 1.2.0

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

@@ -44,101 +44,101 @@ module Aws::RDS
     # Coordinated Time (UTC).
     # @return [Time]
     def snapshot_create_time
-      data.snapshot_create_time
+      data[:snapshot_create_time]
     end
 
     # Specifies the name of the database engine.
     # @return [String]
     def engine
-      data.engine
+      data[:engine]
     end
 
     # Specifies the allocated storage size in gigabytes (GB).
     # @return [Integer]
     def allocated_storage
-      data.allocated_storage
+      data[:allocated_storage]
     end
 
     # Specifies the status of this DB snapshot.
     # @return [String]
     def status
-      data.status
+      data[:status]
     end
 
     # Specifies the port that the database engine was listening on at the
     # time of the snapshot.
     # @return [Integer]
     def port
-      data.port
+      data[:port]
     end
 
     # Specifies the name of the Availability Zone the DB instance was
     # located in at the time of the DB snapshot.
     # @return [String]
     def availability_zone
-      data.availability_zone
+      data[:availability_zone]
     end
 
     # Provides the VPC ID associated with the DB snapshot.
     # @return [String]
     def vpc_id
-      data.vpc_id
+      data[:vpc_id]
     end
 
     # Specifies the time when the snapshot was taken, in Universal
     # Coordinated Time (UTC).
     # @return [Time]
     def instance_create_time
-      data.instance_create_time
+      data[:instance_create_time]
     end
 
     # Provides the master username for the DB snapshot.
     # @return [String]
     def master_username
-      data.master_username
+      data[:master_username]
     end
 
     # Specifies the version of the database engine.
     # @return [String]
     def engine_version
-      data.engine_version
+      data[:engine_version]
     end
 
     # License model information for the restored DB instance.
     # @return [String]
     def license_model
-      data.license_model
+      data[:license_model]
     end
 
     # Provides the type of the DB snapshot.
     # @return [String]
     def snapshot_type
-      data.snapshot_type
+      data[:snapshot_type]
     end
 
     # Specifies the Provisioned IOPS (I/O operations per second) value of
     # the DB instance at the time of the snapshot.
     # @return [Integer]
     def iops
-      data.iops
+      data[:iops]
     end
 
     # Provides the option group name for the DB snapshot.
     # @return [String]
     def option_group_name
-      data.option_group_name
+      data[:option_group_name]
     end
 
     # The percentage of the estimated data that has been transferred.
     # @return [Integer]
     def percent_progress
-      data.percent_progress
+      data[:percent_progress]
     end
 
     # The AWS Region that the DB snapshot was created in or copied from.
     # @return [String]
     def source_region
-      data.source_region
+      data[:source_region]
     end
 
     # The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was
@@ -146,39 +146,39 @@ module Aws::RDS
     # cross-region copy.
     # @return [String]
     def source_db_snapshot_identifier
-      data.source_db_snapshot_identifier
+      data[:source_db_snapshot_identifier]
     end
 
     # Specifies the storage type associated with DB snapshot.
     # @return [String]
     def storage_type
-      data.storage_type
+      data[:storage_type]
     end
 
     # The ARN from the key store with which to associate the instance for
     # TDE encryption.
     # @return [String]
     def tde_credential_arn
-      data.tde_credential_arn
+      data[:tde_credential_arn]
     end
 
     # Specifies whether the DB snapshot is encrypted.
     # @return [Boolean]
     def encrypted
-      data.encrypted
+      data[:encrypted]
     end
 
     # If `Encrypted` is true, the KMS key identifier for the encrypted DB
     # snapshot.
     # @return [String]
     def kms_key_id
-      data.kms_key_id
+      data[:kms_key_id]
     end
 
     # The Amazon Resource Name (ARN) for the DB snapshot.
     # @return [String]
     def db_snapshot_arn
-      data.db_snapshot_arn
+      data[:db_snapshot_arn]
     end
 
     # The time zone of the DB snapshot. In most cases, the `Timezone`
@@ -187,14 +187,14 @@ module Aws::RDS
     # zone specified.
     # @return [String]
     def timezone
-      data.timezone
+      data[:timezone]
     end
 
     # True if mapping of AWS Identity and Access Management (IAM) accounts
     # to database accounts is enabled; otherwise false.
     # @return [Boolean]
     def iam_database_authentication_enabled
-      data.iam_database_authentication_enabled
+      data[:iam_database_authentication_enabled]
     end
 
     # @!endgroup
@@ -232,6 +232,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
@@ -758,9 +853,9 @@ module Aws::RDS
 
     # @return [OptionGroup, nil]
     def option_group
-      if data.db_snapshot.option_group_name
+      if data[:db_snapshot][:option_group_name]
         OptionGroup.new(
-          name: data.db_snapshot.option_group_name,
+          name: data[:db_snapshot][:option_group_name],
           client: @client
         )
       else

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

@@ -48,7 +48,7 @@ module Aws::RDS
     # account to copy or restore.
     # @return [Array<String>]
     def attribute_values
-      data.attribute_values
+      data[:attribute_values]
     end
 
     # @!endgroup
@@ -81,6 +81,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/db_subnet_group.rb

@@ -34,31 +34,31 @@ module Aws::RDS
     # Provides the description of the DB subnet group.
     # @return [String]
     def db_subnet_group_description
-      data.db_subnet_group_description
+      data[:db_subnet_group_description]
     end
 
     # Provides the VpcId of the DB subnet group.
     # @return [String]
     def vpc_id
-      data.vpc_id
+      data[:vpc_id]
     end
 
     # Provides the status of the DB subnet group.
     # @return [String]
     def subnet_group_status
-      data.subnet_group_status
+      data[:subnet_group_status]
     end
 
     # Contains a list of Subnet elements.
     # @return [Array<Types::Subnet>]
     def subnets
-      data.subnets
+      data[:subnets]
     end
 
     # The Amazon Resource Name (ARN) for the DB subnet group.
     # @return [String]
     def db_subnet_group_arn
-      data.db_subnet_group_arn
+      data[:db_subnet_group_arn]
     end
 
     # @!endgroup
@@ -96,6 +96,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