Class: Aws::AutoScaling::ScheduledAction

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ ScheduledAction #initialize(options = {}) ⇒ ScheduledAction

Returns a new instance of ScheduledAction.

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ ScheduledAction

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

  • (String) 


40
41
42
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 40

def auto_scaling_group_name
  data[:auto_scaling_group_name]
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ Types::ScheduledUpdateGroupAction

Returns the data for this Aws::AutoScaling::ScheduledAction. Calls Client#describe_scheduled_actions if #data_loaded? is false.

Returns:



130
131
132
133
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 130

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.



138
139
140
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 138

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


scheduled_action.delete({
  auto_scaling_group_name: "XmlStringMaxLen255", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

Returns:

  • (EmptyStructure) 


252
253
254
255
256
257
258
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 252

def delete(options = {})
  options = options.merge(scheduled_action_name: @name)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_scheduled_action(options)
  end
  resp.data
end

#desired_capacity ⇒ Integer

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

Returns:

  • (Integer) 


95
96
97
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 95

def desired_capacity
  data[:desired_capacity]
end

#end_time ⇒ Time

The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".

Returns:

  • (Time) 


66
67
68
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 66

def end_time
  data[:end_time]
end

#group ⇒ AutoScalingGroup?

Returns:



263
264
265
266
267
268
269
270
271
272
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 263

def group
  if data[:auto_scaling_group_name]
    AutoScalingGroup.new(
      name: data[:auto_scaling_group_name],
      client: @client
    )
  else
    nil
  end
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::AutoScaling::ScheduledAction. Returns self making it possible to chain methods.

scheduled_action.reload.data

Returns:

  • (self) 


118
119
120
121
122
123
124
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 118

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_scheduled_actions(scheduled_action_names: [@name])
  end
  @data = resp.scheduled_update_group_actions[0]
  self
end

#max_size ⇒ Integer

The maximum size of the Auto Scaling group.

Returns:

  • (Integer) 


87
88
89
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 87

def max_size
  data[:max_size]
end

#min_size ⇒ Integer

The minimum size of the Auto Scaling group.

Returns:

  • (Integer) 


81
82
83
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 81

def min_size
  data[:min_size]
end

#name ⇒ String Also known as: scheduled_action_name

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 33

def name
  @name
end

#recurrence ⇒ String

The recurring schedule for the action, in Unix cron syntax format.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

Returns:

  • (String) 


75
76
77
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 75

def recurrence
  data[:recurrence]
end

#scheduled_action_arn ⇒ String

The Amazon Resource Name (ARN) of the scheduled action.

Returns:

  • (String) 


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

def scheduled_action_arn
  data[:scheduled_action_arn]
end

#start_time ⇒ Time

The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".

Returns:

  • (Time) 


59
60
61
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 59

def start_time
  data[:start_time]
end

#time ⇒ Time

This property is no longer used.

Returns:

  • (Time) 


52
53
54
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 52

def time
  data[:time]
end

#time_zone ⇒ String

The time zone for the cron expression.

Returns:

  • (String) 


101
102
103
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/scheduled_action.rb', line 101

def time_zone
  data[:time_zone]
end

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

Deprecated.

Use [Aws::AutoScaling::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



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

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