# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::RDS class PendingMaintenanceAction extend Aws::Deprecations # @overload def initialize(target_arn, name, options = {}) # @param [String] target_arn # @param [String] name # @option options [Client] :client # @overload def initialize(options = {}) # @option options [required, String] :target_arn # @option options [required, String] :name # @option options [Client] :client def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @target_arn = extract_target_arn(args, options) @name = extract_name(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end # @!group Read-Only Attributes # @return [String] def target_arn @target_arn end # @return [String] def name @name end alias :action :name # The date of the maintenance window when the action is applied. The # maintenance action is applied to the resource during its first # maintenance window after this date. # @return [Time] def auto_applied_after_date data[:auto_applied_after_date] end # The date when the maintenance action is automatically applied. The # maintenance action is applied to the resource on this date regardless # of the maintenance window for the resource. # @return [Time] def forced_apply_date data[:forced_apply_date] end # Indicates the type of opt-in request that has been received for the # resource. # @return [String] def opt_in_status data[:opt_in_status] end # The effective date when the pending maintenance action is applied to # the resource. This date takes into account opt-in requests received # from the `ApplyPendingMaintenanceAction` API, the # `AutoAppliedAfterDate`, and the `ForcedApplyDate`. This value is blank # if an opt-in request has not been received and nothing has been # specified as `AutoAppliedAfterDate` or `ForcedApplyDate`. # @return [Time] def current_apply_date data[:current_apply_date] end # A description providing more detail about the maintenance action. # @return [String] def description data[:description] end # @!endgroup # @return [Client] def client @client end # @raise [NotImplementedError] # @api private def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end alias :reload :load # @raise [NotImplementedError] Raises when {#data_loaded?} is `false`. # @return [Types::PendingMaintenanceAction] # Returns the data for this {PendingMaintenanceAction}. def data load unless @data @data end # @return [Boolean] # Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. def data_loaded? !!@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) do |instance| # instance.state.name == 'running' # end # # ## 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 # # @yieldparam [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 # # pending_maintenance_action.apply_immediately() # @param [Hash] options ({}) # @return [ResourcePendingMaintenanceActionList] def apply_immediately(options = {}) options = options.merge( apply_action: @name, resource_identifier: @target_arn, opt_in_type: "immediate" ) resp = @client.apply_pending_maintenance_action(options) ResourcePendingMaintenanceActionList.new( arn: resp.data.resource_pending_maintenance_actions.resource_identifier, data: resp.data.resource_pending_maintenance_actions, client: @client ) end # @example Request syntax with placeholder values # # pending_maintenance_action.undo_opt_in() # @param [Hash] options ({}) # @return [ResourcePendingMaintenanceActionList] def undo_opt_in(options = {}) options = options.merge( apply_action: @name, resource_identifier: @target_arn, opt_in_type: "undo-opt-in" ) resp = @client.apply_pending_maintenance_action(options) ResourcePendingMaintenanceActionList.new( arn: resp.data.resource_pending_maintenance_actions.resource_identifier, data: resp.data.resource_pending_maintenance_actions, client: @client ) end # @example Request syntax with placeholder values # # pending_maintenance_action.apply_on_next_maintenance() # @param [Hash] options ({}) # @return [ResourcePendingMaintenanceActionList] def apply_on_next_maintenance(options = {}) options = options.merge( apply_action: @name, resource_identifier: @target_arn, opt_in_type: "next-maintenance" ) resp = @client.apply_pending_maintenance_action(options) ResourcePendingMaintenanceActionList.new( arn: resp.data.resource_pending_maintenance_actions.resource_identifier, data: resp.data.resource_pending_maintenance_actions, client: @client ) end # @deprecated # @api private def identifiers { target_arn: @target_arn, name: @name } end deprecated(:identifiers) private def extract_target_arn(args, options) value = args[0] || options.delete(:target_arn) case value when String then value when nil then raise ArgumentError, "missing required option :target_arn" else msg = "expected :target_arn to be a String, got #{value.class}" raise ArgumentError, msg end end def extract_name(args, options) value = args[1] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end class Collection < Aws::Resources::Collection; end end end