Class: Aws::RDS::PendingMaintenanceAction
- Inherits:
-
Object
- Object
- Aws::RDS::PendingMaintenanceAction
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/pending_maintenance_action.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#auto_applied_after_date ⇒ Time
The date of the maintenance window when the action is applied.
-
#current_apply_date ⇒ Time
The effective date when the pending maintenance action is applied to the resource.
-
#description ⇒ String
A description providing more detail about the maintenance action.
-
#forced_apply_date ⇒ Time
The date when the maintenance action is automatically applied.
- #name ⇒ String (also: #action)
-
#opt_in_status ⇒ String
Indicates the type of opt-in request that has been received for the resource.
- #target_arn ⇒ String
Actions collapse
- #apply_immediately(options = {}) ⇒ ResourcePendingMaintenanceActionList
- #apply_on_next_maintenance(options = {}) ⇒ ResourcePendingMaintenanceActionList
- #identifiers ⇒ Object deprecated private Deprecated.
- #undo_opt_in(options = {}) ⇒ ResourcePendingMaintenanceActionList
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::PendingMaintenanceAction
Returns the data for this PendingMaintenanceAction.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ PendingMaintenanceAction
constructor
A new instance of PendingMaintenanceAction.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(target_arn, name, options = {}) ⇒ PendingMaintenanceAction #initialize(options = {}) ⇒ PendingMaintenanceAction
Returns a new instance of PendingMaintenanceAction.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 21 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @target_arn = extract_target_arn(args, ) @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#apply_immediately(options = {}) ⇒ ResourcePendingMaintenanceActionList
216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 216 def apply_immediately( = {}) = .merge( apply_action: @name, resource_identifier: @target_arn, opt_in_type: "immediate" ) resp = @client.apply_pending_maintenance_action() ResourcePendingMaintenanceActionList.new( arn: resp.data.resource_pending_maintenance_actions.resource_identifier, data: resp.data.resource_pending_maintenance_actions, client: @client ) end |
#apply_on_next_maintenance(options = {}) ⇒ ResourcePendingMaintenanceActionList
254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 254 def apply_on_next_maintenance( = {}) = .merge( apply_action: @name, resource_identifier: @target_arn, opt_in_type: "next-maintenance" ) resp = @client.apply_pending_maintenance_action() ResourcePendingMaintenanceActionList.new( arn: resp.data.resource_pending_maintenance_actions.resource_identifier, data: resp.data.resource_pending_maintenance_actions, client: @client ) end |
#auto_applied_after_date ⇒ Time
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. If this date is specified, any ‘next-maintenance` opt-in requests are ignored.
47 48 49 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 47 def auto_applied_after_date data[:auto_applied_after_date] end |
#client ⇒ Client
87 88 89 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 87 def client @client end |
#current_apply_date ⇒ Time
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`.
74 75 76 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 74 def current_apply_date data[:current_apply_date] end |
#data ⇒ Types::PendingMaintenanceAction
Returns the data for this Aws::RDS::PendingMaintenanceAction.
102 103 104 105 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 102 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
110 111 112 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 110 def data_loaded? !!@data end |
#description ⇒ String
A description providing more detail about the maintenance action.
80 81 82 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 80 def description data[:description] end |
#forced_apply_date ⇒ Time
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. If this date is specified, any ‘immediate` opt-in requests are ignored.
56 57 58 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 56 def forced_apply_date data[:forced_apply_date] 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.
270 271 272 273 274 275 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 270 def identifiers { target_arn: @target_arn, name: @name } 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.
93 94 95 96 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 93 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#name ⇒ String Also known as: action
37 38 39 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 37 def name @name end |
#opt_in_status ⇒ String
Indicates the type of opt-in request that has been received for the resource.
63 64 65 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 63 def opt_in_status data[:opt_in_status] end |
#target_arn ⇒ String
32 33 34 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 32 def target_arn @target_arn end |
#undo_opt_in(options = {}) ⇒ ResourcePendingMaintenanceActionList
235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 235 def undo_opt_in( = {}) = .merge( apply_action: @name, resource_identifier: @target_arn, opt_in_type: "undo-opt-in" ) resp = @client.apply_pending_maintenance_action() ResourcePendingMaintenanceActionList.new( arn: resp.data.resource_pending_maintenance_actions.resource_identifier, data: resp.data.resource_pending_maintenance_actions, client: @client ) 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
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/aws-sdk-rds/pending_maintenance_action.rb', line 192 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 |