class Aws::AutoScaling::Activity
Public Class Methods
@overload def initialize(id, options = {})
@param [String] id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :id @option options [Client] :client
# File lib/aws-sdk-autoscaling/activity.rb, line 22 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
The Amazon Resource
Name (ARN) of the Auto Scaling group. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 101 def auto_scaling_group_arn data[:auto_scaling_group_arn] end
The name of the Auto Scaling group. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 40 def auto_scaling_group_name data[:auto_scaling_group_name] end
The state of the Auto Scaling group, which is either `InService` or `Deleted`. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 95 def auto_scaling_group_state data[:auto_scaling_group_state] end
The reason the activity began. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 52 def cause data[:cause] end
@return [Client]
# File lib/aws-sdk-autoscaling/activity.rb, line 108 def client @client end
@return [Types::Activity]
Returns the data for this {Activity}. Calls {Client#describe_scaling_activities} if {#data_loaded?} is `false`.
# File lib/aws-sdk-autoscaling/activity.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/activity.rb, line 136 def data_loaded? !!@data end
A friendly, more verbose description of the activity. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 46 def description data[:description] end
The details about the activity. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 88 def details data[:details] end
The end time of the activity. @return [Time]
# File lib/aws-sdk-autoscaling/activity.rb, line 64 def end_time data[:end_time] end
@return [AutoScalingGroup, nil]
# File lib/aws-sdk-autoscaling/activity.rb, line 240 def group if data[:auto_scaling_group_name] AutoScalingGroup.new( name: data[:auto_scaling_group_name], client: @client ) else nil end end
@return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 33 def id @id end
@deprecated @api private
# File lib/aws-sdk-autoscaling/activity.rb, line 253 def identifiers { id: @id } end
Loads, or reloads {#data} for the current {Activity}. Returns `self` making it possible to chain methods.
activity.reload.data
@return [self]
# File lib/aws-sdk-autoscaling/activity.rb, line 118 def load resp = @client.describe_scaling_activities(activity_ids: [@id]) @data = resp.activities[0] self end
A value between 0 and 100 that indicates the progress of the activity. @return [Integer]
# File lib/aws-sdk-autoscaling/activity.rb, line 82 def progress data[:progress] end
The start time of the activity. @return [Time]
# File lib/aws-sdk-autoscaling/activity.rb, line 58 def start_time data[:start_time] end
The current status of the activity. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 70 def status_code data[:status_code] end
A friendly, more verbose description of the activity status. @return [String]
# File lib/aws-sdk-autoscaling/activity.rb, line 76 def status_message data[:status_message] 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/activity.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/activity.rb, line 260 def extract_id(args, options) value = args[0] || options.delete(:id) case value when String then value when nil then raise ArgumentError, "missing required option :id" else msg = "expected :id to be a String, got #{value.class}" raise ArgumentError, msg end end