aws-sdk-autoscaling 1.33.0 → 1.38.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1b91119d5438f8a9221c54356341819b776df8f50ac29cccbac7af0f38fa83c3
4
- data.tar.gz: e2f581c53ec372865c1bd6ffc29dd8ed21695ca35d73b9b1af7141520235a508
3
+ metadata.gz: b7d9b1c93029c64b83d30c6944636ab2f2f56e8f0b699fcc3e2e78eae68e9e04
4
+ data.tar.gz: 1057ebd629a55d49ad47097a34dcd26dea073daf829027e9a0ea0b7be3e2a0e0
5
5
  SHA512:
6
- metadata.gz: 1e3fb49c1e46cc9b4e0a2def902ca57e1232b61668c206626f272c5b1ea5aa9a76bff1026508595b9830849bc39742368061d98d2a6a2e159c1d760195290bfc
7
- data.tar.gz: 7b54eaead6ad303be8aad389fd6b4d086b7d7835ab201bfedd3089212050d70651a7b713d1dfd5338ba55546b891e3d70dc3f4f9da16fddec46b306e811a6c38
6
+ metadata.gz: 70326812f5eab793cf8b61102ac24c6f44adea620226f3217f63ca853e084845f486ef881f1b6d60b71cbab691187f71f3036b8ff1f80c4dddbe38fc0a5e84fe
7
+ data.tar.gz: 31f0072da91a0af36a99dfd617d3d58a207004f755d266a6249eab903ee291915b1b59f525e0bbbd80df48854cfc141da570df482309b45a85d030ea9e008202
@@ -56,6 +56,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
56
56
  # @service
57
57
  module Aws::AutoScaling
58
58
 
59
- GEM_VERSION = '1.33.0'
59
+ GEM_VERSION = '1.38.1'
60
60
 
61
61
  end
@@ -127,7 +127,8 @@ module Aws::AutoScaling
127
127
  # Waiter polls an API operation until a resource enters a desired
128
128
  # state.
129
129
  #
130
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
130
+ # @note The waiting operation is performed on a copy. The original resource
131
+ # remains unchanged.
131
132
  #
132
133
  # ## Basic Usage
133
134
  #
@@ -140,13 +141,15 @@ module Aws::AutoScaling
140
141
  #
141
142
  # ## Example
142
143
  #
143
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
144
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
145
+ # instance.state.name == 'running'
146
+ # end
144
147
  #
145
148
  # ## Configuration
146
149
  #
147
150
  # You can configure the maximum number of polling attempts, and the
148
- # delay (in seconds) between each polling attempt. The waiting condition is set
149
- # by passing a block to {#wait_until}:
151
+ # delay (in seconds) between each polling attempt. The waiting condition is
152
+ # set by passing a block to {#wait_until}:
150
153
  #
151
154
  # # poll for ~25 seconds
152
155
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -177,17 +180,16 @@ module Aws::AutoScaling
177
180
  # # resource did not enter the desired state in time
178
181
  # end
179
182
  #
183
+ # @yieldparam [Resource] resource to be used in the waiting condition.
180
184
  #
181
- # @yield param [Resource] resource to be used in the waiting condition
182
- #
183
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
184
- # because the waiter has entered a state that it will not transition
185
- # out of, preventing success.
185
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
186
+ # terminates because the waiter has entered a state that it will not
187
+ # transition out of, preventing success.
186
188
  #
187
189
  # yet successful.
188
190
  #
189
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
190
- # while polling for a resource that is not expected.
191
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
192
+ # encountered while polling for a resource that is not expected.
191
193
  #
192
194
  # @raise [NotImplementedError] Raised when the resource does not
193
195
  #
@@ -149,8 +149,8 @@ module Aws::AutoScaling
149
149
  data[:enabled_metrics]
150
150
  end
151
151
 
152
- # The current state of the group when DeleteAutoScalingGroup is in
153
- # progress.
152
+ # The current state of the group when the DeleteAutoScalingGroup
153
+ # operation is in progress.
154
154
  # @return [String]
155
155
  def status
156
156
  data[:status]
@@ -179,7 +179,7 @@ module Aws::AutoScaling
179
179
  # The maximum amount of time, in seconds, that an instance can be in
180
180
  # service.
181
181
  #
182
- # Valid Range: Minimum value of 604800.
182
+ # Valid Range: Minimum value of 0.
183
183
  # @return [Integer]
184
184
  def max_instance_lifetime
185
185
  data[:max_instance_lifetime]
@@ -290,7 +290,8 @@ module Aws::AutoScaling
290
290
  # Waiter polls an API operation until a resource enters a desired
291
291
  # state.
292
292
  #
293
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
293
+ # @note The waiting operation is performed on a copy. The original resource
294
+ # remains unchanged.
294
295
  #
295
296
  # ## Basic Usage
296
297
  #
@@ -303,13 +304,15 @@ module Aws::AutoScaling
303
304
  #
304
305
  # ## Example
305
306
  #
306
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
307
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
308
+ # instance.state.name == 'running'
309
+ # end
307
310
  #
308
311
  # ## Configuration
309
312
  #
310
313
  # You can configure the maximum number of polling attempts, and the
311
- # delay (in seconds) between each polling attempt. The waiting condition is set
312
- # by passing a block to {#wait_until}:
314
+ # delay (in seconds) between each polling attempt. The waiting condition is
315
+ # set by passing a block to {#wait_until}:
313
316
  #
314
317
  # # poll for ~25 seconds
315
318
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -340,17 +343,16 @@ module Aws::AutoScaling
340
343
  # # resource did not enter the desired state in time
341
344
  # end
342
345
  #
346
+ # @yieldparam [Resource] resource to be used in the waiting condition.
343
347
  #
344
- # @yield param [Resource] resource to be used in the waiting condition
345
- #
346
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
347
- # because the waiter has entered a state that it will not transition
348
- # out of, preventing success.
348
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
349
+ # terminates because the waiter has entered a state that it will not
350
+ # transition out of, preventing success.
349
351
  #
350
352
  # yet successful.
351
353
  #
352
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
353
- # while polling for a resource that is not expected.
354
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
355
+ # encountered while polling for a resource that is not expected.
354
356
  #
355
357
  # @raise [NotImplementedError] Raised when the resource does not
356
358
  #
@@ -449,8 +451,7 @@ module Aws::AutoScaling
449
451
  # })
450
452
  # @param [Hash] options ({})
451
453
  # @option options [Array<String>] :metrics
452
- # One or more of the following metrics. If you omit this parameter, all
453
- # metrics are disabled.
454
+ # Specifies one or more of the following metrics:
454
455
  #
455
456
  # * `GroupMinSize`
456
457
  #
@@ -467,6 +468,18 @@ module Aws::AutoScaling
467
468
  # * `GroupTerminatingInstances`
468
469
  #
469
470
  # * `GroupTotalInstances`
471
+ #
472
+ # * `GroupInServiceCapacity`
473
+ #
474
+ # * `GroupPendingCapacity`
475
+ #
476
+ # * `GroupStandbyCapacity`
477
+ #
478
+ # * `GroupTerminatingCapacity`
479
+ #
480
+ # * `GroupTotalCapacity`
481
+ #
482
+ # If you omit this parameter, all metrics are disabled.
470
483
  # @return [EmptyStructure]
471
484
  def disable_metrics_collection(options = {})
472
485
  options = options.merge(auto_scaling_group_name: @name)
@@ -482,8 +495,8 @@ module Aws::AutoScaling
482
495
  # })
483
496
  # @param [Hash] options ({})
484
497
  # @option options [Array<String>] :metrics
485
- # One or more of the following metrics. If you omit this parameter, all
486
- # metrics are enabled.
498
+ # Specifies which group-level metrics to start collecting. You can
499
+ # specify one or more of the following metrics:
487
500
  #
488
501
  # * `GroupMinSize`
489
502
  #
@@ -500,6 +513,21 @@ module Aws::AutoScaling
500
513
  # * `GroupTerminatingInstances`
501
514
  #
502
515
  # * `GroupTotalInstances`
516
+ #
517
+ # The instance weighting feature supports the following additional
518
+ # metrics:
519
+ #
520
+ # * `GroupInServiceCapacity`
521
+ #
522
+ # * `GroupPendingCapacity`
523
+ #
524
+ # * `GroupStandbyCapacity`
525
+ #
526
+ # * `GroupTerminatingCapacity`
527
+ #
528
+ # * `GroupTotalCapacity`
529
+ #
530
+ # If you omit this parameter, all metrics are enabled.
503
531
  # @option options [required, String] :granularity
504
532
  # The granularity to associate with the metrics to collect. The only
505
533
  # valid value is `1Minute`.
@@ -574,20 +602,22 @@ module Aws::AutoScaling
574
602
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
575
603
  # instead.
576
604
  # @option options [Integer] :min_adjustment_magnitude
577
- # The minimum number of instances to scale. If the value of
578
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
579
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
580
- # this many instances. Otherwise, the error is `ValidationError`.
581
- #
582
- # This property replaces the `MinAdjustmentStep` property. For example,
583
- # suppose that you create a step scaling policy to scale out an Auto
584
- # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
585
- # of 2. If the group has 4 instances and the scaling policy is
586
- # performed, 25 percent of 4 is 1. However, because you specified a
587
- # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
588
- # group by 2 instances.
589
- #
590
- # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
605
+ # The minimum value to scale by when scaling by percentages. For
606
+ # example, suppose that you create a step scaling policy to scale out an
607
+ # Auto Scaling group by 25 percent and you specify a
608
+ # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
609
+ # scaling policy is performed, 25 percent of 4 is 1. However, because
610
+ # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
611
+ # scales out the group by 2 instances.
612
+ #
613
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
614
+ # the adjustment type is `PercentChangeInCapacity`. For more
615
+ # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
616
+ # Scaling User Guide*.
617
+ #
618
+ #
619
+ #
620
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
591
621
  # @option options [Integer] :scaling_adjustment
592
622
  # The amount by which a simple scaling policy scales the Auto Scaling
593
623
  # group in response to an alarm breach. The adjustment is based on the
@@ -656,7 +686,7 @@ module Aws::AutoScaling
656
686
  # @return [ScalingPolicy]
657
687
  def put_scaling_policy(options = {})
658
688
  options = options.merge(auto_scaling_group_name: @name)
659
- resp = @client.put_scaling_policy(options)
689
+ @client.put_scaling_policy(options)
660
690
  ScalingPolicy.new(
661
691
  name: options[:policy_name],
662
692
  client: @client
@@ -708,16 +738,18 @@ module Aws::AutoScaling
708
738
  #
709
739
  # [1]: http://crontab.org
710
740
  # @option options [Integer] :min_size
711
- # The minimum number of instances in the Auto Scaling group.
741
+ # The minimum size of the Auto Scaling group.
712
742
  # @option options [Integer] :max_size
713
- # The maximum number of instances in the Auto Scaling group.
743
+ # The maximum size of the Auto Scaling group.
714
744
  # @option options [Integer] :desired_capacity
715
- # The number of EC2 instances that should be running in the Auto Scaling
716
- # group.
745
+ # The desired capacity is the initial capacity of the Auto Scaling group
746
+ # after the scheduled action runs and the capacity it attempts to
747
+ # maintain. It can scale beyond this capacity if you add more scaling
748
+ # conditions.
717
749
  # @return [ScheduledAction]
718
750
  def put_scheduled_update_group_action(options = {})
719
751
  options = options.merge(auto_scaling_group_name: @name)
720
- resp = @client.put_scheduled_update_group_action(options)
752
+ @client.put_scheduled_update_group_action(options)
721
753
  ScheduledAction.new(
722
754
  name: options[:scheduled_action_name],
723
755
  client: @client
@@ -764,8 +796,9 @@ module Aws::AutoScaling
764
796
  # })
765
797
  # @param [Hash] options ({})
766
798
  # @option options [required, Integer] :desired_capacity
767
- # The number of EC2 instances that should be running in the Auto Scaling
768
- # group.
799
+ # The desired capacity is the initial capacity of the Auto Scaling group
800
+ # after this operation completes and the capacity it attempts to
801
+ # maintain.
769
802
  # @option options [Boolean] :honor_cooldown
770
803
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
771
804
  # period to complete before initiating a scaling activity to set your
@@ -893,10 +926,22 @@ module Aws::AutoScaling
893
926
  # The minimum size of the Auto Scaling group.
894
927
  # @option options [Integer] :max_size
895
928
  # The maximum size of the Auto Scaling group.
929
+ #
930
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
931
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
932
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
933
+ # above `MaxSize` by more than your maximum instance weight (weights
934
+ # that define how many capacity units each instance contributes to the
935
+ # capacity of the group).
936
+ #
937
+ # </note>
896
938
  # @option options [Integer] :desired_capacity
897
- # The number of EC2 instances that should be running in the Auto Scaling
898
- # group. This number must be greater than or equal to the minimum size
899
- # of the group and less than or equal to the maximum size of the group.
939
+ # The desired capacity is the initial capacity of the Auto Scaling group
940
+ # after this operation completes and the capacity it attempts to
941
+ # maintain.
942
+ #
943
+ # This number must be greater than or equal to the minimum size of the
944
+ # group and less than or equal to the maximum size of the group.
900
945
  # @option options [Integer] :default_cooldown
901
946
  # The amount of time, in seconds, after a scaling activity completes
902
947
  # before another scaling activity can start. The default value is `300`.
@@ -982,13 +1027,17 @@ module Aws::AutoScaling
982
1027
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
983
1028
  # @option options [Integer] :max_instance_lifetime
984
1029
  # The maximum amount of time, in seconds, that an instance can be in
985
- # service.
1030
+ # service. The default is null.
1031
+ #
1032
+ # This parameter is optional, but if you specify a value for it, you
1033
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
1034
+ # previously set value, specify a new value of 0.
986
1035
  #
987
1036
  # For more information, see [Replacing Auto Scaling Instances Based on
988
1037
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
989
1038
  # Guide*.
990
1039
  #
991
- # Valid Range: Minimum value of 604800.
1040
+ # Valid Range: Minimum value of 0.
992
1041
  #
993
1042
  #
994
1043
  #
@@ -996,7 +1045,7 @@ module Aws::AutoScaling
996
1045
  # @return [AutoScalingGroup]
997
1046
  def update(options = {})
998
1047
  options = options.merge(auto_scaling_group_name: @name)
999
- resp = @client.update_auto_scaling_group(options)
1048
+ @client.update_auto_scaling_group(options)
1000
1049
  AutoScalingGroup.new(
1001
1050
  name: options[:auto_scaling_group_name],
1002
1051
  client: @client
@@ -1291,8 +1340,8 @@ module Aws::AutoScaling
1291
1340
 
1292
1341
  def yield_waiter_and_warn(waiter, &block)
1293
1342
  if !@waiter_block_warned
1294
- msg = "pass options to configure the waiter; "
1295
- msg << "yielding the waiter is deprecated"
1343
+ msg = "pass options to configure the waiter; "\
1344
+ "yielding the waiter is deprecated"
1296
1345
  warn(msg)
1297
1346
  @waiter_block_warned = true
1298
1347
  end
@@ -1300,7 +1349,9 @@ module Aws::AutoScaling
1300
1349
  end
1301
1350
 
1302
1351
  def separate_params_and_options(options)
1303
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
1352
+ opts = Set.new(
1353
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
1354
+ )
1304
1355
  waiter_opts = {}
1305
1356
  waiter_params = {}
1306
1357
  options.each_pair do |key, value|
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/query.rb'
29
30
 
@@ -69,6 +70,7 @@ module Aws::AutoScaling
69
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
72
74
  add_plugin(Aws::Plugins::SignatureV4)
73
75
  add_plugin(Aws::Plugins::Protocols::Query)
74
76
 
@@ -105,7 +107,7 @@ module Aws::AutoScaling
105
107
  # @option options [required, String] :region
106
108
  # The AWS region to connect to. The configured `:region` is
107
109
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
109
111
  #
110
112
  # * `Aws.config[:region]`
111
113
  # * `ENV['AWS_REGION']`
@@ -161,7 +163,7 @@ module Aws::AutoScaling
161
163
  # @option options [String] :endpoint
162
164
  # The client endpoint is normally constructed from the `:region`
163
165
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
167
  #
166
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +178,7 @@ module Aws::AutoScaling
176
178
  # requests fetching endpoints information. Defaults to 60 sec.
177
179
  #
178
180
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
182
  #
181
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
184
  # The log formatter.
@@ -269,8 +271,7 @@ module Aws::AutoScaling
269
271
  #
270
272
  # @option options [Integer] :http_read_timeout (60) The default
271
273
  # number of seconds to wait for response data. This value can
272
- # safely be set
273
- # per-request on the session yielded by {#session_for}.
274
+ # safely be set per-request on the session.
274
275
  #
275
276
  # @option options [Float] :http_idle_timeout (5) The number of
276
277
  # seconds a connection is allowed to sit idle before it is
@@ -282,7 +283,7 @@ module Aws::AutoScaling
282
283
  # request body. This option has no effect unless the request has
283
284
  # "Expect" header set to "100-continue". Defaults to `nil` which
284
285
  # disables this behaviour. This value can safely be set per
285
- # request on the session yielded by {#session_for}.
286
+ # request on the session.
286
287
  #
287
288
  # @option options [Boolean] :http_wire_trace (false) When `true`,
288
289
  # HTTP debug output will be sent to the `:logger`.
@@ -369,9 +370,9 @@ module Aws::AutoScaling
369
370
  # Attaches one or more target groups to the specified Auto Scaling
370
371
  # group.
371
372
  #
372
- # To describe the target groups for an Auto Scaling group, use
373
- # DescribeLoadBalancerTargetGroups. To detach the target group from the
374
- # Auto Scaling group, use DetachLoadBalancerTargetGroups.
373
+ # To describe the target groups for an Auto Scaling group, call the
374
+ # DescribeLoadBalancerTargetGroups API. To detach the target group from
375
+ # the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
375
376
  #
376
377
  # With Application Load Balancers and Network Load Balancers, instances
377
378
  # are registered as targets with a target group. With Classic Load
@@ -420,15 +421,18 @@ module Aws::AutoScaling
420
421
  req.send_request(options)
421
422
  end
422
423
 
423
- # Attaches one or more Classic Load Balancers to the specified Auto
424
- # Scaling group.
424
+ # <note markdown="1"> To attach an Application Load Balancer or a Network Load Balancer, use
425
+ # the AttachLoadBalancerTargetGroups API operation instead.
425
426
  #
426
- # To attach an Application Load Balancer or a Network Load Balancer
427
- # instead, see AttachLoadBalancerTargetGroups.
427
+ # </note>
428
428
  #
429
- # To describe the load balancers for an Auto Scaling group, use
430
- # DescribeLoadBalancers. To detach the load balancer from the Auto
431
- # Scaling group, use DetachLoadBalancers.
429
+ # Attaches one or more Classic Load Balancers to the specified Auto
430
+ # Scaling group. Amazon EC2 Auto Scaling registers the running instances
431
+ # with these Classic Load Balancers.
432
+ #
433
+ # To describe the load balancers for an Auto Scaling group, call the
434
+ # DescribeLoadBalancers API. To detach the load balancer from the Auto
435
+ # Scaling group, call the DetachLoadBalancers API.
432
436
  #
433
437
  # For more information, see [Attaching a Load Balancer to Your Auto
434
438
  # Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -645,34 +649,49 @@ module Aws::AutoScaling
645
649
  # Creates an Auto Scaling group with the specified name and attributes.
646
650
  #
647
651
  # If you exceed your maximum limit of Auto Scaling groups, the call
648
- # fails. For information about viewing this limit, see
649
- # DescribeAccountLimits. For information about updating this limit, see
650
- # [Amazon EC2 Auto Scaling Service Quotas][1] in the *Amazon EC2 Auto
651
- # Scaling User Guide*.
652
+ # fails. To query this limit, call the DescribeAccountLimits API. For
653
+ # information about updating this limit, see [Amazon EC2 Auto Scaling
654
+ # Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
655
+ #
656
+ # For introductory exercises for creating an Auto Scaling group, see
657
+ # [Getting Started with Amazon EC2 Auto Scaling][2] and [Tutorial: Set
658
+ # Up a Scaled and Load-Balanced Application][3] in the *Amazon EC2 Auto
659
+ # Scaling User Guide*. For more information, see [Auto Scaling
660
+ # Groups][4] in the *Amazon EC2 Auto Scaling User Guide*.
652
661
  #
653
662
  #
654
663
  #
655
664
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
665
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html
666
+ # [3]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html
667
+ # [4]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html
656
668
  #
657
669
  # @option params [required, String] :auto_scaling_group_name
658
670
  # The name of the Auto Scaling group. This name must be unique per
659
671
  # Region per account.
660
672
  #
661
673
  # @option params [String] :launch_configuration_name
662
- # The name of the launch configuration.
674
+ # The name of the launch configuration to use when an instance is
675
+ # launched. To get the launch configuration name, use the
676
+ # DescribeLaunchConfigurations API operation. New launch configurations
677
+ # can be created with the CreateLaunchConfiguration API.
663
678
  #
664
- # If you do not specify `LaunchConfigurationName`, you must specify one
665
- # of the following parameters: `InstanceId`, `LaunchTemplate`, or
679
+ # You must specify one of the following parameters in your request:
680
+ # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
666
681
  # `MixedInstancesPolicy`.
667
682
  #
668
683
  # @option params [Types::LaunchTemplateSpecification] :launch_template
669
- # The launch template to use to launch instances.
684
+ # Parameters used to specify the launch template and version to use when
685
+ # an instance is launched.
670
686
  #
671
687
  # For more information, see [LaunchTemplateSpecification][1] in the
672
688
  # *Amazon EC2 Auto Scaling API Reference*.
673
689
  #
674
- # If you do not specify `LaunchTemplate`, you must specify one of the
675
- # following parameters: `InstanceId`, `LaunchConfigurationName`, or
690
+ # You can alternatively associate a launch template to the Auto Scaling
691
+ # group by using the `MixedInstancesPolicy` parameter.
692
+ #
693
+ # You must specify one of the following parameters in your request:
694
+ # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
676
695
  # `MixedInstancesPolicy`.
677
696
  #
678
697
  #
@@ -707,23 +726,21 @@ module Aws::AutoScaling
707
726
  #
708
727
  # @option params [String] :instance_id
709
728
  # The ID of the instance used to create a launch configuration for the
710
- # group.
729
+ # group. To get the instance ID, use the Amazon EC2
730
+ # [DescribeInstances][1] API operation.
711
731
  #
712
732
  # When you specify an ID of an instance, Amazon EC2 Auto Scaling creates
713
733
  # a new launch configuration and associates it with the group. This
714
734
  # launch configuration derives its attributes from the specified
715
735
  # instance, except for the block device mapping.
716
736
  #
717
- # For more information, see [Create an Auto Scaling Group Using an EC2
718
- # Instance][1] in the *Amazon EC2 Auto Scaling User Guide*.
719
- #
720
737
  # You must specify one of the following parameters in your request:
721
738
  # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
722
739
  # `MixedInstancesPolicy`.
723
740
  #
724
741
  #
725
742
  #
726
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
743
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
727
744
  #
728
745
  # @option params [required, Integer] :min_size
729
746
  # The minimum size of the group.
@@ -731,12 +748,24 @@ module Aws::AutoScaling
731
748
  # @option params [required, Integer] :max_size
732
749
  # The maximum size of the group.
733
750
  #
751
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
752
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
753
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
754
+ # above `MaxSize` by more than your maximum instance weight (weights
755
+ # that define how many capacity units each instance contributes to the
756
+ # capacity of the group).
757
+ #
758
+ # </note>
759
+ #
734
760
  # @option params [Integer] :desired_capacity
735
- # The number of Amazon EC2 instances that the Auto Scaling group
736
- # attempts to maintain. This number must be greater than or equal to the
737
- # minimum size of the group and less than or equal to the maximum size
738
- # of the group. If you do not specify a desired capacity, the default is
739
- # the minimum size of the group.
761
+ # The desired capacity is the initial capacity of the Auto Scaling group
762
+ # at the time of its creation and the capacity it attempts to maintain.
763
+ # It can scale beyond this capacity if you configure automatic scaling.
764
+ #
765
+ # This number must be greater than or equal to the minimum size of the
766
+ # group and less than or equal to the maximum size of the group. If you
767
+ # do not specify a desired capacity, the default is the minimum size of
768
+ # the group.
740
769
  #
741
770
  # @option params [Integer] :default_cooldown
742
771
  # The amount of time, in seconds, after a scaling activity completes
@@ -862,7 +891,15 @@ module Aws::AutoScaling
862
891
  # One or more lifecycle hooks.
863
892
  #
864
893
  # @option params [Array<Types::Tag>] :tags
865
- # One or more tags.
894
+ # One or more tags. You can tag your Auto Scaling group and propagate
895
+ # the tags to the Amazon EC2 instances it launches.
896
+ #
897
+ # Tags are not propagated to Amazon EBS volumes. To add tags to Amazon
898
+ # EBS volumes, specify the tags in a launch template but use caution. If
899
+ # the launch template specifies an instance tag with a key that is also
900
+ # specified for the Auto Scaling group, Amazon EC2 Auto Scaling
901
+ # overrides the value of that instance tag with the value specified by
902
+ # the Auto Scaling group.
866
903
  #
867
904
  # For more information, see [Tagging Auto Scaling Groups and
868
905
  # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -885,13 +922,17 @@ module Aws::AutoScaling
885
922
  #
886
923
  # @option params [Integer] :max_instance_lifetime
887
924
  # The maximum amount of time, in seconds, that an instance can be in
888
- # service.
925
+ # service. The default is null.
926
+ #
927
+ # This parameter is optional, but if you specify a value for it, you
928
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
929
+ # previously set value, specify a new value of 0.
889
930
  #
890
931
  # For more information, see [Replacing Auto Scaling Instances Based on
891
932
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
892
933
  # Guide*.
893
934
  #
894
- # Valid Range: Minimum value of 604800.
935
+ # Valid Range: Minimum value of 0.
895
936
  #
896
937
  #
897
938
  #
@@ -1031,10 +1072,9 @@ module Aws::AutoScaling
1031
1072
  # Creates a launch configuration.
1032
1073
  #
1033
1074
  # If you exceed your maximum limit of launch configurations, the call
1034
- # fails. For information about viewing this limit, see
1035
- # DescribeAccountLimits. For information about updating this limit, see
1036
- # [Amazon EC2 Auto Scaling Service Quotas][1] in the *Amazon EC2 Auto
1037
- # Scaling User Guide*.
1075
+ # fails. To query this limit, call the DescribeAccountLimits API. For
1076
+ # information about updating this limit, see [Amazon EC2 Auto Scaling
1077
+ # Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
1038
1078
  #
1039
1079
  # For more information, see [Launch Configurations][2] in the *Amazon
1040
1080
  # EC2 Auto Scaling User Guide*.
@@ -1416,13 +1456,13 @@ module Aws::AutoScaling
1416
1456
  # associated action.
1417
1457
  #
1418
1458
  # To remove instances from the Auto Scaling group before deleting it,
1419
- # call DetachInstances with the list of instances and the option to
1420
- # decrement the desired capacity. This ensures that Amazon EC2 Auto
1459
+ # call the DetachInstances API with the list of instances and the option
1460
+ # to decrement the desired capacity. This ensures that Amazon EC2 Auto
1421
1461
  # Scaling does not launch replacement instances.
1422
1462
  #
1423
1463
  # To terminate all instances before deleting the Auto Scaling group,
1424
- # call UpdateAutoScalingGroup and set the minimum size and desired
1425
- # capacity of the Auto Scaling group to zero.
1464
+ # call the UpdateAutoScalingGroup API and set the minimum size and
1465
+ # desired capacity of the Auto Scaling group to zero.
1426
1466
  #
1427
1467
  # @option params [required, String] :auto_scaling_group_name
1428
1468
  # The name of the Auto Scaling group.
@@ -1760,7 +1800,18 @@ module Aws::AutoScaling
1760
1800
  req.send_request(options)
1761
1801
  end
1762
1802
 
1763
- # Describes the policy adjustment types for use with PutScalingPolicy.
1803
+ # Describes the available adjustment types for Amazon EC2 Auto Scaling
1804
+ # scaling policies. These settings apply to step scaling policies and
1805
+ # simple scaling policies; they do not apply to target tracking scaling
1806
+ # policies.
1807
+ #
1808
+ # The following adjustment types are supported:
1809
+ #
1810
+ # * ChangeInCapacity
1811
+ #
1812
+ # * ExactCapacity
1813
+ #
1814
+ # * PercentChangeInCapacity
1764
1815
  #
1765
1816
  # @return [Types::DescribeAdjustmentTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1766
1817
  #
@@ -1825,6 +1876,8 @@ module Aws::AutoScaling
1825
1876
  # * {Types::AutoScalingGroupsType#auto_scaling_groups #auto_scaling_groups} => Array&lt;Types::AutoScalingGroup&gt;
1826
1877
  # * {Types::AutoScalingGroupsType#next_token #next_token} => String
1827
1878
  #
1879
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1880
+ #
1828
1881
  #
1829
1882
  # @example Example: To describe an Auto Scaling group
1830
1883
  #
@@ -1956,6 +2009,13 @@ module Aws::AutoScaling
1956
2009
  # resp.auto_scaling_groups[0].max_instance_lifetime #=> Integer
1957
2010
  # resp.next_token #=> String
1958
2011
  #
2012
+ #
2013
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2014
+ #
2015
+ # * group_exists
2016
+ # * group_in_service
2017
+ # * group_not_exists
2018
+ #
1959
2019
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingGroups AWS API Documentation
1960
2020
  #
1961
2021
  # @overload describe_auto_scaling_groups(params = {})
@@ -1985,6 +2045,8 @@ module Aws::AutoScaling
1985
2045
  # * {Types::AutoScalingInstancesType#auto_scaling_instances #auto_scaling_instances} => Array&lt;Types::AutoScalingInstanceDetails&gt;
1986
2046
  # * {Types::AutoScalingInstancesType#next_token #next_token} => String
1987
2047
  #
2048
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2049
+ #
1988
2050
  #
1989
2051
  # @example Example: To describe one or more Auto Scaling instances
1990
2052
  #
@@ -2104,6 +2166,8 @@ module Aws::AutoScaling
2104
2166
  # * {Types::LaunchConfigurationsType#launch_configurations #launch_configurations} => Array&lt;Types::LaunchConfiguration&gt;
2105
2167
  # * {Types::LaunchConfigurationsType#next_token #next_token} => String
2106
2168
  #
2169
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2170
+ #
2107
2171
  #
2108
2172
  # @example Example: To describe Auto Scaling launch configurations
2109
2173
  #
@@ -2363,8 +2427,8 @@ module Aws::AutoScaling
2363
2427
  # Describes the load balancers for the specified Auto Scaling group.
2364
2428
  #
2365
2429
  # This operation describes only Classic Load Balancers. If you have
2366
- # Application Load Balancers or Network Load Balancers, use
2367
- # DescribeLoadBalancerTargetGroups instead.
2430
+ # Application Load Balancers or Network Load Balancers, use the
2431
+ # DescribeLoadBalancerTargetGroups API instead.
2368
2432
  #
2369
2433
  # @option params [required, String] :auto_scaling_group_name
2370
2434
  # The name of the Auto Scaling group.
@@ -2429,8 +2493,8 @@ module Aws::AutoScaling
2429
2493
  # Scaling.
2430
2494
  #
2431
2495
  # The `GroupStandbyInstances` metric is not returned by default. You
2432
- # must explicitly request this metric when calling
2433
- # EnableMetricsCollection.
2496
+ # must explicitly request this metric when calling the
2497
+ # EnableMetricsCollection API.
2434
2498
  #
2435
2499
  # @return [Types::DescribeMetricCollectionTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2436
2500
  #
@@ -2515,6 +2579,8 @@ module Aws::AutoScaling
2515
2579
  # * {Types::DescribeNotificationConfigurationsAnswer#notification_configurations #notification_configurations} => Array&lt;Types::NotificationConfiguration&gt;
2516
2580
  # * {Types::DescribeNotificationConfigurationsAnswer#next_token #next_token} => String
2517
2581
  #
2582
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2583
+ #
2518
2584
  #
2519
2585
  # @example Example: To describe Auto Scaling notification configurations
2520
2586
  #
@@ -2595,6 +2661,8 @@ module Aws::AutoScaling
2595
2661
  # * {Types::PoliciesType#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt;
2596
2662
  # * {Types::PoliciesType#next_token #next_token} => String
2597
2663
  #
2664
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2665
+ #
2598
2666
  #
2599
2667
  # @example Example: To describe Auto Scaling policies
2600
2668
  #
@@ -2710,6 +2778,8 @@ module Aws::AutoScaling
2710
2778
  # * {Types::ActivitiesType#activities #activities} => Array&lt;Types::Activity&gt;
2711
2779
  # * {Types::ActivitiesType#next_token #next_token} => String
2712
2780
  #
2781
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2782
+ #
2713
2783
  #
2714
2784
  # @example Example: To describe the scaling activities for an Auto Scaling group
2715
2785
  #
@@ -2769,8 +2839,8 @@ module Aws::AutoScaling
2769
2839
  req.send_request(options)
2770
2840
  end
2771
2841
 
2772
- # Describes the scaling process types for use with ResumeProcesses and
2773
- # SuspendProcesses.
2842
+ # Describes the scaling process types for use with the ResumeProcesses
2843
+ # and SuspendProcesses APIs.
2774
2844
  #
2775
2845
  # @return [Types::ProcessesType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2776
2846
  #
@@ -2830,7 +2900,7 @@ module Aws::AutoScaling
2830
2900
 
2831
2901
  # Describes the actions scheduled for your Auto Scaling group that
2832
2902
  # haven't run or that have not reached their end time. To describe the
2833
- # actions that have already run, use DescribeScalingActivities.
2903
+ # actions that have already run, call the DescribeScalingActivities API.
2834
2904
  #
2835
2905
  # @option params [String] :auto_scaling_group_name
2836
2906
  # The name of the Auto Scaling group.
@@ -2862,6 +2932,8 @@ module Aws::AutoScaling
2862
2932
  # * {Types::ScheduledActionsType#scheduled_update_group_actions #scheduled_update_group_actions} => Array&lt;Types::ScheduledUpdateGroupAction&gt;
2863
2933
  # * {Types::ScheduledActionsType#next_token #next_token} => String
2864
2934
  #
2935
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2936
+ #
2865
2937
  #
2866
2938
  # @example Example: To describe scheduled actions
2867
2939
  #
@@ -2934,6 +3006,13 @@ module Aws::AutoScaling
2934
3006
  # for a particular tag only if it matches all the filters. If there's
2935
3007
  # no match, no special message is returned.
2936
3008
  #
3009
+ # For more information, see [Tagging Auto Scaling Groups and
3010
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
3011
+ #
3012
+ #
3013
+ #
3014
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
3015
+ #
2937
3016
  # @option params [Array<Types::Filter>] :filters
2938
3017
  # One or more filters to scope the tags to return. The maximum number of
2939
3018
  # filters per filter type (for example, `auto-scaling-group`) is 1000.
@@ -2951,6 +3030,8 @@ module Aws::AutoScaling
2951
3030
  # * {Types::TagsType#tags #tags} => Array&lt;Types::TagDescription&gt;
2952
3031
  # * {Types::TagsType#next_token #next_token} => String
2953
3032
  #
3033
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3034
+ #
2954
3035
  #
2955
3036
  # @example Example: To describe tags
2956
3037
  #
@@ -3206,13 +3287,13 @@ module Aws::AutoScaling
3206
3287
  # Scaling group.
3207
3288
  #
3208
3289
  # This operation detaches only Classic Load Balancers. If you have
3209
- # Application Load Balancers or Network Load Balancers, use
3210
- # DetachLoadBalancerTargetGroups instead.
3290
+ # Application Load Balancers or Network Load Balancers, use the
3291
+ # DetachLoadBalancerTargetGroups API instead.
3211
3292
  #
3212
3293
  # When you detach a load balancer, it enters the `Removing` state while
3213
3294
  # deregistering the instances in the group. When all instances are
3214
3295
  # deregistered, then you can no longer describe the load balancer using
3215
- # DescribeLoadBalancers. The instances remain running.
3296
+ # the DescribeLoadBalancers API call. The instances remain running.
3216
3297
  #
3217
3298
  # @option params [required, String] :auto_scaling_group_name
3218
3299
  # The name of the Auto Scaling group.
@@ -3257,8 +3338,7 @@ module Aws::AutoScaling
3257
3338
  # The name of the Auto Scaling group.
3258
3339
  #
3259
3340
  # @option params [Array<String>] :metrics
3260
- # One or more of the following metrics. If you omit this parameter, all
3261
- # metrics are disabled.
3341
+ # Specifies one or more of the following metrics:
3262
3342
  #
3263
3343
  # * `GroupMinSize`
3264
3344
  #
@@ -3276,6 +3356,18 @@ module Aws::AutoScaling
3276
3356
  #
3277
3357
  # * `GroupTotalInstances`
3278
3358
  #
3359
+ # * `GroupInServiceCapacity`
3360
+ #
3361
+ # * `GroupPendingCapacity`
3362
+ #
3363
+ # * `GroupStandbyCapacity`
3364
+ #
3365
+ # * `GroupTerminatingCapacity`
3366
+ #
3367
+ # * `GroupTotalCapacity`
3368
+ #
3369
+ # If you omit this parameter, all metrics are disabled.
3370
+ #
3279
3371
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3280
3372
  #
3281
3373
  #
@@ -3318,8 +3410,8 @@ module Aws::AutoScaling
3318
3410
  # The name of the Auto Scaling group.
3319
3411
  #
3320
3412
  # @option params [Array<String>] :metrics
3321
- # One or more of the following metrics. If you omit this parameter, all
3322
- # metrics are enabled.
3413
+ # Specifies which group-level metrics to start collecting. You can
3414
+ # specify one or more of the following metrics:
3323
3415
  #
3324
3416
  # * `GroupMinSize`
3325
3417
  #
@@ -3337,6 +3429,21 @@ module Aws::AutoScaling
3337
3429
  #
3338
3430
  # * `GroupTotalInstances`
3339
3431
  #
3432
+ # The instance weighting feature supports the following additional
3433
+ # metrics:
3434
+ #
3435
+ # * `GroupInServiceCapacity`
3436
+ #
3437
+ # * `GroupPendingCapacity`
3438
+ #
3439
+ # * `GroupStandbyCapacity`
3440
+ #
3441
+ # * `GroupTerminatingCapacity`
3442
+ #
3443
+ # * `GroupTotalCapacity`
3444
+ #
3445
+ # If you omit this parameter, all metrics are enabled.
3446
+ #
3340
3447
  # @option params [required, String] :granularity
3341
3448
  # The granularity to associate with the metrics to collect. The only
3342
3449
  # valid value is `1Minute`.
@@ -3638,11 +3745,11 @@ module Aws::AutoScaling
3638
3745
  # the instances launch or terminate.**
3639
3746
  #
3640
3747
  # 4. If you need more time, record the lifecycle action heartbeat to
3641
- # keep the instance in a pending state using
3642
- # RecordLifecycleActionHeartbeat.
3748
+ # keep the instance in a pending state using the
3749
+ # RecordLifecycleActionHeartbeat API call.
3643
3750
  #
3644
3751
  # 5. If you finish before the timeout period ends, complete the
3645
- # lifecycle action using CompleteLifecycleAction.
3752
+ # lifecycle action using the CompleteLifecycleAction API call.
3646
3753
  #
3647
3754
  # For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
3648
3755
  # in the *Amazon EC2 Auto Scaling User Guide*.
@@ -3650,9 +3757,10 @@ module Aws::AutoScaling
3650
3757
  # If you exceed your maximum limit of lifecycle hooks, which by default
3651
3758
  # is 50 per Auto Scaling group, the call fails.
3652
3759
  #
3653
- # You can view the lifecycle hooks for an Auto Scaling group using
3654
- # DescribeLifecycleHooks. If you are no longer using a lifecycle hook,
3655
- # you can delete it using DeleteLifecycleHook.
3760
+ # You can view the lifecycle hooks for an Auto Scaling group using the
3761
+ # DescribeLifecycleHooks API call. If you are no longer using a
3762
+ # lifecycle hook, you can delete it by calling the DeleteLifecycleHook
3763
+ # API.
3656
3764
  #
3657
3765
  #
3658
3766
  #
@@ -3710,8 +3818,8 @@ module Aws::AutoScaling
3710
3818
  #
3711
3819
  # If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
3712
3820
  # action that you specified in the `DefaultResult` parameter. You can
3713
- # prevent the lifecycle hook from timing out by calling
3714
- # RecordLifecycleActionHeartbeat.
3821
+ # prevent the lifecycle hook from timing out by calling the
3822
+ # RecordLifecycleActionHeartbeat API.
3715
3823
  #
3716
3824
  # @option params [String] :default_result
3717
3825
  # Defines the action the Auto Scaling group should take when the
@@ -3779,9 +3887,9 @@ module Aws::AutoScaling
3779
3887
  # Service (Amazon SNS) topic.
3780
3888
  #
3781
3889
  # @option params [required, Array<String>] :notification_types
3782
- # The type of event that causes the notification to be sent. For more
3783
- # information about notification types supported by Amazon EC2 Auto
3784
- # Scaling, see DescribeAutoScalingNotificationTypes.
3890
+ # The type of event that causes the notification to be sent. To query
3891
+ # the notification types supported by Amazon EC2 Auto Scaling, call the
3892
+ # DescribeAutoScalingNotificationTypes API.
3785
3893
  #
3786
3894
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3787
3895
  #
@@ -3818,12 +3926,14 @@ module Aws::AutoScaling
3818
3926
  # Creates or updates a scaling policy for an Auto Scaling group.
3819
3927
  #
3820
3928
  # For more information about using scaling policies to scale your Auto
3821
- # Scaling group automatically, see [Dynamic Scaling][1] in the *Amazon
3822
- # EC2 Auto Scaling User Guide*.
3929
+ # Scaling group, see [Target Tracking Scaling Policies][1] and [Step and
3930
+ # Simple Scaling Policies][2] in the *Amazon EC2 Auto Scaling User
3931
+ # Guide*.
3823
3932
  #
3824
3933
  #
3825
3934
  #
3826
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3935
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html
3936
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
3827
3937
  #
3828
3938
  # @option params [required, String] :auto_scaling_group_name
3829
3939
  # The name of the Auto Scaling group.
@@ -3854,20 +3964,22 @@ module Aws::AutoScaling
3854
3964
  # instead.
3855
3965
  #
3856
3966
  # @option params [Integer] :min_adjustment_magnitude
3857
- # The minimum number of instances to scale. If the value of
3858
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
3859
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
3860
- # this many instances. Otherwise, the error is `ValidationError`.
3967
+ # The minimum value to scale by when scaling by percentages. For
3968
+ # example, suppose that you create a step scaling policy to scale out an
3969
+ # Auto Scaling group by 25 percent and you specify a
3970
+ # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
3971
+ # scaling policy is performed, 25 percent of 4 is 1. However, because
3972
+ # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
3973
+ # scales out the group by 2 instances.
3974
+ #
3975
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
3976
+ # the adjustment type is `PercentChangeInCapacity`. For more
3977
+ # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
3978
+ # Scaling User Guide*.
3861
3979
  #
3862
- # This property replaces the `MinAdjustmentStep` property. For example,
3863
- # suppose that you create a step scaling policy to scale out an Auto
3864
- # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
3865
- # of 2. If the group has 4 instances and the scaling policy is
3866
- # performed, 25 percent of 4 is 1. However, because you specified a
3867
- # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
3868
- # group by 2 instances.
3869
3980
  #
3870
- # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
3981
+ #
3982
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
3871
3983
  #
3872
3984
  # @option params [Integer] :scaling_adjustment
3873
3985
  # The amount by which a simple scaling policy scales the Auto Scaling
@@ -4073,14 +4185,16 @@ module Aws::AutoScaling
4073
4185
  # [1]: http://crontab.org
4074
4186
  #
4075
4187
  # @option params [Integer] :min_size
4076
- # The minimum number of instances in the Auto Scaling group.
4188
+ # The minimum size of the Auto Scaling group.
4077
4189
  #
4078
4190
  # @option params [Integer] :max_size
4079
- # The maximum number of instances in the Auto Scaling group.
4191
+ # The maximum size of the Auto Scaling group.
4080
4192
  #
4081
4193
  # @option params [Integer] :desired_capacity
4082
- # The number of EC2 instances that should be running in the Auto Scaling
4083
- # group.
4194
+ # The desired capacity is the initial capacity of the Auto Scaling group
4195
+ # after the scheduled action runs and the capacity it attempts to
4196
+ # maintain. It can scale beyond this capacity if you add more scaling
4197
+ # conditions.
4084
4198
  #
4085
4199
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4086
4200
  #
@@ -4124,7 +4238,7 @@ module Aws::AutoScaling
4124
4238
 
4125
4239
  # Records a heartbeat for the lifecycle action associated with the
4126
4240
  # specified token or instance. This extends the timeout by the length of
4127
- # time defined using PutLifecycleHook.
4241
+ # time defined using the PutLifecycleHook API call.
4128
4242
  #
4129
4243
  # This step is a part of the procedure for adding a lifecycle hook to an
4130
4244
  # Auto Scaling group:
@@ -4265,19 +4379,25 @@ module Aws::AutoScaling
4265
4379
 
4266
4380
  # Sets the size of the specified Auto Scaling group.
4267
4381
  #
4268
- # For more information about desired capacity, see [What Is Amazon EC2
4269
- # Auto Scaling?][1] in the *Amazon EC2 Auto Scaling User Guide*.
4382
+ # If a scale-in activity occurs as a result of a new `DesiredCapacity`
4383
+ # value that is lower than the current size of the group, the Auto
4384
+ # Scaling group uses its termination policy to determine which instances
4385
+ # to terminate.
4386
+ #
4387
+ # For more information, see [Manual Scaling][1] in the *Amazon EC2 Auto
4388
+ # Scaling User Guide*.
4270
4389
  #
4271
4390
  #
4272
4391
  #
4273
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html
4392
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html
4274
4393
  #
4275
4394
  # @option params [required, String] :auto_scaling_group_name
4276
4395
  # The name of the Auto Scaling group.
4277
4396
  #
4278
4397
  # @option params [required, Integer] :desired_capacity
4279
- # The number of EC2 instances that should be running in the Auto Scaling
4280
- # group.
4398
+ # The desired capacity is the initial capacity of the Auto Scaling group
4399
+ # after this operation completes and the capacity it attempts to
4400
+ # maintain.
4281
4401
  #
4282
4402
  # @option params [Boolean] :honor_cooldown
4283
4403
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
@@ -4341,7 +4461,12 @@ module Aws::AutoScaling
4341
4461
  # not respect the grace period associated with the group.
4342
4462
  #
4343
4463
  # For more information about the health check grace period, see
4344
- # CreateAutoScalingGroup.
4464
+ # [CreateAutoScalingGroup][1] in the *Amazon EC2 Auto Scaling API
4465
+ # Reference*.
4466
+ #
4467
+ #
4468
+ #
4469
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html
4345
4470
  #
4346
4471
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4347
4472
  #
@@ -4440,12 +4565,12 @@ module Aws::AutoScaling
4440
4565
  # for the specified Auto Scaling group.
4441
4566
  #
4442
4567
  # If you suspend either the `Launch` or `Terminate` process types, it
4443
- # can prevent other process types from functioning properly.
4444
- #
4445
- # To resume processes that have been suspended, use ResumeProcesses.
4568
+ # can prevent other process types from functioning properly. For more
4569
+ # information, see [Suspending and Resuming Scaling Processes][1] in the
4570
+ # *Amazon EC2 Auto Scaling User Guide*.
4446
4571
  #
4447
- # For more information, see [Suspending and Resuming Scaling
4448
- # Processes][1] in the *Amazon EC2 Auto Scaling User Guide*.
4572
+ # To resume processes that have been suspended, call the ResumeProcesses
4573
+ # API.
4449
4574
  #
4450
4575
  #
4451
4576
  #
@@ -4505,10 +4630,12 @@ module Aws::AutoScaling
4505
4630
  end
4506
4631
 
4507
4632
  # Terminates the specified instance and optionally adjusts the desired
4508
- # group size. This call simply makes a termination request. The instance
4509
- # is not terminated immediately. When an instance is terminated, the
4510
- # instance status changes to `terminated`. You can't connect to or
4511
- # start an instance after you've terminated it.
4633
+ # group size.
4634
+ #
4635
+ # This call simply makes a termination request. The instance is not
4636
+ # terminated immediately. When an instance is terminated, the instance
4637
+ # status changes to `terminated`. You can't connect to or start an
4638
+ # instance after you've terminated it.
4512
4639
  #
4513
4640
  # If you do not specify the option to decrement the desired capacity,
4514
4641
  # Amazon EC2 Auto Scaling launches instances to replace the ones that
@@ -4601,7 +4728,7 @@ module Aws::AutoScaling
4601
4728
  # Note the following about changing `DesiredCapacity`, `MaxSize`, or
4602
4729
  # `MinSize`\:
4603
4730
  #
4604
- # * If a scale-in event occurs as a result of a new `DesiredCapacity`
4731
+ # * If a scale-in activity occurs as a result of a new `DesiredCapacity`
4605
4732
  # value that is lower than the current size of the group, the Auto
4606
4733
  # Scaling group uses its termination policy to determine which
4607
4734
  # instances to terminate.
@@ -4616,10 +4743,11 @@ module Aws::AutoScaling
4616
4743
  # current size of the group, this sets the group's `DesiredCapacity`
4617
4744
  # to the new `MaxSize` value.
4618
4745
  #
4619
- # To see which parameters have been set, use DescribeAutoScalingGroups.
4620
- # You can also view the scaling policies for an Auto Scaling group using
4621
- # DescribePolicies. If the group has scaling policies, you can update
4622
- # them using PutScalingPolicy.
4746
+ # To see which parameters have been set, call the
4747
+ # DescribeAutoScalingGroups API. To view the scaling policies for an
4748
+ # Auto Scaling group, call the DescribePolicies API. If the group has
4749
+ # scaling policies, you can update them by calling the PutScalingPolicy
4750
+ # API.
4623
4751
  #
4624
4752
  # @option params [required, String] :auto_scaling_group_name
4625
4753
  # The name of the Auto Scaling group.
@@ -4664,10 +4792,22 @@ module Aws::AutoScaling
4664
4792
  # @option params [Integer] :max_size
4665
4793
  # The maximum size of the Auto Scaling group.
4666
4794
  #
4795
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
4796
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
4797
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
4798
+ # above `MaxSize` by more than your maximum instance weight (weights
4799
+ # that define how many capacity units each instance contributes to the
4800
+ # capacity of the group).
4801
+ #
4802
+ # </note>
4803
+ #
4667
4804
  # @option params [Integer] :desired_capacity
4668
- # The number of EC2 instances that should be running in the Auto Scaling
4669
- # group. This number must be greater than or equal to the minimum size
4670
- # of the group and less than or equal to the maximum size of the group.
4805
+ # The desired capacity is the initial capacity of the Auto Scaling group
4806
+ # after this operation completes and the capacity it attempts to
4807
+ # maintain.
4808
+ #
4809
+ # This number must be greater than or equal to the minimum size of the
4810
+ # group and less than or equal to the maximum size of the group.
4671
4811
  #
4672
4812
  # @option params [Integer] :default_cooldown
4673
4813
  # The amount of time, in seconds, after a scaling activity completes
@@ -4763,13 +4903,17 @@ module Aws::AutoScaling
4763
4903
  #
4764
4904
  # @option params [Integer] :max_instance_lifetime
4765
4905
  # The maximum amount of time, in seconds, that an instance can be in
4766
- # service.
4906
+ # service. The default is null.
4907
+ #
4908
+ # This parameter is optional, but if you specify a value for it, you
4909
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
4910
+ # previously set value, specify a new value of 0.
4767
4911
  #
4768
4912
  # For more information, see [Replacing Auto Scaling Instances Based on
4769
4913
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
4770
4914
  # Guide*.
4771
4915
  #
4772
- # Valid Range: Minimum value of 604800.
4916
+ # Valid Range: Minimum value of 0.
4773
4917
  #
4774
4918
  #
4775
4919
  #
@@ -4876,7 +5020,7 @@ module Aws::AutoScaling
4876
5020
  params: params,
4877
5021
  config: config)
4878
5022
  context[:gem_name] = 'aws-sdk-autoscaling'
4879
- context[:gem_version] = '1.33.0'
5023
+ context[:gem_version] = '1.38.1'
4880
5024
  Seahorse::Client::Request.new(handlers, context)
4881
5025
  end
4882
5026
 
@@ -4942,11 +5086,11 @@ module Aws::AutoScaling
4942
5086
  # The following table lists the valid waiter names, the operations they call,
4943
5087
  # and the default `:delay` and `:max_attempts` values.
4944
5088
  #
4945
- # | waiter_name | params | :delay | :max_attempts |
4946
- # | ---------------- | ------------------------------- | -------- | ------------- |
4947
- # | group_exists | {#describe_auto_scaling_groups} | 5 | 10 |
4948
- # | group_in_service | {#describe_auto_scaling_groups} | 15 | 40 |
4949
- # | group_not_exists | {#describe_auto_scaling_groups} | 15 | 40 |
5089
+ # | waiter_name | params | :delay | :max_attempts |
5090
+ # | ---------------- | ------------------------------------- | -------- | ------------- |
5091
+ # | group_exists | {Client#describe_auto_scaling_groups} | 5 | 10 |
5092
+ # | group_in_service | {Client#describe_auto_scaling_groups} | 15 | 40 |
5093
+ # | group_not_exists | {Client#describe_auto_scaling_groups} | 15 | 40 |
4950
5094
  #
4951
5095
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
4952
5096
  # because the waiter has entered a state that it will not transition