Class: Aws::RDS::PendingMaintenanceAction

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_arn, name, options = {}) ⇒ PendingMaintenanceAction #initialize(options = {}) ⇒ PendingMaintenanceAction

Returns a new instance of PendingMaintenanceAction.

Overloads:

  • #initialize(target_arn, name, options = {}) ⇒ PendingMaintenanceAction

    Parameters:

    • target_arn (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ PendingMaintenanceAction

    Options Hash (options):

    • :target_arn (required, String)
    • :name (required, String)
    • :client (Client) 


24
25
26
27
28
29
30
31
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 24

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

Instance Method Details

#apply_immediately(options = {}) ⇒ ResourcePendingMaintenanceActionList

Examples:

Request syntax with placeholder values


pending_maintenance_action.apply_immediately()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 225

def apply_immediately(options = {})
  options = options.merge(
    apply_action: @name,
    resource_identifier: @target_arn,
    opt_in_type: "immediate"
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.apply_pending_maintenance_action(options)
  end
  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

Examples:

Request syntax with placeholder values


pending_maintenance_action.apply_on_next_maintenance()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 267

def apply_on_next_maintenance(options = {})
  options = options.merge(
    apply_action: @name,
    resource_identifier: @target_arn,
    opt_in_type: "next-maintenance"
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.apply_pending_maintenance_action(options)
  end
  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.

Returns:

  • (Time) 


50
51
52
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 50

def auto_applied_after_date
  data[:auto_applied_after_date]
end

#client ⇒ Client

Returns:



92
93
94
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 92

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.

Returns:

  • (Time) 


79
80
81
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 79

def current_apply_date
  data[:current_apply_date]
end

#data ⇒ Types::PendingMaintenanceAction

Returns the data for this Aws::RDS::PendingMaintenanceAction.

Returns:

Raises:



107
108
109
110
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 107

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



115
116
117
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 115

def data_loaded?
  !!@data
end

#description ⇒ String

A description providing more detail about the maintenance action.

Returns:

  • (String) 


85
86
87
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 85

def description
  data[:description]
end

#forced_apply_date ⇒ Time

The date when the maintenance action is automatically applied.

On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.

Returns:

  • (Time) 


61
62
63
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 61

def forced_apply_date
  data[:forced_apply_date]
end

#name ⇒ String Also known as: action

Returns:

  • (String) 


41
42
43
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 41

def name
  @name
end

#opt_in_status ⇒ String

Indicates the type of opt-in request that has been received for the resource.

Returns:

  • (String) 


68
69
70
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 68

def opt_in_status
  data[:opt_in_status]
end

#target_arn ⇒ String

Returns:

  • (String) 


36
37
38
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 36

def target_arn
  @target_arn
end

#undo_opt_in(options = {}) ⇒ ResourcePendingMaintenanceActionList

Examples:

Request syntax with placeholder values


pending_maintenance_action.undo_opt_in()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 246

def undo_opt_in(options = {})
  options = options.merge(
    apply_action: @name,
    resource_identifier: @target_arn,
    opt_in_type: "undo-opt-in"
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.apply_pending_maintenance_action(options)
  end
  ResourcePendingMaintenanceActionList.new(
    arn: resp.data.resource_pending_maintenance_actions.resource_identifier,
    data: resp.data.resource_pending_maintenance_actions,
    client: @client
  )
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

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(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

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 199

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::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end