Class: Aws::RDS::ResourcePendingMaintenanceActionList
- Inherits:
-
Object
- Object
- Aws::RDS::ResourcePendingMaintenanceActionList
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #arn ⇒ String (also: #resource_identifier)
-
#pending_maintenance_action_details ⇒ Array<Types::PendingMaintenanceAction>
A list that provides details about the pending maintenance actions for the resource.
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #pending_maintenance_actions ⇒ PendingMaintenanceAction::Collection
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::ResourcePendingMaintenanceActions
Returns the data for this ResourcePendingMaintenanceActionList.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ ResourcePendingMaintenanceActionList
constructor
A new instance of ResourcePendingMaintenanceActionList.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(arn, options = {}) ⇒ ResourcePendingMaintenanceActionList #initialize(options = {}) ⇒ ResourcePendingMaintenanceActionList
Returns a new instance of ResourcePendingMaintenanceActionList.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @arn = extract_arn(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#arn ⇒ String Also known as: resource_identifier
29 30 31 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 29 def arn @arn end |
#client ⇒ Client
44 45 46 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 44 def client @client end |
#data ⇒ Types::ResourcePendingMaintenanceActions
Returns the data for this Aws::RDS::ResourcePendingMaintenanceActionList.
59 60 61 62 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 59 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
67 68 69 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 67 def data_loaded? !!@data end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
184 185 186 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 184 def identifiers { arn: @arn } end |
#load ⇒ Object Also known as: reload
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
50 51 52 53 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 50 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#pending_maintenance_action_details ⇒ Array<Types::PendingMaintenanceAction>
A list that provides details about the pending maintenance actions for the resource.
37 38 39 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 37 def pending_maintenance_action_details data[:pending_maintenance_action_details] end |
#pending_maintenance_actions ⇒ PendingMaintenanceAction::Collection
169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 169 def pending_maintenance_actions batch = [] data[:pending_maintenance_action_details].each do |d| batch << PendingMaintenanceAction.new( target_arn: @arn, name: d[:action], data: d, client: @client ) end PendingMaintenanceAction::Collection.new([batch], size: batch.size) end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged
Waiter polls an API operation until a resource enters a desired state.
## 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() {|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
attempts attempt in seconds invoked before each attempt invoked before each wait
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/aws-sdk-rds/resource_pending_maintenance_action_list.rb', line 149 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |