class Aws::AutoScaling::ScheduledAction
Public Class Methods
@overload def initialize(name, options = {})
@param [String] name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :name @option options [Client] :client
# File 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
Public Instance Methods
The name of the Auto Scaling group. @return [String]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 40 def auto_scaling_group_name data[:auto_scaling_group_name] end
@return [Client]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 108 def client @client end
@return [Types::ScheduledUpdateGroupAction]
Returns the data for this {ScheduledAction}. Calls {Client#describe_scheduled_actions} if {#data_loaded?} is `false`.
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 128 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 136 def data_loaded? !!@data end
@example Request syntax with placeholder values
scheduled_action.delete({ auto_scaling_group_name: "XmlStringMaxLen255", # required })
@param [Hash] options ({}) @option options [required, String] :auto_scaling_group_name
The name of the Auto Scaling group.
@return [EmptyStructure]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 248 def delete(options = {}) options = options.merge(scheduled_action_name: @name) resp = @client.delete_scheduled_action(options) resp.data end
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. @return [Integer]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 95 def desired_capacity data[:desired_capacity] end
The date and time in UTC for the recurring schedule to end. For example, `ā2019-06-01T00:00:00Zā`. @return [Time]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 66 def end_time data[:end_time] end
@return [AutoScalingGroup, nil]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 257 def group if data[:auto_scaling_group_name] AutoScalingGroup.new( name: data[:auto_scaling_group_name], client: @client ) else nil end end
@deprecated @api private
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 270 def identifiers { name: @name } end
Loads, or reloads {#data} for the current {ScheduledAction}. Returns `self` making it possible to chain methods.
scheduled_action.reload.data
@return [self]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 118 def load resp = @client.describe_scheduled_actions(scheduled_action_names: [@name]) @data = resp.scheduled_update_group_actions[0] self end
The maximum size of the Auto Scaling group. @return [Integer]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 87 def max_size data[:max_size] end
The minimum size of the Auto Scaling group. @return [Integer]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 81 def min_size data[:min_size] end
@return [String]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 33 def name @name end
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. @return [String]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 75 def recurrence data[:recurrence] end
The Amazon Resource
Name (ARN) of the scheduled action. @return [String]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 46 def scheduled_action_arn data[:scheduled_action_arn] end
The date and time in UTC for this action to start. For example, `ā2019-06-01T00:00:00Zā`. @return [Time]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 59 def start_time data[:start_time] end
This parameter is no longer used. @return [Time]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 52 def time data[:time] end
The time zone for the cron expression. @return [String]
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 101 def time_zone data[:time_zone] end
@deprecated Use [Aws::AutoScaling::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 220 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
Private Instance Methods
# File lib/aws-sdk-autoscaling/scheduled_action.rb, line 277 def extract_name(args, options) value = args[0] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end