Class: Aws::AutoScaling::ScheduledAction
- Inherits:
-
Object
- Object
- Aws::AutoScaling::ScheduledAction
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-autoscaling/scheduled_action.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#auto_scaling_group_name ⇒ String
The name of the Auto Scaling group.
-
#desired_capacity ⇒ Integer
The number of instances you prefer to maintain in the group.
-
#end_time ⇒ Time
The date and time that the action is scheduled to end.
-
#max_size ⇒ Integer
The maximum size of the group.
-
#min_size ⇒ Integer
The minimum size of the group.
- #name ⇒ String (also: #scheduled_action_name)
-
#recurrence ⇒ String
The recurring schedule for the action.
-
#scheduled_action_arn ⇒ String
The Amazon Resource Name (ARN) of the scheduled action.
-
#start_time ⇒ Time
The date and time that the action is scheduled to begin.
-
#time ⇒ Time
This parameter is deprecated.
Actions collapse
Associations collapse
- #group ⇒ AutoScalingGroup?
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::ScheduledUpdateGroupAction
Returns the data for this ScheduledAction.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ ScheduledAction
constructor
A new instance of ScheduledAction.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current ScheduledAction.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::AutoScaling::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ ScheduledAction #initialize(options = {}) ⇒ ScheduledAction
Returns a new instance of ScheduledAction.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#auto_scaling_group_name ⇒ String
The name of the Auto Scaling group.
36 37 38 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 36 def auto_scaling_group_name data[:auto_scaling_group_name] end |
#client ⇒ Client
96 97 98 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 96 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`.
116 117 118 119 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 116 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
124 125 126 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 124 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
234 235 236 237 238 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 234 def delete( = {}) = .merge(scheduled_action_name: @name) resp = @client.delete_scheduled_action() resp.data end |
#desired_capacity ⇒ Integer
The number of instances you prefer to maintain in the group.
89 90 91 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 89 def desired_capacity data[:desired_capacity] end |
#end_time ⇒ Time
The date and time that the action is scheduled to end. This date and time can be up to one month in the future.
65 66 67 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 65 def end_time data[:end_time] end |
#group ⇒ AutoScalingGroup?
243 244 245 246 247 248 249 250 251 252 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 243 def group if data[:auto_scaling_group_name] AutoScalingGroup.new( name: data[:auto_scaling_group_name], client: @client ) else nil end 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.
256 257 258 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 256 def identifiers { name: @name } 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
106 107 108 109 110 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 106 def load resp = @client.describe_scheduled_actions(scheduled_action_names: [@name]) @data = resp.scheduled_update_group_actions[0] self end |
#max_size ⇒ Integer
The maximum size of the group.
83 84 85 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 83 def max_size data[:max_size] end |
#min_size ⇒ Integer
The minimum size of the group.
77 78 79 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 77 def min_size data[:min_size] end |
#name ⇒ String Also known as: scheduled_action_name
29 30 31 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 29 def name @name end |
#recurrence ⇒ String
The recurring schedule for the action.
71 72 73 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 71 def recurrence data[:recurrence] end |
#scheduled_action_arn ⇒ String
The Amazon Resource Name (ARN) of the scheduled action.
42 43 44 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 42 def scheduled_action_arn data[:scheduled_action_arn] end |
#start_time ⇒ Time
The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.
When ‘StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops.
58 59 60 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 58 def start_time data[:start_time] end |
#time ⇒ Time
This parameter is deprecated.
48 49 50 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 48 def time data[:time] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::AutoScaling::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
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/aws-sdk-autoscaling/scheduled_action.rb', line 206 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 |