aws-sdk-autoscaling 1.40.0 → 1.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 21162b28994033fe0561bd454630f85ec3e09bfaf1d19030a2a600a2e9246b47
4
- data.tar.gz: 20d545494b188d07ac04240ee6d7dffad9614b38d7a4c4f26de204d4d6762969
3
+ metadata.gz: 0a0212772f92a489009f672d3f3368f1ffcaa8923f54453bf195c37b0058c60a
4
+ data.tar.gz: 8025d59bd8e73f95923cbdad9a64c9dd9dadda9ba33e679683c3ac93f7152fbb
5
5
  SHA512:
6
- metadata.gz: d29d595273b5ab4103bdc7c01c128fe0f32b062b3e647303e9d4d1421d12d9ab5be3961295149216bbcd73ff97043c62250c21e1ce582abd2368ce7afbc9c218
7
- data.tar.gz: 113b4092ff01627ad2e23a85869cca40bfe5bc2be421dc3055554b59b8a455b6843de3fc29ddb9d0b9a0a3eef983b31ff26702204d6535b6031b19631219c8a2
6
+ metadata.gz: d7787741e13ea3e023d996ce2780dee1431bfb0ec0ab00b9cc8c254df1d1d00acf0b85e4de4e131af277b4ceda4638aaa13185fc237915857f2cb283b1c5e1da
7
+ data.tar.gz: 8a102ee668e948b2aaa5bfb9412130d7520f09dffe2c50444b2b2d090472d413c1c36b47d675574c0f8be052411ae26d3da24a38dc309d3ec2ce3deb31225ac0
@@ -58,6 +58,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
58
58
  # @service
59
59
  module Aws::AutoScaling
60
60
 
61
- GEM_VERSION = '1.40.0'
61
+ GEM_VERSION = '1.41.0'
62
62
 
63
63
  end
@@ -77,8 +77,7 @@ module Aws::AutoScaling
77
77
  data[:desired_capacity]
78
78
  end
79
79
 
80
- # The amount of time, in seconds, after a scaling activity completes
81
- # before another scaling activity can start.
80
+ # The duration of the default cooldown period, in seconds.
82
81
  # @return [Integer]
83
82
  def default_cooldown
84
83
  data[:default_cooldown]
@@ -585,15 +584,19 @@ module Aws::AutoScaling
585
584
  # @option options [required, String] :policy_name
586
585
  # The name of the policy.
587
586
  # @option options [String] :policy_type
588
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
589
- # and `TargetTrackingScaling`. If the policy type is null, the value is
590
- # treated as `SimpleScaling`.
587
+ # One of the following policy types:
588
+ #
589
+ # * `TargetTrackingScaling`
590
+ #
591
+ # * `StepScaling`
592
+ #
593
+ # * `SimpleScaling` (default)
591
594
  # @option options [String] :adjustment_type
592
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
593
- # 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
594
597
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
595
598
  #
596
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
599
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
597
600
  # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
598
601
  # Auto Scaling User Guide*.
599
602
  #
@@ -604,41 +607,43 @@ module Aws::AutoScaling
604
607
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
605
608
  # instead.
606
609
  # @option options [Integer] :min_adjustment_magnitude
607
- # The minimum value to scale by when scaling by percentages. For
608
- # example, suppose that you create a step scaling policy to scale out an
609
- # Auto Scaling group by 25 percent and you specify a
610
- # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
611
- # scaling policy is performed, 25 percent of 4 is 1. However, because
612
- # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
613
- # scales out the group by 2 instances.
614
- #
615
- # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
616
- # the adjustment type is `PercentChangeInCapacity`. For more
617
- # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
618
- # 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>
619
627
  #
620
628
  #
621
629
  #
622
630
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
623
631
  # @option options [Integer] :scaling_adjustment
624
- # The amount by which a simple scaling policy scales the Auto Scaling
625
- # group in response to an alarm breach. The adjustment is based on the
626
- # value that you specified in the `AdjustmentType` parameter (either an
627
- # absolute number or a percentage). A positive value adds to the current
628
- # capacity and a negative value subtracts from the current capacity. For
629
- # exact capacity, you must specify a positive value.
630
- #
631
- # Conditional: If you specify `SimpleScaling` for the policy type, you
632
- # 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.)
633
639
  # @option options [Integer] :cooldown
634
- # The amount of time, in seconds, after a scaling activity completes
635
- # before any further dynamic scaling activities can start. If this
636
- # parameter is not specified, the default cooldown period for the group
637
- # 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.
638
643
  #
639
644
  # Valid only if the policy type is `SimpleScaling`. For more
640
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
641
- # Scaling User Guide*.
645
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
646
+ # the *Amazon EC2 Auto Scaling User Guide*.
642
647
  #
643
648
  #
644
649
  #
@@ -653,25 +658,38 @@ module Aws::AutoScaling
653
658
  # A set of adjustments that enable you to scale based on the size of the
654
659
  # alarm breach.
655
660
  #
656
- # Conditional: If you specify `StepScaling` for the policy type, you
657
- # 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.)
658
663
  # @option options [Integer] :estimated_instance_warmup
659
664
  # The estimated time, in seconds, until a newly launched instance can
660
- # contribute to the CloudWatch metrics. The default is to use the value
661
- # 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.
662
668
  #
663
- # Valid only if the policy type is `StepScaling` or
664
- # `TargetTrackingScaling`.
669
+ # Valid only if the policy type is `TargetTrackingScaling` or
670
+ # `StepScaling`.
665
671
  # @option options [Types::TargetTrackingConfiguration] :target_tracking_configuration
666
672
  # A target tracking scaling policy. Includes support for predefined or
667
673
  # customized metrics.
668
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
+ #
669
689
  # For more information, see [TargetTrackingConfiguration][1] in the
670
690
  # *Amazon EC2 Auto Scaling API Reference*.
671
691
  #
672
- # Conditional: If you specify `TargetTrackingScaling` for the policy
673
- # type, you must specify this parameter. (Not used with any other policy
674
- # type.)
692
+ # Required if the policy type is `TargetTrackingScaling`.
675
693
  #
676
694
  #
677
695
  #
@@ -953,13 +971,11 @@ module Aws::AutoScaling
953
971
  # @option options [Integer] :default_cooldown
954
972
  # The amount of time, in seconds, after a scaling activity completes
955
973
  # before another scaling activity can start. The default value is `300`.
956
- # This cooldown period is not used when a scaling-specific cooldown is
957
- # specified.
958
974
  #
959
- # Cooldown periods are not supported for target tracking scaling
960
- # policies, step scaling policies, or scheduled scaling. For more
961
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
962
- # 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*.
963
979
  #
964
980
  #
965
981
  #
@@ -979,8 +995,7 @@ module Aws::AutoScaling
979
995
  # For more information, see [Health Check Grace Period][1] in the
980
996
  # *Amazon EC2 Auto Scaling User Guide*.
981
997
  #
982
- # Conditional: This parameter is required if you are adding an `ELB`
983
- # health check.
998
+ # Required if you are adding an `ELB` health check.
984
999
  #
985
1000
  #
986
1001
  #
@@ -810,8 +810,10 @@ module Aws::AutoScaling
810
810
  # The amount of time, in seconds, after a scaling activity completes
811
811
  # before another scaling activity can start. The default value is `300`.
812
812
  #
813
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
814
- # 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*.
815
817
  #
816
818
  #
817
819
  #
@@ -872,8 +874,7 @@ module Aws::AutoScaling
872
874
  # For more information, see [Health Check Grace Period][1] in the
873
875
  # *Amazon EC2 Auto Scaling User Guide*.
874
876
  #
875
- # Conditional: This parameter is required if you are adding an `ELB`
876
- # health check.
877
+ # Required if you are adding an `ELB` health check.
877
878
  #
878
879
  #
879
880
  #
@@ -2207,6 +2208,13 @@ module Aws::AutoScaling
2207
2208
  #
2208
2209
  # * `Cancelled` - The operation is cancelled.
2209
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
+ #
2210
2218
  # @option params [required, String] :auto_scaling_group_name
2211
2219
  # The name of the Auto Scaling group.
2212
2220
  #
@@ -3694,8 +3702,8 @@ module Aws::AutoScaling
3694
3702
  # This parameter is not supported if the policy type is `StepScaling` or
3695
3703
  # `TargetTrackingScaling`.
3696
3704
  #
3697
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
3698
- # 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*.
3699
3707
  #
3700
3708
  #
3701
3709
  #
@@ -3711,14 +3719,14 @@ module Aws::AutoScaling
3711
3719
  # If you specify a metric value that doesn't correspond to a step
3712
3720
  # adjustment for the policy, the call returns an error.
3713
3721
  #
3714
- # Conditional: This parameter is required if the policy type is
3715
- # `StepScaling` and not supported otherwise.
3722
+ # Required if the policy type is `StepScaling` and not supported
3723
+ # otherwise.
3716
3724
  #
3717
3725
  # @option params [Float] :breach_threshold
3718
3726
  # The breach threshold for the alarm.
3719
3727
  #
3720
- # Conditional: This parameter is required if the policy type is
3721
- # `StepScaling` and not supported otherwise.
3728
+ # Required if the policy type is `StepScaling` and not supported
3729
+ # otherwise.
3722
3730
  #
3723
3731
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3724
3732
  #
@@ -3890,16 +3898,16 @@ module Aws::AutoScaling
3890
3898
  #
3891
3899
  # * autoscaling:EC2\_INSTANCE\_TERMINATING
3892
3900
  #
3893
- # Conditional: This parameter is required for new lifecycle hooks, but
3894
- # optional when updating existing hooks.
3901
+ # Required for new lifecycle hooks, but optional when updating existing
3902
+ # hooks.
3895
3903
  #
3896
3904
  # @option params [String] :role_arn
3897
3905
  # The ARN of the IAM role that allows the Auto Scaling group to publish
3898
3906
  # to the specified notification target, for example, an Amazon SNS topic
3899
3907
  # or an Amazon SQS queue.
3900
3908
  #
3901
- # Conditional: This parameter is required for new lifecycle hooks, but
3902
- # optional when updating existing hooks.
3909
+ # Required for new lifecycle hooks, but optional when updating existing
3910
+ # hooks.
3903
3911
  #
3904
3912
  # @option params [String] :notification_target_arn
3905
3913
  # The ARN of the notification target that Amazon EC2 Auto Scaling uses
@@ -4052,16 +4060,20 @@ module Aws::AutoScaling
4052
4060
  # The name of the policy.
4053
4061
  #
4054
4062
  # @option params [String] :policy_type
4055
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
4056
- # and `TargetTrackingScaling`. If the policy type is null, the value is
4057
- # treated as `SimpleScaling`.
4063
+ # One of the following policy types:
4064
+ #
4065
+ # * `TargetTrackingScaling`
4066
+ #
4067
+ # * `StepScaling`
4068
+ #
4069
+ # * `SimpleScaling` (default)
4058
4070
  #
4059
4071
  # @option params [String] :adjustment_type
4060
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
4061
- # 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
4062
4074
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
4063
4075
  #
4064
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
4076
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
4065
4077
  # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
4066
4078
  # Auto Scaling User Guide*.
4067
4079
  #
@@ -4074,43 +4086,45 @@ module Aws::AutoScaling
4074
4086
  # instead.
4075
4087
  #
4076
4088
  # @option params [Integer] :min_adjustment_magnitude
4077
- # The minimum value to scale by when scaling by percentages. For
4078
- # example, suppose that you create a step scaling policy to scale out an
4079
- # Auto Scaling group by 25 percent and you specify a
4080
- # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
4081
- # scaling policy is performed, 25 percent of 4 is 1. However, because
4082
- # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
4083
- # scales out the group by 2 instances.
4084
- #
4085
- # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
4086
- # the adjustment type is `PercentChangeInCapacity`. For more
4087
- # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
4088
- # 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>
4089
4106
  #
4090
4107
  #
4091
4108
  #
4092
4109
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
4093
4110
  #
4094
4111
  # @option params [Integer] :scaling_adjustment
4095
- # The amount by which a simple scaling policy scales the Auto Scaling
4096
- # group in response to an alarm breach. The adjustment is based on the
4097
- # value that you specified in the `AdjustmentType` parameter (either an
4098
- # absolute number or a percentage). A positive value adds to the current
4099
- # capacity and a negative value subtracts from the current capacity. For
4100
- # 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.
4101
4116
  #
4102
- # Conditional: If you specify `SimpleScaling` for the policy type, you
4103
- # 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.)
4104
4119
  #
4105
4120
  # @option params [Integer] :cooldown
4106
- # The amount of time, in seconds, after a scaling activity completes
4107
- # before any further dynamic scaling activities can start. If this
4108
- # parameter is not specified, the default cooldown period for the group
4109
- # 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.
4110
4124
  #
4111
4125
  # Valid only if the policy type is `SimpleScaling`. For more
4112
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
4113
- # Scaling User Guide*.
4126
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
4127
+ # the *Amazon EC2 Auto Scaling User Guide*.
4114
4128
  #
4115
4129
  #
4116
4130
  #
@@ -4127,27 +4141,40 @@ module Aws::AutoScaling
4127
4141
  # A set of adjustments that enable you to scale based on the size of the
4128
4142
  # alarm breach.
4129
4143
  #
4130
- # Conditional: If you specify `StepScaling` for the policy type, you
4131
- # 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.)
4132
4146
  #
4133
4147
  # @option params [Integer] :estimated_instance_warmup
4134
4148
  # The estimated time, in seconds, until a newly launched instance can
4135
- # contribute to the CloudWatch metrics. The default is to use the value
4136
- # 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.
4137
4152
  #
4138
- # Valid only if the policy type is `StepScaling` or
4139
- # `TargetTrackingScaling`.
4153
+ # Valid only if the policy type is `TargetTrackingScaling` or
4154
+ # `StepScaling`.
4140
4155
  #
4141
4156
  # @option params [Types::TargetTrackingConfiguration] :target_tracking_configuration
4142
4157
  # A target tracking scaling policy. Includes support for predefined or
4143
4158
  # customized metrics.
4144
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
+ #
4145
4174
  # For more information, see [TargetTrackingConfiguration][1] in the
4146
4175
  # *Amazon EC2 Auto Scaling API Reference*.
4147
4176
  #
4148
- # Conditional: If you specify `TargetTrackingScaling` for the policy
4149
- # type, you must specify this parameter. (Not used with any other policy
4150
- # type.)
4177
+ # Required if the policy type is `TargetTrackingScaling`.
4151
4178
  #
4152
4179
  #
4153
4180
  #
@@ -4682,7 +4709,7 @@ module Aws::AutoScaling
4682
4709
  # unique ID that you can use to track its progress. To query its status,
4683
4710
  # call the DescribeInstanceRefreshes API. To describe the instance
4684
4711
  # refreshes that have already run, call the DescribeInstanceRefreshes
4685
- # API. To cancel an active instance refresh operation, use the
4712
+ # API. To cancel an instance refresh operation in progress, use the
4686
4713
  # CancelInstanceRefresh API.
4687
4714
  #
4688
4715
  # For more information, see [Replacing Auto Scaling Instances Based on
@@ -4702,13 +4729,25 @@ module Aws::AutoScaling
4702
4729
  # A rolling update is an update that is applied to all instances in an
4703
4730
  # Auto Scaling group until all instances have been updated. A rolling
4704
4731
  # update can fail due to failed health checks or if instances are on
4705
- # standby or are protected from scale-in. If the rolling update process
4732
+ # standby or are protected from scale in. If the rolling update process
4706
4733
  # fails, any instances that were already replaced are not rolled back to
4707
4734
  # their previous configuration.
4708
4735
  #
4709
4736
  # @option params [Types::RefreshPreferences] :preferences
4710
4737
  # Set of preferences associated with the instance refresh request.
4711
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
+ #
4712
4751
  # @return [Types::StartInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4713
4752
  #
4714
4753
  # * {Types::StartInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
@@ -4991,13 +5030,11 @@ module Aws::AutoScaling
4991
5030
  # @option params [Integer] :default_cooldown
4992
5031
  # The amount of time, in seconds, after a scaling activity completes
4993
5032
  # before another scaling activity can start. The default value is `300`.
4994
- # This cooldown period is not used when a scaling-specific cooldown is
4995
- # specified.
4996
5033
  #
4997
- # Cooldown periods are not supported for target tracking scaling
4998
- # policies, step scaling policies, or scheduled scaling. For more
4999
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
5000
- # 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*.
5001
5038
  #
5002
5039
  #
5003
5040
  #
@@ -5020,8 +5057,7 @@ module Aws::AutoScaling
5020
5057
  # For more information, see [Health Check Grace Period][1] in the
5021
5058
  # *Amazon EC2 Auto Scaling User Guide*.
5022
5059
  #
5023
- # Conditional: This parameter is required if you are adding an `ELB`
5024
- # health check.
5060
+ # Required if you are adding an `ELB` health check.
5025
5061
  #
5026
5062
  #
5027
5063
  #
@@ -5199,7 +5235,7 @@ module Aws::AutoScaling
5199
5235
  params: params,
5200
5236
  config: config)
5201
5237
  context[:gem_name] = 'aws-sdk-autoscaling'
5202
- context[:gem_version] = '1.40.0'
5238
+ context[:gem_version] = '1.41.0'
5203
5239
  Seahorse::Client::Request.new(handlers, context)
5204
5240
  end
5205
5241
 
@@ -301,15 +301,15 @@ module Aws::AutoScaling
301
301
  #
302
302
  # * autoscaling:EC2\_INSTANCE\_TERMINATING
303
303
  #
304
- # Conditional: This parameter is required for new lifecycle hooks, but
305
- # optional when updating existing hooks.
304
+ # Required for new lifecycle hooks, but optional when updating existing
305
+ # hooks.
306
306
  # @option options [String] :role_arn
307
307
  # The ARN of the IAM role that allows the Auto Scaling group to publish
308
308
  # to the specified notification target, for example, an Amazon SNS topic
309
309
  # or an Amazon SQS queue.
310
310
  #
311
- # Conditional: This parameter is required for new lifecycle hooks, but
312
- # optional when updating existing hooks.
311
+ # Required for new lifecycle hooks, but optional when updating existing
312
+ # hooks.
313
313
  # @option options [String] :notification_target_arn
314
314
  # The ARN of the notification target that Amazon EC2 Auto Scaling uses
315
315
  # to notify you when an instance is in the transition state for the
@@ -203,8 +203,10 @@ module Aws::AutoScaling
203
203
  # The amount of time, in seconds, after a scaling activity completes
204
204
  # before another scaling activity can start. The default value is `300`.
205
205
  #
206
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
207
- # Auto Scaling User Guide*.
206
+ # This setting applies when using simple scaling policies, but not when
207
+ # using other scaling policies or scheduled scaling. For more
208
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
209
+ # the *Amazon EC2 Auto Scaling User Guide*.
208
210
  #
209
211
  #
210
212
  #
@@ -260,8 +262,7 @@ module Aws::AutoScaling
260
262
  # For more information, see [Health Check Grace Period][1] in the
261
263
  # *Amazon EC2 Auto Scaling User Guide*.
262
264
  #
263
- # Conditional: This parameter is required if you are adding an `ELB`
264
- # health check.
265
+ # Required if you are adding an `ELB` health check.
265
266
  #
266
267
  #
267
268
  #
@@ -47,16 +47,30 @@ module Aws::AutoScaling
47
47
  data[:policy_arn]
48
48
  end
49
49
 
50
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
51
- # and `TargetTrackingScaling`.
50
+ # One of the following policy types:
51
+ #
52
+ # * `TargetTrackingScaling`
53
+ #
54
+ # * `StepScaling`
55
+ #
56
+ # * `SimpleScaling` (default)
57
+ #
58
+ # For more information, see [Target Tracking Scaling Policies][1] and
59
+ # [Step and Simple Scaling Policies][2] in the *Amazon EC2 Auto Scaling
60
+ # User Guide*.
61
+ #
62
+ #
63
+ #
64
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html
65
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
52
66
  # @return [String]
53
67
  def policy_type
54
68
  data[:policy_type]
55
69
  end
56
70
 
57
- # The adjustment type, which specifies how `ScalingAdjustment` is
58
- # interpreted. The valid values are `ChangeInCapacity`, `ExactCapacity`,
59
- # and `PercentChangeInCapacity`.
71
+ # Specifies how the scaling adjustment is interpreted (either an
72
+ # absolute number or a percentage). The valid values are
73
+ # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
60
74
  # @return [String]
61
75
  def adjustment_type
62
76
  data[:adjustment_type]
@@ -69,10 +83,8 @@ module Aws::AutoScaling
69
83
  data[:min_adjustment_step]
70
84
  end
71
85
 
72
- # The minimum number of instances to scale. If the value of
73
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
74
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
75
- # this many instances. Otherwise, the error is `ValidationError`.
86
+ # The minimum value to scale by when the adjustment type is
87
+ # `PercentChangeInCapacity`.
76
88
  # @return [Integer]
77
89
  def min_adjustment_magnitude
78
90
  data[:min_adjustment_magnitude]
@@ -86,8 +98,7 @@ module Aws::AutoScaling
86
98
  data[:scaling_adjustment]
87
99
  end
88
100
 
89
- # The amount of time, in seconds, after a scaling activity completes
90
- # before any further dynamic scaling activities can start.
101
+ # The duration of the policy's cooldown period, in seconds.
91
102
  # @return [Integer]
92
103
  def cooldown
93
104
  data[:cooldown]
@@ -300,8 +311,8 @@ module Aws::AutoScaling
300
311
  # This parameter is not supported if the policy type is `StepScaling` or
301
312
  # `TargetTrackingScaling`.
302
313
  #
303
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
304
- # Auto Scaling User Guide*.
314
+ # For more information, see [Scaling Cooldowns for Amazon EC2 Auto
315
+ # Scaling][1] in the *Amazon EC2 Auto Scaling User Guide*.
305
316
  #
306
317
  #
307
318
  #
@@ -316,13 +327,13 @@ module Aws::AutoScaling
316
327
  # If you specify a metric value that doesn't correspond to a step
317
328
  # adjustment for the policy, the call returns an error.
318
329
  #
319
- # Conditional: This parameter is required if the policy type is
320
- # `StepScaling` and not supported otherwise.
330
+ # Required if the policy type is `StepScaling` and not supported
331
+ # otherwise.
321
332
  # @option options [Float] :breach_threshold
322
333
  # The breach threshold for the alarm.
323
334
  #
324
- # Conditional: This parameter is required if the policy type is
325
- # `StepScaling` and not supported otherwise.
335
+ # Required if the policy type is `StepScaling` and not supported
336
+ # otherwise.
326
337
  # @return [EmptyStructure]
327
338
  def execute(options = {})
328
339
  options = options.merge(policy_name: @name)
@@ -288,8 +288,7 @@ module Aws::AutoScaling
288
288
  # @return [Integer]
289
289
  #
290
290
  # @!attribute [rw] default_cooldown
291
- # The amount of time, in seconds, after a scaling activity completes
292
- # before another scaling activity can start.
291
+ # The duration of the default cooldown period, in seconds.
293
292
  # @return [Integer]
294
293
  #
295
294
  # @!attribute [rw] availability_zones
@@ -975,8 +974,10 @@ module Aws::AutoScaling
975
974
  # before another scaling activity can start. The default value is
976
975
  # `300`.
977
976
  #
978
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
979
- # Auto Scaling User Guide*.
977
+ # This setting applies when using simple scaling policies, but not
978
+ # when using other scaling policies or scheduled scaling. For more
979
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1]
980
+ # in the *Amazon EC2 Auto Scaling User Guide*.
980
981
  #
981
982
  #
982
983
  #
@@ -1042,8 +1043,7 @@ module Aws::AutoScaling
1042
1043
  # For more information, see [Health Check Grace Period][1] in the
1043
1044
  # *Amazon EC2 Auto Scaling User Guide*.
1044
1045
  #
1045
- # Conditional: This parameter is required if you are adding an `ELB`
1046
- # health check.
1046
+ # Required if you are adding an `ELB` health check.
1047
1047
  #
1048
1048
  #
1049
1049
  #
@@ -1856,13 +1856,6 @@ module Aws::AutoScaling
1856
1856
 
1857
1857
  # @!attribute [rw] instance_refreshes
1858
1858
  # The instance refreshes for the specified group.
1859
- #
1860
- # For more information, see [Replacing Auto Scaling Instances Based on
1861
- # an Instance Refresh][1].
1862
- #
1863
- #
1864
- #
1865
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
1866
1859
  # @return [Array<Types::InstanceRefresh>]
1867
1860
  #
1868
1861
  # @!attribute [rw] next_token
@@ -2529,9 +2522,9 @@ module Aws::AutoScaling
2529
2522
  # @!attribute [rw] snapshot_id
2530
2523
  # The snapshot ID of the volume to use.
2531
2524
  #
2532
- # Conditional: This parameter is optional if you specify a volume
2533
- # size. If you specify both `SnapshotId` and `VolumeSize`,
2534
- # `VolumeSize` must be equal or greater than the size of the snapshot.
2525
+ # `SnapshotId` is optional if you specify a volume size. If you
2526
+ # specify both `SnapshotId` and `VolumeSize`, the volume size must be
2527
+ # equal or greater than the size of the snapshot.
2535
2528
  # @return [String]
2536
2529
  #
2537
2530
  # @!attribute [rw] volume_size
@@ -2545,7 +2538,7 @@ module Aws::AutoScaling
2545
2538
  # Default: If you create a volume from a snapshot and you don't
2546
2539
  # specify a volume size, the default is the snapshot size.
2547
2540
  #
2548
- # <note markdown="1"> At least one of VolumeSize or SnapshotId is required.
2541
+ # <note markdown="1"> At least one of `VolumeSize` or `SnapshotId` is required.
2549
2542
  #
2550
2543
  # </note>
2551
2544
  # @return [Integer]
@@ -2575,8 +2568,8 @@ module Aws::AutoScaling
2575
2568
  # For more information, see [Amazon EBS Volume Types][1] in the
2576
2569
  # *Amazon EC2 User Guide for Linux Instances*.
2577
2570
  #
2578
- # Conditional: This parameter is required when the volume type is
2579
- # `io1`. (Not used with `standard`, `gp2`, `st1`, or `sc1` volumes.)
2571
+ # Required when the volume type is `io1`. (Not used with `standard`,
2572
+ # `gp2`, `st1`, or `sc1` volumes.)
2580
2573
  #
2581
2574
  #
2582
2575
  #
@@ -2812,8 +2805,8 @@ module Aws::AutoScaling
2812
2805
  # This parameter is not supported if the policy type is `StepScaling`
2813
2806
  # or `TargetTrackingScaling`.
2814
2807
  #
2815
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
2816
- # Auto Scaling User Guide*.
2808
+ # For more information, see [Scaling Cooldowns for Amazon EC2 Auto
2809
+ # Scaling][1] in the *Amazon EC2 Auto Scaling User Guide*.
2817
2810
  #
2818
2811
  #
2819
2812
  #
@@ -2830,15 +2823,15 @@ module Aws::AutoScaling
2830
2823
  # If you specify a metric value that doesn't correspond to a step
2831
2824
  # adjustment for the policy, the call returns an error.
2832
2825
  #
2833
- # Conditional: This parameter is required if the policy type is
2834
- # `StepScaling` and not supported otherwise.
2826
+ # Required if the policy type is `StepScaling` and not supported
2827
+ # otherwise.
2835
2828
  # @return [Float]
2836
2829
  #
2837
2830
  # @!attribute [rw] breach_threshold
2838
2831
  # The breach threshold for the alarm.
2839
2832
  #
2840
- # Conditional: This parameter is required if the policy type is
2841
- # `StepScaling` and not supported otherwise.
2833
+ # Required if the policy type is `StepScaling` and not supported
2834
+ # otherwise.
2842
2835
  # @return [Float]
2843
2836
  #
2844
2837
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExecutePolicyType AWS API Documentation
@@ -4123,7 +4116,7 @@ module Aws::AutoScaling
4123
4116
  # You can create a mixed instances policy for a new Auto Scaling group,
4124
4117
  # or you can create it for an existing group by updating the group to
4125
4118
  # specify `MixedInstancesPolicy` as the top-level parameter instead of a
4126
- # launch configuration or template. For more information, see
4119
+ # launch configuration or launch template. For more information, see
4127
4120
  # CreateAutoScalingGroup and UpdateAutoScalingGroup.
4128
4121
  #
4129
4122
  #
@@ -4160,8 +4153,7 @@ module Aws::AutoScaling
4160
4153
  # @!attribute [rw] launch_template
4161
4154
  # The launch template and instance types (overrides).
4162
4155
  #
4163
- # This parameter must be specified when creating a mixed instances
4164
- # policy.
4156
+ # Required when creating a mixed instances policy.
4165
4157
  # @return [Types::LaunchTemplate]
4166
4158
  #
4167
4159
  # @!attribute [rw] instances_distribution
@@ -4405,8 +4397,8 @@ module Aws::AutoScaling
4405
4397
  #
4406
4398
  # * autoscaling:EC2\_INSTANCE\_TERMINATING
4407
4399
  #
4408
- # Conditional: This parameter is required for new lifecycle hooks, but
4409
- # optional when updating existing hooks.
4400
+ # Required for new lifecycle hooks, but optional when updating
4401
+ # existing hooks.
4410
4402
  # @return [String]
4411
4403
  #
4412
4404
  # @!attribute [rw] role_arn
@@ -4414,8 +4406,8 @@ module Aws::AutoScaling
4414
4406
  # publish to the specified notification target, for example, an Amazon
4415
4407
  # SNS topic or an Amazon SQS queue.
4416
4408
  #
4417
- # Conditional: This parameter is required for new lifecycle hooks, but
4418
- # optional when updating existing hooks.
4409
+ # Required for new lifecycle hooks, but optional when updating
4410
+ # existing hooks.
4419
4411
  # @return [String]
4420
4412
  #
4421
4413
  # @!attribute [rw] notification_target_arn
@@ -4561,19 +4553,23 @@ module Aws::AutoScaling
4561
4553
  # @return [String]
4562
4554
  #
4563
4555
  # @!attribute [rw] policy_type
4564
- # The policy type. The valid values are `SimpleScaling`,
4565
- # `StepScaling`, and `TargetTrackingScaling`. If the policy type is
4566
- # null, the value is treated as `SimpleScaling`.
4556
+ # One of the following policy types:
4557
+ #
4558
+ # * `TargetTrackingScaling`
4559
+ #
4560
+ # * `StepScaling`
4561
+ #
4562
+ # * `SimpleScaling` (default)
4567
4563
  # @return [String]
4568
4564
  #
4569
4565
  # @!attribute [rw] adjustment_type
4570
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
4571
- # number or a percentage of the current capacity. The valid values are
4566
+ # Specifies how the scaling adjustment is interpreted (either an
4567
+ # absolute number or a percentage). The valid values are
4572
4568
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
4573
4569
  #
4574
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`.
4575
- # For more information, see [Scaling Adjustment Types][1] in the
4576
- # *Amazon EC2 Auto Scaling User Guide*.
4570
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
4571
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon
4572
+ # EC2 Auto Scaling User Guide*.
4577
4573
  #
4578
4574
  #
4579
4575
  #
@@ -4586,18 +4582,23 @@ module Aws::AutoScaling
4586
4582
  # @return [Integer]
4587
4583
  #
4588
4584
  # @!attribute [rw] min_adjustment_magnitude
4589
- # The minimum value to scale by when scaling by percentages. For
4590
- # example, suppose that you create a step scaling policy to scale out
4591
- # an Auto Scaling group by 25 percent and you specify a
4592
- # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
4593
- # scaling policy is performed, 25 percent of 4 is 1. However, because
4594
- # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto
4595
- # Scaling scales out the group by 2 instances.
4596
- #
4597
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`
4598
- # and the adjustment type is `PercentChangeInCapacity`. For more
4599
- # information, see [Scaling Adjustment Types][1] in the *Amazon EC2
4600
- # Auto Scaling User Guide*.
4585
+ # The minimum value to scale by when the adjustment type is
4586
+ # `PercentChangeInCapacity`. For example, suppose that you create a
4587
+ # step scaling policy to scale out an Auto Scaling group by 25 percent
4588
+ # and you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
4589
+ # instances and the scaling policy is performed, 25 percent of 4 is 1.
4590
+ # However, because you specified a `MinAdjustmentMagnitude` of 2,
4591
+ # Amazon EC2 Auto Scaling scales out the group by 2 instances.
4592
+ #
4593
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`.
4594
+ # For more information, see [Scaling Adjustment Types][1] in the
4595
+ # *Amazon EC2 Auto Scaling User Guide*.
4596
+ #
4597
+ # <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
4598
+ # `MinAdjustmentMagnitude` to a value that is at least as large as
4599
+ # your largest instance weight.
4600
+ #
4601
+ # </note>
4601
4602
  #
4602
4603
  #
4603
4604
  #
@@ -4605,26 +4606,23 @@ module Aws::AutoScaling
4605
4606
  # @return [Integer]
4606
4607
  #
4607
4608
  # @!attribute [rw] scaling_adjustment
4608
- # The amount by which a simple scaling policy scales the Auto Scaling
4609
- # group in response to an alarm breach. The adjustment is based on the
4610
- # value that you specified in the `AdjustmentType` parameter (either
4611
- # an absolute number or a percentage). A positive value adds to the
4612
- # current capacity and a negative value subtracts from the current
4613
- # capacity. For exact capacity, you must specify a positive value.
4614
- #
4615
- # Conditional: If you specify `SimpleScaling` for the policy type, you
4616
- # must specify this parameter. (Not used with any other policy type.)
4609
+ # The amount by which to scale, based on the specified adjustment
4610
+ # type. A positive value adds to the current capacity while a negative
4611
+ # number removes from the current capacity. For exact capacity, you
4612
+ # must specify a positive value.
4613
+ #
4614
+ # Required if the policy type is `SimpleScaling`. (Not used with any
4615
+ # other policy type.)
4617
4616
  # @return [Integer]
4618
4617
  #
4619
4618
  # @!attribute [rw] cooldown
4620
- # The amount of time, in seconds, after a scaling activity completes
4621
- # before any further dynamic scaling activities can start. If this
4622
- # parameter is not specified, the default cooldown period for the
4623
- # group applies.
4619
+ # The duration of the policy's cooldown period, in seconds. When a
4620
+ # cooldown period is specified here, it overrides the default cooldown
4621
+ # period defined for the Auto Scaling group.
4624
4622
  #
4625
4623
  # Valid only if the policy type is `SimpleScaling`. For more
4626
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
4627
- # Scaling User Guide*.
4624
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1]
4625
+ # in the *Amazon EC2 Auto Scaling User Guide*.
4628
4626
  #
4629
4627
  #
4630
4628
  #
@@ -4643,29 +4641,42 @@ module Aws::AutoScaling
4643
4641
  # A set of adjustments that enable you to scale based on the size of
4644
4642
  # the alarm breach.
4645
4643
  #
4646
- # Conditional: If you specify `StepScaling` for the policy type, you
4647
- # must specify this parameter. (Not used with any other policy type.)
4644
+ # Required if the policy type is `StepScaling`. (Not used with any
4645
+ # other policy type.)
4648
4646
  # @return [Array<Types::StepAdjustment>]
4649
4647
  #
4650
4648
  # @!attribute [rw] estimated_instance_warmup
4651
4649
  # The estimated time, in seconds, until a newly launched instance can
4652
- # contribute to the CloudWatch metrics. The default is to use the
4653
- # value specified for the default cooldown period for the group.
4650
+ # contribute to the CloudWatch metrics. If not provided, the default
4651
+ # is to use the value from the default cooldown period for the Auto
4652
+ # Scaling group.
4654
4653
  #
4655
- # Valid only if the policy type is `StepScaling` or
4656
- # `TargetTrackingScaling`.
4654
+ # Valid only if the policy type is `TargetTrackingScaling` or
4655
+ # `StepScaling`.
4657
4656
  # @return [Integer]
4658
4657
  #
4659
4658
  # @!attribute [rw] target_tracking_configuration
4660
4659
  # A target tracking scaling policy. Includes support for predefined or
4661
4660
  # customized metrics.
4662
4661
  #
4662
+ # The following predefined metrics are available:
4663
+ #
4664
+ # * `ASGAverageCPUUtilization`
4665
+ #
4666
+ # * `ASGAverageNetworkIn`
4667
+ #
4668
+ # * `ASGAverageNetworkOut`
4669
+ #
4670
+ # * `ALBRequestCountPerTarget`
4671
+ #
4672
+ # If you specify `ALBRequestCountPerTarget` for the metric, you must
4673
+ # specify the `ResourceLabel` parameter with the
4674
+ # `PredefinedMetricSpecification`.
4675
+ #
4663
4676
  # For more information, see [TargetTrackingConfiguration][1] in the
4664
4677
  # *Amazon EC2 Auto Scaling API Reference*.
4665
4678
  #
4666
- # Conditional: If you specify `TargetTrackingScaling` for the policy
4667
- # type, you must specify this parameter. (Not used with any other
4668
- # policy type.)
4679
+ # Required if the policy type is `TargetTrackingScaling`.
4669
4680
  #
4670
4681
  #
4671
4682
  #
@@ -4861,10 +4872,7 @@ module Aws::AutoScaling
4861
4872
  # The number of seconds until a newly launched instance is configured
4862
4873
  # and ready to use. During this time, Amazon EC2 Auto Scaling does not
4863
4874
  # immediately move on to the next replacement. The default is to use
4864
- # the value specified for the health check grace period for the group.
4865
- #
4866
- # Note: While warming up, a newly launched instance is not counted
4867
- # toward the aggregated metrics of the Auto Scaling group.
4875
+ # the value for the health check grace period defined for the group.
4868
4876
  # @return [Integer]
4869
4877
  #
4870
4878
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/RefreshPreferences AWS API Documentation
@@ -4933,14 +4941,28 @@ module Aws::AutoScaling
4933
4941
  # @return [String]
4934
4942
  #
4935
4943
  # @!attribute [rw] policy_type
4936
- # The policy type. The valid values are `SimpleScaling`,
4937
- # `StepScaling`, and `TargetTrackingScaling`.
4944
+ # One of the following policy types:
4945
+ #
4946
+ # * `TargetTrackingScaling`
4947
+ #
4948
+ # * `StepScaling`
4949
+ #
4950
+ # * `SimpleScaling` (default)
4951
+ #
4952
+ # For more information, see [Target Tracking Scaling Policies][1] and
4953
+ # [Step and Simple Scaling Policies][2] in the *Amazon EC2 Auto
4954
+ # Scaling User Guide*.
4955
+ #
4956
+ #
4957
+ #
4958
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html
4959
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
4938
4960
  # @return [String]
4939
4961
  #
4940
4962
  # @!attribute [rw] adjustment_type
4941
- # The adjustment type, which specifies how `ScalingAdjustment` is
4942
- # interpreted. The valid values are `ChangeInCapacity`,
4943
- # `ExactCapacity`, and `PercentChangeInCapacity`.
4963
+ # Specifies how the scaling adjustment is interpreted (either an
4964
+ # absolute number or a percentage). The valid values are
4965
+ # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
4944
4966
  # @return [String]
4945
4967
  #
4946
4968
  # @!attribute [rw] min_adjustment_step
@@ -4949,10 +4971,8 @@ module Aws::AutoScaling
4949
4971
  # @return [Integer]
4950
4972
  #
4951
4973
  # @!attribute [rw] min_adjustment_magnitude
4952
- # The minimum number of instances to scale. If the value of
4953
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
4954
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
4955
- # this many instances. Otherwise, the error is `ValidationError`.
4974
+ # The minimum value to scale by when the adjustment type is
4975
+ # `PercentChangeInCapacity`.
4956
4976
  # @return [Integer]
4957
4977
  #
4958
4978
  # @!attribute [rw] scaling_adjustment
@@ -4962,8 +4982,7 @@ module Aws::AutoScaling
4962
4982
  # @return [Integer]
4963
4983
  #
4964
4984
  # @!attribute [rw] cooldown
4965
- # The amount of time, in seconds, after a scaling activity completes
4966
- # before any further dynamic scaling activities can start.
4985
+ # The duration of the policy's cooldown period, in seconds.
4967
4986
  # @return [Integer]
4968
4987
  #
4969
4988
  # @!attribute [rw] step_adjustments
@@ -5399,13 +5418,25 @@ module Aws::AutoScaling
5399
5418
  # A rolling update is an update that is applied to all instances in an
5400
5419
  # Auto Scaling group until all instances have been updated. A rolling
5401
5420
  # update can fail due to failed health checks or if instances are on
5402
- # standby or are protected from scale-in. If the rolling update
5421
+ # standby or are protected from scale in. If the rolling update
5403
5422
  # process fails, any instances that were already replaced are not
5404
5423
  # rolled back to their previous configuration.
5405
5424
  # @return [String]
5406
5425
  #
5407
5426
  # @!attribute [rw] preferences
5408
5427
  # Set of preferences associated with the instance refresh request.
5428
+ #
5429
+ # If not provided, the default values are used. For
5430
+ # `MinHealthyPercentage`, the default value is `90`. For
5431
+ # `InstanceWarmup`, the default is to use the value specified for the
5432
+ # health check grace period for the Auto Scaling group.
5433
+ #
5434
+ # For more information, see [RefreshPreferences][1] in the *Amazon EC2
5435
+ # Auto Scaling API Reference*.
5436
+ #
5437
+ #
5438
+ #
5439
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html
5409
5440
  # @return [Types::RefreshPreferences]
5410
5441
  #
5411
5442
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefreshType AWS API Documentation
@@ -5834,13 +5865,12 @@ module Aws::AutoScaling
5834
5865
  # @!attribute [rw] default_cooldown
5835
5866
  # The amount of time, in seconds, after a scaling activity completes
5836
5867
  # before another scaling activity can start. The default value is
5837
- # `300`. This cooldown period is not used when a scaling-specific
5838
- # cooldown is specified.
5868
+ # `300`.
5839
5869
  #
5840
- # Cooldown periods are not supported for target tracking scaling
5841
- # policies, step scaling policies, or scheduled scaling. For more
5842
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
5843
- # Scaling User Guide*.
5870
+ # This setting applies when using simple scaling policies, but not
5871
+ # when using other scaling policies or scheduled scaling. For more
5872
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1]
5873
+ # in the *Amazon EC2 Auto Scaling User Guide*.
5844
5874
  #
5845
5875
  #
5846
5876
  #
@@ -5866,8 +5896,7 @@ module Aws::AutoScaling
5866
5896
  # For more information, see [Health Check Grace Period][1] in the
5867
5897
  # *Amazon EC2 Auto Scaling User Guide*.
5868
5898
  #
5869
- # Conditional: This parameter is required if you are adding an `ELB`
5870
- # health check.
5899
+ # Required if you are adding an `ELB` health check.
5871
5900
  #
5872
5901
  #
5873
5902
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-autoscaling
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.40.0
4
+ version: 1.41.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-23 00:00:00.000000000 Z
11
+ date: 2020-06-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core