You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AutoScaling::Activity

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Activity #initialize(options = {}) ⇒ Activity

Returns a new instance of Activity

Overloads:

  • #initialize(id, options = {}) ⇒ Activity

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Activity

    Options Hash (options):

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


19
20
21
22
23
24
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 19

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)
end

Instance Method Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 36

def auto_scaling_group_name
  data[:auto_scaling_group_name]
end

#causeString

The reason the activity began.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 48

def cause
  data[:cause]
end

#clientClient

Returns:



91
92
93
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 91

def client
  @client
end

#dataTypes::Activity

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

Returns:



111
112
113
114
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 111

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.



119
120
121
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 119

def data_loaded?
  !!@data
end

#descriptionString

A friendly, more verbose description of the activity.

Returns:

  • (String)


42
43
44
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 42

def description
  data[:description]
end

#detailsString

The details about the activity.

Returns:

  • (String)


84
85
86
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 84

def details
  data[:details]
end

#end_timeTime

The end time of the activity.

Returns:

  • (Time)


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

def end_time
  data[:end_time]
end

#groupAutoScalingGroup?

Returns:



221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-autoscaling/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

#idString Also known as: activity_id

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 29

def id
  @id
end

#loadself 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

Returns:

  • (self)


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

def load
  resp = @client.describe_scaling_activities(activity_ids: [@id])
  @data = resp.activities[0]
  self
end

#progressInteger

A value between 0 and 100 that indicates the progress of the activity.

Returns:

  • (Integer)


78
79
80
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 78

def progress
  data[:progress]
end

#start_timeTime

The start time of the activity.

Returns:

  • (Time)


54
55
56
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 54

def start_time
  data[:start_time]
end

#status_codeString

The current status of the activity.

Returns:

  • (String)


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

def status_code
  data[:status_code]
end

#status_messageString

A friendly, more verbose description of the activity status.

Returns:

  • (String)


72
73
74
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 72

def status_message
  data[:status_message]
end

#wait_until(options = {}, &block) ⇒ 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) {|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

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

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 201

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