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 +4 -4
- data/lib/aws-sdk-autoscaling.rb +1 -1
- data/lib/aws-sdk-autoscaling/activity.rb +13 -11
- data/lib/aws-sdk-autoscaling/auto_scaling_group.rb +100 -49
- data/lib/aws-sdk-autoscaling/client.rb +268 -124
- data/lib/aws-sdk-autoscaling/instance.rb +19 -12
- data/lib/aws-sdk-autoscaling/launch_configuration.rb +13 -11
- data/lib/aws-sdk-autoscaling/lifecycle_hook.rb +15 -13
- data/lib/aws-sdk-autoscaling/load_balancer.rb +13 -11
- data/lib/aws-sdk-autoscaling/notification_configuration.rb +13 -11
- data/lib/aws-sdk-autoscaling/resource.rb +56 -22
- data/lib/aws-sdk-autoscaling/scaling_policy.rb +13 -11
- data/lib/aws-sdk-autoscaling/scheduled_action.rb +18 -14
- data/lib/aws-sdk-autoscaling/tag.rb +13 -11
- data/lib/aws-sdk-autoscaling/types.rb +264 -109
- data/lib/aws-sdk-autoscaling/waiters.rb +63 -0
- metadata +6 -5
@@ -74,19 +74,21 @@ module Aws::AutoScaling
|
|
74
74
|
data[:recurrence]
|
75
75
|
end
|
76
76
|
|
77
|
-
# The minimum
|
77
|
+
# The minimum size of the Auto Scaling group.
|
78
78
|
# @return [Integer]
|
79
79
|
def min_size
|
80
80
|
data[:min_size]
|
81
81
|
end
|
82
82
|
|
83
|
-
# The maximum
|
83
|
+
# The maximum size of the Auto Scaling group.
|
84
84
|
# @return [Integer]
|
85
85
|
def max_size
|
86
86
|
data[:max_size]
|
87
87
|
end
|
88
88
|
|
89
|
-
# The
|
89
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
90
|
+
# after the scheduled action runs and the capacity it attempts to
|
91
|
+
# maintain.
|
90
92
|
# @return [Integer]
|
91
93
|
def desired_capacity
|
92
94
|
data[:desired_capacity]
|
@@ -132,7 +134,8 @@ module Aws::AutoScaling
|
|
132
134
|
# Waiter polls an API operation until a resource enters a desired
|
133
135
|
# state.
|
134
136
|
#
|
135
|
-
# @note The waiting operation is performed on a copy. The original resource
|
137
|
+
# @note The waiting operation is performed on a copy. The original resource
|
138
|
+
# remains unchanged.
|
136
139
|
#
|
137
140
|
# ## Basic Usage
|
138
141
|
#
|
@@ -145,13 +148,15 @@ module Aws::AutoScaling
|
|
145
148
|
#
|
146
149
|
# ## Example
|
147
150
|
#
|
148
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
151
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
152
|
+
# instance.state.name == 'running'
|
153
|
+
# end
|
149
154
|
#
|
150
155
|
# ## Configuration
|
151
156
|
#
|
152
157
|
# You can configure the maximum number of polling attempts, and the
|
153
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
154
|
-
# by passing a block to {#wait_until}:
|
158
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
159
|
+
# set by passing a block to {#wait_until}:
|
155
160
|
#
|
156
161
|
# # poll for ~25 seconds
|
157
162
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -182,17 +187,16 @@ module Aws::AutoScaling
|
|
182
187
|
# # resource did not enter the desired state in time
|
183
188
|
# end
|
184
189
|
#
|
190
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
185
191
|
#
|
186
|
-
# @
|
187
|
-
#
|
188
|
-
#
|
189
|
-
# because the waiter has entered a state that it will not transition
|
190
|
-
# out of, preventing success.
|
192
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
193
|
+
# terminates because the waiter has entered a state that it will not
|
194
|
+
# transition out of, preventing success.
|
191
195
|
#
|
192
196
|
# yet successful.
|
193
197
|
#
|
194
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
195
|
-
# while polling for a resource that is not expected.
|
198
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
199
|
+
# encountered while polling for a resource that is not expected.
|
196
200
|
#
|
197
201
|
# @raise [NotImplementedError] Raised when the resource does not
|
198
202
|
#
|
@@ -110,7 +110,8 @@ module Aws::AutoScaling
|
|
110
110
|
# Waiter polls an API operation until a resource enters a desired
|
111
111
|
# state.
|
112
112
|
#
|
113
|
-
# @note The waiting operation is performed on a copy. The original resource
|
113
|
+
# @note The waiting operation is performed on a copy. The original resource
|
114
|
+
# remains unchanged.
|
114
115
|
#
|
115
116
|
# ## Basic Usage
|
116
117
|
#
|
@@ -123,13 +124,15 @@ module Aws::AutoScaling
|
|
123
124
|
#
|
124
125
|
# ## Example
|
125
126
|
#
|
126
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
127
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
128
|
+
# instance.state.name == 'running'
|
129
|
+
# end
|
127
130
|
#
|
128
131
|
# ## Configuration
|
129
132
|
#
|
130
133
|
# You can configure the maximum number of polling attempts, and the
|
131
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
132
|
-
# by passing a block to {#wait_until}:
|
134
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
135
|
+
# set by passing a block to {#wait_until}:
|
133
136
|
#
|
134
137
|
# # poll for ~25 seconds
|
135
138
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -160,17 +163,16 @@ module Aws::AutoScaling
|
|
160
163
|
# # resource did not enter the desired state in time
|
161
164
|
# end
|
162
165
|
#
|
166
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
163
167
|
#
|
164
|
-
# @
|
165
|
-
#
|
166
|
-
#
|
167
|
-
# because the waiter has entered a state that it will not transition
|
168
|
-
# out of, preventing success.
|
168
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
169
|
+
# terminates because the waiter has entered a state that it will not
|
170
|
+
# transition out of, preventing success.
|
169
171
|
#
|
170
172
|
# yet successful.
|
171
173
|
#
|
172
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
173
|
-
# while polling for a resource that is not expected.
|
174
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
175
|
+
# encountered while polling for a resource that is not expected.
|
174
176
|
#
|
175
177
|
# @raise [NotImplementedError] Raised when the resource does not
|
176
178
|
#
|
@@ -319,8 +319,8 @@ module Aws::AutoScaling
|
|
319
319
|
# @return [Array<Types::EnabledMetric>]
|
320
320
|
#
|
321
321
|
# @!attribute [rw] status
|
322
|
-
# The current state of the group when DeleteAutoScalingGroup
|
323
|
-
# progress.
|
322
|
+
# The current state of the group when the DeleteAutoScalingGroup
|
323
|
+
# operation is in progress.
|
324
324
|
# @return [String]
|
325
325
|
#
|
326
326
|
# @!attribute [rw] tags
|
@@ -345,7 +345,7 @@ module Aws::AutoScaling
|
|
345
345
|
# The maximum amount of time, in seconds, that an instance can be in
|
346
346
|
# service.
|
347
347
|
#
|
348
|
-
# Valid Range: Minimum value of
|
348
|
+
# Valid Range: Minimum value of 0.
|
349
349
|
# @return [Integer]
|
350
350
|
#
|
351
351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AutoScalingGroup AWS API Documentation
|
@@ -628,6 +628,8 @@ module Aws::AutoScaling
|
|
628
628
|
#
|
629
629
|
# @!attribute [rw] virtual_name
|
630
630
|
# The name of the virtual device (for example, `ephemeral0`).
|
631
|
+
#
|
632
|
+
# You can specify either `VirtualName` or `Ebs`, but not both.
|
631
633
|
# @return [String]
|
632
634
|
#
|
633
635
|
# @!attribute [rw] device_name
|
@@ -641,15 +643,21 @@ module Aws::AutoScaling
|
|
641
643
|
# @return [String]
|
642
644
|
#
|
643
645
|
# @!attribute [rw] ebs
|
644
|
-
#
|
646
|
+
# Parameters used to automatically set up EBS volumes when an instance
|
647
|
+
# is launched.
|
648
|
+
#
|
649
|
+
# You can specify either `VirtualName` or `Ebs`, but not both.
|
645
650
|
# @return [Types::Ebs]
|
646
651
|
#
|
647
652
|
# @!attribute [rw] no_device
|
648
|
-
#
|
653
|
+
# Setting this value to `true` suppresses the specified device
|
654
|
+
# included in the block device mapping of the AMI.
|
649
655
|
#
|
650
|
-
# If
|
651
|
-
#
|
652
|
-
#
|
656
|
+
# If `NoDevice` is `true` for the root device, instances might fail
|
657
|
+
# the EC2 health check. In that case, Amazon EC2 Auto Scaling launches
|
658
|
+
# replacement instances.
|
659
|
+
#
|
660
|
+
# If you specify `NoDevice`, you cannot specify `Ebs`.
|
653
661
|
# @return [Boolean]
|
654
662
|
#
|
655
663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/BlockDeviceMapping AWS API Documentation
|
@@ -790,21 +798,29 @@ module Aws::AutoScaling
|
|
790
798
|
# @return [String]
|
791
799
|
#
|
792
800
|
# @!attribute [rw] launch_configuration_name
|
793
|
-
# The name of the launch configuration
|
801
|
+
# The name of the launch configuration to use when an instance is
|
802
|
+
# launched. To get the launch configuration name, use the
|
803
|
+
# DescribeLaunchConfigurations API operation. New launch
|
804
|
+
# configurations can be created with the CreateLaunchConfiguration
|
805
|
+
# API.
|
794
806
|
#
|
795
|
-
#
|
796
|
-
#
|
807
|
+
# You must specify one of the following parameters in your request:
|
808
|
+
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
797
809
|
# `MixedInstancesPolicy`.
|
798
810
|
# @return [String]
|
799
811
|
#
|
800
812
|
# @!attribute [rw] launch_template
|
801
|
-
#
|
813
|
+
# Parameters used to specify the launch template and version to use
|
814
|
+
# when an instance is launched.
|
802
815
|
#
|
803
816
|
# For more information, see [LaunchTemplateSpecification][1] in the
|
804
817
|
# *Amazon EC2 Auto Scaling API Reference*.
|
805
818
|
#
|
806
|
-
#
|
807
|
-
#
|
819
|
+
# You can alternatively associate a launch template to the Auto
|
820
|
+
# Scaling group by using the `MixedInstancesPolicy` parameter.
|
821
|
+
#
|
822
|
+
# You must specify one of the following parameters in your request:
|
823
|
+
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
808
824
|
# `MixedInstancesPolicy`.
|
809
825
|
#
|
810
826
|
#
|
@@ -841,23 +857,21 @@ module Aws::AutoScaling
|
|
841
857
|
#
|
842
858
|
# @!attribute [rw] instance_id
|
843
859
|
# The ID of the instance used to create a launch configuration for the
|
844
|
-
# group.
|
860
|
+
# group. To get the instance ID, use the Amazon EC2
|
861
|
+
# [DescribeInstances][1] API operation.
|
845
862
|
#
|
846
863
|
# When you specify an ID of an instance, Amazon EC2 Auto Scaling
|
847
864
|
# creates a new launch configuration and associates it with the group.
|
848
865
|
# This launch configuration derives its attributes from the specified
|
849
866
|
# instance, except for the block device mapping.
|
850
867
|
#
|
851
|
-
# For more information, see [Create an Auto Scaling Group Using an EC2
|
852
|
-
# Instance][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
853
|
-
#
|
854
868
|
# You must specify one of the following parameters in your request:
|
855
869
|
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
856
870
|
# `MixedInstancesPolicy`.
|
857
871
|
#
|
858
872
|
#
|
859
873
|
#
|
860
|
-
# [1]: https://docs.aws.amazon.com/
|
874
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
|
861
875
|
# @return [String]
|
862
876
|
#
|
863
877
|
# @!attribute [rw] min_size
|
@@ -866,14 +880,27 @@ module Aws::AutoScaling
|
|
866
880
|
#
|
867
881
|
# @!attribute [rw] max_size
|
868
882
|
# The maximum size of the group.
|
883
|
+
#
|
884
|
+
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon
|
885
|
+
# EC2 Auto Scaling may need to go above `MaxSize` to meet your
|
886
|
+
# capacity requirements. In this event, Amazon EC2 Auto Scaling will
|
887
|
+
# never go above `MaxSize` by more than your maximum instance weight
|
888
|
+
# (weights that define how many capacity units each instance
|
889
|
+
# contributes to the capacity of the group).
|
890
|
+
#
|
891
|
+
# </note>
|
869
892
|
# @return [Integer]
|
870
893
|
#
|
871
894
|
# @!attribute [rw] desired_capacity
|
872
|
-
# The
|
873
|
-
#
|
874
|
-
#
|
875
|
-
#
|
876
|
-
#
|
895
|
+
# The desired capacity is the initial capacity of the Auto Scaling
|
896
|
+
# group at the time of its creation and the capacity it attempts to
|
897
|
+
# maintain. It can scale beyond this capacity if you configure
|
898
|
+
# automatic scaling.
|
899
|
+
#
|
900
|
+
# This number must be greater than or equal to the minimum size of the
|
901
|
+
# group and less than or equal to the maximum size of the group. If
|
902
|
+
# you do not specify a desired capacity, the default is the minimum
|
903
|
+
# size of the group.
|
877
904
|
# @return [Integer]
|
878
905
|
#
|
879
906
|
# @!attribute [rw] default_cooldown
|
@@ -1012,7 +1039,15 @@ module Aws::AutoScaling
|
|
1012
1039
|
# @return [Array<Types::LifecycleHookSpecification>]
|
1013
1040
|
#
|
1014
1041
|
# @!attribute [rw] tags
|
1015
|
-
# One or more tags.
|
1042
|
+
# One or more tags. You can tag your Auto Scaling group and propagate
|
1043
|
+
# the tags to the Amazon EC2 instances it launches.
|
1044
|
+
#
|
1045
|
+
# Tags are not propagated to Amazon EBS volumes. To add tags to Amazon
|
1046
|
+
# EBS volumes, specify the tags in a launch template but use caution.
|
1047
|
+
# If the launch template specifies an instance tag with a key that is
|
1048
|
+
# also specified for the Auto Scaling group, Amazon EC2 Auto Scaling
|
1049
|
+
# overrides the value of that instance tag with the value specified by
|
1050
|
+
# the Auto Scaling group.
|
1016
1051
|
#
|
1017
1052
|
# For more information, see [Tagging Auto Scaling Groups and
|
1018
1053
|
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
@@ -1037,13 +1072,17 @@ module Aws::AutoScaling
|
|
1037
1072
|
#
|
1038
1073
|
# @!attribute [rw] max_instance_lifetime
|
1039
1074
|
# The maximum amount of time, in seconds, that an instance can be in
|
1040
|
-
# service.
|
1075
|
+
# service. The default is null.
|
1076
|
+
#
|
1077
|
+
# This parameter is optional, but if you specify a value for it, you
|
1078
|
+
# must specify a value of at least 604,800 seconds (7 days). To clear
|
1079
|
+
# a previously set value, specify a new value of 0.
|
1041
1080
|
#
|
1042
1081
|
# For more information, see [Replacing Auto Scaling Instances Based on
|
1043
1082
|
# Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
|
1044
1083
|
# Guide*.
|
1045
1084
|
#
|
1046
|
-
# Valid Range: Minimum value of
|
1085
|
+
# Valid Range: Minimum value of 0.
|
1047
1086
|
#
|
1048
1087
|
#
|
1049
1088
|
#
|
@@ -2265,8 +2304,7 @@ module Aws::AutoScaling
|
|
2265
2304
|
# @return [String]
|
2266
2305
|
#
|
2267
2306
|
# @!attribute [rw] metrics
|
2268
|
-
#
|
2269
|
-
# all metrics are disabled.
|
2307
|
+
# Specifies one or more of the following metrics:
|
2270
2308
|
#
|
2271
2309
|
# * `GroupMinSize`
|
2272
2310
|
#
|
@@ -2283,6 +2321,18 @@ module Aws::AutoScaling
|
|
2283
2321
|
# * `GroupTerminatingInstances`
|
2284
2322
|
#
|
2285
2323
|
# * `GroupTotalInstances`
|
2324
|
+
#
|
2325
|
+
# * `GroupInServiceCapacity`
|
2326
|
+
#
|
2327
|
+
# * `GroupPendingCapacity`
|
2328
|
+
#
|
2329
|
+
# * `GroupStandbyCapacity`
|
2330
|
+
#
|
2331
|
+
# * `GroupTerminatingCapacity`
|
2332
|
+
#
|
2333
|
+
# * `GroupTotalCapacity`
|
2334
|
+
#
|
2335
|
+
# If you omit this parameter, all metrics are disabled.
|
2286
2336
|
# @return [Array<String>]
|
2287
2337
|
#
|
2288
2338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DisableMetricsCollectionQuery AWS API Documentation
|
@@ -2293,8 +2343,8 @@ module Aws::AutoScaling
|
|
2293
2343
|
include Aws::Structure
|
2294
2344
|
end
|
2295
2345
|
|
2296
|
-
# Describes an Amazon EBS volume
|
2297
|
-
#
|
2346
|
+
# Describes information used to set up an Amazon EBS volume specified in
|
2347
|
+
# a block device mapping.
|
2298
2348
|
#
|
2299
2349
|
# @note When making an API call, you may pass Ebs
|
2300
2350
|
# data as a hash:
|
@@ -2428,8 +2478,8 @@ module Aws::AutoScaling
|
|
2428
2478
|
# @return [String]
|
2429
2479
|
#
|
2430
2480
|
# @!attribute [rw] metrics
|
2431
|
-
#
|
2432
|
-
#
|
2481
|
+
# Specifies which group-level metrics to start collecting. You can
|
2482
|
+
# specify one or more of the following metrics:
|
2433
2483
|
#
|
2434
2484
|
# * `GroupMinSize`
|
2435
2485
|
#
|
@@ -2446,6 +2496,21 @@ module Aws::AutoScaling
|
|
2446
2496
|
# * `GroupTerminatingInstances`
|
2447
2497
|
#
|
2448
2498
|
# * `GroupTotalInstances`
|
2499
|
+
#
|
2500
|
+
# The instance weighting feature supports the following additional
|
2501
|
+
# metrics:
|
2502
|
+
#
|
2503
|
+
# * `GroupInServiceCapacity`
|
2504
|
+
#
|
2505
|
+
# * `GroupPendingCapacity`
|
2506
|
+
#
|
2507
|
+
# * `GroupStandbyCapacity`
|
2508
|
+
#
|
2509
|
+
# * `GroupTerminatingCapacity`
|
2510
|
+
#
|
2511
|
+
# * `GroupTotalCapacity`
|
2512
|
+
#
|
2513
|
+
# If you omit this parameter, all metrics are enabled.
|
2449
2514
|
# @return [Array<String>]
|
2450
2515
|
#
|
2451
2516
|
# @!attribute [rw] granularity
|
@@ -2482,6 +2547,16 @@ module Aws::AutoScaling
|
|
2482
2547
|
# * `GroupTerminatingInstances`
|
2483
2548
|
#
|
2484
2549
|
# * `GroupTotalInstances`
|
2550
|
+
#
|
2551
|
+
# * `GroupInServiceCapacity`
|
2552
|
+
#
|
2553
|
+
# * `GroupPendingCapacity`
|
2554
|
+
#
|
2555
|
+
# * `GroupStandbyCapacity`
|
2556
|
+
#
|
2557
|
+
# * `GroupTerminatingCapacity`
|
2558
|
+
#
|
2559
|
+
# * `GroupTotalCapacity`
|
2485
2560
|
# @return [String]
|
2486
2561
|
#
|
2487
2562
|
# @!attribute [rw] granularity
|
@@ -2663,7 +2738,15 @@ module Aws::AutoScaling
|
|
2663
2738
|
include Aws::Structure
|
2664
2739
|
end
|
2665
2740
|
|
2666
|
-
# Describes a filter
|
2741
|
+
# Describes a filter that is used to return a more specific list of
|
2742
|
+
# results when describing tags.
|
2743
|
+
#
|
2744
|
+
# For more information, see [Tagging Auto Scaling Groups and
|
2745
|
+
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
2746
|
+
#
|
2747
|
+
#
|
2748
|
+
#
|
2749
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
|
2667
2750
|
#
|
2668
2751
|
# @note When making an API call, you may pass Filter
|
2669
2752
|
# data as a hash:
|
@@ -2674,13 +2757,12 @@ module Aws::AutoScaling
|
|
2674
2757
|
# }
|
2675
2758
|
#
|
2676
2759
|
# @!attribute [rw] name
|
2677
|
-
# The name of the filter. The valid values are:
|
2678
|
-
# `
|
2679
|
-
# `"propagate-at-launch"`.
|
2760
|
+
# The name of the filter. The valid values are: `auto-scaling-group`,
|
2761
|
+
# `key`, `value`, and `propagate-at-launch`.
|
2680
2762
|
# @return [String]
|
2681
2763
|
#
|
2682
2764
|
# @!attribute [rw] values
|
2683
|
-
#
|
2765
|
+
# One or more filter values. Filter values are case-sensitive.
|
2684
2766
|
# @return [Array<String>]
|
2685
2767
|
#
|
2686
2768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/Filter AWS API Documentation
|
@@ -3245,10 +3327,12 @@ module Aws::AutoScaling
|
|
3245
3327
|
# @return [Types::LaunchTemplateSpecification]
|
3246
3328
|
#
|
3247
3329
|
# @!attribute [rw] overrides
|
3248
|
-
#
|
3249
|
-
#
|
3250
|
-
#
|
3251
|
-
#
|
3330
|
+
# Any parameters that you specify override the same parameters in the
|
3331
|
+
# launch template. Currently, the only supported override is instance
|
3332
|
+
# type. You can specify between 1 and 20 instance types.
|
3333
|
+
#
|
3334
|
+
# If not provided, Amazon EC2 Auto Scaling will use the instance type
|
3335
|
+
# specified in the launch template to launch instances.
|
3252
3336
|
# @return [Array<Types::LaunchTemplateOverrides>]
|
3253
3337
|
#
|
3254
3338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchTemplate AWS API Documentation
|
@@ -3259,7 +3343,11 @@ module Aws::AutoScaling
|
|
3259
3343
|
include Aws::Structure
|
3260
3344
|
end
|
3261
3345
|
|
3262
|
-
# Describes an override for a launch template.
|
3346
|
+
# Describes an override for a launch template. Currently, the only
|
3347
|
+
# supported override is instance type.
|
3348
|
+
#
|
3349
|
+
# The maximum number of instance type overrides that can be associated
|
3350
|
+
# with an Auto Scaling group is 20.
|
3263
3351
|
#
|
3264
3352
|
# @note When making an API call, you may pass LaunchTemplateOverrides
|
3265
3353
|
# data as a hash:
|
@@ -3270,7 +3358,8 @@ module Aws::AutoScaling
|
|
3270
3358
|
# }
|
3271
3359
|
#
|
3272
3360
|
# @!attribute [rw] instance_type
|
3273
|
-
# The instance type.
|
3361
|
+
# The instance type. You must use an instance type that is supported
|
3362
|
+
# in your requested Region and Availability Zones.
|
3274
3363
|
#
|
3275
3364
|
# For information about available instance types, see [Available
|
3276
3365
|
# Instance Types][1] in the *Amazon Elastic Compute Cloud User Guide.*
|
@@ -3306,7 +3395,9 @@ module Aws::AutoScaling
|
|
3306
3395
|
include Aws::Structure
|
3307
3396
|
end
|
3308
3397
|
|
3309
|
-
# Describes
|
3398
|
+
# Describes the Amazon EC2 launch template and the launch template
|
3399
|
+
# version that can be used by an Auto Scaling group to configure Amazon
|
3400
|
+
# EC2 instances.
|
3310
3401
|
#
|
3311
3402
|
# The launch template that is specified must be configured for use with
|
3312
3403
|
# an Auto Scaling group. For more information, see [Creating a Launch
|
@@ -3327,22 +3418,49 @@ module Aws::AutoScaling
|
|
3327
3418
|
# }
|
3328
3419
|
#
|
3329
3420
|
# @!attribute [rw] launch_template_id
|
3330
|
-
# The ID of the launch template.
|
3331
|
-
#
|
3421
|
+
# The ID of the launch template. To get the template ID, use the
|
3422
|
+
# Amazon EC2 [DescribeLaunchTemplates][1] API operation. New launch
|
3423
|
+
# templates can be created using the Amazon EC2
|
3424
|
+
# [CreateLaunchTemplate][2] API.
|
3425
|
+
#
|
3426
|
+
# You must specify either a template ID or a template name.
|
3427
|
+
#
|
3428
|
+
#
|
3429
|
+
#
|
3430
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html
|
3431
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html
|
3332
3432
|
# @return [String]
|
3333
3433
|
#
|
3334
3434
|
# @!attribute [rw] launch_template_name
|
3335
|
-
# The name of the launch template.
|
3336
|
-
#
|
3435
|
+
# The name of the launch template. To get the template name, use the
|
3436
|
+
# Amazon EC2 [DescribeLaunchTemplates][1] API operation. New launch
|
3437
|
+
# templates can be created using the Amazon EC2
|
3438
|
+
# [CreateLaunchTemplate][2] API.
|
3439
|
+
#
|
3440
|
+
# You must specify either a template ID or a template name.
|
3441
|
+
#
|
3442
|
+
#
|
3443
|
+
#
|
3444
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html
|
3445
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html
|
3337
3446
|
# @return [String]
|
3338
3447
|
#
|
3339
3448
|
# @!attribute [rw] version
|
3340
|
-
# The version number, `$Latest`, or `$Default`.
|
3341
|
-
#
|
3342
|
-
# launch template
|
3343
|
-
#
|
3344
|
-
#
|
3345
|
-
# `$
|
3449
|
+
# The version number, `$Latest`, or `$Default`. To get the version
|
3450
|
+
# number, use the Amazon EC2 [DescribeLaunchTemplateVersions][1] API
|
3451
|
+
# operation. New launch template versions can be created using the
|
3452
|
+
# Amazon EC2 [CreateLaunchTemplateVersion][2] API.
|
3453
|
+
#
|
3454
|
+
# If the value is `$Latest`, Amazon EC2 Auto Scaling selects the
|
3455
|
+
# latest version of the launch template when launching instances. If
|
3456
|
+
# the value is `$Default`, Amazon EC2 Auto Scaling selects the default
|
3457
|
+
# version of the launch template when launching instances. The default
|
3458
|
+
# value is `$Default`.
|
3459
|
+
#
|
3460
|
+
#
|
3461
|
+
#
|
3462
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html
|
3463
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html
|
3346
3464
|
# @return [String]
|
3347
3465
|
#
|
3348
3466
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchTemplateSpecification AWS API Documentation
|
@@ -3356,7 +3474,7 @@ module Aws::AutoScaling
|
|
3356
3474
|
|
3357
3475
|
# Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that
|
3358
3476
|
# you want to perform an action whenever it launches instances or
|
3359
|
-
# terminates instances.
|
3477
|
+
# terminates instances.
|
3360
3478
|
#
|
3361
3479
|
# @!attribute [rw] lifecycle_hook_name
|
3362
3480
|
# The name of the lifecycle hook.
|
@@ -3427,8 +3545,8 @@ module Aws::AutoScaling
|
|
3427
3545
|
include Aws::Structure
|
3428
3546
|
end
|
3429
3547
|
|
3430
|
-
# Describes a lifecycle hook
|
3431
|
-
#
|
3548
|
+
# Describes information used to specify a lifecycle hook for an Auto
|
3549
|
+
# Scaling group.
|
3432
3550
|
#
|
3433
3551
|
# A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on
|
3434
3552
|
# an instance when the instance launches (before it is put into service)
|
@@ -3450,21 +3568,14 @@ module Aws::AutoScaling
|
|
3450
3568
|
# the instances launch or terminate.**
|
3451
3569
|
#
|
3452
3570
|
# 4. If you need more time, record the lifecycle action heartbeat to
|
3453
|
-
# keep the instance in a pending state
|
3454
|
-
# RecordLifecycleActionHeartbeat.
|
3571
|
+
# keep the instance in a pending state.
|
3455
3572
|
#
|
3456
3573
|
# 5. If you finish before the timeout period ends, complete the
|
3457
|
-
# lifecycle action
|
3574
|
+
# lifecycle action.
|
3458
3575
|
#
|
3459
3576
|
# For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
|
3460
3577
|
# in the *Amazon EC2 Auto Scaling User Guide*.
|
3461
3578
|
#
|
3462
|
-
# You can view the lifecycle hooks for an Auto Scaling group using
|
3463
|
-
# DescribeLifecycleHooks. You can modify an existing lifecycle hook or
|
3464
|
-
# create new lifecycle hooks using PutLifecycleHook. If you are no
|
3465
|
-
# longer using a lifecycle hook, you can delete it using
|
3466
|
-
# DeleteLifecycleHook.
|
3467
|
-
#
|
3468
3579
|
#
|
3469
3580
|
#
|
3470
3581
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
|
@@ -3545,7 +3656,12 @@ module Aws::AutoScaling
|
|
3545
3656
|
|
3546
3657
|
# You have already reached a limit for your Amazon EC2 Auto Scaling
|
3547
3658
|
# resources (for example, Auto Scaling groups, launch configurations, or
|
3548
|
-
# lifecycle hooks). For more information, see DescribeAccountLimits
|
3659
|
+
# lifecycle hooks). For more information, see [DescribeAccountLimits][1]
|
3660
|
+
# in the *Amazon EC2 Auto Scaling API Reference*.
|
3661
|
+
#
|
3662
|
+
#
|
3663
|
+
#
|
3664
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DescribeAccountLimits.html
|
3549
3665
|
#
|
3550
3666
|
# @!attribute [rw] message
|
3551
3667
|
# @return [String]
|
@@ -4029,8 +4145,8 @@ module Aws::AutoScaling
|
|
4029
4145
|
#
|
4030
4146
|
# If the lifecycle hook times out, Amazon EC2 Auto Scaling performs
|
4031
4147
|
# the action that you specified in the `DefaultResult` parameter. You
|
4032
|
-
# can prevent the lifecycle hook from timing out by calling
|
4033
|
-
# RecordLifecycleActionHeartbeat.
|
4148
|
+
# can prevent the lifecycle hook from timing out by calling the
|
4149
|
+
# RecordLifecycleActionHeartbeat API.
|
4034
4150
|
# @return [Integer]
|
4035
4151
|
#
|
4036
4152
|
# @!attribute [rw] default_result
|
@@ -4073,9 +4189,9 @@ module Aws::AutoScaling
|
|
4073
4189
|
# @return [String]
|
4074
4190
|
#
|
4075
4191
|
# @!attribute [rw] notification_types
|
4076
|
-
# The type of event that causes the notification to be sent.
|
4077
|
-
#
|
4078
|
-
#
|
4192
|
+
# The type of event that causes the notification to be sent. To query
|
4193
|
+
# the notification types supported by Amazon EC2 Auto Scaling, call
|
4194
|
+
# the DescribeAutoScalingNotificationTypes API.
|
4079
4195
|
# @return [Array<String>]
|
4080
4196
|
#
|
4081
4197
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutNotificationConfigurationType AWS API Documentation
|
@@ -4165,12 +4281,7 @@ module Aws::AutoScaling
|
|
4165
4281
|
# @return [Integer]
|
4166
4282
|
#
|
4167
4283
|
# @!attribute [rw] min_adjustment_magnitude
|
4168
|
-
# The minimum
|
4169
|
-
# `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
|
4170
|
-
# changes the `DesiredCapacity` of the Auto Scaling group by at least
|
4171
|
-
# this many instances. Otherwise, the error is `ValidationError`.
|
4172
|
-
#
|
4173
|
-
# This property replaces the `MinAdjustmentStep` property. For
|
4284
|
+
# The minimum value to scale by when scaling by percentages. For
|
4174
4285
|
# example, suppose that you create a step scaling policy to scale out
|
4175
4286
|
# an Auto Scaling group by 25 percent and you specify a
|
4176
4287
|
# `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
|
@@ -4178,7 +4289,14 @@ module Aws::AutoScaling
|
|
4178
4289
|
# you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto
|
4179
4290
|
# Scaling scales out the group by 2 instances.
|
4180
4291
|
#
|
4181
|
-
# Valid only if the policy type is `
|
4292
|
+
# Valid only if the policy type is `StepScaling` or `SimpleScaling`
|
4293
|
+
# and the adjustment type is `PercentChangeInCapacity`. For more
|
4294
|
+
# information, see [Scaling Adjustment Types][1] in the *Amazon EC2
|
4295
|
+
# Auto Scaling User Guide*.
|
4296
|
+
#
|
4297
|
+
#
|
4298
|
+
#
|
4299
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
|
4182
4300
|
# @return [Integer]
|
4183
4301
|
#
|
4184
4302
|
# @!attribute [rw] scaling_adjustment
|
@@ -4341,16 +4459,18 @@ module Aws::AutoScaling
|
|
4341
4459
|
# @return [String]
|
4342
4460
|
#
|
4343
4461
|
# @!attribute [rw] min_size
|
4344
|
-
# The minimum
|
4462
|
+
# The minimum size of the Auto Scaling group.
|
4345
4463
|
# @return [Integer]
|
4346
4464
|
#
|
4347
4465
|
# @!attribute [rw] max_size
|
4348
|
-
# The maximum
|
4466
|
+
# The maximum size of the Auto Scaling group.
|
4349
4467
|
# @return [Integer]
|
4350
4468
|
#
|
4351
4469
|
# @!attribute [rw] desired_capacity
|
4352
|
-
# The
|
4353
|
-
#
|
4470
|
+
# The desired capacity is the initial capacity of the Auto Scaling
|
4471
|
+
# group after the scheduled action runs and the capacity it attempts
|
4472
|
+
# to maintain. It can scale beyond this capacity if you add more
|
4473
|
+
# scaling conditions.
|
4354
4474
|
# @return [Integer]
|
4355
4475
|
#
|
4356
4476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PutScheduledUpdateGroupActionType AWS API Documentation
|
@@ -4608,8 +4728,7 @@ module Aws::AutoScaling
|
|
4608
4728
|
include Aws::Structure
|
4609
4729
|
end
|
4610
4730
|
|
4611
|
-
# Describes a scheduled scaling action.
|
4612
|
-
# DescribeScheduledActions.
|
4731
|
+
# Describes a scheduled scaling action.
|
4613
4732
|
#
|
4614
4733
|
# @!attribute [rw] auto_scaling_group_name
|
4615
4734
|
# The name of the Auto Scaling group.
|
@@ -4645,15 +4764,17 @@ module Aws::AutoScaling
|
|
4645
4764
|
# @return [String]
|
4646
4765
|
#
|
4647
4766
|
# @!attribute [rw] min_size
|
4648
|
-
# The minimum
|
4767
|
+
# The minimum size of the Auto Scaling group.
|
4649
4768
|
# @return [Integer]
|
4650
4769
|
#
|
4651
4770
|
# @!attribute [rw] max_size
|
4652
|
-
# The maximum
|
4771
|
+
# The maximum size of the Auto Scaling group.
|
4653
4772
|
# @return [Integer]
|
4654
4773
|
#
|
4655
4774
|
# @!attribute [rw] desired_capacity
|
4656
|
-
# The
|
4775
|
+
# The desired capacity is the initial capacity of the Auto Scaling
|
4776
|
+
# group after the scheduled action runs and the capacity it attempts
|
4777
|
+
# to maintain.
|
4657
4778
|
# @return [Integer]
|
4658
4779
|
#
|
4659
4780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ScheduledUpdateGroupAction AWS API Documentation
|
@@ -4672,9 +4793,8 @@ module Aws::AutoScaling
|
|
4672
4793
|
include Aws::Structure
|
4673
4794
|
end
|
4674
4795
|
|
4675
|
-
# Describes one or more scheduled scaling action
|
4676
|
-
#
|
4677
|
-
# BatchPutScheduledUpdateGroupAction.
|
4796
|
+
# Describes information used for one or more scheduled scaling action
|
4797
|
+
# updates in a BatchPutScheduledUpdateGroupAction operation.
|
4678
4798
|
#
|
4679
4799
|
# When updating a scheduled scaling action, all optional parameters are
|
4680
4800
|
# left unchanged if not specified.
|
@@ -4731,15 +4851,17 @@ module Aws::AutoScaling
|
|
4731
4851
|
# @return [String]
|
4732
4852
|
#
|
4733
4853
|
# @!attribute [rw] min_size
|
4734
|
-
# The minimum
|
4854
|
+
# The minimum size of the Auto Scaling group.
|
4735
4855
|
# @return [Integer]
|
4736
4856
|
#
|
4737
4857
|
# @!attribute [rw] max_size
|
4738
|
-
# The maximum
|
4858
|
+
# The maximum size of the Auto Scaling group.
|
4739
4859
|
# @return [Integer]
|
4740
4860
|
#
|
4741
4861
|
# @!attribute [rw] desired_capacity
|
4742
|
-
# The
|
4862
|
+
# The desired capacity is the initial capacity of the Auto Scaling
|
4863
|
+
# group after the scheduled action runs and the capacity it attempts
|
4864
|
+
# to maintain.
|
4743
4865
|
# @return [Integer]
|
4744
4866
|
#
|
4745
4867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ScheduledUpdateGroupActionRequest AWS API Documentation
|
@@ -4781,8 +4903,9 @@ module Aws::AutoScaling
|
|
4781
4903
|
# @return [String]
|
4782
4904
|
#
|
4783
4905
|
# @!attribute [rw] desired_capacity
|
4784
|
-
# The
|
4785
|
-
#
|
4906
|
+
# The desired capacity is the initial capacity of the Auto Scaling
|
4907
|
+
# group after this operation completes and the capacity it attempts to
|
4908
|
+
# maintain.
|
4786
4909
|
# @return [Integer]
|
4787
4910
|
#
|
4788
4911
|
# @!attribute [rw] honor_cooldown
|
@@ -4829,7 +4952,12 @@ module Aws::AutoScaling
|
|
4829
4952
|
# call not respect the grace period associated with the group.
|
4830
4953
|
#
|
4831
4954
|
# For more information about the health check grace period, see
|
4832
|
-
# CreateAutoScalingGroup
|
4955
|
+
# [CreateAutoScalingGroup][1] in the *Amazon EC2 Auto Scaling API
|
4956
|
+
# Reference*.
|
4957
|
+
#
|
4958
|
+
#
|
4959
|
+
#
|
4960
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html
|
4833
4961
|
# @return [Boolean]
|
4834
4962
|
#
|
4835
4963
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/SetInstanceHealthQuery AWS API Documentation
|
@@ -4876,9 +5004,8 @@ module Aws::AutoScaling
|
|
4876
5004
|
include Aws::Structure
|
4877
5005
|
end
|
4878
5006
|
|
4879
|
-
# Describes
|
4880
|
-
#
|
4881
|
-
# defined for the alarm. Used in combination with PutScalingPolicy.
|
5007
|
+
# Describes information used to create a step adjustment for a step
|
5008
|
+
# scaling policy.
|
4882
5009
|
#
|
4883
5010
|
# For the following examples, suppose that you have an alarm with a
|
4884
5011
|
# breach threshold of 50:
|
@@ -4906,6 +5033,13 @@ module Aws::AutoScaling
|
|
4906
5033
|
# * The upper and lower bound can't be null in the same step
|
4907
5034
|
# adjustment.
|
4908
5035
|
#
|
5036
|
+
# For more information, see [Step Adjustments][1] in the *Amazon EC2
|
5037
|
+
# Auto Scaling User Guide*.
|
5038
|
+
#
|
5039
|
+
#
|
5040
|
+
#
|
5041
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps
|
5042
|
+
#
|
4909
5043
|
# @note When making an API call, you may pass StepAdjustment
|
4910
5044
|
# data as a hash:
|
4911
5045
|
#
|
@@ -4950,8 +5084,14 @@ module Aws::AutoScaling
|
|
4950
5084
|
include Aws::Structure
|
4951
5085
|
end
|
4952
5086
|
|
4953
|
-
# Describes an automatic scaling process that has been suspended.
|
4954
|
-
#
|
5087
|
+
# Describes an automatic scaling process that has been suspended.
|
5088
|
+
#
|
5089
|
+
# For more information, see [Scaling Processes][1] in the *Amazon EC2
|
5090
|
+
# Auto Scaling User Guide*.
|
5091
|
+
#
|
5092
|
+
#
|
5093
|
+
#
|
5094
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types
|
4955
5095
|
#
|
4956
5096
|
# @!attribute [rw] process_name
|
4957
5097
|
# The name of the suspended process.
|
@@ -5250,13 +5390,24 @@ module Aws::AutoScaling
|
|
5250
5390
|
#
|
5251
5391
|
# @!attribute [rw] max_size
|
5252
5392
|
# The maximum size of the Auto Scaling group.
|
5393
|
+
#
|
5394
|
+
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon
|
5395
|
+
# EC2 Auto Scaling may need to go above `MaxSize` to meet your
|
5396
|
+
# capacity requirements. In this event, Amazon EC2 Auto Scaling will
|
5397
|
+
# never go above `MaxSize` by more than your maximum instance weight
|
5398
|
+
# (weights that define how many capacity units each instance
|
5399
|
+
# contributes to the capacity of the group).
|
5400
|
+
#
|
5401
|
+
# </note>
|
5253
5402
|
# @return [Integer]
|
5254
5403
|
#
|
5255
5404
|
# @!attribute [rw] desired_capacity
|
5256
|
-
# The
|
5257
|
-
#
|
5258
|
-
#
|
5259
|
-
#
|
5405
|
+
# The desired capacity is the initial capacity of the Auto Scaling
|
5406
|
+
# group after this operation completes and the capacity it attempts to
|
5407
|
+
# maintain.
|
5408
|
+
#
|
5409
|
+
# This number must be greater than or equal to the minimum size of the
|
5410
|
+
# group and less than or equal to the maximum size of the group.
|
5260
5411
|
# @return [Integer]
|
5261
5412
|
#
|
5262
5413
|
# @!attribute [rw] default_cooldown
|
@@ -5363,13 +5514,17 @@ module Aws::AutoScaling
|
|
5363
5514
|
#
|
5364
5515
|
# @!attribute [rw] max_instance_lifetime
|
5365
5516
|
# The maximum amount of time, in seconds, that an instance can be in
|
5366
|
-
# service.
|
5517
|
+
# service. The default is null.
|
5518
|
+
#
|
5519
|
+
# This parameter is optional, but if you specify a value for it, you
|
5520
|
+
# must specify a value of at least 604,800 seconds (7 days). To clear
|
5521
|
+
# a previously set value, specify a new value of 0.
|
5367
5522
|
#
|
5368
5523
|
# For more information, see [Replacing Auto Scaling Instances Based on
|
5369
5524
|
# Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
|
5370
5525
|
# Guide*.
|
5371
5526
|
#
|
5372
|
-
# Valid Range: Minimum value of
|
5527
|
+
# Valid Range: Minimum value of 0.
|
5373
5528
|
#
|
5374
5529
|
#
|
5375
5530
|
#
|