Class: Aws::AutoScaling::AutoScalingGroup

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-autoscaling/auto_scaling_group.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ AutoScalingGroup #initialize(options = {}) ⇒ AutoScalingGroup

Returns a new instance of AutoScalingGroup.

Overloads:

  • #initialize(name, options = {}) ⇒ AutoScalingGroup

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ AutoScalingGroup

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 22

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

Instance Method Details

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

Examples:

Request syntax with placeholder values


activities = auto_scaling_group.activities({
  activity_ids: ["XmlString"],
  include_deleted_groups: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :activity_ids (Array<String>) —

    The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

    Array Members: Maximum number of 50 IDs.

  • :include_deleted_groups (Boolean) —

    Indicates whether to include scaling activity from deleted Auto Scaling groups.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1500

def activities(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_scaling_activities(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.activities.each do |a|
        batch << Activity.new(
          id: a.activity_id,
          data: a,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Activity::Collection.new(batches)
end

#attach_instances(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.attach_instances({
  instance_ids: ["XmlStringMaxLen19"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :instance_ids (Array<String>) —

    The IDs of the instances. You can specify up to 20 instances.

Returns:

  • (EmptyStructure) 


460
461
462
463
464
465
466
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 460

def attach_instances(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_instances(options)
  end
  resp.data
end

#auto_scaling_group_arn ⇒ String

The Amazon Resource Name (ARN) of the Auto Scaling group.

Returns:

  • (String) 


40
41
42
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 40

def auto_scaling_group_arn
  data[:auto_scaling_group_arn]
end

#availability_zones ⇒ Array<String>

One or more Availability Zones for the group.

Returns:

  • (Array<String>) 


95
96
97
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 95

def availability_zones
  data[:availability_zones]
end

#capacity_rebalance ⇒ Boolean

Indicates whether Capacity Rebalancing is enabled.

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 194

def capacity_rebalance
  data[:capacity_rebalance]
end

#client ⇒ Client

Returns:



245
246
247
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 245

def client
  @client
end

#context ⇒ String

Reserved.

Returns:

  • (String) 


212
213
214
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 212

def context
  data[:context]
end

#created_time ⇒ Time

The date and time the group was created.

Returns:

  • (Time) 


126
127
128
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 126

def created_time
  data[:created_time]
end

#data ⇒ Types::AutoScalingGroup

Returns the data for this Aws::AutoScaling::AutoScalingGroup. Calls Client#describe_auto_scaling_groups if #data_loaded? is ‘false`.

Returns:



267
268
269
270
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 267

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.



275
276
277
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 275

def data_loaded?
  !!@data
end

#default_cooldown ⇒ Integer

The duration of the default cooldown period, in seconds.

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 89

def default_cooldown
  data[:default_cooldown]
end

#default_instance_warmup ⇒ Integer

The duration of the default instance warmup, in seconds.

Returns:

  • (Integer) 


226
227
228
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 226

def default_instance_warmup
  data[:default_instance_warmup]
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.delete({
  force_delete: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :force_delete (Boolean) —

    Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This action also deletes any outstanding lifecycle actions associated with the group.

Returns:

  • (EmptyStructure) 


480
481
482
483
484
485
486
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 480

def delete(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_auto_scaling_group(options)
  end
  resp.data
end

#desired_capacity ⇒ Integer

The desired size of the group.

Returns:

  • (Integer) 


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

def desired_capacity
  data[:desired_capacity]
end

#desired_capacity_type ⇒ String

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ‘DesiredCapacityType` for attribute-based instance type selection only.

Returns:

  • (String) 


220
221
222
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 220

def desired_capacity_type
  data[:desired_capacity_type]
end

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

Examples:

Request syntax with placeholder values


activity = auto_scaling_group.detach_instances({
  instance_ids: ["XmlStringMaxLen19"],
  should_decrement_desired_capacity: false, # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :instance_ids (Array<String>) —

    The IDs of the instances. You can specify up to 20 instances.

  • :should_decrement_desired_capacity (required, Boolean) —

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

Returns:



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 501

def detach_instances(options = {})
  batch = []
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') 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

#disable_metrics_collection(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.disable_metrics_collection({
  metrics: ["XmlStringMaxLen255"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :metrics (Array<String>) —

    Identifies the metrics to disable.

    You can specify one or more of the following metrics:

    • ‘GroupMinSize`

    • ‘GroupMaxSize`

    • ‘GroupDesiredCapacity`

    • ‘GroupInServiceInstances`

    • ‘GroupPendingInstances`

    • ‘GroupStandbyInstances`

    • ‘GroupTerminatingInstances`

    • ‘GroupTotalInstances`

    • ‘GroupInServiceCapacity`

    • ‘GroupPendingCapacity`

    • ‘GroupStandbyCapacity`

    • ‘GroupTerminatingCapacity`

    • ‘GroupTotalCapacity`

    • ‘WarmPoolDesiredCapacity`

    • ‘WarmPoolWarmedCapacity`

    • ‘WarmPoolPendingCapacity`

    • ‘WarmPoolTerminatingCapacity`

    • ‘WarmPoolTotalCapacity`

    • ‘GroupAndWarmPoolDesiredCapacity`

    • ‘GroupAndWarmPoolTotalCapacity`

    If you omit this property, all metrics are disabled.

    For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html

Returns:

  • (EmptyStructure) 


577
578
579
580
581
582
583
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 577

def disable_metrics_collection(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.disable_metrics_collection(options)
  end
  resp.data
end

#enable_metrics_collection(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.enable_metrics_collection({
  metrics: ["XmlStringMaxLen255"],
  granularity: "XmlStringMaxLen255", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :metrics (Array<String>) —

    Identifies the metrics to enable.

    You can specify one or more of the following metrics:

    • ‘GroupMinSize`

    • ‘GroupMaxSize`

    • ‘GroupDesiredCapacity`

    • ‘GroupInServiceInstances`

    • ‘GroupPendingInstances`

    • ‘GroupStandbyInstances`

    • ‘GroupTerminatingInstances`

    • ‘GroupTotalInstances`

    • ‘GroupInServiceCapacity`

    • ‘GroupPendingCapacity`

    • ‘GroupStandbyCapacity`

    • ‘GroupTerminatingCapacity`

    • ‘GroupTotalCapacity`

    • ‘WarmPoolDesiredCapacity`

    • ‘WarmPoolWarmedCapacity`

    • ‘WarmPoolPendingCapacity`

    • ‘WarmPoolTerminatingCapacity`

    • ‘WarmPoolTotalCapacity`

    • ‘GroupAndWarmPoolDesiredCapacity`

    • ‘GroupAndWarmPoolTotalCapacity`

    If you specify ‘Granularity` and don’t specify any metrics, all metrics are enabled.

    For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html

  • :granularity (required, String) —

    The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ‘1Minute`.

Returns:

  • (EmptyStructure) 


650
651
652
653
654
655
656
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 650

def enable_metrics_collection(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.enable_metrics_collection(options)
  end
  resp.data
end

#enabled_metrics ⇒ Array<Types::EnabledMetric>

The metrics enabled for the group.

Returns:



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

def enabled_metrics
  data[:enabled_metrics]
end

#exists?(options = {}) ⇒ Boolean

Returns ‘true` if the AutoScalingGroup exists.

Parameters:

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

    ({})

Returns:

  • (Boolean) —

    Returns ‘true` if the AutoScalingGroup exists.



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 282

def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end

#health_check_grace_period ⇒ Integer

The duration of the health check grace period, in seconds.

Returns:

  • (Integer) 


120
121
122
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 120

def health_check_grace_period
  data[:health_check_grace_period]
end

#health_check_type ⇒ String

A comma-separated value string of one or more health check types.

Returns:

  • (String) 


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

def health_check_type
  data[:health_check_type]
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.

Deprecated. 


1761
1762
1763
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1761

def identifiers
  { name: @name }
end

#instance_maintenance_policy ⇒ Types::InstanceMaintenancePolicy

An instance maintenance policy.

Returns:



238
239
240
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 238

def instance_maintenance_policy
  data[:instance_maintenance_policy]
end

#instances ⇒ Instance::Collection

Returns:



1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1522

def instances
  batch = []
  data[:instances].each do |d|
    batch << Instance.new(
      group_name: @name,
      id: d[:instance_id],
      data: d,
      client: @client
    )
  end
  Instance::Collection.new([batch], size: batch.size)
end

#launch_configuration ⇒ LaunchConfiguration?

Returns:



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1536

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 name of the associated launch configuration.

Returns:

  • (String) 


46
47
48
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 46

def launch_configuration_name
  data[:launch_configuration_name]
end

#launch_template ⇒ Types::LaunchTemplateSpecification

The launch template for the group.

Returns:



52
53
54
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 52

def launch_template
  data[:launch_template]
end

#lifecycle_hook(name) ⇒ LifecycleHook

Parameters:

  • name (String)

Returns:



1549
1550
1551
1552
1553
1554
1555
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1549

def lifecycle_hook(name)
  LifecycleHook.new(
    group_name: @name,
    name: name,
    client: @client
  )
end

#lifecycle_hooks(options = {}) ⇒ LifecycleHook::Collection

Examples:

Request syntax with placeholder values


lifecycle_hooks = auto_scaling_group.lifecycle_hooks({
  lifecycle_hook_names: ["AsciiStringMaxLen255"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :lifecycle_hook_names (Array<String>) —

    The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described.

Returns:



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1567

def lifecycle_hooks(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(auto_scaling_group_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_lifecycle_hooks(options)
    end
    resp.data.lifecycle_hooks.each do |l|
      batch << LifecycleHook.new(
        group_name: l.auto_scaling_group_name,
        name: l.lifecycle_hook_name,
        data: l,
        client: @client
      )
    end
    y.yield(batch)
  end
  LifecycleHook::Collection.new(batches)
end

#load ⇒ self Also known as: reload

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

auto_scaling_group.reload.data

Returns:

  • (self) 


255
256
257
258
259
260
261
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 255

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_auto_scaling_groups(auto_scaling_group_names: [@name])
  end
  @data = resp.auto_scaling_groups[0]
  self
end

#load_balancer(name) ⇒ LoadBalancer

Parameters:

  • name (String)

Returns:



1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1589

def load_balancer(name)
  LoadBalancer.new(
    group_name: @name,
    name: name,
    client: @client
  )
end

#load_balancer_names ⇒ Array<String>

One or more load balancers associated with the group.

Returns:

  • (Array<String>) 


101
102
103
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 101

def load_balancer_names
  data[:load_balancer_names]
end

#load_balancers(options = {}) ⇒ LoadBalancer::Collection

Examples:

Request syntax with placeholder values


auto_scaling_group.load_balancers()

Parameters:

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

    ({})

Returns:



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1602

def load_balancers(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_load_balancers(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.load_balancers.each do |l|
        batch << LoadBalancer.new(
          group_name: @name,
          name: l.load_balancer_name,
          data: l,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  LoadBalancer::Collection.new(batches)
end

#max_instance_lifetime ⇒ Integer

The maximum amount of time, in seconds, that an instance can be in service.

Valid Range: Minimum value of 0.

Returns:

  • (Integer) 


188
189
190
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 188

def max_instance_lifetime
  data[:max_instance_lifetime]
end

#max_size ⇒ Integer

The maximum size of the group.

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 70

def max_size
  data[:max_size]
end

#min_size ⇒ Integer

The minimum size of the group.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 64

def min_size
  data[:min_size]
end

#mixed_instances_policy ⇒ Types::MixedInstancesPolicy

The mixed instances policy for the group.

Returns:



58
59
60
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 58

def mixed_instances_policy
  data[:mixed_instances_policy]
end

#name ⇒ String Also known as: auto_scaling_group_name

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 33

def name
  @name
end

#new_instances_protected_from_scale_in ⇒ Boolean

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 171

def new_instances_protected_from_scale_in
  data[:new_instances_protected_from_scale_in]
end

#notification_configurations(options = {}) ⇒ NotificationConfiguration::Collection

Examples:

Request syntax with placeholder values


auto_scaling_group.notification_configurations()

Parameters:

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

    ({})

Returns:



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1629

def notification_configurations(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, auto_scaling_group_names: [@name])
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_notification_configurations(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.notification_configurations.each do |n|
        batch << NotificationConfiguration.new(
          group_name: n.auto_scaling_group_name,
          type: n.notification_type,
          topic_arn: n.topic_arn,
          data: n,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  NotificationConfiguration::Collection.new(batches)
end

#placement_group ⇒ String

The name of the placement group into which to launch your instances, if any.

Returns:

  • (String) 


139
140
141
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 139

def placement_group
  data[:placement_group]
end

#policies(options = {}) ⇒ ScalingPolicy::Collection

Examples:

Request syntax with placeholder values


policies = auto_scaling_group.policies({
  policy_names: ["ResourceName"],
  policy_types: ["XmlStringMaxLen64"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_names (Array<String>) —

    The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.

    Array Members: Maximum number of 50 items.

  • :policy_types (Array<String>) —

    One or more policy types. The valid values are ‘SimpleScaling`, `StepScaling`, `TargetTrackingScaling`, and `PredictiveScaling`.

Returns:



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1670

def policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_policies(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.scaling_policies.each do |s|
        batch << ScalingPolicy.new(
          name: s.policy_name,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ScalingPolicy::Collection.new(batches)
end

#predicted_capacity ⇒ Integer

The predicted capacity of the group when it has a predictive scaling policy.

Returns:

  • (Integer) 


83
84
85
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 83

def predicted_capacity
  data[:predicted_capacity]
end

#put_scaling_policy(options = {}) ⇒ ScalingPolicy

Examples:

Request syntax with placeholder values


scalingpolicy = auto_scaling_group.put_scaling_policy({
  policy_name: "XmlStringMaxLen255", # required
  policy_type: "XmlStringMaxLen64",
  adjustment_type: "XmlStringMaxLen255",
  min_adjustment_step: 1,
  min_adjustment_magnitude: 1,
  scaling_adjustment: 1,
  cooldown: 1,
  metric_aggregation_type: "XmlStringMaxLen32",
  step_adjustments: [
    {
      metric_interval_lower_bound: 1.0,
      metric_interval_upper_bound: 1.0,
      scaling_adjustment: 1, # required
    },
  ],
  estimated_instance_warmup: 1,
  target_tracking_configuration: {
    predefined_metric_specification: {
      predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget
      resource_label: "XmlStringMaxLen1023",
    },
    customized_metric_specification: {
      metric_name: "MetricName",
      namespace: "MetricNamespace",
      dimensions: [
        {
          name: "MetricDimensionName", # required
          value: "MetricDimensionValue", # required
        },
      ],
      statistic: "Average", # accepts Average, Minimum, Maximum, SampleCount, Sum
      unit: "MetricUnit",
      metrics: [
        {
          id: "XmlStringMaxLen64", # required
          expression: "XmlStringMaxLen2047",
          metric_stat: {
            metric: { # required
              namespace: "MetricNamespace", # required
              metric_name: "MetricName", # required
              dimensions: [
                {
                  name: "MetricDimensionName", # required
                  value: "MetricDimensionValue", # required
                },
              ],
            },
            stat: "XmlStringMetricStat", # required
            unit: "MetricUnit",
          },
          label: "XmlStringMetricLabel",
          return_data: false,
        },
      ],
    },
    target_value: 1.0, # required
    disable_scale_in: false,
  },
  enabled: false,
  predictive_scaling_configuration: {
    metric_specifications: [ # required
      {
        target_value: 1.0, # required
        predefined_metric_pair_specification: {
          predefined_metric_type: "ASGCPUUtilization", # required, accepts ASGCPUUtilization, ASGNetworkIn, ASGNetworkOut, ALBRequestCount
          resource_label: "XmlStringMaxLen1023",
        },
        predefined_scaling_metric_specification: {
          predefined_metric_type: "ASGAverageCPUUtilization", # required, accepts ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, ALBRequestCountPerTarget
          resource_label: "XmlStringMaxLen1023",
        },
        predefined_load_metric_specification: {
          predefined_metric_type: "ASGTotalCPUUtilization", # required, accepts ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount
          resource_label: "XmlStringMaxLen1023",
        },
        customized_scaling_metric_specification: {
          metric_data_queries: [ # required
            {
              id: "XmlStringMaxLen255", # required
              expression: "XmlStringMaxLen1023",
              metric_stat: {
                metric: { # required
                  namespace: "MetricNamespace", # required
                  metric_name: "MetricName", # required
                  dimensions: [
                    {
                      name: "MetricDimensionName", # required
                      value: "MetricDimensionValue", # required
                    },
                  ],
                },
                stat: "XmlStringMetricStat", # required
                unit: "MetricUnit",
              },
              label: "XmlStringMetricLabel",
              return_data: false,
            },
          ],
        },
        customized_load_metric_specification: {
          metric_data_queries: [ # required
            {
              id: "XmlStringMaxLen255", # required
              expression: "XmlStringMaxLen1023",
              metric_stat: {
                metric: { # required
                  namespace: "MetricNamespace", # required
                  metric_name: "MetricName", # required
                  dimensions: [
                    {
                      name: "MetricDimensionName", # required
                      value: "MetricDimensionValue", # required
                    },
                  ],
                },
                stat: "XmlStringMetricStat", # required
                unit: "MetricUnit",
              },
              label: "XmlStringMetricLabel",
              return_data: false,
            },
          ],
        },
        customized_capacity_metric_specification: {
          metric_data_queries: [ # required
            {
              id: "XmlStringMaxLen255", # required
              expression: "XmlStringMaxLen1023",
              metric_stat: {
                metric: { # required
                  namespace: "MetricNamespace", # required
                  metric_name: "MetricName", # required
                  dimensions: [
                    {
                      name: "MetricDimensionName", # required
                      value: "MetricDimensionValue", # required
                    },
                  ],
                },
                stat: "XmlStringMetricStat", # required
                unit: "MetricUnit",
              },
              label: "XmlStringMetricLabel",
              return_data: false,
            },
          ],
        },
      },
    ],
    mode: "ForecastAndScale", # accepts ForecastAndScale, ForecastOnly
    scheduling_buffer_time: 1,
    max_capacity_breach_behavior: "HonorMaxCapacity", # accepts HonorMaxCapacity, IncreaseMaxCapacity
    max_capacity_buffer: 1,
  },
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_name (required, String) —

    The name of the policy.

  • :policy_type (String) —

    One of the following policy types:

    • ‘TargetTrackingScaling`

    • ‘StepScaling`

    • ‘SimpleScaling` (default)

    • ‘PredictiveScaling`

  • :adjustment_type (String) —

    Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ‘ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.

    Required if the policy type is ‘StepScaling` or `SimpleScaling`. For more information, see [Scaling adjustment types] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment

  • :min_adjustment_step (Integer) —

    Available for backward compatibility. Use ‘MinAdjustmentMagnitude` instead.

  • :min_adjustment_magnitude (Integer) —

    The minimum value to scale by when the adjustment type is ‘PercentChangeInCapacity`. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

    Valid only if the policy type is ‘StepScaling` or `SimpleScaling`. For more information, see [Scaling adjustment types] in the *Amazon EC2 Auto Scaling User Guide*.

    <note markdown=“1”> Some Auto Scaling groups use instance weights. In this case, set the ‘MinAdjustmentMagnitude` to a value that is at least as large as your largest instance weight.

    </note>

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment

  • :scaling_adjustment (Integer) —

    The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.

    Required if the policy type is ‘SimpleScaling`. (Not used with any other policy type.)

  • :cooldown (Integer) —

    A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.

    Valid only if the policy type is ‘SimpleScaling`. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling] in the *Amazon EC2 Auto Scaling User Guide*.

    Default: None

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html

  • :metric_aggregation_type (String) —

    The aggregation type for the CloudWatch metrics. The valid values are ‘Minimum`, `Maximum`, and `Average`. If the aggregation type is null, the value is treated as `Average`.

    Valid only if the policy type is ‘StepScaling`.

  • :step_adjustments (Array<Types::StepAdjustment>) —

    A set of adjustments that enable you to scale based on the size of the alarm breach.

    Required if the policy type is ‘StepScaling`. (Not used with any other policy type.)

  • :estimated_instance_warmup (Integer) —

    *Not needed if the default instance warmup is defined for the group.*

    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.

    Valid only if the policy type is ‘TargetTrackingScaling` or `StepScaling`.

    <note markdown=“1”> The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then ‘EstimatedInstanceWarmup` falls back to the value of default cooldown.

    </note>
  • :target_tracking_configuration (Types::TargetTrackingConfiguration) —

    A target tracking scaling policy. Provides support for predefined or custom metrics.

    The following predefined metrics are available:

    • ‘ASGAverageCPUUtilization`

    • ‘ASGAverageNetworkIn`

    • ‘ASGAverageNetworkOut`

    • ‘ALBRequestCountPerTarget`

    If you specify ‘ALBRequestCountPerTarget` for the metric, you must specify the `ResourceLabel` property with the `PredefinedMetricSpecification`.

    For more information, see [TargetTrackingConfiguration] in the *Amazon EC2 Auto Scaling API Reference*.

    Required if the policy type is ‘TargetTrackingScaling`.

    [1]: docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html

  • :enabled (Boolean) —

    Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see [Disable a scaling policy for an Auto Scaling group] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html

  • :predictive_scaling_configuration (Types::PredictiveScalingConfiguration) —

    A predictive scaling policy. Provides support for predefined and custom metrics.

    Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.

    For more information, see [PredictiveScalingConfiguration] in the *Amazon EC2 Auto Scaling API Reference*.

    Required if the policy type is ‘PredictiveScaling`.

    [1]: docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html

Returns:



968
969
970
971
972
973
974
975
976
977
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 968

def put_scaling_policy(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.put_scaling_policy(options)
  end
  ScalingPolicy.new(
    name: options[:policy_name],
    client: @client
  )
end

#put_scheduled_update_group_action(options = {}) ⇒ ScheduledAction

Examples:

Request syntax with placeholder values


scheduledaction = auto_scaling_group.put_scheduled_update_group_action({
  scheduled_action_name: "XmlStringMaxLen255", # required
  time: Time.now,
  start_time: Time.now,
  end_time: Time.now,
  recurrence: "XmlStringMaxLen255",
  min_size: 1,
  max_size: 1,
  desired_capacity: 1,
  time_zone: "XmlStringMaxLen255",
})

Parameters:

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

    ({})

Options Hash (options):

  • :scheduled_action_name (required, String) —

    The name of this scaling action.

  • :time (Time, DateTime, Date, Integer, String) —

    This property is no longer used.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, ‘“2021-06-01T00:00:00Z”`).

    If you specify ‘Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The date and time for the recurring schedule to end, in UTC. For example, ‘“2021-06-01T00:00:00Z”`.

  • :recurrence (String) —

    The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, ‘“30 0 1 1,6,12 *”`). For more information about this format, see [Crontab].

    When ‘StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops.

    Cron expressions use Universal Coordinated Time (UTC) by default.

    [1]: crontab.org

  • :min_size (Integer) —

    The minimum size of the Auto Scaling group.

  • :max_size (Integer) —

    The maximum size of the Auto Scaling group.

  • :desired_capacity (Integer) —

    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.

    <note markdown=“1”> You must specify at least one of the following properties: ‘MaxSize`, `MinSize`, or `DesiredCapacity`.

    </note>
  • :time_zone (String) —

    Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

    Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as ‘Etc/GMT+9` or `Pacific/Tahiti`). For more information, see [en.wikipedia.org/wiki/List_of_tz_database_time_zones][1].

    [1]: en.wikipedia.org/wiki/List_of_tz_database_time_zones

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1050

def put_scheduled_update_group_action(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.put_scheduled_update_group_action(options)
  end
  ScheduledAction.new(
    name: options[:scheduled_action_name],
    client: @client
  )
end

#resume_processes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.resume_processes({
  scaling_processes: ["XmlStringMaxLen255"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :scaling_processes (Array<String>) —

    One or more of the following processes:

    • ‘Launch`

    • ‘Terminate`

    • ‘AddToLoadBalancer`

    • ‘AlarmNotification`

    • ‘AZRebalance`

    • ‘HealthCheck`

    • ‘InstanceRefresh`

    • ‘ReplaceUnhealthy`

    • ‘ScheduledActions`

    If you omit this property, all processes are specified.

Returns:

  • (EmptyStructure) 


1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1090

def resume_processes(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.resume_processes(options)
  end
  resp.data
end

#scheduled_actions(options = {}) ⇒ ScheduledAction::Collection

Examples:

Request syntax with placeholder values


scheduled_actions = auto_scaling_group.scheduled_actions({
  scheduled_action_names: ["XmlStringMaxLen255"],
  start_time: Time.now,
  end_time: Time.now,
})

Parameters:

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

    ({})

Options Hash (options):

  • :scheduled_action_names (Array<String>) —

    The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

    Array Members: Maximum number of 50 actions.

  • :start_time (Time, DateTime, Date, Integer, String) —

    The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.

Returns:



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1712

def scheduled_actions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_scheduled_actions(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.scheduled_update_group_actions.each do |s|
        batch << ScheduledAction.new(
          name: s.scheduled_action_name,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ScheduledAction::Collection.new(batches)
end

#service_linked_role_arn ⇒ String

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.

Returns:

  • (String) 


179
180
181
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 179

def service_linked_role_arn
  data[:service_linked_role_arn]
end

#set_desired_capacity(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.set_desired_capacity({
  desired_capacity: 1, # required
  honor_cooldown: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :desired_capacity (required, Integer) —

    The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.

  • :honor_cooldown (Boolean) —

    Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

Returns:

  • (EmptyStructure) 


1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1116

def set_desired_capacity(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.set_desired_capacity(options)
  end
  resp.data
end

#status ⇒ String

The current state of the group when the DeleteAutoScalingGroup operation is in progress.

Returns:

  • (String) 


158
159
160
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 158

def status
  data[:status]
end

#suspend_processes(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


auto_scaling_group.suspend_processes({
  scaling_processes: ["XmlStringMaxLen255"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :scaling_processes (Array<String>) —

    One or more of the following processes:

    • ‘Launch`

    • ‘Terminate`

    • ‘AddToLoadBalancer`

    • ‘AlarmNotification`

    • ‘AZRebalance`

    • ‘HealthCheck`

    • ‘InstanceRefresh`

    • ‘ReplaceUnhealthy`

    • ‘ScheduledActions`

    If you omit this property, all processes are specified.

Returns:

  • (EmptyStructure) 


1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1153

def suspend_processes(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.suspend_processes(options)
  end
  resp.data
end

#suspended_processes ⇒ Array<Types::SuspendedProcess>

The suspended processes associated with the group.

Returns:



132
133
134
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 132

def suspended_processes
  data[:suspended_processes]
end

#tag(key) ⇒ Tag

Parameters:

  • key (String)

Returns:



1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1735

def tag(key)
  Tag.new(
    key: key,
    resource_id: @name,
    resource_type: "auto-scaling-group",
    client: @client
  )
end

#tags ⇒ Tag::Collection

Returns:



1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1745

def tags
  batch = []
  data[:tags].each do |d|
    batch << Tag.new(
      key: d[:key],
      resource_id: d[:resource_id],
      resource_type: d[:resource_type],
      data: d,
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#target_group_arns ⇒ Array<String>

The Amazon Resource Names (ARN) of the target groups for your load balancer.

Returns:

  • (Array<String>) 


108
109
110
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 108

def target_group_arns
  data[:target_group_arns]
end

#termination_policies ⇒ Array<String>

The termination policies for the group.

Returns:

  • (Array<String>) 


164
165
166
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 164

def termination_policies
  data[:termination_policies]
end

#traffic_sources ⇒ Array<Types::TrafficSourceIdentifier>

The traffic sources associated with this Auto Scaling group.

Returns:



232
233
234
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 232

def traffic_sources
  data[:traffic_sources]
end

#update(options = {}) ⇒ AutoScalingGroup

Examples:

Request syntax with placeholder values


autoscalinggroup = auto_scaling_group.update({
  launch_configuration_name: "XmlStringMaxLen255",
  launch_template: {
    launch_template_id: "XmlStringMaxLen255",
    launch_template_name: "LaunchTemplateName",
    version: "XmlStringMaxLen255",
  },
  mixed_instances_policy: {
    launch_template: {
      launch_template_specification: {
        launch_template_id: "XmlStringMaxLen255",
        launch_template_name: "LaunchTemplateName",
        version: "XmlStringMaxLen255",
      },
      overrides: [
        {
          instance_type: "XmlStringMaxLen255",
          weighted_capacity: "XmlStringMaxLen32",
          launch_template_specification: {
            launch_template_id: "XmlStringMaxLen255",
            launch_template_name: "LaunchTemplateName",
            version: "XmlStringMaxLen255",
          },
          instance_requirements: {
            v_cpu_count: { # required
              min: 1, # required
              max: 1,
            },
            memory_mi_b: { # required
              min: 1, # required
              max: 1,
            },
            cpu_manufacturers: ["intel"], # accepts intel, amd, amazon-web-services
            memory_gi_b_per_v_cpu: {
              min: 1.0,
              max: 1.0,
            },
            excluded_instance_types: ["ExcludedInstance"],
            instance_generations: ["current"], # accepts current, previous
            spot_max_price_percentage_over_lowest_price: 1,
            max_spot_price_as_percentage_of_optimal_on_demand_price: 1,
            on_demand_max_price_percentage_over_lowest_price: 1,
            bare_metal: "included", # accepts included, excluded, required
            burstable_performance: "included", # accepts included, excluded, required
            require_hibernate_support: false,
            network_interface_count: {
              min: 1,
              max: 1,
            },
            local_storage: "included", # accepts included, excluded, required
            local_storage_types: ["hdd"], # accepts hdd, ssd
            total_local_storage_gb: {
              min: 1.0,
              max: 1.0,
            },
            baseline_ebs_bandwidth_mbps: {
              min: 1,
              max: 1,
            },
            accelerator_types: ["gpu"], # accepts gpu, fpga, inference
            accelerator_count: {
              min: 1,
              max: 1,
            },
            accelerator_manufacturers: ["nvidia"], # accepts nvidia, amd, amazon-web-services, xilinx
            accelerator_names: ["a100"], # accepts a100, v100, k80, t4, m60, radeon-pro-v520, vu9p
            accelerator_total_memory_mi_b: {
              min: 1,
              max: 1,
            },
            network_bandwidth_gbps: {
              min: 1.0,
              max: 1.0,
            },
            allowed_instance_types: ["AllowedInstanceType"],
          },
        },
      ],
    },
    instances_distribution: {
      on_demand_allocation_strategy: "XmlString",
      on_demand_base_capacity: 1,
      on_demand_percentage_above_base_capacity: 1,
      spot_allocation_strategy: "XmlString",
      spot_instance_pools: 1,
      spot_max_price: "MixedInstanceSpotPrice",
    },
  },
  min_size: 1,
  max_size: 1,
  desired_capacity: 1,
  default_cooldown: 1,
  availability_zones: ["XmlStringMaxLen255"],
  health_check_type: "XmlStringMaxLen32",
  health_check_grace_period: 1,
  placement_group: "XmlStringMaxLen255",
  vpc_zone_identifier: "XmlStringMaxLen5000",
  termination_policies: ["XmlStringMaxLen1600"],
  new_instances_protected_from_scale_in: false,
  service_linked_role_arn: "ResourceName",
  max_instance_lifetime: 1,
  capacity_rebalance: false,
  context: "Context",
  desired_capacity_type: "XmlStringMaxLen255",
  default_instance_warmup: 1,
  instance_maintenance_policy: {
    min_healthy_percentage: 1,
    max_healthy_percentage: 1,
  },
})

Parameters:

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

    ({})

Options Hash (options):

  • :launch_configuration_name (String) —

    The name of the launch configuration. If you specify ‘LaunchConfigurationName` in your update request, you can’t specify ‘LaunchTemplate` or `MixedInstancesPolicy`.

  • :launch_template (Types::LaunchTemplateSpecification) —

    The launch template and version to use to specify the updates. If you specify ‘LaunchTemplate` in your update request, you can’t specify ‘LaunchConfigurationName` or `MixedInstancesPolicy`.

  • :mixed_instances_policy (Types::MixedInstancesPolicy) —

    The mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html

  • :min_size (Integer) —

    The minimum size of the Auto Scaling group.

  • :max_size (Integer) —

    The maximum size of the Auto Scaling group.

    <note markdown=“1”> With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ‘MaxSize` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above `MaxSize` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).

    </note>
  • :desired_capacity (Integer) —

    The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

  • :default_cooldown (Integer) —

    *Only needed if you use simple scaling policies.*

    The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html

  • :availability_zones (Array<String>) —

    One or more Availability Zones for the group.

  • :health_check_type (String) —

    A comma-separated value string of one or more health check types.

    The valid values are ‘EC2`, `EBS`, `ELB`, and `VPC_LATTICE`. `EC2` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group] in the *Amazon EC2 Auto Scaling User Guide*.

    Only specify ‘EC2` if you must clear a value that was previously set.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html

  • :health_check_grace_period (Integer) —

    The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ‘InService` state. For more information, see [Set the health check grace period for an Auto Scaling group] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html

  • :placement_group (String) —

    The name of an existing placement group into which to launch your instances. For more information, see [Placement groups] in the *Amazon EC2 User Guide for Linux Instances*.

    <note markdown=“1”> A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.

    </note>

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html

  • :vpc_zone_identifier (String) —

    A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify ‘VPCZoneIdentifier` with `AvailabilityZones`, the subnets that you specify must reside in those Availability Zones.

  • :termination_policies (Array<String>) —

    A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling] in the *Amazon EC2 Auto Scaling User Guide*.

    Valid values: ‘Default` | `AllocationStrategy` | `ClosestToNextInstanceHour` | `NewestInstance` | `OldestInstance` | `OldestLaunchConfiguration` | `OldestLaunchTemplate` | `arn:aws:lambda:region:account-id:function:my-function:my-alias`

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html

  • :new_instances_protected_from_scale_in (Boolean) —

    Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html

  • :service_linked_role_arn (String) —

    The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see [Service-linked roles] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html

  • :max_instance_lifetime (Integer) —

    The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html

  • :capacity_rebalance (Boolean) —

    Enables or disables Capacity Rebalancing. For more information, see

    Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions][1

    in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html

  • :context (String) —

    Reserved.

  • :desired_capacity_type (String) —

    The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ‘DesiredCapacityType` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection] in the *Amazon EC2 Auto Scaling User Guide*.

    By default, Amazon EC2 Auto Scaling specifies ‘units`, which translates into number of instances.

    Valid values: ‘units` | `vcpu` | `memory-mib`

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html

  • :default_instance_warmup (Integer) —

    The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ‘InService` state.

    During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group] in the *Amazon EC2 Auto Scaling User Guide*.

    To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ‘-1` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of `0` or other nominal value.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html

  • :instance_maintenance_policy (Types::InstanceMaintenancePolicy) —

    An instance maintenance policy. For more information, see [Set instance maintenance policy] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html

Returns:



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1468

def update(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.update_auto_scaling_group(options)
  end
  AutoScalingGroup.new(
    name: options[:auto_scaling_group_name],
    client: @client
  )
end

#vpc_zone_identifier ⇒ String

One or more subnet IDs, if applicable, separated by commas.

Returns:

  • (String) 


145
146
147
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 145

def vpc_zone_identifier
  data[:vpc_zone_identifier]
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 430

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.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

#wait_until_exists(options = {}, &block) ⇒ AutoScalingGroup

Parameters:

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

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 10
  • :delay (Float) — default: 5
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 299

def wait_until_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::GroupExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    waiter.wait(params.merge(auto_scaling_group_names: [@name]))
  end
  AutoScalingGroup.new({
    name: @name,
    client: @client
  })
end

#wait_until_in_service(options = {}, &block) ⇒ AutoScalingGroup

Parameters:

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

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 40
  • :delay (Float) — default: 15
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 318

def wait_until_in_service(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::GroupInService.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    waiter.wait(params.merge(auto_scaling_group_names: [@name]))
  end
  AutoScalingGroup.new({
    name: @name,
    client: @client
  })
end

#wait_until_not_exists(options = {}, &block) ⇒ AutoScalingGroup

Parameters:

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

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 40
  • :delay (Float) — default: 15
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 337

def wait_until_not_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::GroupNotExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    waiter.wait(params.merge(auto_scaling_group_names: [@name]))
  end
  AutoScalingGroup.new({
    name: @name,
    client: @client
  })
end

#warm_pool_configuration ⇒ Types::WarmPoolConfiguration

The warm pool for the group.

Returns:



200
201
202
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 200

def warm_pool_configuration
  data[:warm_pool_configuration]
end

#warm_pool_size ⇒ Integer

The current size of the warm pool.

Returns:

  • (Integer) 


206
207
208
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 206

def warm_pool_size
  data[:warm_pool_size]
end