Class: Aws::AutoScaling::Instance

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(group_name, id, options = {}) ⇒ Instance #initialize(options = {}) ⇒ Instance

Returns a new instance of Instance.

Overloads:

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

    Parameters:

    • group_name (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Instance

    Options Hash (options):

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


24
25
26
27
28
29
30
31
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 24

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @group_name = extract_group_name(args, options)
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#attach(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.attach()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (EmptyStructure) 


261
262
263
264
265
266
267
268
269
270
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 261

def attach(options = {})
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @group_name,
    instance_ids: [@id]
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.attach_instances(options)
  end
  resp.data
end

#availability_zone ⇒ String

The Availability Zone for the instance.

Returns:

  • (String) 


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

def availability_zone
  data[:availability_zone]
end

#client ⇒ Client

Returns:



121
122
123
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 121

def client
  @client
end

#data ⇒ Types::AutoScalingInstanceDetails

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

Returns:



143
144
145
146
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 143

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.



151
152
153
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 151

def data_loaded?
  !!@data
end

#detach(options = {}) ⇒ Activity::Collection

Examples:

Request syntax with placeholder values


activity = instance.detach({
  should_decrement_desired_capacity: false, # required
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :should_decrement_desired_capacity (required, Boolean) —

    Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 282

def detach(options = {})
  batch = []
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @group_name,
    instance_ids: [@id]
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.detach_instances(options)
  end
  resp.data.activities.each do |a|
    batch << Activity.new(
      id: a.activity_id,
      data: a,
      client: @client
    )
  end
  Activity::Collection.new([batch], size: batch.size)
end

#enter_standby(options = {}) ⇒ Activity::Collection

Examples:

Request syntax with placeholder values


activity = instance.enter_standby({
  should_decrement_desired_capacity: false, # required
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :should_decrement_desired_capacity (required, Boolean) —

    Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 311

def enter_standby(options = {})
  batch = []
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @group_name,
    instance_ids: [@id]
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.enter_standby(options)
  end
  resp.data.activities.each do |a|
    batch << Activity.new(
      id: a.activity_id,
      data: a,
      client: @client
    )
  end
  Activity::Collection.new([batch], size: batch.size)
end

#exit_standby(options = {}) ⇒ Activity::Collection

Examples:

Request syntax with placeholder values


instance.exit_standby()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 335

def exit_standby(options = {})
  batch = []
  options = Aws::Util.deep_merge(options,
    auto_scaling_group_name: @group_name,
    instance_ids: [@id]
  )
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.exit_standby(options)
  end
  resp.data.activities.each do |a|
    batch << Activity.new(
      id: a.activity_id,
      data: a,
      client: @client
    )
  end
  Activity::Collection.new([batch], size: batch.size)
end

#group ⇒ AutoScalingGroup

Returns:



413
414
415
416
417
418
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 413

def group
  AutoScalingGroup.new(
    name: @group_name,
    client: @client
  )
end

#group_name ⇒ String Also known as: auto_scaling_group_name

Returns:

  • (String) 


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

def group_name
  @group_name
end

#health_status ⇒ String

The last reported health status of this instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

Returns:

  • (String) 


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

def health_status
  data[:health_status]
end

#id ⇒ String Also known as: instance_id

Returns:

  • (String) 


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

def id
  @id
end

#instance_type ⇒ String

The instance type of the EC2 instance.

Returns:

  • (String) 


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

def instance_type
  data[:instance_type]
end

#launch_configuration ⇒ LaunchConfiguration?

Returns:



421
422
423
424
425
426
427
428
429
430
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 421

def launch_configuration
  if data[:launch_configuration_name]
    LaunchConfiguration.new(
      name: data[:launch_configuration_name],
      client: @client
    )
  else
    nil
  end
end

#launch_configuration_name ⇒ String

The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

Returns:

  • (String) 


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

def launch_configuration_name
  data[:launch_configuration_name]
end

#launch_template ⇒ Types::LaunchTemplateSpecification

The launch template for the instance.

Returns:



98
99
100
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 98

def launch_template
  data[:launch_template]
end

#lifecycle_state ⇒ String

The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined | InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached | EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating | Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running

Returns:

  • (String) 


76
77
78
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 76

def lifecycle_state
  data[:lifecycle_state]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::AutoScaling::Instance. Returns self making it possible to chain methods.

instance.reload.data

Returns:

  • (self) 


131
132
133
134
135
136
137
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 131

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_auto_scaling_instances(instance_ids: [@id])
  end
  @data = resp.auto_scaling_instances[0]
  self
end

#protected_from_scale_in ⇒ Boolean

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Returns:

  • (Boolean) 


105
106
107
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 105

def protected_from_scale_in
  data[:protected_from_scale_in]
end

#set_health(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.set_health({
  health_status: "XmlStringMaxLen32", # required
  should_respect_grace_period: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :health_status (required, String) —

    The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

  • :should_respect_grace_period (Boolean) —

    If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

    For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

Returns:

  • (EmptyStructure) 


380
381
382
383
384
385
386
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 380

def set_health(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.set_instance_health(options)
  end
  resp.data
end

#terminate(options = {}) ⇒ Activity

Examples:

Request syntax with placeholder values


activity = instance.terminate({
  should_decrement_desired_capacity: false, # required
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :should_decrement_desired_capacity (required, Boolean) —

    Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

Returns:



398
399
400
401
402
403
404
405
406
407
408
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 398

def terminate(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.terminate_instance_in_auto_scaling_group(options)
  end
  Activity.new(
    id: resp.data.activity.activity_id,
    data: resp.data.activity,
    client: @client
  )
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 235

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::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

#weighted_capacity ⇒ String

The number of capacity units contributed by the instance based on its instance type.

Valid Range: Minimum value of 1. Maximum value of 999.

Returns:

  • (String) 


114
115
116
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/instance.rb', line 114

def weighted_capacity
  data[:weighted_capacity]
end