Class: Aws::AutoScaling::Activity
- Inherits:
-
Object
- Object
- Aws::AutoScaling::Activity
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-autoscaling/activity.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#auto_scaling_group_name ⇒ String
The name of the Auto Scaling group.
-
#cause ⇒ String
The reason the activity began.
-
#description ⇒ String
A friendly, more verbose description of the activity.
-
#details ⇒ String
The details about the activity.
-
#end_time ⇒ Time
The end time of the activity.
- #id ⇒ String (also: #activity_id)
-
#progress ⇒ Integer
A value between 0 and 100 that indicates the progress of the activity.
-
#start_time ⇒ Time
The start time of the activity.
-
#status_code ⇒ String
The current status of the activity.
-
#status_message ⇒ String
A friendly, more verbose description of the activity status.
Associations collapse
- #group ⇒ AutoScalingGroup?
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Activity
Returns the data for this Activity.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ Activity
constructor
A new instance of Activity.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::AutoScaling::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ Activity #initialize(options = {}) ⇒ Activity
Returns a new instance of Activity.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(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/activity.rb', line 36 def auto_scaling_group_name data[:auto_scaling_group_name] end |
#cause ⇒ String
The reason the activity began.
48 49 50 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 48 def cause data[:cause] end |
#client ⇒ Client
91 92 93 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 91 def client @client end |
#data ⇒ Types::Activity
Returns the data for this Aws::AutoScaling::Activity. Calls Client#describe_scaling_activities if #data_loaded? is ‘false`.
111 112 113 114 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 111 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
119 120 121 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 119 def data_loaded? !!@data end |
#description ⇒ String
A friendly, more verbose description of the activity.
42 43 44 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 42 def description data[:description] end |
#details ⇒ String
The details about the activity.
84 85 86 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 84 def details data[:details] end |
#end_time ⇒ Time
The end time of the activity.
60 61 62 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 60 def end_time data[:end_time] end |
#group ⇒ AutoScalingGroup?
221 222 223 224 225 226 227 228 229 230 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 221 def group if data[:auto_scaling_group_name] AutoScalingGroup.new( name: data[:auto_scaling_group_name], client: @client ) else nil end end |
#id ⇒ String Also known as: activity_id
29 30 31 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 29 def id @id 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.
234 235 236 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 234 def identifiers { id: @id } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::AutoScaling::Activity. Returns ‘self` making it possible to chain methods.
activity.reload.data
101 102 103 104 105 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 101 def load resp = @client.describe_scaling_activities(activity_ids: [@id]) @data = resp.activities[0] self end |
#progress ⇒ Integer
A value between 0 and 100 that indicates the progress of the activity.
78 79 80 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 78 def progress data[:progress] end |
#start_time ⇒ Time
The start time of the activity.
54 55 56 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 54 def start_time data[:start_time] end |
#status_code ⇒ String
The current status of the activity.
66 67 68 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 66 def status_code data[:status_code] end |
#status_message ⇒ String
A friendly, more verbose description of the activity status.
72 73 74 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 72 def data[:status_message] 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
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/aws-sdk-autoscaling/activity.rb', line 201 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 |