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:



126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/activity.rb', line 126

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