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) 


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

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

Instance Method Details

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :activity_ids (Array<String>) —

    The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, 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.

Returns:



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 928

def activities(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = @client.describe_scaling_activities(options)
    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) 


390
391
392
393
394
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 390

def attach_instances(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.attach_instances(options)
  resp.data
end

#auto_scaling_group_arn ⇒ String

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

Returns:

  • (String) 


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

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


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

def availability_zones
  data[:availability_zones]
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#created_time ⇒ Time

The date and time the group was created.

Returns:

  • (Time) 


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

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:



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

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.



215
216
217
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 215

def data_loaded?
  !!@data
end

#default_cooldown ⇒ Integer

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

Returns:

  • (Integer) 


79
80
81
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 79

def default_cooldown
  data[:default_cooldown]
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 parameter also deletes any lifecycle actions associated with the group.

Returns:

  • (EmptyStructure) 


408
409
410
411
412
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 408

def delete(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.delete_auto_scaling_group(options)
  resp.data
end

#desired_capacity ⇒ Integer

The desired size of the group.

Returns:

  • (Integer) 


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

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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 427

def detach_instances(options = {})
  batch = []
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.detach_instances(options)
  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>) —

    One or more of the following metrics. If you omit this parameter, all metrics are disabled.

    • ‘GroupMinSize`

    • ‘GroupMaxSize`

    • ‘GroupDesiredCapacity`

    • ‘GroupInServiceInstances`

    • ‘GroupPendingInstances`

    • ‘GroupStandbyInstances`

    • ‘GroupTerminatingInstances`

    • ‘GroupTotalInstances`

Returns:

  • (EmptyStructure) 


467
468
469
470
471
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 467

def disable_metrics_collection(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.disable_metrics_collection(options)
  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>) —

    One or more of the following metrics. If you omit this parameter, all metrics are enabled.

    • ‘GroupMinSize`

    • ‘GroupMaxSize`

    • ‘GroupDesiredCapacity`

    • ‘GroupInServiceInstances`

    • ‘GroupPendingInstances`

    • ‘GroupStandbyInstances`

    • ‘GroupTerminatingInstances`

    • ‘GroupTotalInstances`

  • :granularity (required, String) —

    The granularity to associate with the metrics to collect. The only valid value is ‘1Minute`.

Returns:

  • (EmptyStructure) 


503
504
505
506
507
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 503

def enable_metrics_collection(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.enable_metrics_collection(options)
  resp.data
end

#enabled_metrics ⇒ Array<Types::EnabledMetric>

The metrics enabled for the group.

Returns:



153
154
155
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 153

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.



222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 222

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 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.

Returns:

  • (Integer) 


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

def health_check_grace_period
  data[:health_check_grace_period]
end

#health_check_type ⇒ String

The service to use for the health checks. The valid values are ‘EC2` and `ELB`.

Returns:

  • (String) 


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

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. 


1181
1182
1183
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1181

def identifiers
  { name: @name }
end

#instances ⇒ Instance::Collection

Returns:



948
949
950
951
952
953
954
955
956
957
958
959
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 948

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:



962
963
964
965
966
967
968
969
970
971
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 962

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) 


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

def launch_configuration_name
  data[:launch_configuration_name]
end

#launch_template ⇒ Types::LaunchTemplateSpecification

The launch template for the group.

Returns:



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

def launch_template
  data[:launch_template]
end

#lifecycle_hook(name) ⇒ LifecycleHook

Parameters:

  • name (String)

Returns:



975
976
977
978
979
980
981
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 975

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 parameter, all lifecycle hooks are described.

Returns:



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 993

def lifecycle_hooks(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(auto_scaling_group_name: @name)
    resp = @client.describe_lifecycle_hooks(options)
    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) 


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

def load
  resp = @client.describe_auto_scaling_groups(auto_scaling_group_names: [@name])
  @data = resp.auto_scaling_groups[0]
  self
end

#load_balancer(name) ⇒ LoadBalancer

Parameters:

  • name (String)

Returns:



1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1013

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


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

def load_balancer_names
  data[:load_balancer_names]
end

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

Examples:

Request syntax with placeholder values


load_balancers = auto_scaling_group.load_balancers({
  next_token: "XmlString",
  max_records: 1,
})

Parameters:

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

    ({})

Options Hash (options):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_records (Integer) —

    The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

Returns:



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1035

def load_balancers(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(auto_scaling_group_name: @name)
    resp = @client.describe_load_balancers(options)
    resp.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
  LoadBalancer::Collection.new(batches)
end

#max_size ⇒ Integer

The maximum size of the group.

Returns:

  • (Integer) 


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

def max_size
  data[:max_size]
end

#min_size ⇒ Integer

The minimum size of the group.

Returns:

  • (Integer) 


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

def min_size
  data[:min_size]
end

#mixed_instances_policy ⇒ Types::MixedInstancesPolicy

The mixed instances policy for the group.

Returns:



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

def mixed_instances_policy
  data[:mixed_instances_policy]
end

#name ⇒ String Also known as: auto_scaling_group_name

Returns:

  • (String) 


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

def name
  @name
end

#new_instances_protected_from_scale_in ⇒ Boolean

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

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 173

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:



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1058

def notification_configurations(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, auto_scaling_group_names: [@name])
    resp = @client.describe_notification_configurations(options)
    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. For more information, see [Placement Groups] in the *Amazon Elastic Compute Cloud User Guide*.

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

Returns:

  • (String) 


137
138
139
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 137

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 parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

  • :policy_types (Array<String>) —

    One or more policy types. Valid values are ‘SimpleScaling` and `StepScaling`.

Returns:



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1095

def policies(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = @client.describe_policies(options)
    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

#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", # required
      namespace: "MetricNamespace", # required
      dimensions: [
        {
          name: "MetricDimensionName", # required
          value: "MetricDimensionValue", # required
        },
      ],
      statistic: "Average", # required, accepts Average, Minimum, Maximum, SampleCount, Sum
      unit: "MetricUnit",
    },
    target_value: 1.0, # required
    disable_scale_in: false,
  },
})

Parameters:

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

    ({})

Options Hash (options):

  • :policy_name (required, String) —

    The name of the policy.

  • :policy_type (String) —

    The policy type. The valid values are ‘SimpleScaling`, `StepScaling`, and `TargetTrackingScaling`. If the policy type is null, the value is treated as `SimpleScaling`.

  • :adjustment_type (String) —

    The adjustment type. The valid values are ‘ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.

    This parameter is supported if the policy type is ‘SimpleScaling` or `StepScaling`.

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

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html

  • :min_adjustment_step (Integer) —

    Available for backward compatibility. Use ‘MinAdjustmentMagnitude` instead.

  • :min_adjustment_magnitude (Integer) —

    The minimum number of instances to scale. If the value of ‘AdjustmentType` is `PercentChangeInCapacity`, the scaling policy changes the `DesiredCapacity` of the Auto Scaling group by at least this many instances. Otherwise, the error is `ValidationError`.

    This parameter is supported if the policy type is ‘SimpleScaling` or `StepScaling`.

  • :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.

    This parameter is required if the policy type is ‘SimpleScaling` and not supported otherwise.

  • :cooldown (Integer) —

    The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

    This parameter is supported if the policy type is ‘SimpleScaling`.

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

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.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`.

    This parameter is supported 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.

    This parameter is required if the policy type is ‘StepScaling` and not supported otherwise.

  • :estimated_instance_warmup (Integer) —

    The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

    This parameter is supported if the policy type is ‘StepScaling` or `TargetTrackingScaling`.

  • :target_tracking_configuration (Types::TargetTrackingConfiguration) —

    A target tracking policy.

    This parameter is required if the policy type is ‘TargetTrackingScaling` and not supported otherwise.

Returns:



625
626
627
628
629
630
631
632
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 625

def put_scaling_policy(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.put_scaling_policy(options)
  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,
})

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 parameter is deprecated.

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

    The time for this action to start, in “YYYY-MM-DDThh:mm:ssZ” format in UTC/GMT only (for example, ‘2014-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.

    If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

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

    The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

  • :recurrence (String) —

    The recurring schedule for this action, in Unix cron syntax format. For more information about this format, see [Crontab].

    [1]: crontab.org

  • :min_size (Integer) —

    The minimum size for the Auto Scaling group.

  • :max_size (Integer) —

    The maximum size for the Auto Scaling group.

  • :desired_capacity (Integer) —

    The number of EC2 instances that should be running in the group.

Returns:



678
679
680
681
682
683
684
685
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 678

def put_scheduled_update_group_action(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.put_scheduled_update_group_action(options)
  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. If you omit this parameter, all processes are specified.

    • ‘Launch`

    • ‘Terminate`

    • ‘HealthCheck`

    • ‘ReplaceUnhealthy`

    • ‘AZRebalance`

    • ‘AlarmNotification`

    • ‘ScheduledActions`

    • ‘AddToLoadBalancer`

Returns:

  • (EmptyStructure) 


713
714
715
716
717
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 713

def resume_processes(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.resume_processes(options)
  resp.data
end

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

Examples:

Request syntax with placeholder values


scheduled_actions = auto_scaling_group.scheduled_actions({
  scheduled_action_names: ["ResourceName"],
  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. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

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

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

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

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

Returns:



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1134

def scheduled_actions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(auto_scaling_group_name: @name)
    resp = @client.describe_scheduled_actions(options)
    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 AWS services on your behalf.

Returns:

  • (String) 


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

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 number of EC2 instances that should be running in the Auto Scaling group.

  • :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) 


736
737
738
739
740
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 736

def set_desired_capacity(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.set_desired_capacity(options)
  resp.data
end

#status ⇒ String

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

Returns:

  • (String) 


160
161
162
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 160

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. If you omit this parameter, all processes are specified.

    • ‘Launch`

    • ‘Terminate`

    • ‘HealthCheck`

    • ‘ReplaceUnhealthy`

    • ‘AZRebalance`

    • ‘AlarmNotification`

    • ‘ScheduledActions`

    • ‘AddToLoadBalancer`

Returns:

  • (EmptyStructure) 


768
769
770
771
772
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 768

def suspend_processes(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.suspend_processes(options)
  resp.data
end

#suspended_processes ⇒ Array<Types::SuspendedProcess>

The suspended processes associated with the group.

Returns:



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

def suspended_processes
  data[:suspended_processes]
end

#tag(key) ⇒ Tag

Parameters:

  • key (String)

Returns:



1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1155

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

#tags ⇒ Tag::Collection

Returns:



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 1165

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


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

def target_group_arns
  data[:target_group_arns]
end

#termination_policies ⇒ Array<String>

The termination policies for the group.

Returns:

  • (Array<String>) 


166
167
168
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 166

def termination_policies
  data[:termination_policies]
end

#update(options = {}) ⇒ AutoScalingGroup

Examples:

Request syntax with placeholder values


autoscalinggroup = auto_scaling_group.update({
  launch_configuration_name: "ResourceName",
  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",
        },
      ],
    },
    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: "SpotPrice",
    },
  },
  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: "XmlStringMaxLen2047",
  termination_policies: ["XmlStringMaxLen1600"],
  new_instances_protected_from_scale_in: false,
  service_linked_role_arn: "ResourceName",
})

Parameters:

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

    ({})

Options Hash (options):

  • :launch_configuration_name (String) —

    The name of the launch configuration. If you specify this parameter, you can’t specify a launch template or a mixed instances policy.

  • :launch_template (Types::LaunchTemplateSpecification) —

    The launch template and version to use to specify the updates. If you specify this parameter, you can’t specify a launch configuration or a mixed instances policy.

  • :mixed_instances_policy (Types::MixedInstancesPolicy) —

    The mixed instances policy to use to specify the updates. If you specify this parameter, you can’t specify a launch configuration or a launch template.

  • :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 number of EC2 instances that should be running in the Auto Scaling group. 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) —

    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

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

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html

  • :availability_zones (Array<String>) —

    One or more Availability Zones for the group.

  • :health_check_type (String) —

    The service to use for the health checks. The valid values are ‘EC2` and `ELB`.

  • :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. The default is 0.

    For more information, see [Health Checks] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html

  • :placement_group (String) —

    The name of the placement group into which to launch your instances, if any. For more information, see [Placement Groups] in the *Amazon Elastic Compute Cloud User Guide*.

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

  • :vpc_zone_identifier (String) —

    The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

    When you specify ‘VPCZoneIdentifier` with `AvailabilityZones`, ensure that the subnets’ Availability Zones match the values you specify for ‘AvailabilityZones`.

    For more information, see [Launching Auto Scaling Instances in a VPC] in the *Amazon EC2 Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html

  • :termination_policies (Array<String>) —

    A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

    For more information, see [Controlling Which Instances Auto Scaling Terminates During Scale In] in the *Auto Scaling User Guide*.

    [1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html

  • :new_instances_protected_from_scale_in (Boolean) —

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

  • :service_linked_role_arn (String) —

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

Returns:



904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 904

def update(options = {})
  options = options.merge(auto_scaling_group_name: @name)
  resp = @client.update_auto_scaling_group(options)
  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.

If you specify ‘VPCZoneIdentifier` and `AvailabilityZones`, ensure that the Availability Zones of the subnets match the values for `AvailabilityZones`.

Returns:

  • (String) 


147
148
149
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 147

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 362

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

#wait_until_exists(options = {}) ⇒ 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:



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 239

def wait_until_exists(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::GroupExists.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  waiter.wait(params.merge(auto_scaling_group_names: [@name]))
  AutoScalingGroup.new({
    name: @name,
    client: @client
  })
end

#wait_until_in_service(options = {}) ⇒ 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:



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

def wait_until_in_service(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::GroupInService.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  waiter.wait(params.merge(auto_scaling_group_names: [@name]))
  AutoScalingGroup.new({
    name: @name,
    client: @client
  })
end

#wait_until_not_exists(options = {}) ⇒ 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:



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/aws-sdk-autoscaling/auto_scaling_group.rb', line 273

def wait_until_not_exists(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::GroupNotExists.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  waiter.wait(params.merge(auto_scaling_group_names: [@name]))
  AutoScalingGroup.new({
    name: @name,
    client: @client
  })
end