You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Actions collapse

Read-Only Attributes 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)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 21

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)
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:



214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 214

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

#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:



252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 252

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

#auto_applied_after_dateTime

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)


46
47
48
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 46

def auto_applied_after_date
  data[:auto_applied_after_date]
end

#clientClient

Returns:



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

def client
  @client
end

#current_apply_dateTime

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)


72
73
74
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 72

def current_apply_date
  data[:current_apply_date]
end

#dataTypes::PendingMaintenanceAction

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

Returns:

Raises:



100
101
102
103
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 100

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.



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

def data_loaded?
  !!@data
end

#descriptionString

A description providing more detail about the maintenance action.

Returns:

  • (String)


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

def description
  data[:description]
end

#forced_apply_dateTime

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.

Returns:

  • (Time)


54
55
56
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 54

def forced_apply_date
  data[:forced_apply_date]
end

#nameString Also known as: action

Returns:

  • (String)


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

def name
  @name
end

#opt_in_statusString

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

Returns:

  • (String)


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

def opt_in_status
  data[:opt_in_status]
end

#target_arnString

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 32

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:



233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 233

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

#wait_until(options = {}, &block) ⇒ 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) {|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

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

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/pending_maintenance_action.rb', line 190

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