aws-sdk-autoscaling 1.36.0 → 1.41.0

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: c1ea8c327418e3423e234d451050995d1dab98486db36b5e8b2713196b87d3da
4
- data.tar.gz: c3a6fe5e513a3c2af82e4aa6f6befef66f9c0463127ab48f89401ab72f3eae3e
3
+ metadata.gz: 0a0212772f92a489009f672d3f3368f1ffcaa8923f54453bf195c37b0058c60a
4
+ data.tar.gz: 8025d59bd8e73f95923cbdad9a64c9dd9dadda9ba33e679683c3ac93f7152fbb
5
5
  SHA512:
6
- metadata.gz: '04102821b6b81b72841cf084c219327a35aac9ae1d0d16473795edb68dd90409868651493db2616fa3fd333b114f8efbb371b2b4a964e5a54c512a5b8cba749b'
7
- data.tar.gz: 3dd50231249f5e11319819eab74fe2eba9d928ac8703e3068e9603433dce0bc0e3dcda1e78529d06b27aa54828176820478b37906fb4043d71f7250f5a4b1815
6
+ metadata.gz: d7787741e13ea3e023d996ce2780dee1431bfb0ec0ab00b9cc8c254df1d1d00acf0b85e4de4e131af277b4ceda4638aaa13185fc237915857f2cb283b1c5e1da
7
+ data.tar.gz: 8a102ee668e948b2aaa5bfb9412130d7520f09dffe2c50444b2b2d090472d413c1c36b47d675574c0f8be052411ae26d3da24a38dc309d3ec2ce3deb31225ac0
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -56,6 +58,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
56
58
  # @service
57
59
  module Aws::AutoScaling
58
60
 
59
- GEM_VERSION = '1.36.0'
61
+ GEM_VERSION = '1.41.0'
60
62
 
61
63
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -75,8 +77,7 @@ module Aws::AutoScaling
75
77
  data[:desired_capacity]
76
78
  end
77
79
 
78
- # The amount of time, in seconds, after a scaling activity completes
79
- # before another scaling activity can start.
80
+ # The duration of the default cooldown period, in seconds.
80
81
  # @return [Integer]
81
82
  def default_cooldown
82
83
  data[:default_cooldown]
@@ -583,15 +584,19 @@ module Aws::AutoScaling
583
584
  # @option options [required, String] :policy_name
584
585
  # The name of the policy.
585
586
  # @option options [String] :policy_type
586
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
587
- # and `TargetTrackingScaling`. If the policy type is null, the value is
588
- # treated as `SimpleScaling`.
587
+ # One of the following policy types:
588
+ #
589
+ # * `TargetTrackingScaling`
590
+ #
591
+ # * `StepScaling`
592
+ #
593
+ # * `SimpleScaling` (default)
589
594
  # @option options [String] :adjustment_type
590
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
591
- # number or a percentage of the current capacity. The valid values are
595
+ # Specifies how the scaling adjustment is interpreted (either an
596
+ # absolute number or a percentage). The valid values are
592
597
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
593
598
  #
594
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
599
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
595
600
  # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
596
601
  # Auto Scaling User Guide*.
597
602
  #
@@ -602,41 +607,43 @@ module Aws::AutoScaling
602
607
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
603
608
  # instead.
604
609
  # @option options [Integer] :min_adjustment_magnitude
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*.
610
+ # The minimum value to scale by when the adjustment type is
611
+ # `PercentChangeInCapacity`. For example, suppose that you create a step
612
+ # scaling policy to scale out an Auto Scaling group by 25 percent and
613
+ # you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
614
+ # instances and the scaling policy is performed, 25 percent of 4 is 1.
615
+ # However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon
616
+ # EC2 Auto Scaling scales out the group by 2 instances.
617
+ #
618
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
619
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
620
+ # Auto Scaling User Guide*.
621
+ #
622
+ # <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
623
+ # `MinAdjustmentMagnitude` to a value that is at least as large as your
624
+ # largest instance weight.
625
+ #
626
+ # </note>
617
627
  #
618
628
  #
619
629
  #
620
630
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
621
631
  # @option options [Integer] :scaling_adjustment
622
- # The amount by which a simple scaling policy scales the Auto Scaling
623
- # group in response to an alarm breach. The adjustment is based on the
624
- # value that you specified in the `AdjustmentType` parameter (either an
625
- # absolute number or a percentage). A positive value adds to the current
626
- # capacity and a negative value subtracts from the current capacity. For
627
- # exact capacity, you must specify a positive value.
628
- #
629
- # Conditional: If you specify `SimpleScaling` for the policy type, you
630
- # must specify this parameter. (Not used with any other policy type.)
632
+ # The amount by which to scale, based on the specified adjustment type.
633
+ # A positive value adds to the current capacity while a negative number
634
+ # removes from the current capacity. For exact capacity, you must
635
+ # specify a positive value.
636
+ #
637
+ # Required if the policy type is `SimpleScaling`. (Not used with any
638
+ # other policy type.)
631
639
  # @option options [Integer] :cooldown
632
- # The amount of time, in seconds, after a scaling activity completes
633
- # before any further dynamic scaling activities can start. If this
634
- # parameter is not specified, the default cooldown period for the group
635
- # applies.
640
+ # The duration of the policy's cooldown period, in seconds. When a
641
+ # cooldown period is specified here, it overrides the default cooldown
642
+ # period defined for the Auto Scaling group.
636
643
  #
637
644
  # Valid only if the policy type is `SimpleScaling`. For more
638
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
639
- # Scaling User Guide*.
645
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
646
+ # the *Amazon EC2 Auto Scaling User Guide*.
640
647
  #
641
648
  #
642
649
  #
@@ -651,25 +658,38 @@ module Aws::AutoScaling
651
658
  # A set of adjustments that enable you to scale based on the size of the
652
659
  # alarm breach.
653
660
  #
654
- # Conditional: If you specify `StepScaling` for the policy type, you
655
- # must specify this parameter. (Not used with any other policy type.)
661
+ # Required if the policy type is `StepScaling`. (Not used with any other
662
+ # policy type.)
656
663
  # @option options [Integer] :estimated_instance_warmup
657
664
  # The estimated time, in seconds, until a newly launched instance can
658
- # contribute to the CloudWatch metrics. The default is to use the value
659
- # specified for the default cooldown period for the group.
665
+ # contribute to the CloudWatch metrics. If not provided, the default is
666
+ # to use the value from the default cooldown period for the Auto Scaling
667
+ # group.
660
668
  #
661
- # Valid only if the policy type is `StepScaling` or
662
- # `TargetTrackingScaling`.
669
+ # Valid only if the policy type is `TargetTrackingScaling` or
670
+ # `StepScaling`.
663
671
  # @option options [Types::TargetTrackingConfiguration] :target_tracking_configuration
664
672
  # A target tracking scaling policy. Includes support for predefined or
665
673
  # customized metrics.
666
674
  #
675
+ # The following predefined metrics are available:
676
+ #
677
+ # * `ASGAverageCPUUtilization`
678
+ #
679
+ # * `ASGAverageNetworkIn`
680
+ #
681
+ # * `ASGAverageNetworkOut`
682
+ #
683
+ # * `ALBRequestCountPerTarget`
684
+ #
685
+ # If you specify `ALBRequestCountPerTarget` for the metric, you must
686
+ # specify the `ResourceLabel` parameter with the
687
+ # `PredefinedMetricSpecification`.
688
+ #
667
689
  # For more information, see [TargetTrackingConfiguration][1] in the
668
690
  # *Amazon EC2 Auto Scaling API Reference*.
669
691
  #
670
- # Conditional: If you specify `TargetTrackingScaling` for the policy
671
- # type, you must specify this parameter. (Not used with any other policy
672
- # type.)
692
+ # Required if the policy type is `TargetTrackingScaling`.
673
693
  #
674
694
  #
675
695
  #
@@ -763,24 +783,27 @@ module Aws::AutoScaling
763
783
  # })
764
784
  # @param [Hash] options ({})
765
785
  # @option options [Array<String>] :scaling_processes
766
- # One or more of the following processes. If you omit this parameter,
767
- # all processes are specified.
786
+ # One or more of the following processes:
768
787
  #
769
788
  # * `Launch`
770
789
  #
771
790
  # * `Terminate`
772
791
  #
773
- # * `HealthCheck`
792
+ # * `AddToLoadBalancer`
774
793
  #
775
- # * `ReplaceUnhealthy`
794
+ # * `AlarmNotification`
776
795
  #
777
796
  # * `AZRebalance`
778
797
  #
779
- # * `AlarmNotification`
798
+ # * `HealthCheck`
799
+ #
800
+ # * `InstanceRefresh`
801
+ #
802
+ # * `ReplaceUnhealthy`
780
803
  #
781
804
  # * `ScheduledActions`
782
805
  #
783
- # * `AddToLoadBalancer`
806
+ # If you omit this parameter, all processes are specified.
784
807
  # @return [EmptyStructure]
785
808
  def resume_processes(options = {})
786
809
  options = options.merge(auto_scaling_group_name: @name)
@@ -819,24 +842,27 @@ module Aws::AutoScaling
819
842
  # })
820
843
  # @param [Hash] options ({})
821
844
  # @option options [Array<String>] :scaling_processes
822
- # One or more of the following processes. If you omit this parameter,
823
- # all processes are specified.
845
+ # One or more of the following processes:
824
846
  #
825
847
  # * `Launch`
826
848
  #
827
849
  # * `Terminate`
828
850
  #
829
- # * `HealthCheck`
851
+ # * `AddToLoadBalancer`
830
852
  #
831
- # * `ReplaceUnhealthy`
853
+ # * `AlarmNotification`
832
854
  #
833
855
  # * `AZRebalance`
834
856
  #
835
- # * `AlarmNotification`
857
+ # * `HealthCheck`
858
+ #
859
+ # * `InstanceRefresh`
860
+ #
861
+ # * `ReplaceUnhealthy`
836
862
  #
837
863
  # * `ScheduledActions`
838
864
  #
839
- # * `AddToLoadBalancer`
865
+ # If you omit this parameter, all processes are specified.
840
866
  # @return [EmptyStructure]
841
867
  def suspend_processes(options = {})
842
868
  options = options.merge(auto_scaling_group_name: @name)
@@ -945,13 +971,11 @@ module Aws::AutoScaling
945
971
  # @option options [Integer] :default_cooldown
946
972
  # The amount of time, in seconds, after a scaling activity completes
947
973
  # before another scaling activity can start. The default value is `300`.
948
- # This cooldown period is not used when a scaling-specific cooldown is
949
- # specified.
950
974
  #
951
- # Cooldown periods are not supported for target tracking scaling
952
- # policies, step scaling policies, or scheduled scaling. For more
953
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
954
- # Scaling User Guide*.
975
+ # This setting applies when using simple scaling policies, but not when
976
+ # using other scaling policies or scheduled scaling. For more
977
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
978
+ # the *Amazon EC2 Auto Scaling User Guide*.
955
979
  #
956
980
  #
957
981
  #
@@ -971,8 +995,7 @@ module Aws::AutoScaling
971
995
  # For more information, see [Health Check Grace Period][1] in the
972
996
  # *Amazon EC2 Auto Scaling User Guide*.
973
997
  #
974
- # Conditional: This parameter is required if you are adding an `ELB`
975
- # health check.
998
+ # Required if you are adding an `ELB` health check.
976
999
  #
977
1000
  #
978
1001
  #
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/query.rb'
29
32
 
@@ -69,6 +72,7 @@ module Aws::AutoScaling
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::Query)
74
78
 
@@ -161,7 +165,7 @@ module Aws::AutoScaling
161
165
  # @option options [String] :endpoint
162
166
  # The client endpoint is normally constructed from the `:region`
163
167
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be a valid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
169
  #
166
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::AutoScaling
176
180
  # requests fetching endpoints information. Defaults to 60 sec.
177
181
  #
178
182
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
184
  #
181
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
186
  # The log formatter.
@@ -560,6 +564,43 @@ module Aws::AutoScaling
560
564
  req.send_request(options)
561
565
  end
562
566
 
567
+ # Cancels an instance refresh operation in progress. Cancellation does
568
+ # not roll back any replacements that have already been completed, but
569
+ # it prevents new replacements from being started.
570
+ #
571
+ # For more information, see [Replacing Auto Scaling Instances Based on
572
+ # an Instance Refresh][1].
573
+ #
574
+ #
575
+ #
576
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
577
+ #
578
+ # @option params [required, String] :auto_scaling_group_name
579
+ # The name of the Auto Scaling group.
580
+ #
581
+ # @return [Types::CancelInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
582
+ #
583
+ # * {Types::CancelInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
584
+ #
585
+ # @example Request syntax with placeholder values
586
+ #
587
+ # resp = client.cancel_instance_refresh({
588
+ # auto_scaling_group_name: "XmlStringMaxLen255", # required
589
+ # })
590
+ #
591
+ # @example Response structure
592
+ #
593
+ # resp.instance_refresh_id #=> String
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CancelInstanceRefresh AWS API Documentation
596
+ #
597
+ # @overload cancel_instance_refresh(params = {})
598
+ # @param [Hash] params ({})
599
+ def cancel_instance_refresh(params = {}, options = {})
600
+ req = build_request(:cancel_instance_refresh, params)
601
+ req.send_request(options)
602
+ end
603
+
563
604
  # Completes the lifecycle action for the specified token or instance
564
605
  # with the specified result.
565
606
  #
@@ -769,8 +810,10 @@ module Aws::AutoScaling
769
810
  # The amount of time, in seconds, after a scaling activity completes
770
811
  # before another scaling activity can start. The default value is `300`.
771
812
  #
772
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
773
- # Auto Scaling User Guide*.
813
+ # This setting applies when using simple scaling policies, but not when
814
+ # using other scaling policies or scheduled scaling. For more
815
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
816
+ # the *Amazon EC2 Auto Scaling User Guide*.
774
817
  #
775
818
  #
776
819
  #
@@ -831,8 +874,7 @@ module Aws::AutoScaling
831
874
  # For more information, see [Health Check Grace Period][1] in the
832
875
  # *Amazon EC2 Auto Scaling User Guide*.
833
876
  #
834
- # Conditional: This parameter is required if you are adding an `ELB`
835
- # health check.
877
+ # Required if you are adding an `ELB` health check.
836
878
  #
837
879
  #
838
880
  #
@@ -2145,6 +2187,84 @@ module Aws::AutoScaling
2145
2187
  req.send_request(options)
2146
2188
  end
2147
2189
 
2190
+ # Describes one or more instance refreshes.
2191
+ #
2192
+ # You can determine the status of a request by looking at the `Status`
2193
+ # parameter. The following are the possible statuses:
2194
+ #
2195
+ # * `Pending` - The request was created, but the operation has not
2196
+ # started.
2197
+ #
2198
+ # * `InProgress` - The operation is in progress.
2199
+ #
2200
+ # * `Successful` - The operation completed successfully.
2201
+ #
2202
+ # * `Failed` - The operation failed to complete. You can troubleshoot
2203
+ # using the status reason and the scaling activities.
2204
+ #
2205
+ # * `Cancelling` - An ongoing operation is being cancelled. Cancellation
2206
+ # does not roll back any replacements that have already been
2207
+ # completed, but it prevents new replacements from being started.
2208
+ #
2209
+ # * `Cancelled` - The operation is cancelled.
2210
+ #
2211
+ # For more information, see [Replacing Auto Scaling Instances Based on
2212
+ # an Instance Refresh][1].
2213
+ #
2214
+ #
2215
+ #
2216
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
2217
+ #
2218
+ # @option params [required, String] :auto_scaling_group_name
2219
+ # The name of the Auto Scaling group.
2220
+ #
2221
+ # @option params [Array<String>] :instance_refresh_ids
2222
+ # One or more instance refresh IDs.
2223
+ #
2224
+ # @option params [String] :next_token
2225
+ # The token for the next set of items to return. (You received this
2226
+ # token from a previous call.)
2227
+ #
2228
+ # @option params [Integer] :max_records
2229
+ # The maximum number of items to return with this call. The default
2230
+ # value is `50` and the maximum value is `100`.
2231
+ #
2232
+ # @return [Types::DescribeInstanceRefreshesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2233
+ #
2234
+ # * {Types::DescribeInstanceRefreshesAnswer#instance_refreshes #instance_refreshes} => Array&lt;Types::InstanceRefresh&gt;
2235
+ # * {Types::DescribeInstanceRefreshesAnswer#next_token #next_token} => String
2236
+ #
2237
+ # @example Request syntax with placeholder values
2238
+ #
2239
+ # resp = client.describe_instance_refreshes({
2240
+ # auto_scaling_group_name: "XmlStringMaxLen255", # required
2241
+ # instance_refresh_ids: ["XmlStringMaxLen255"],
2242
+ # next_token: "XmlString",
2243
+ # max_records: 1,
2244
+ # })
2245
+ #
2246
+ # @example Response structure
2247
+ #
2248
+ # resp.instance_refreshes #=> Array
2249
+ # resp.instance_refreshes[0].instance_refresh_id #=> String
2250
+ # resp.instance_refreshes[0].auto_scaling_group_name #=> String
2251
+ # resp.instance_refreshes[0].status #=> String, one of "Pending", "InProgress", "Successful", "Failed", "Cancelling", "Cancelled"
2252
+ # resp.instance_refreshes[0].status_reason #=> String
2253
+ # resp.instance_refreshes[0].start_time #=> Time
2254
+ # resp.instance_refreshes[0].end_time #=> Time
2255
+ # resp.instance_refreshes[0].percentage_complete #=> Integer
2256
+ # resp.instance_refreshes[0].instances_to_update #=> Integer
2257
+ # resp.next_token #=> String
2258
+ #
2259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeInstanceRefreshes AWS API Documentation
2260
+ #
2261
+ # @overload describe_instance_refreshes(params = {})
2262
+ # @param [Hash] params ({})
2263
+ def describe_instance_refreshes(params = {}, options = {})
2264
+ req = build_request(:describe_instance_refreshes, params)
2265
+ req.send_request(options)
2266
+ end
2267
+
2148
2268
  # Describes one or more launch configurations.
2149
2269
  #
2150
2270
  # @option params [Array<String>] :launch_configuration_names
@@ -3582,8 +3702,8 @@ module Aws::AutoScaling
3582
3702
  # This parameter is not supported if the policy type is `StepScaling` or
3583
3703
  # `TargetTrackingScaling`.
3584
3704
  #
3585
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
3586
- # Auto Scaling User Guide*.
3705
+ # For more information, see [Scaling Cooldowns for Amazon EC2 Auto
3706
+ # Scaling][1] in the *Amazon EC2 Auto Scaling User Guide*.
3587
3707
  #
3588
3708
  #
3589
3709
  #
@@ -3599,14 +3719,14 @@ module Aws::AutoScaling
3599
3719
  # If you specify a metric value that doesn't correspond to a step
3600
3720
  # adjustment for the policy, the call returns an error.
3601
3721
  #
3602
- # Conditional: This parameter is required if the policy type is
3603
- # `StepScaling` and not supported otherwise.
3722
+ # Required if the policy type is `StepScaling` and not supported
3723
+ # otherwise.
3604
3724
  #
3605
3725
  # @option params [Float] :breach_threshold
3606
3726
  # The breach threshold for the alarm.
3607
3727
  #
3608
- # Conditional: This parameter is required if the policy type is
3609
- # `StepScaling` and not supported otherwise.
3728
+ # Required if the policy type is `StepScaling` and not supported
3729
+ # otherwise.
3610
3730
  #
3611
3731
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3612
3732
  #
@@ -3778,16 +3898,16 @@ module Aws::AutoScaling
3778
3898
  #
3779
3899
  # * autoscaling:EC2\_INSTANCE\_TERMINATING
3780
3900
  #
3781
- # Conditional: This parameter is required for new lifecycle hooks, but
3782
- # optional when updating existing hooks.
3901
+ # Required for new lifecycle hooks, but optional when updating existing
3902
+ # hooks.
3783
3903
  #
3784
3904
  # @option params [String] :role_arn
3785
3905
  # The ARN of the IAM role that allows the Auto Scaling group to publish
3786
3906
  # to the specified notification target, for example, an Amazon SNS topic
3787
3907
  # or an Amazon SQS queue.
3788
3908
  #
3789
- # Conditional: This parameter is required for new lifecycle hooks, but
3790
- # optional when updating existing hooks.
3909
+ # Required for new lifecycle hooks, but optional when updating existing
3910
+ # hooks.
3791
3911
  #
3792
3912
  # @option params [String] :notification_target_arn
3793
3913
  # The ARN of the notification target that Amazon EC2 Auto Scaling uses
@@ -3940,16 +4060,20 @@ module Aws::AutoScaling
3940
4060
  # The name of the policy.
3941
4061
  #
3942
4062
  # @option params [String] :policy_type
3943
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
3944
- # and `TargetTrackingScaling`. If the policy type is null, the value is
3945
- # treated as `SimpleScaling`.
4063
+ # One of the following policy types:
4064
+ #
4065
+ # * `TargetTrackingScaling`
4066
+ #
4067
+ # * `StepScaling`
4068
+ #
4069
+ # * `SimpleScaling` (default)
3946
4070
  #
3947
4071
  # @option params [String] :adjustment_type
3948
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
3949
- # number or a percentage of the current capacity. The valid values are
4072
+ # Specifies how the scaling adjustment is interpreted (either an
4073
+ # absolute number or a percentage). The valid values are
3950
4074
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
3951
4075
  #
3952
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
4076
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
3953
4077
  # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
3954
4078
  # Auto Scaling User Guide*.
3955
4079
  #
@@ -3962,43 +4086,45 @@ module Aws::AutoScaling
3962
4086
  # instead.
3963
4087
  #
3964
4088
  # @option params [Integer] :min_adjustment_magnitude
3965
- # The minimum value to scale by when scaling by percentages. For
3966
- # example, suppose that you create a step scaling policy to scale out an
3967
- # Auto Scaling group by 25 percent and you specify a
3968
- # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
3969
- # scaling policy is performed, 25 percent of 4 is 1. However, because
3970
- # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
3971
- # scales out the group by 2 instances.
3972
- #
3973
- # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
3974
- # the adjustment type is `PercentChangeInCapacity`. For more
3975
- # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
3976
- # Scaling User Guide*.
4089
+ # The minimum value to scale by when the adjustment type is
4090
+ # `PercentChangeInCapacity`. For example, suppose that you create a step
4091
+ # scaling policy to scale out an Auto Scaling group by 25 percent and
4092
+ # you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
4093
+ # instances and the scaling policy is performed, 25 percent of 4 is 1.
4094
+ # However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon
4095
+ # EC2 Auto Scaling scales out the group by 2 instances.
4096
+ #
4097
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
4098
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
4099
+ # Auto Scaling User Guide*.
4100
+ #
4101
+ # <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
4102
+ # `MinAdjustmentMagnitude` to a value that is at least as large as your
4103
+ # largest instance weight.
4104
+ #
4105
+ # </note>
3977
4106
  #
3978
4107
  #
3979
4108
  #
3980
4109
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
3981
4110
  #
3982
4111
  # @option params [Integer] :scaling_adjustment
3983
- # The amount by which a simple scaling policy scales the Auto Scaling
3984
- # group in response to an alarm breach. The adjustment is based on the
3985
- # value that you specified in the `AdjustmentType` parameter (either an
3986
- # absolute number or a percentage). A positive value adds to the current
3987
- # capacity and a negative value subtracts from the current capacity. For
3988
- # exact capacity, you must specify a positive value.
4112
+ # The amount by which to scale, based on the specified adjustment type.
4113
+ # A positive value adds to the current capacity while a negative number
4114
+ # removes from the current capacity. For exact capacity, you must
4115
+ # specify a positive value.
3989
4116
  #
3990
- # Conditional: If you specify `SimpleScaling` for the policy type, you
3991
- # must specify this parameter. (Not used with any other policy type.)
4117
+ # Required if the policy type is `SimpleScaling`. (Not used with any
4118
+ # other policy type.)
3992
4119
  #
3993
4120
  # @option params [Integer] :cooldown
3994
- # The amount of time, in seconds, after a scaling activity completes
3995
- # before any further dynamic scaling activities can start. If this
3996
- # parameter is not specified, the default cooldown period for the group
3997
- # applies.
4121
+ # The duration of the policy's cooldown period, in seconds. When a
4122
+ # cooldown period is specified here, it overrides the default cooldown
4123
+ # period defined for the Auto Scaling group.
3998
4124
  #
3999
4125
  # Valid only if the policy type is `SimpleScaling`. For more
4000
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
4001
- # Scaling User Guide*.
4126
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
4127
+ # the *Amazon EC2 Auto Scaling User Guide*.
4002
4128
  #
4003
4129
  #
4004
4130
  #
@@ -4015,27 +4141,40 @@ module Aws::AutoScaling
4015
4141
  # A set of adjustments that enable you to scale based on the size of the
4016
4142
  # alarm breach.
4017
4143
  #
4018
- # Conditional: If you specify `StepScaling` for the policy type, you
4019
- # must specify this parameter. (Not used with any other policy type.)
4144
+ # Required if the policy type is `StepScaling`. (Not used with any other
4145
+ # policy type.)
4020
4146
  #
4021
4147
  # @option params [Integer] :estimated_instance_warmup
4022
4148
  # The estimated time, in seconds, until a newly launched instance can
4023
- # contribute to the CloudWatch metrics. The default is to use the value
4024
- # specified for the default cooldown period for the group.
4149
+ # contribute to the CloudWatch metrics. If not provided, the default is
4150
+ # to use the value from the default cooldown period for the Auto Scaling
4151
+ # group.
4025
4152
  #
4026
- # Valid only if the policy type is `StepScaling` or
4027
- # `TargetTrackingScaling`.
4153
+ # Valid only if the policy type is `TargetTrackingScaling` or
4154
+ # `StepScaling`.
4028
4155
  #
4029
4156
  # @option params [Types::TargetTrackingConfiguration] :target_tracking_configuration
4030
4157
  # A target tracking scaling policy. Includes support for predefined or
4031
4158
  # customized metrics.
4032
4159
  #
4160
+ # The following predefined metrics are available:
4161
+ #
4162
+ # * `ASGAverageCPUUtilization`
4163
+ #
4164
+ # * `ASGAverageNetworkIn`
4165
+ #
4166
+ # * `ASGAverageNetworkOut`
4167
+ #
4168
+ # * `ALBRequestCountPerTarget`
4169
+ #
4170
+ # If you specify `ALBRequestCountPerTarget` for the metric, you must
4171
+ # specify the `ResourceLabel` parameter with the
4172
+ # `PredefinedMetricSpecification`.
4173
+ #
4033
4174
  # For more information, see [TargetTrackingConfiguration][1] in the
4034
4175
  # *Amazon EC2 Auto Scaling API Reference*.
4035
4176
  #
4036
- # Conditional: If you specify `TargetTrackingScaling` for the policy
4037
- # type, you must specify this parameter. (Not used with any other policy
4038
- # type.)
4177
+ # Required if the policy type is `TargetTrackingScaling`.
4039
4178
  #
4040
4179
  #
4041
4180
  #
@@ -4326,24 +4465,27 @@ module Aws::AutoScaling
4326
4465
  # The name of the Auto Scaling group.
4327
4466
  #
4328
4467
  # @option params [Array<String>] :scaling_processes
4329
- # One or more of the following processes. If you omit this parameter,
4330
- # all processes are specified.
4468
+ # One or more of the following processes:
4331
4469
  #
4332
4470
  # * `Launch`
4333
4471
  #
4334
4472
  # * `Terminate`
4335
4473
  #
4336
- # * `HealthCheck`
4474
+ # * `AddToLoadBalancer`
4337
4475
  #
4338
- # * `ReplaceUnhealthy`
4476
+ # * `AlarmNotification`
4339
4477
  #
4340
4478
  # * `AZRebalance`
4341
4479
  #
4342
- # * `AlarmNotification`
4480
+ # * `HealthCheck`
4481
+ #
4482
+ # * `InstanceRefresh`
4483
+ #
4484
+ # * `ReplaceUnhealthy`
4343
4485
  #
4344
4486
  # * `ScheduledActions`
4345
4487
  #
4346
- # * `AddToLoadBalancer`
4488
+ # If you omit this parameter, all processes are specified.
4347
4489
  #
4348
4490
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4349
4491
  #
@@ -4559,6 +4701,81 @@ module Aws::AutoScaling
4559
4701
  req.send_request(options)
4560
4702
  end
4561
4703
 
4704
+ # Starts a new instance refresh operation, which triggers a rolling
4705
+ # replacement of all previously launched instances in the Auto Scaling
4706
+ # group with a new group of instances.
4707
+ #
4708
+ # If successful, this call creates a new instance refresh request with a
4709
+ # unique ID that you can use to track its progress. To query its status,
4710
+ # call the DescribeInstanceRefreshes API. To describe the instance
4711
+ # refreshes that have already run, call the DescribeInstanceRefreshes
4712
+ # API. To cancel an instance refresh operation in progress, use the
4713
+ # CancelInstanceRefresh API.
4714
+ #
4715
+ # For more information, see [Replacing Auto Scaling Instances Based on
4716
+ # an Instance Refresh][1].
4717
+ #
4718
+ #
4719
+ #
4720
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
4721
+ #
4722
+ # @option params [required, String] :auto_scaling_group_name
4723
+ # The name of the Auto Scaling group.
4724
+ #
4725
+ # @option params [String] :strategy
4726
+ # The strategy to use for the instance refresh. The only valid value is
4727
+ # `Rolling`.
4728
+ #
4729
+ # A rolling update is an update that is applied to all instances in an
4730
+ # Auto Scaling group until all instances have been updated. A rolling
4731
+ # update can fail due to failed health checks or if instances are on
4732
+ # standby or are protected from scale in. If the rolling update process
4733
+ # fails, any instances that were already replaced are not rolled back to
4734
+ # their previous configuration.
4735
+ #
4736
+ # @option params [Types::RefreshPreferences] :preferences
4737
+ # Set of preferences associated with the instance refresh request.
4738
+ #
4739
+ # If not provided, the default values are used. For
4740
+ # `MinHealthyPercentage`, the default value is `90`. For
4741
+ # `InstanceWarmup`, the default is to use the value specified for the
4742
+ # health check grace period for the Auto Scaling group.
4743
+ #
4744
+ # For more information, see [RefreshPreferences][1] in the *Amazon EC2
4745
+ # Auto Scaling API Reference*.
4746
+ #
4747
+ #
4748
+ #
4749
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html
4750
+ #
4751
+ # @return [Types::StartInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4752
+ #
4753
+ # * {Types::StartInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
4754
+ #
4755
+ # @example Request syntax with placeholder values
4756
+ #
4757
+ # resp = client.start_instance_refresh({
4758
+ # auto_scaling_group_name: "XmlStringMaxLen255", # required
4759
+ # strategy: "Rolling", # accepts Rolling
4760
+ # preferences: {
4761
+ # min_healthy_percentage: 1,
4762
+ # instance_warmup: 1,
4763
+ # },
4764
+ # })
4765
+ #
4766
+ # @example Response structure
4767
+ #
4768
+ # resp.instance_refresh_id #=> String
4769
+ #
4770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefresh AWS API Documentation
4771
+ #
4772
+ # @overload start_instance_refresh(params = {})
4773
+ # @param [Hash] params ({})
4774
+ def start_instance_refresh(params = {}, options = {})
4775
+ req = build_request(:start_instance_refresh, params)
4776
+ req.send_request(options)
4777
+ end
4778
+
4562
4779
  # Suspends the specified automatic scaling processes, or all processes,
4563
4780
  # for the specified Auto Scaling group.
4564
4781
  #
@@ -4578,24 +4795,27 @@ module Aws::AutoScaling
4578
4795
  # The name of the Auto Scaling group.
4579
4796
  #
4580
4797
  # @option params [Array<String>] :scaling_processes
4581
- # One or more of the following processes. If you omit this parameter,
4582
- # all processes are specified.
4798
+ # One or more of the following processes:
4583
4799
  #
4584
4800
  # * `Launch`
4585
4801
  #
4586
4802
  # * `Terminate`
4587
4803
  #
4588
- # * `HealthCheck`
4804
+ # * `AddToLoadBalancer`
4589
4805
  #
4590
- # * `ReplaceUnhealthy`
4806
+ # * `AlarmNotification`
4591
4807
  #
4592
4808
  # * `AZRebalance`
4593
4809
  #
4594
- # * `AlarmNotification`
4810
+ # * `HealthCheck`
4811
+ #
4812
+ # * `InstanceRefresh`
4813
+ #
4814
+ # * `ReplaceUnhealthy`
4595
4815
  #
4596
4816
  # * `ScheduledActions`
4597
4817
  #
4598
- # * `AddToLoadBalancer`
4818
+ # If you omit this parameter, all processes are specified.
4599
4819
  #
4600
4820
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4601
4821
  #
@@ -4810,13 +5030,11 @@ module Aws::AutoScaling
4810
5030
  # @option params [Integer] :default_cooldown
4811
5031
  # The amount of time, in seconds, after a scaling activity completes
4812
5032
  # before another scaling activity can start. The default value is `300`.
4813
- # This cooldown period is not used when a scaling-specific cooldown is
4814
- # specified.
4815
5033
  #
4816
- # Cooldown periods are not supported for target tracking scaling
4817
- # policies, step scaling policies, or scheduled scaling. For more
4818
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
4819
- # Scaling User Guide*.
5034
+ # This setting applies when using simple scaling policies, but not when
5035
+ # using other scaling policies or scheduled scaling. For more
5036
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
5037
+ # the *Amazon EC2 Auto Scaling User Guide*.
4820
5038
  #
4821
5039
  #
4822
5040
  #
@@ -4839,8 +5057,7 @@ module Aws::AutoScaling
4839
5057
  # For more information, see [Health Check Grace Period][1] in the
4840
5058
  # *Amazon EC2 Auto Scaling User Guide*.
4841
5059
  #
4842
- # Conditional: This parameter is required if you are adding an `ELB`
4843
- # health check.
5060
+ # Required if you are adding an `ELB` health check.
4844
5061
  #
4845
5062
  #
4846
5063
  #
@@ -5018,7 +5235,7 @@ module Aws::AutoScaling
5018
5235
  params: params,
5019
5236
  config: config)
5020
5237
  context[:gem_name] = 'aws-sdk-autoscaling'
5021
- context[:gem_version] = '1.36.0'
5238
+ context[:gem_version] = '1.41.0'
5022
5239
  Seahorse::Client::Request.new(handlers, context)
5023
5240
  end
5024
5241