aws-sdk-autoscaling 1.14.0 → 1.15.0
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/auto_scaling_group.rb +53 -58
- data/lib/aws-sdk-autoscaling/client.rb +208 -162
- data/lib/aws-sdk-autoscaling/instance.rb +1 -13
- data/lib/aws-sdk-autoscaling/launch_configuration.rb +10 -9
- data/lib/aws-sdk-autoscaling/lifecycle_hook.rb +22 -19
- data/lib/aws-sdk-autoscaling/resource.rb +88 -58
- data/lib/aws-sdk-autoscaling/scaling_policy.rb +11 -10
- data/lib/aws-sdk-autoscaling/scheduled_action.rb +2 -4
- data/lib/aws-sdk-autoscaling/types.rb +404 -279
- metadata +2 -2
@@ -43,15 +43,16 @@ module Aws::AutoScaling
|
|
43
43
|
data[:policy_arn]
|
44
44
|
end
|
45
45
|
|
46
|
-
# The policy type.
|
46
|
+
# The policy type. The valid values are `SimpleScaling` and
|
47
|
+
# `StepScaling`.
|
47
48
|
# @return [String]
|
48
49
|
def policy_type
|
49
50
|
data[:policy_type]
|
50
51
|
end
|
51
52
|
|
52
53
|
# The adjustment type, which specifies how `ScalingAdjustment` is
|
53
|
-
# interpreted.
|
54
|
-
# `PercentChangeInCapacity`.
|
54
|
+
# interpreted. The valid values are `ChangeInCapacity`, `ExactCapacity`,
|
55
|
+
# and `PercentChangeInCapacity`.
|
55
56
|
# @return [String]
|
56
57
|
def adjustment_type
|
57
58
|
data[:adjustment_type]
|
@@ -95,7 +96,7 @@ module Aws::AutoScaling
|
|
95
96
|
data[:step_adjustments]
|
96
97
|
end
|
97
98
|
|
98
|
-
# The aggregation type for the CloudWatch metrics.
|
99
|
+
# The aggregation type for the CloudWatch metrics. The valid values are
|
99
100
|
# `Minimum`, `Maximum`, and `Average`.
|
100
101
|
# @return [String]
|
101
102
|
def metric_aggregation_type
|
@@ -115,7 +116,7 @@ module Aws::AutoScaling
|
|
115
116
|
data[:alarms]
|
116
117
|
end
|
117
118
|
|
118
|
-
# A target tracking policy.
|
119
|
+
# A target tracking scaling policy.
|
119
120
|
# @return [Types::TargetTrackingConfiguration]
|
120
121
|
def target_tracking_configuration
|
121
122
|
data[:target_tracking_configuration]
|
@@ -290,7 +291,7 @@ module Aws::AutoScaling
|
|
290
291
|
#
|
291
292
|
#
|
292
293
|
#
|
293
|
-
# [1]:
|
294
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
|
294
295
|
# @option options [Float] :metric_value
|
295
296
|
# The metric value to compare to `BreachThreshold`. This enables you to
|
296
297
|
# execute a policy of type `StepScaling` and determine which step
|
@@ -301,13 +302,13 @@ module Aws::AutoScaling
|
|
301
302
|
# If you specify a metric value that doesn't correspond to a step
|
302
303
|
# adjustment for the policy, the call returns an error.
|
303
304
|
#
|
304
|
-
# This parameter is required if the policy type is
|
305
|
-
# supported otherwise.
|
305
|
+
# Conditional: This parameter is required if the policy type is
|
306
|
+
# `StepScaling` and not supported otherwise.
|
306
307
|
# @option options [Float] :breach_threshold
|
307
308
|
# The breach threshold for the alarm.
|
308
309
|
#
|
309
|
-
# This parameter is required if the policy type is
|
310
|
-
# supported otherwise.
|
310
|
+
# Conditional: This parameter is required if the policy type is
|
311
|
+
# `StepScaling` and not supported otherwise.
|
311
312
|
# @return [EmptyStructure]
|
312
313
|
def execute(options = {})
|
313
314
|
options = options.merge(policy_name: @name)
|
@@ -49,8 +49,7 @@ module Aws::AutoScaling
|
|
49
49
|
data[:time]
|
50
50
|
end
|
51
51
|
|
52
|
-
# The date and time that the action is scheduled to begin.
|
53
|
-
# time can be up to one month in the future.
|
52
|
+
# The date and time that the action is scheduled to begin.
|
54
53
|
#
|
55
54
|
# When `StartTime` and `EndTime` are specified with `Recurrence`, they
|
56
55
|
# form the boundaries of when the recurring action starts and stops.
|
@@ -59,8 +58,7 @@ module Aws::AutoScaling
|
|
59
58
|
data[:start_time]
|
60
59
|
end
|
61
60
|
|
62
|
-
# The date and time that the action is scheduled to end.
|
63
|
-
# time can be up to one month in the future.
|
61
|
+
# The date and time that the action is scheduled to end.
|
64
62
|
# @return [Time]
|
65
63
|
def end_time
|
66
64
|
data[:end_time]
|
@@ -14,8 +14,11 @@ module Aws::AutoScaling
|
|
14
14
|
# @return [Array<Types::Activity>]
|
15
15
|
#
|
16
16
|
# @!attribute [rw] next_token
|
17
|
-
#
|
18
|
-
#
|
17
|
+
# A string that indicates that the response contains more items than
|
18
|
+
# can be returned in a single response. To receive additional items,
|
19
|
+
# specify this string for the `NextToken` value when requesting the
|
20
|
+
# next set of items. This value is null when there are no more items
|
21
|
+
# to return.
|
19
22
|
# @return [String]
|
20
23
|
#
|
21
24
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ActivitiesType AWS API Documentation
|
@@ -289,20 +292,11 @@ module Aws::AutoScaling
|
|
289
292
|
#
|
290
293
|
# @!attribute [rw] placement_group
|
291
294
|
# The name of the placement group into which to launch your instances,
|
292
|
-
# if any.
|
293
|
-
# *Amazon EC2 User Guide for Linux Instances*.
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
|
295
|
+
# if any.
|
298
296
|
# @return [String]
|
299
297
|
#
|
300
298
|
# @!attribute [rw] vpc_zone_identifier
|
301
299
|
# One or more subnet IDs, if applicable, separated by commas.
|
302
|
-
#
|
303
|
-
# If you specify `VPCZoneIdentifier` and `AvailabilityZones`, ensure
|
304
|
-
# that the Availability Zones of the subnets match the values for
|
305
|
-
# `AvailabilityZones`.
|
306
300
|
# @return [String]
|
307
301
|
#
|
308
302
|
# @!attribute [rw] enabled_metrics
|
@@ -324,14 +318,7 @@ module Aws::AutoScaling
|
|
324
318
|
#
|
325
319
|
# @!attribute [rw] new_instances_protected_from_scale_in
|
326
320
|
# Indicates whether newly launched instances are protected from
|
327
|
-
# termination by Auto Scaling when scaling in.
|
328
|
-
#
|
329
|
-
# For more information, see [Instance Protection][1] in the *Amazon
|
330
|
-
# EC2 Auto Scaling User Guide*.
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
|
321
|
+
# termination by Amazon EC2 Auto Scaling when scaling in.
|
335
322
|
# @return [Boolean]
|
336
323
|
#
|
337
324
|
# @!attribute [rw] service_linked_role_arn
|
@@ -395,7 +382,7 @@ module Aws::AutoScaling
|
|
395
382
|
#
|
396
383
|
# @!attribute [rw] max_records
|
397
384
|
# The maximum number of items to return with this call. The default
|
398
|
-
# value is 50 and the maximum value is 100
|
385
|
+
# value is `50` and the maximum value is `100`.
|
399
386
|
# @return [Integer]
|
400
387
|
#
|
401
388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AutoScalingGroupNamesType AWS API Documentation
|
@@ -412,8 +399,11 @@ module Aws::AutoScaling
|
|
412
399
|
# @return [Array<Types::AutoScalingGroup>]
|
413
400
|
#
|
414
401
|
# @!attribute [rw] next_token
|
415
|
-
#
|
416
|
-
#
|
402
|
+
# A string that indicates that the response contains more items than
|
403
|
+
# can be returned in a single response. To receive additional items,
|
404
|
+
# specify this string for the `NextToken` value when requesting the
|
405
|
+
# next set of items. This value is null when there are no more items
|
406
|
+
# to return.
|
417
407
|
# @return [String]
|
418
408
|
#
|
419
409
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AutoScalingGroupsType AWS API Documentation
|
@@ -439,13 +429,7 @@ module Aws::AutoScaling
|
|
439
429
|
# @return [String]
|
440
430
|
#
|
441
431
|
# @!attribute [rw] lifecycle_state
|
442
|
-
# The lifecycle state for the instance.
|
443
|
-
# [Auto Scaling Lifecycle][1] in the *Amazon EC2 Auto Scaling User
|
444
|
-
# Guide*.
|
445
|
-
#
|
446
|
-
#
|
447
|
-
#
|
448
|
-
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html
|
432
|
+
# The lifecycle state for the instance.
|
449
433
|
# @return [String]
|
450
434
|
#
|
451
435
|
# @!attribute [rw] health_status
|
@@ -468,13 +452,6 @@ module Aws::AutoScaling
|
|
468
452
|
# @!attribute [rw] protected_from_scale_in
|
469
453
|
# Indicates whether the instance is protected from termination by
|
470
454
|
# Amazon EC2 Auto Scaling when scaling in.
|
471
|
-
#
|
472
|
-
# For more information, see [Instance Protection][1] in the *Amazon
|
473
|
-
# EC2 Auto Scaling User Guide*.
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
|
478
455
|
# @return [Boolean]
|
479
456
|
#
|
480
457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AutoScalingInstanceDetails AWS API Documentation
|
@@ -496,8 +473,11 @@ module Aws::AutoScaling
|
|
496
473
|
# @return [Array<Types::AutoScalingInstanceDetails>]
|
497
474
|
#
|
498
475
|
# @!attribute [rw] next_token
|
499
|
-
#
|
500
|
-
#
|
476
|
+
# A string that indicates that the response contains more items than
|
477
|
+
# can be returned in a single response. To receive additional items,
|
478
|
+
# specify this string for the `NextToken` value when requesting the
|
479
|
+
# next set of items. This value is null when there are no more items
|
480
|
+
# to return.
|
501
481
|
# @return [String]
|
502
482
|
#
|
503
483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/AutoScalingInstancesType AWS API Documentation
|
@@ -616,7 +596,12 @@ module Aws::AutoScaling
|
|
616
596
|
#
|
617
597
|
# @!attribute [rw] device_name
|
618
598
|
# The device name exposed to the EC2 instance (for example, `/dev/sdh`
|
619
|
-
# or `xvdh`).
|
599
|
+
# or `xvdh`). For more information, see [Device Naming on Linux
|
600
|
+
# Instances][1] in the *Amazon EC2 User Guide for Linux Instances*.
|
601
|
+
#
|
602
|
+
#
|
603
|
+
#
|
604
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html
|
620
605
|
# @return [String]
|
621
606
|
#
|
622
607
|
# @!attribute [rw] ebs
|
@@ -770,18 +755,40 @@ module Aws::AutoScaling
|
|
770
755
|
# The name of the launch configuration. This parameter, a launch
|
771
756
|
# template, a mixed instances policy, or an EC2 instance must be
|
772
757
|
# specified.
|
758
|
+
#
|
759
|
+
# For more information, see [Creating an Auto Scaling Group Using a
|
760
|
+
# Launch Configuration][1] in the *Amazon EC2 Auto Scaling User
|
761
|
+
# Guide*.
|
762
|
+
#
|
763
|
+
#
|
764
|
+
#
|
765
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg.html
|
773
766
|
# @return [String]
|
774
767
|
#
|
775
768
|
# @!attribute [rw] launch_template
|
776
769
|
# The launch template to use to launch instances. This parameter, a
|
777
770
|
# launch configuration, a mixed instances policy, or an EC2 instance
|
778
771
|
# must be specified.
|
772
|
+
#
|
773
|
+
# For more information, see [Creating an Auto Scaling Group Using a
|
774
|
+
# Launch Template][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
775
|
+
#
|
776
|
+
#
|
777
|
+
#
|
778
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-launch-template.html
|
779
779
|
# @return [Types::LaunchTemplateSpecification]
|
780
780
|
#
|
781
781
|
# @!attribute [rw] mixed_instances_policy
|
782
782
|
# The mixed instances policy to use to launch instances. This
|
783
783
|
# parameter, a launch template, a launch configuration, or an EC2
|
784
784
|
# instance must be specified.
|
785
|
+
#
|
786
|
+
# For more information, see [Using Multiple Instance Types and
|
787
|
+
# Purchase Options][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
788
|
+
#
|
789
|
+
#
|
790
|
+
#
|
791
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options
|
785
792
|
# @return [Types::MixedInstancesPolicy]
|
786
793
|
#
|
787
794
|
# @!attribute [rw] instance_id
|
@@ -799,7 +806,7 @@ module Aws::AutoScaling
|
|
799
806
|
#
|
800
807
|
#
|
801
808
|
#
|
802
|
-
# [1]:
|
809
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
|
803
810
|
# @return [String]
|
804
811
|
#
|
805
812
|
# @!attribute [rw] min_size
|
@@ -820,19 +827,23 @@ module Aws::AutoScaling
|
|
820
827
|
#
|
821
828
|
# @!attribute [rw] default_cooldown
|
822
829
|
# The amount of time, in seconds, after a scaling activity completes
|
823
|
-
# before another scaling activity can start. The default is
|
830
|
+
# before another scaling activity can start. The default value is
|
831
|
+
# `300`.
|
824
832
|
#
|
825
833
|
# For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
|
826
834
|
# Auto Scaling User Guide*.
|
827
835
|
#
|
828
836
|
#
|
829
837
|
#
|
830
|
-
# [1]:
|
838
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
|
831
839
|
# @return [Integer]
|
832
840
|
#
|
833
841
|
# @!attribute [rw] availability_zones
|
834
842
|
# One or more Availability Zones for the group. This parameter is
|
835
|
-
# optional if you specify one or more subnets
|
843
|
+
# optional if you specify one or more subnets for `VPCZoneIdentifier`.
|
844
|
+
#
|
845
|
+
# Conditional: If your account supports EC2-Classic and VPC, this
|
846
|
+
# parameter is required to launch instances into EC2-Classic.
|
836
847
|
# @return [Array<String>]
|
837
848
|
#
|
838
849
|
# @!attribute [rw] load_balancer_names
|
@@ -844,7 +855,7 @@ module Aws::AutoScaling
|
|
844
855
|
#
|
845
856
|
#
|
846
857
|
#
|
847
|
-
# [1]:
|
858
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html
|
848
859
|
# @return [Array<String>]
|
849
860
|
#
|
850
861
|
# @!attribute [rw] target_group_arns
|
@@ -853,57 +864,55 @@ module Aws::AutoScaling
|
|
853
864
|
#
|
854
865
|
# @!attribute [rw] health_check_type
|
855
866
|
# The service to use for the health checks. The valid values are `EC2`
|
856
|
-
# and `ELB`.
|
867
|
+
# and `ELB`. The default value is `EC2`.
|
857
868
|
#
|
858
|
-
#
|
859
|
-
#
|
860
|
-
# [Health Checks][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
869
|
+
# For more information, see [Health Checks for Auto Scaling
|
870
|
+
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
861
871
|
#
|
862
872
|
#
|
863
873
|
#
|
864
|
-
# [1]:
|
874
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
|
865
875
|
# @return [String]
|
866
876
|
#
|
867
877
|
# @!attribute [rw] health_check_grace_period
|
868
878
|
# The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
|
869
879
|
# before checking the health status of an EC2 instance that has come
|
870
880
|
# into service. During this time, any health check failures for the
|
871
|
-
# instance are ignored. The default is 0
|
881
|
+
# instance are ignored. The default value is `0`.
|
872
882
|
#
|
873
|
-
#
|
883
|
+
# For more information, see [Health Checks for Auto Scaling
|
884
|
+
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
874
885
|
#
|
875
|
-
#
|
876
|
-
#
|
886
|
+
# Conditional: This parameter is required if you are adding an `ELB`
|
887
|
+
# health check.
|
877
888
|
#
|
878
889
|
#
|
879
890
|
#
|
880
|
-
# [1]:
|
891
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
|
881
892
|
# @return [Integer]
|
882
893
|
#
|
883
894
|
# @!attribute [rw] placement_group
|
884
895
|
# The name of the placement group into which to launch your instances,
|
885
|
-
# if any.
|
886
|
-
#
|
896
|
+
# if any. A placement group is a logical grouping of instances within
|
897
|
+
# a single Availability Zone. You cannot specify multiple Availability
|
898
|
+
# Zones and a placement group. For more information, see [Placement
|
899
|
+
# Groups][1] in the *Amazon EC2 User Guide for Linux Instances*.
|
887
900
|
#
|
888
901
|
#
|
889
902
|
#
|
890
|
-
# [1]:
|
903
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
|
891
904
|
# @return [String]
|
892
905
|
#
|
893
906
|
# @!attribute [rw] vpc_zone_identifier
|
894
|
-
# A comma-separated list of subnet
|
895
|
-
#
|
907
|
+
# A comma-separated list of subnet IDs for your virtual private cloud
|
908
|
+
# (VPC).
|
896
909
|
#
|
897
|
-
# If you specify
|
898
|
-
# that
|
899
|
-
#
|
900
|
-
#
|
901
|
-
# For more information, see [Launching Auto Scaling Instances in a
|
902
|
-
# VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
910
|
+
# If you specify `VPCZoneIdentifier` with `AvailabilityZones`, the
|
911
|
+
# subnets that you specify for this parameter must reside in those
|
912
|
+
# Availability Zones.
|
903
913
|
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
|
914
|
+
# Conditional: If your account supports EC2-Classic and VPC, this
|
915
|
+
# parameter is required to launch instances into a VPC.
|
907
916
|
# @return [String]
|
908
917
|
#
|
909
918
|
# @!attribute [rw] termination_policies
|
@@ -917,12 +926,12 @@ module Aws::AutoScaling
|
|
917
926
|
#
|
918
927
|
#
|
919
928
|
#
|
920
|
-
# [1]:
|
929
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
|
921
930
|
# @return [Array<String>]
|
922
931
|
#
|
923
932
|
# @!attribute [rw] new_instances_protected_from_scale_in
|
924
933
|
# Indicates whether newly launched instances are protected from
|
925
|
-
# termination by Auto Scaling when scaling in.
|
934
|
+
# termination by Amazon EC2 Auto Scaling when scaling in.
|
926
935
|
#
|
927
936
|
# For more information about preventing instances from terminating on
|
928
937
|
# scale in, see [Instance Protection][1] in the *Amazon EC2 Auto
|
@@ -930,7 +939,7 @@ module Aws::AutoScaling
|
|
930
939
|
#
|
931
940
|
#
|
932
941
|
#
|
933
|
-
# [1]:
|
942
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
|
934
943
|
# @return [Boolean]
|
935
944
|
#
|
936
945
|
# @!attribute [rw] lifecycle_hook_specification_list
|
@@ -945,7 +954,7 @@ module Aws::AutoScaling
|
|
945
954
|
#
|
946
955
|
#
|
947
956
|
#
|
948
|
-
# [1]:
|
957
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
|
949
958
|
# @return [Array<Types::Tag>]
|
950
959
|
#
|
951
960
|
# @!attribute [rw] service_linked_role_arn
|
@@ -953,6 +962,12 @@ module Aws::AutoScaling
|
|
953
962
|
# Auto Scaling group uses to call other AWS services on your behalf.
|
954
963
|
# By default, Amazon EC2 Auto Scaling uses a service-linked role named
|
955
964
|
# AWSServiceRoleForAutoScaling, which it creates if it does not exist.
|
965
|
+
# For more information, see [Service-Linked Roles][1] in the *Amazon
|
966
|
+
# EC2 Auto Scaling User Guide*.
|
967
|
+
#
|
968
|
+
#
|
969
|
+
#
|
970
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
|
956
971
|
# @return [String]
|
957
972
|
#
|
958
973
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateAutoScalingGroupType AWS API Documentation
|
@@ -1038,7 +1053,7 @@ module Aws::AutoScaling
|
|
1038
1053
|
#
|
1039
1054
|
#
|
1040
1055
|
#
|
1041
|
-
# [1]:
|
1056
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
|
1042
1057
|
# @return [String]
|
1043
1058
|
#
|
1044
1059
|
# @!attribute [rw] key_name
|
@@ -1047,7 +1062,7 @@ module Aws::AutoScaling
|
|
1047
1062
|
#
|
1048
1063
|
#
|
1049
1064
|
#
|
1050
|
-
# [1]:
|
1065
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
|
1051
1066
|
# @return [String]
|
1052
1067
|
#
|
1053
1068
|
# @!attribute [rw] security_groups
|
@@ -1064,8 +1079,8 @@ module Aws::AutoScaling
|
|
1064
1079
|
#
|
1065
1080
|
#
|
1066
1081
|
#
|
1067
|
-
# [1]:
|
1068
|
-
# [2]:
|
1082
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
|
1083
|
+
# [2]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
|
1069
1084
|
# @return [Array<String>]
|
1070
1085
|
#
|
1071
1086
|
# @!attribute [rw] classic_link_vpc_id
|
@@ -1078,22 +1093,24 @@ module Aws::AutoScaling
|
|
1078
1093
|
#
|
1079
1094
|
#
|
1080
1095
|
#
|
1081
|
-
# [1]:
|
1082
|
-
# [2]:
|
1096
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
1097
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
|
1083
1098
|
# @return [String]
|
1084
1099
|
#
|
1085
1100
|
# @!attribute [rw] classic_link_vpc_security_groups
|
1086
1101
|
# The IDs of one or more security groups for the specified
|
1087
|
-
# ClassicLink-enabled VPC.
|
1088
|
-
#
|
1089
|
-
#
|
1090
|
-
#
|
1091
|
-
# the *Amazon EC2 Auto Scaling User Guide*.
|
1102
|
+
# ClassicLink-enabled VPC. For more information, see [ClassicLink][1]
|
1103
|
+
# in the *Amazon EC2 User Guide for Linux Instances* and [Linking
|
1104
|
+
# EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
|
1105
|
+
# User Guide*.
|
1092
1106
|
#
|
1107
|
+
# Conditional: This parameter is required if you specify a
|
1108
|
+
# ClassicLink-enabled VPC, and is not supported otherwise.
|
1093
1109
|
#
|
1094
1110
|
#
|
1095
|
-
#
|
1096
|
-
# [
|
1111
|
+
#
|
1112
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
1113
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
|
1097
1114
|
# @return [Array<String>]
|
1098
1115
|
#
|
1099
1116
|
# @!attribute [rw] user_data
|
@@ -1103,7 +1120,7 @@ module Aws::AutoScaling
|
|
1103
1120
|
#
|
1104
1121
|
#
|
1105
1122
|
#
|
1106
|
-
# [1]:
|
1123
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
|
1107
1124
|
# @return [String]
|
1108
1125
|
#
|
1109
1126
|
# @!attribute [rw] instance_id
|
@@ -1123,7 +1140,7 @@ module Aws::AutoScaling
|
|
1123
1140
|
#
|
1124
1141
|
#
|
1125
1142
|
#
|
1126
|
-
# [1]:
|
1143
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
|
1127
1144
|
# @return [String]
|
1128
1145
|
#
|
1129
1146
|
# @!attribute [rw] instance_type
|
@@ -1137,7 +1154,7 @@ module Aws::AutoScaling
|
|
1137
1154
|
#
|
1138
1155
|
#
|
1139
1156
|
#
|
1140
|
-
# [1]:
|
1157
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
|
1141
1158
|
# @return [String]
|
1142
1159
|
#
|
1143
1160
|
# @!attribute [rw] kernel_id
|
@@ -1155,12 +1172,12 @@ module Aws::AutoScaling
|
|
1155
1172
|
#
|
1156
1173
|
#
|
1157
1174
|
#
|
1158
|
-
# [1]:
|
1175
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
|
1159
1176
|
# @return [Array<Types::BlockDeviceMapping>]
|
1160
1177
|
#
|
1161
1178
|
# @!attribute [rw] instance_monitoring
|
1162
1179
|
# Enables detailed monitoring (`true`) or basic monitoring (`false`)
|
1163
|
-
# for the Auto Scaling instances. The default is `true`.
|
1180
|
+
# for the Auto Scaling instances. The default value is `true`.
|
1164
1181
|
# @return [Types::InstanceMonitoring]
|
1165
1182
|
#
|
1166
1183
|
# @!attribute [rw] spot_price
|
@@ -1172,7 +1189,7 @@ module Aws::AutoScaling
|
|
1172
1189
|
#
|
1173
1190
|
#
|
1174
1191
|
#
|
1175
|
-
# [1]:
|
1192
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
|
1176
1193
|
# @return [String]
|
1177
1194
|
#
|
1178
1195
|
# @!attribute [rw] iam_instance_profile
|
@@ -1189,7 +1206,7 @@ module Aws::AutoScaling
|
|
1189
1206
|
#
|
1190
1207
|
#
|
1191
1208
|
#
|
1192
|
-
# [1]:
|
1209
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
|
1193
1210
|
# @return [String]
|
1194
1211
|
#
|
1195
1212
|
# @!attribute [rw] ebs_optimized
|
@@ -1203,7 +1220,7 @@ module Aws::AutoScaling
|
|
1203
1220
|
#
|
1204
1221
|
#
|
1205
1222
|
#
|
1206
|
-
# [1]:
|
1223
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
|
1207
1224
|
# @return [Boolean]
|
1208
1225
|
#
|
1209
1226
|
# @!attribute [rw] associate_public_ip_address
|
@@ -1222,7 +1239,7 @@ module Aws::AutoScaling
|
|
1222
1239
|
#
|
1223
1240
|
#
|
1224
1241
|
#
|
1225
|
-
# [1]:
|
1242
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
|
1226
1243
|
# @return [Boolean]
|
1227
1244
|
#
|
1228
1245
|
# @!attribute [rw] placement_tenancy
|
@@ -1244,7 +1261,7 @@ module Aws::AutoScaling
|
|
1244
1261
|
#
|
1245
1262
|
#
|
1246
1263
|
#
|
1247
|
-
# [1]:
|
1264
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
|
1248
1265
|
# @return [String]
|
1249
1266
|
#
|
1250
1267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateLaunchConfigurationType AWS API Documentation
|
@@ -1297,8 +1314,29 @@ module Aws::AutoScaling
|
|
1297
1314
|
include Aws::Structure
|
1298
1315
|
end
|
1299
1316
|
|
1300
|
-
#
|
1301
|
-
# with Amazon EC2 Auto Scaling.
|
1317
|
+
# Represents a CloudWatch metric of your choosing for a target tracking
|
1318
|
+
# scaling policy to use with Amazon EC2 Auto Scaling.
|
1319
|
+
#
|
1320
|
+
# To create your customized metric specification:
|
1321
|
+
#
|
1322
|
+
# * Add values for each required parameter from CloudWatch. You can use
|
1323
|
+
# an existing metric, or a new metric that you create. To use your own
|
1324
|
+
# metric, you must first publish the metric to CloudWatch. For more
|
1325
|
+
# information, see [Publish Custom Metrics][1] in the *Amazon
|
1326
|
+
# CloudWatch User Guide*.
|
1327
|
+
#
|
1328
|
+
# * Choose a metric that changes proportionally with capacity. The value
|
1329
|
+
# of the metric should increase or decrease in inverse proportion to
|
1330
|
+
# the number of capacity units. That is, the value of the metric
|
1331
|
+
# should decrease when capacity increases.
|
1332
|
+
#
|
1333
|
+
# For more information about CloudWatch, see [Amazon CloudWatch
|
1334
|
+
# Concepts][2].
|
1335
|
+
#
|
1336
|
+
#
|
1337
|
+
#
|
1338
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html
|
1339
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html
|
1302
1340
|
#
|
1303
1341
|
# @note When making an API call, you may pass CustomizedMetricSpecification
|
1304
1342
|
# data as a hash:
|
@@ -1326,6 +1364,9 @@ module Aws::AutoScaling
|
|
1326
1364
|
#
|
1327
1365
|
# @!attribute [rw] dimensions
|
1328
1366
|
# The dimensions of the metric.
|
1367
|
+
#
|
1368
|
+
# Conditional: If you published your metric with dimensions, you must
|
1369
|
+
# specify the same dimensions in your scaling policy.
|
1329
1370
|
# @return [Array<Types::MetricDimension>]
|
1330
1371
|
#
|
1331
1372
|
# @!attribute [rw] statistic
|
@@ -1558,7 +1599,7 @@ module Aws::AutoScaling
|
|
1558
1599
|
#
|
1559
1600
|
# @!attribute [rw] max_records
|
1560
1601
|
# The maximum number of items to return with this call. The default
|
1561
|
-
# value is 50 and the maximum value is 50
|
1602
|
+
# value is `50` and the maximum value is `50`.
|
1562
1603
|
# @return [Integer]
|
1563
1604
|
#
|
1564
1605
|
# @!attribute [rw] next_token
|
@@ -1653,7 +1694,7 @@ module Aws::AutoScaling
|
|
1653
1694
|
#
|
1654
1695
|
# @!attribute [rw] max_records
|
1655
1696
|
# The maximum number of items to return with this call. The default
|
1656
|
-
# value is 100 and the maximum value is 100
|
1697
|
+
# value is `100` and the maximum value is `100`.
|
1657
1698
|
# @return [Integer]
|
1658
1699
|
#
|
1659
1700
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancerTargetGroupsRequest AWS API Documentation
|
@@ -1670,8 +1711,11 @@ module Aws::AutoScaling
|
|
1670
1711
|
# @return [Array<Types::LoadBalancerTargetGroupState>]
|
1671
1712
|
#
|
1672
1713
|
# @!attribute [rw] next_token
|
1673
|
-
#
|
1674
|
-
#
|
1714
|
+
# A string that indicates that the response contains more items than
|
1715
|
+
# can be returned in a single response. To receive additional items,
|
1716
|
+
# specify this string for the `NextToken` value when requesting the
|
1717
|
+
# next set of items. This value is null when there are no more items
|
1718
|
+
# to return.
|
1675
1719
|
# @return [String]
|
1676
1720
|
#
|
1677
1721
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancerTargetGroupsResponse AWS API Documentation
|
@@ -1702,7 +1746,7 @@ module Aws::AutoScaling
|
|
1702
1746
|
#
|
1703
1747
|
# @!attribute [rw] max_records
|
1704
1748
|
# The maximum number of items to return with this call. The default
|
1705
|
-
# value is 100 and the maximum value is 100
|
1749
|
+
# value is `100` and the maximum value is `100`.
|
1706
1750
|
# @return [Integer]
|
1707
1751
|
#
|
1708
1752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancersRequest AWS API Documentation
|
@@ -1719,8 +1763,11 @@ module Aws::AutoScaling
|
|
1719
1763
|
# @return [Array<Types::LoadBalancerState>]
|
1720
1764
|
#
|
1721
1765
|
# @!attribute [rw] next_token
|
1722
|
-
#
|
1723
|
-
#
|
1766
|
+
# A string that indicates that the response contains more items than
|
1767
|
+
# can be returned in a single response. To receive additional items,
|
1768
|
+
# specify this string for the `NextToken` value when requesting the
|
1769
|
+
# next set of items. This value is null when there are no more items
|
1770
|
+
# to return.
|
1724
1771
|
# @return [String]
|
1725
1772
|
#
|
1726
1773
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLoadBalancersResponse AWS API Documentation
|
@@ -1752,8 +1799,11 @@ module Aws::AutoScaling
|
|
1752
1799
|
# @return [Array<Types::NotificationConfiguration>]
|
1753
1800
|
#
|
1754
1801
|
# @!attribute [rw] next_token
|
1755
|
-
#
|
1756
|
-
#
|
1802
|
+
# A string that indicates that the response contains more items than
|
1803
|
+
# can be returned in a single response. To receive additional items,
|
1804
|
+
# specify this string for the `NextToken` value when requesting the
|
1805
|
+
# next set of items. This value is null when there are no more items
|
1806
|
+
# to return.
|
1757
1807
|
# @return [String]
|
1758
1808
|
#
|
1759
1809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeNotificationConfigurationsAnswer AWS API Documentation
|
@@ -1784,7 +1834,7 @@ module Aws::AutoScaling
|
|
1784
1834
|
#
|
1785
1835
|
# @!attribute [rw] max_records
|
1786
1836
|
# The maximum number of items to return with this call. The default
|
1787
|
-
# value is 50 and the maximum value is 100
|
1837
|
+
# value is `50` and the maximum value is `100`.
|
1788
1838
|
# @return [Integer]
|
1789
1839
|
#
|
1790
1840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeNotificationConfigurationsType AWS API Documentation
|
@@ -1819,8 +1869,8 @@ module Aws::AutoScaling
|
|
1819
1869
|
# @return [Array<String>]
|
1820
1870
|
#
|
1821
1871
|
# @!attribute [rw] policy_types
|
1822
|
-
# One or more policy types.
|
1823
|
-
# `StepScaling`.
|
1872
|
+
# One or more policy types. The valid values are `SimpleScaling`,
|
1873
|
+
# `StepScaling`, and `TargetTrackingScaling`.
|
1824
1874
|
# @return [Array<String>]
|
1825
1875
|
#
|
1826
1876
|
# @!attribute [rw] next_token
|
@@ -1830,7 +1880,7 @@ module Aws::AutoScaling
|
|
1830
1880
|
#
|
1831
1881
|
# @!attribute [rw] max_records
|
1832
1882
|
# The maximum number of items to be returned with each call. The
|
1833
|
-
# default value is 50 and the maximum value is 100
|
1883
|
+
# default value is `50` and the maximum value is `100`.
|
1834
1884
|
# @return [Integer]
|
1835
1885
|
#
|
1836
1886
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribePoliciesType AWS API Documentation
|
@@ -1868,7 +1918,7 @@ module Aws::AutoScaling
|
|
1868
1918
|
#
|
1869
1919
|
# @!attribute [rw] max_records
|
1870
1920
|
# The maximum number of items to return with this call. The default
|
1871
|
-
# value is 100 and the maximum value is 100
|
1921
|
+
# value is `100` and the maximum value is `100`.
|
1872
1922
|
# @return [Integer]
|
1873
1923
|
#
|
1874
1924
|
# @!attribute [rw] next_token
|
@@ -1926,7 +1976,7 @@ module Aws::AutoScaling
|
|
1926
1976
|
#
|
1927
1977
|
# @!attribute [rw] max_records
|
1928
1978
|
# The maximum number of items to return with this call. The default
|
1929
|
-
# value is 50 and the maximum value is 100
|
1979
|
+
# value is `50` and the maximum value is `100`.
|
1930
1980
|
# @return [Integer]
|
1931
1981
|
#
|
1932
1982
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeScheduledActionsType AWS API Documentation
|
@@ -1968,7 +2018,7 @@ module Aws::AutoScaling
|
|
1968
2018
|
#
|
1969
2019
|
# @!attribute [rw] max_records
|
1970
2020
|
# The maximum number of items to return with this call. The default
|
1971
|
-
# value is 50 and the maximum value is 100
|
2021
|
+
# value is `50` and the maximum value is `100`.
|
1972
2022
|
# @return [Integer]
|
1973
2023
|
#
|
1974
2024
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeTagsType AWS API Documentation
|
@@ -2138,7 +2188,8 @@ module Aws::AutoScaling
|
|
2138
2188
|
include Aws::Structure
|
2139
2189
|
end
|
2140
2190
|
|
2141
|
-
# Describes an Amazon EBS volume.
|
2191
|
+
# Describes an Amazon EBS volume. Used in combination with
|
2192
|
+
# BlockDeviceMapping.
|
2142
2193
|
#
|
2143
2194
|
# @note When making an API call, you may pass Ebs
|
2144
2195
|
# data as a hash:
|
@@ -2153,55 +2204,72 @@ module Aws::AutoScaling
|
|
2153
2204
|
# }
|
2154
2205
|
#
|
2155
2206
|
# @!attribute [rw] snapshot_id
|
2156
|
-
# The ID of the snapshot.
|
2207
|
+
# The ID of the snapshot. This parameter is optional if you specify a
|
2208
|
+
# volume size.
|
2157
2209
|
# @return [String]
|
2158
2210
|
#
|
2159
2211
|
# @!attribute [rw] volume_size
|
2160
|
-
# The volume size, in GiB.
|
2161
|
-
#
|
2162
|
-
#
|
2163
|
-
#
|
2164
|
-
# the
|
2212
|
+
# The volume size, in GiB.
|
2213
|
+
#
|
2214
|
+
# Constraints: 1-1,024 for `standard`, 4-16,384 for `io1`, 1-16,384
|
2215
|
+
# for `gp2`, and 500-16,384 for `st1` and `sc1`. If you specify a
|
2216
|
+
# snapshot, the volume size must be equal to or larger than the
|
2217
|
+
# snapshot size.
|
2165
2218
|
#
|
2166
2219
|
# Default: If you create a volume from a snapshot and you don't
|
2167
2220
|
# specify a volume size, the default is the snapshot size.
|
2221
|
+
#
|
2222
|
+
# <note markdown="1"> At least one of VolumeSize or SnapshotId is required.
|
2223
|
+
#
|
2224
|
+
# </note>
|
2168
2225
|
# @return [Integer]
|
2169
2226
|
#
|
2170
2227
|
# @!attribute [rw] volume_type
|
2171
|
-
# The volume type
|
2172
|
-
#
|
2228
|
+
# The volume type, which can be `standard` for Magnetic, `io1` for
|
2229
|
+
# Provisioned IOPS SSD, `gp2` for General Purpose SSD, `st1` for
|
2230
|
+
# Throughput Optimized HDD, or `sc1` for Cold HDD. For more
|
2231
|
+
# information, see [Amazon EBS Volume Types][1] in the *Amazon EC2
|
2232
|
+
# User Guide for Linux Instances*.
|
2173
2233
|
#
|
2174
|
-
# Valid values: `standard` \| `io1` \| `gp2`
|
2234
|
+
# Valid values: `standard` \| `io1` \| `gp2` \| `st1` \| `sc1`
|
2175
2235
|
#
|
2176
2236
|
#
|
2177
2237
|
#
|
2178
|
-
# [1]:
|
2238
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
|
2179
2239
|
# @return [String]
|
2180
2240
|
#
|
2181
2241
|
# @!attribute [rw] delete_on_termination
|
2182
2242
|
# Indicates whether the volume is deleted on instance termination. The
|
2183
|
-
# default is `true`.
|
2243
|
+
# default value is `true`.
|
2184
2244
|
# @return [Boolean]
|
2185
2245
|
#
|
2186
2246
|
# @!attribute [rw] iops
|
2187
2247
|
# The number of I/O operations per second (IOPS) to provision for the
|
2188
|
-
# volume.
|
2248
|
+
# volume. For more information, see [Amazon EBS Volume Types][1] in
|
2249
|
+
# the *Amazon EC2 User Guide for Linux Instances*.
|
2250
|
+
#
|
2251
|
+
# Conditional: This parameter is required when the volume type is
|
2252
|
+
# `io1`. (Not used with `standard`, `gp2`, `st1`, or `sc1` volumes.)
|
2253
|
+
#
|
2189
2254
|
#
|
2190
|
-
#
|
2255
|
+
#
|
2256
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
|
2191
2257
|
# @return [Integer]
|
2192
2258
|
#
|
2193
2259
|
# @!attribute [rw] encrypted
|
2194
|
-
#
|
2260
|
+
# Specifies whether the volume should be encrypted. Encrypted EBS
|
2195
2261
|
# volumes must be attached to instances that support Amazon EBS
|
2196
2262
|
# encryption. Volumes that are created from encrypted snapshots are
|
2197
2263
|
# automatically encrypted. There is no way to create an encrypted
|
2198
2264
|
# volume from an unencrypted snapshot or an unencrypted volume from an
|
2199
|
-
# encrypted snapshot.
|
2200
|
-
#
|
2265
|
+
# encrypted snapshot. If your AMI uses encrypted volumes, you can only
|
2266
|
+
# launch it on supported instance types. For more information, see
|
2267
|
+
# [Amazon EBS Encryption][1] in the *Amazon EC2 User Guide for Linux
|
2268
|
+
# Instances*.
|
2201
2269
|
#
|
2202
2270
|
#
|
2203
2271
|
#
|
2204
|
-
# [1]:
|
2272
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html
|
2205
2273
|
# @return [Boolean]
|
2206
2274
|
#
|
2207
2275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/Ebs AWS API Documentation
|
@@ -2370,7 +2438,7 @@ module Aws::AutoScaling
|
|
2370
2438
|
#
|
2371
2439
|
#
|
2372
2440
|
#
|
2373
|
-
# [1]:
|
2441
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
|
2374
2442
|
# @return [Boolean]
|
2375
2443
|
#
|
2376
2444
|
# @!attribute [rw] metric_value
|
@@ -2383,15 +2451,15 @@ module Aws::AutoScaling
|
|
2383
2451
|
# If you specify a metric value that doesn't correspond to a step
|
2384
2452
|
# adjustment for the policy, the call returns an error.
|
2385
2453
|
#
|
2386
|
-
# This parameter is required if the policy type is
|
2387
|
-
# not supported otherwise.
|
2454
|
+
# Conditional: This parameter is required if the policy type is
|
2455
|
+
# `StepScaling` and not supported otherwise.
|
2388
2456
|
# @return [Float]
|
2389
2457
|
#
|
2390
2458
|
# @!attribute [rw] breach_threshold
|
2391
2459
|
# The breach threshold for the alarm.
|
2392
2460
|
#
|
2393
|
-
# This parameter is required if the policy type is
|
2394
|
-
# not supported otherwise.
|
2461
|
+
# Conditional: This parameter is required if the policy type is
|
2462
|
+
# `StepScaling` and not supported otherwise.
|
2395
2463
|
# @return [Float]
|
2396
2464
|
#
|
2397
2465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ExecutePolicyType AWS API Documentation
|
@@ -2525,13 +2593,6 @@ module Aws::AutoScaling
|
|
2525
2593
|
# @!attribute [rw] protected_from_scale_in
|
2526
2594
|
# Indicates whether the instance is protected from termination by
|
2527
2595
|
# Amazon EC2 Auto Scaling when scaling in.
|
2528
|
-
#
|
2529
|
-
# For more information, see [Instance Protection][1] in the *Amazon
|
2530
|
-
# EC2 Auto Scaling User Guide*.
|
2531
|
-
#
|
2532
|
-
#
|
2533
|
-
#
|
2534
|
-
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
|
2535
2596
|
# @return [Boolean]
|
2536
2597
|
#
|
2537
2598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/Instance AWS API Documentation
|
@@ -2593,13 +2654,13 @@ module Aws::AutoScaling
|
|
2593
2654
|
# capacity.
|
2594
2655
|
#
|
2595
2656
|
# The only valid value is `prioritized`, which is also the default
|
2596
|
-
# value. This strategy uses the order of instance
|
2597
|
-
#
|
2598
|
-
#
|
2599
|
-
#
|
2600
|
-
#
|
2601
|
-
#
|
2602
|
-
#
|
2657
|
+
# value. This strategy uses the order of instance type overrides for
|
2658
|
+
# the LaunchTemplate to define the launch priority of each instance
|
2659
|
+
# type. The first instance type in the array is prioritized higher
|
2660
|
+
# than the last. If all your On-Demand capacity cannot be fulfilled
|
2661
|
+
# using your highest priority instance, then the Auto Scaling groups
|
2662
|
+
# launches the remaining capacity using the second priority instance
|
2663
|
+
# type, and so on.
|
2603
2664
|
# @return [String]
|
2604
2665
|
#
|
2605
2666
|
# @!attribute [rw] on_demand_base_capacity
|
@@ -2607,18 +2668,18 @@ module Aws::AutoScaling
|
|
2607
2668
|
# be fulfilled by On-Demand Instances. This base portion is
|
2608
2669
|
# provisioned first as your group scales.
|
2609
2670
|
#
|
2610
|
-
# The default value is 0
|
2671
|
+
# The default value is `0`. If you leave this parameter set to `0`,
|
2611
2672
|
# On-Demand Instances are launched as a percentage of the Auto Scaling
|
2612
2673
|
# group's desired capacity, per the
|
2613
|
-
#
|
2674
|
+
# `OnDemandPercentageAboveBaseCapacity` setting.
|
2614
2675
|
# @return [Integer]
|
2615
2676
|
#
|
2616
2677
|
# @!attribute [rw] on_demand_percentage_above_base_capacity
|
2617
2678
|
# Controls the percentages of On-Demand Instances and Spot Instances
|
2618
|
-
# for your additional capacity beyond
|
2679
|
+
# for your additional capacity beyond `OnDemandBaseCapacity`.
|
2619
2680
|
#
|
2620
|
-
# The range is 0–100. The default value is 100
|
2621
|
-
# parameter set to 100
|
2681
|
+
# The range is 0–100. The default value is `100`. If you leave this
|
2682
|
+
# parameter set to `100`, the percentages are 100% for On-Demand
|
2622
2683
|
# Instances and 0% for Spot Instances.
|
2623
2684
|
# @return [Integer]
|
2624
2685
|
#
|
@@ -2634,7 +2695,7 @@ module Aws::AutoScaling
|
|
2634
2695
|
# @!attribute [rw] spot_instance_pools
|
2635
2696
|
# The number of Spot pools to use to allocate your Spot capacity. The
|
2636
2697
|
# Spot pools are determined from the different instance types in the
|
2637
|
-
#
|
2698
|
+
# Overrides array of LaunchTemplate.
|
2638
2699
|
#
|
2639
2700
|
# The range is 1–20 and the default is 2.
|
2640
2701
|
# @return [Integer]
|
@@ -2693,22 +2754,24 @@ module Aws::AutoScaling
|
|
2693
2754
|
#
|
2694
2755
|
#
|
2695
2756
|
#
|
2696
|
-
# [1]:
|
2697
|
-
# [2]:
|
2757
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
2758
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
|
2698
2759
|
# @return [String]
|
2699
2760
|
#
|
2700
2761
|
# @!attribute [rw] classic_link_vpc_security_groups
|
2701
2762
|
# The IDs of one or more security groups for the VPC specified in
|
2702
|
-
# `ClassicLinkVPCId`.
|
2703
|
-
#
|
2704
|
-
#
|
2705
|
-
#
|
2706
|
-
#
|
2763
|
+
# `ClassicLinkVPCId`. For more information, see [ClassicLink][1] in
|
2764
|
+
# the *Amazon EC2 User Guide for Linux Instances* and [Linking
|
2765
|
+
# EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
|
2766
|
+
# User Guide*.
|
2767
|
+
#
|
2768
|
+
# Conditional: This parameter is required if you specify a
|
2769
|
+
# ClassicLink-enabled VPC, and cannot be used otherwise.
|
2707
2770
|
#
|
2708
2771
|
#
|
2709
2772
|
#
|
2710
|
-
# [1]:
|
2711
|
-
# [2]:
|
2773
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
|
2774
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
|
2712
2775
|
# @return [Array<String>]
|
2713
2776
|
#
|
2714
2777
|
# @!attribute [rw] user_data
|
@@ -2830,7 +2893,7 @@ module Aws::AutoScaling
|
|
2830
2893
|
#
|
2831
2894
|
# @!attribute [rw] max_records
|
2832
2895
|
# The maximum number of items to return with this call. The default
|
2833
|
-
# value is 50 and the maximum value is 100
|
2896
|
+
# value is `50` and the maximum value is `100`.
|
2834
2897
|
# @return [Integer]
|
2835
2898
|
#
|
2836
2899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchConfigurationNamesType AWS API Documentation
|
@@ -2847,8 +2910,11 @@ module Aws::AutoScaling
|
|
2847
2910
|
# @return [Array<Types::LaunchConfiguration>]
|
2848
2911
|
#
|
2849
2912
|
# @!attribute [rw] next_token
|
2850
|
-
#
|
2851
|
-
#
|
2913
|
+
# A string that indicates that the response contains more items than
|
2914
|
+
# can be returned in a single response. To receive additional items,
|
2915
|
+
# specify this string for the `NextToken` value when requesting the
|
2916
|
+
# next set of items. This value is null when there are no more items
|
2917
|
+
# to return.
|
2852
2918
|
# @return [String]
|
2853
2919
|
#
|
2854
2920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchConfigurationsType AWS API Documentation
|
@@ -2919,7 +2985,7 @@ module Aws::AutoScaling
|
|
2919
2985
|
#
|
2920
2986
|
#
|
2921
2987
|
#
|
2922
|
-
# [1]:
|
2988
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
|
2923
2989
|
# @return [String]
|
2924
2990
|
#
|
2925
2991
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LaunchTemplateOverrides AWS API Documentation
|
@@ -2933,12 +2999,12 @@ module Aws::AutoScaling
|
|
2933
2999
|
#
|
2934
3000
|
# The launch template that is specified must be configured for use with
|
2935
3001
|
# an Auto Scaling group. For more information, see [Creating a Launch
|
2936
|
-
# Template for an Auto Scaling
|
3002
|
+
# Template for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling
|
2937
3003
|
# User Guide*.
|
2938
3004
|
#
|
2939
3005
|
#
|
2940
3006
|
#
|
2941
|
-
# [1]:
|
3007
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
2942
3008
|
#
|
2943
3009
|
# @note When making an API call, you may pass LaunchTemplateSpecification
|
2944
3010
|
# data as a hash:
|
@@ -2979,14 +3045,8 @@ module Aws::AutoScaling
|
|
2979
3045
|
|
2980
3046
|
# Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that
|
2981
3047
|
# you want to perform an action whenever it launches instances or
|
2982
|
-
# whenever it terminates instances.
|
2983
|
-
#
|
2984
|
-
# For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
|
2985
|
-
# in the *Amazon EC2 Auto Scaling User Guide*.
|
2986
|
-
#
|
2987
|
-
#
|
2988
|
-
#
|
2989
|
-
# [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
|
3048
|
+
# whenever it terminates instances. Used in response to
|
3049
|
+
# DescribeLifecycleHooks.
|
2990
3050
|
#
|
2991
3051
|
# @!attribute [rw] lifecycle_hook_name
|
2992
3052
|
# The name of the lifecycle hook.
|
@@ -3018,15 +3078,15 @@ module Aws::AutoScaling
|
|
3018
3078
|
# @return [String]
|
3019
3079
|
#
|
3020
3080
|
# @!attribute [rw] notification_metadata
|
3021
|
-
# Additional information that
|
3022
|
-
#
|
3081
|
+
# Additional information that is included any time Amazon EC2 Auto
|
3082
|
+
# Scaling sends a message to the notification target.
|
3023
3083
|
# @return [String]
|
3024
3084
|
#
|
3025
3085
|
# @!attribute [rw] heartbeat_timeout
|
3026
3086
|
# The maximum time, in seconds, that can elapse before the lifecycle
|
3027
3087
|
# hook times out. If the lifecycle hook times out, Amazon EC2 Auto
|
3028
|
-
# Scaling performs the
|
3029
|
-
#
|
3088
|
+
# Scaling performs the action that you specified in the
|
3089
|
+
# `DefaultResult` parameter.
|
3030
3090
|
# @return [Integer]
|
3031
3091
|
#
|
3032
3092
|
# @!attribute [rw] global_timeout
|
@@ -3039,8 +3099,7 @@ module Aws::AutoScaling
|
|
3039
3099
|
# @!attribute [rw] default_result
|
3040
3100
|
# Defines the action the Auto Scaling group should take when the
|
3041
3101
|
# lifecycle hook timeout elapses or if an unexpected failure occurs.
|
3042
|
-
# The
|
3043
|
-
# `CONTINUE`.
|
3102
|
+
# The possible values are `CONTINUE` and `ABANDON`.
|
3044
3103
|
# @return [String]
|
3045
3104
|
#
|
3046
3105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LifecycleHook AWS API Documentation
|
@@ -3058,16 +3117,47 @@ module Aws::AutoScaling
|
|
3058
3117
|
include Aws::Structure
|
3059
3118
|
end
|
3060
3119
|
|
3061
|
-
# Describes a lifecycle hook
|
3062
|
-
#
|
3063
|
-
#
|
3120
|
+
# Describes a lifecycle hook. Used in combination with
|
3121
|
+
# CreateAutoScalingGroup.
|
3122
|
+
#
|
3123
|
+
# A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on
|
3124
|
+
# an instance when the instance launches (before it is put into service)
|
3125
|
+
# or as the instance terminates (before it is fully terminated).
|
3126
|
+
#
|
3127
|
+
# This step is a part of the procedure for creating a lifecycle hook for
|
3128
|
+
# an Auto Scaling group:
|
3129
|
+
#
|
3130
|
+
# 1. (Optional) Create a Lambda function and a rule that allows
|
3131
|
+
# CloudWatch Events to invoke your Lambda function when Amazon EC2
|
3132
|
+
# Auto Scaling launches or terminates instances.
|
3133
|
+
#
|
3134
|
+
# 2. (Optional) Create a notification target and an IAM role. The
|
3135
|
+
# target can be either an Amazon SQS queue or an Amazon SNS topic.
|
3136
|
+
# The role allows Amazon EC2 Auto Scaling to publish lifecycle
|
3137
|
+
# notifications to the target.
|
3138
|
+
#
|
3139
|
+
# 3. **Create the lifecycle hook. Specify whether the hook is used when
|
3140
|
+
# the instances launch or terminate.**
|
3141
|
+
#
|
3142
|
+
# 4. If you need more time, record the lifecycle action heartbeat to
|
3143
|
+
# keep the instance in a pending state using using
|
3144
|
+
# RecordLifecycleActionHeartbeat.
|
3145
|
+
#
|
3146
|
+
# 5. If you finish before the timeout period ends, complete the
|
3147
|
+
# lifecycle action using CompleteLifecycleAction.
|
3064
3148
|
#
|
3065
3149
|
# For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
|
3066
3150
|
# in the *Amazon EC2 Auto Scaling User Guide*.
|
3067
3151
|
#
|
3152
|
+
# You can view the lifecycle hooks for an Auto Scaling group using
|
3153
|
+
# DescribeLifecycleHooks. You can modify an existing lifecycle hook or
|
3154
|
+
# create new lifecycle hooks using PutLifecycleHook. If you are no
|
3155
|
+
# longer using a lifecycle hook, you can delete it using
|
3156
|
+
# DeleteLifecycleHook.
|
3068
3157
|
#
|
3069
3158
|
#
|
3070
|
-
#
|
3159
|
+
#
|
3160
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
|
3071
3161
|
#
|
3072
3162
|
# @note When making an API call, you may pass LifecycleHookSpecification
|
3073
3163
|
# data as a hash:
|
@@ -3088,7 +3178,7 @@ module Aws::AutoScaling
|
|
3088
3178
|
#
|
3089
3179
|
# @!attribute [rw] lifecycle_transition
|
3090
3180
|
# The state of the EC2 instance to which you want to attach the
|
3091
|
-
# lifecycle hook. The
|
3181
|
+
# lifecycle hook. The valid values are:
|
3092
3182
|
#
|
3093
3183
|
# * autoscaling:EC2\_INSTANCE\_LAUNCHING
|
3094
3184
|
#
|
@@ -3102,15 +3192,19 @@ module Aws::AutoScaling
|
|
3102
3192
|
#
|
3103
3193
|
# @!attribute [rw] heartbeat_timeout
|
3104
3194
|
# The maximum time, in seconds, that can elapse before the lifecycle
|
3105
|
-
# hook times out.
|
3106
|
-
#
|
3107
|
-
# hook
|
3195
|
+
# hook times out.
|
3196
|
+
#
|
3197
|
+
# If the lifecycle hook times out, Amazon EC2 Auto Scaling performs
|
3198
|
+
# the action that you specified in the `DefaultResult` parameter. You
|
3199
|
+
# can prevent the lifecycle hook from timing out by calling
|
3200
|
+
# RecordLifecycleActionHeartbeat.
|
3108
3201
|
# @return [Integer]
|
3109
3202
|
#
|
3110
3203
|
# @!attribute [rw] default_result
|
3111
3204
|
# Defines the action the Auto Scaling group should take when the
|
3112
3205
|
# lifecycle hook timeout elapses or if an unexpected failure occurs.
|
3113
|
-
# The valid values are `CONTINUE` and `ABANDON`.
|
3206
|
+
# The valid values are `CONTINUE` and `ABANDON`. The default value is
|
3207
|
+
# `ABANDON`.
|
3114
3208
|
# @return [String]
|
3115
3209
|
#
|
3116
3210
|
# @!attribute [rw] notification_target_arn
|
@@ -3122,7 +3216,8 @@ module Aws::AutoScaling
|
|
3122
3216
|
#
|
3123
3217
|
# @!attribute [rw] role_arn
|
3124
3218
|
# The ARN of the IAM role that allows the Auto Scaling group to
|
3125
|
-
# publish to the specified notification target
|
3219
|
+
# publish to the specified notification target, for example, an Amazon
|
3220
|
+
# SNS topic or an Amazon SQS queue.
|
3126
3221
|
# @return [String]
|
3127
3222
|
#
|
3128
3223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/LifecycleHookSpecification AWS API Documentation
|
@@ -3298,8 +3393,9 @@ module Aws::AutoScaling
|
|
3298
3393
|
# Describes a mixed instances policy for an Auto Scaling group. With
|
3299
3394
|
# mixed instances, your Auto Scaling group can provision a combination
|
3300
3395
|
# of On-Demand Instances and Spot Instances across multiple instance
|
3301
|
-
# types.
|
3302
|
-
#
|
3396
|
+
# types. Used in combination with CreateAutoScalingGroup. For more
|
3397
|
+
# information, see [Using Multiple Instance Types and Purchase
|
3398
|
+
# Options][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
3303
3399
|
#
|
3304
3400
|
# When you create your Auto Scaling group, you can specify a launch
|
3305
3401
|
# configuration or template as a parameter for the top-level object, or
|
@@ -3308,7 +3404,7 @@ module Aws::AutoScaling
|
|
3308
3404
|
#
|
3309
3405
|
#
|
3310
3406
|
#
|
3311
|
-
# [1]:
|
3407
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options
|
3312
3408
|
#
|
3313
3409
|
# @note When making an API call, you may pass MixedInstancesPolicy
|
3314
3410
|
# data as a hash:
|
@@ -3398,8 +3494,11 @@ module Aws::AutoScaling
|
|
3398
3494
|
# @return [Array<Types::ScalingPolicy>]
|
3399
3495
|
#
|
3400
3496
|
# @!attribute [rw] next_token
|
3401
|
-
#
|
3402
|
-
#
|
3497
|
+
# A string that indicates that the response contains more items than
|
3498
|
+
# can be returned in a single response. To receive additional items,
|
3499
|
+
# specify this string for the `NextToken` value when requesting the
|
3500
|
+
# next set of items. This value is null when there are no more items
|
3501
|
+
# to return.
|
3403
3502
|
# @return [String]
|
3404
3503
|
#
|
3405
3504
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PoliciesType AWS API Documentation
|
@@ -3417,7 +3516,8 @@ module Aws::AutoScaling
|
|
3417
3516
|
# @return [String]
|
3418
3517
|
#
|
3419
3518
|
# @!attribute [rw] alarms
|
3420
|
-
# The CloudWatch alarms created for the target tracking
|
3519
|
+
# The CloudWatch alarms created for the target tracking scaling
|
3520
|
+
# policy.
|
3421
3521
|
# @return [Array<Types::Alarm>]
|
3422
3522
|
#
|
3423
3523
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/PolicyARNType AWS API Documentation
|
@@ -3428,7 +3528,8 @@ module Aws::AutoScaling
|
|
3428
3528
|
include Aws::Structure
|
3429
3529
|
end
|
3430
3530
|
|
3431
|
-
#
|
3531
|
+
# Represents a predefined metric for a target tracking scaling policy to
|
3532
|
+
# use with Amazon EC2 Auto Scaling.
|
3432
3533
|
#
|
3433
3534
|
# @note When making an API call, you may pass PredefinedMetricSpecification
|
3434
3535
|
# data as a hash:
|
@@ -3488,7 +3589,7 @@ module Aws::AutoScaling
|
|
3488
3589
|
#
|
3489
3590
|
#
|
3490
3591
|
#
|
3491
|
-
# [1]:
|
3592
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types
|
3492
3593
|
#
|
3493
3594
|
# @!attribute [rw] process_name
|
3494
3595
|
# One of the following processes:
|
@@ -3556,30 +3657,32 @@ module Aws::AutoScaling
|
|
3556
3657
|
#
|
3557
3658
|
# @!attribute [rw] lifecycle_transition
|
3558
3659
|
# The instance state to which you want to attach the lifecycle hook.
|
3559
|
-
# The
|
3660
|
+
# The valid values are:
|
3560
3661
|
#
|
3561
3662
|
# * autoscaling:EC2\_INSTANCE\_LAUNCHING
|
3562
3663
|
#
|
3563
3664
|
# * autoscaling:EC2\_INSTANCE\_TERMINATING
|
3564
3665
|
#
|
3565
|
-
# This parameter is required for new lifecycle hooks, but
|
3566
|
-
# when updating existing hooks.
|
3666
|
+
# Conditional: This parameter is required for new lifecycle hooks, but
|
3667
|
+
# optional when updating existing hooks.
|
3567
3668
|
# @return [String]
|
3568
3669
|
#
|
3569
3670
|
# @!attribute [rw] role_arn
|
3570
3671
|
# The ARN of the IAM role that allows the Auto Scaling group to
|
3571
|
-
# publish to the specified notification target
|
3672
|
+
# publish to the specified notification target, for example, an Amazon
|
3673
|
+
# SNS topic or an Amazon SQS queue.
|
3572
3674
|
#
|
3573
|
-
# This parameter is required for new lifecycle hooks, but
|
3574
|
-
# when updating existing hooks.
|
3675
|
+
# Conditional: This parameter is required for new lifecycle hooks, but
|
3676
|
+
# optional when updating existing hooks.
|
3575
3677
|
# @return [String]
|
3576
3678
|
#
|
3577
3679
|
# @!attribute [rw] notification_target_arn
|
3578
3680
|
# The ARN of the notification target that Amazon EC2 Auto Scaling uses
|
3579
3681
|
# to notify you when an instance is in the transition state for the
|
3580
3682
|
# lifecycle hook. This target can be either an SQS queue or an SNS
|
3581
|
-
# topic.
|
3582
|
-
#
|
3683
|
+
# topic.
|
3684
|
+
#
|
3685
|
+
# If you specify an empty string, this overrides the current ARN.
|
3583
3686
|
#
|
3584
3687
|
# This operation uses the JSON format when sending notifications to an
|
3585
3688
|
# Amazon SQS queue, and an email key-value pair format when sending
|
@@ -3592,18 +3695,19 @@ module Aws::AutoScaling
|
|
3592
3695
|
# @return [String]
|
3593
3696
|
#
|
3594
3697
|
# @!attribute [rw] notification_metadata
|
3595
|
-
#
|
3596
|
-
#
|
3698
|
+
# Additional information that you want to include any time Amazon EC2
|
3699
|
+
# Auto Scaling sends a message to the notification target.
|
3597
3700
|
# @return [String]
|
3598
3701
|
#
|
3599
3702
|
# @!attribute [rw] heartbeat_timeout
|
3600
3703
|
# The maximum time, in seconds, that can elapse before the lifecycle
|
3601
|
-
# hook times out. The range is from 30 to 7200 seconds. The
|
3602
|
-
# 3600 seconds (1 hour).
|
3704
|
+
# hook times out. The range is from `30` to `7200` seconds. The
|
3705
|
+
# default value is `3600` seconds (1 hour).
|
3603
3706
|
#
|
3604
3707
|
# If the lifecycle hook times out, Amazon EC2 Auto Scaling performs
|
3605
|
-
# the
|
3606
|
-
# out by calling
|
3708
|
+
# the action that you specified in the `DefaultResult` parameter. You
|
3709
|
+
# can prevent the lifecycle hook from timing out by calling
|
3710
|
+
# RecordLifecycleActionHeartbeat.
|
3607
3711
|
# @return [Integer]
|
3608
3712
|
#
|
3609
3713
|
# @!attribute [rw] default_result
|
@@ -3729,7 +3833,7 @@ module Aws::AutoScaling
|
|
3729
3833
|
#
|
3730
3834
|
#
|
3731
3835
|
#
|
3732
|
-
# [1]:
|
3836
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
|
3733
3837
|
# @return [String]
|
3734
3838
|
#
|
3735
3839
|
# @!attribute [rw] min_adjustment_step
|
@@ -3752,8 +3856,8 @@ module Aws::AutoScaling
|
|
3752
3856
|
# type. A positive value adds to the current capacity while a negative
|
3753
3857
|
# number removes from the current capacity.
|
3754
3858
|
#
|
3755
|
-
# This parameter is required if the policy type is
|
3756
|
-
# not supported otherwise.
|
3859
|
+
# Conditional: This parameter is required if the policy type is
|
3860
|
+
# `SimpleScaling` and not supported otherwise.
|
3757
3861
|
# @return [Integer]
|
3758
3862
|
#
|
3759
3863
|
# @!attribute [rw] cooldown
|
@@ -3768,7 +3872,7 @@ module Aws::AutoScaling
|
|
3768
3872
|
#
|
3769
3873
|
#
|
3770
3874
|
#
|
3771
|
-
# [1]:
|
3875
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
|
3772
3876
|
# @return [Integer]
|
3773
3877
|
#
|
3774
3878
|
# @!attribute [rw] metric_aggregation_type
|
@@ -3783,8 +3887,8 @@ module Aws::AutoScaling
|
|
3783
3887
|
# A set of adjustments that enable you to scale based on the size of
|
3784
3888
|
# the alarm breach.
|
3785
3889
|
#
|
3786
|
-
# This parameter is required if the policy type is
|
3787
|
-
# not supported otherwise.
|
3890
|
+
# Conditional: This parameter is required if the policy type is
|
3891
|
+
# `StepScaling` and not supported otherwise.
|
3788
3892
|
# @return [Array<Types::StepAdjustment>]
|
3789
3893
|
#
|
3790
3894
|
# @!attribute [rw] estimated_instance_warmup
|
@@ -3797,9 +3901,10 @@ module Aws::AutoScaling
|
|
3797
3901
|
# @return [Integer]
|
3798
3902
|
#
|
3799
3903
|
# @!attribute [rw] target_tracking_configuration
|
3800
|
-
# A target tracking policy.
|
3904
|
+
# A target tracking scaling policy. Includes support for predefined or
|
3905
|
+
# customized metrics.
|
3801
3906
|
#
|
3802
|
-
# This parameter is required if the policy type is
|
3907
|
+
# Conditional: This parameter is required if the policy type is
|
3803
3908
|
# `TargetTrackingScaling` and not supported otherwise.
|
3804
3909
|
# @return [Types::TargetTrackingConfiguration]
|
3805
3910
|
#
|
@@ -3849,8 +3954,8 @@ module Aws::AutoScaling
|
|
3849
3954
|
# @return [Time]
|
3850
3955
|
#
|
3851
3956
|
# @!attribute [rw] start_time
|
3852
|
-
# The time for this action to start, in
|
3853
|
-
#
|
3957
|
+
# The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in
|
3958
|
+
# UTC/GMT only and in quotes (for example, `"2019-06-01T00:00:00Z"`).
|
3854
3959
|
#
|
3855
3960
|
# If you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling
|
3856
3961
|
# performs the action at this time, and then performs the action based
|
@@ -3869,7 +3974,8 @@ module Aws::AutoScaling
|
|
3869
3974
|
# The recurring schedule for this action, in Unix cron syntax format.
|
3870
3975
|
# This format consists of five fields separated by white spaces:
|
3871
3976
|
# \[Minute\] \[Hour\] \[Day\_of\_Month\] \[Month\_of\_Year\]
|
3872
|
-
# \[Day\_of\_Week\].
|
3977
|
+
# \[Day\_of\_Week\]. The value must be in quotes (for example, `"30 0
|
3978
|
+
# 1 1,6,12 *"`). For more information about this format, see
|
3873
3979
|
# [Crontab][1].
|
3874
3980
|
#
|
3875
3981
|
#
|
@@ -3962,13 +4068,14 @@ module Aws::AutoScaling
|
|
3962
4068
|
# @return [String]
|
3963
4069
|
#
|
3964
4070
|
# @!attribute [rw] policy_type
|
3965
|
-
# The policy type.
|
4071
|
+
# The policy type. The valid values are `SimpleScaling` and
|
4072
|
+
# `StepScaling`.
|
3966
4073
|
# @return [String]
|
3967
4074
|
#
|
3968
4075
|
# @!attribute [rw] adjustment_type
|
3969
4076
|
# The adjustment type, which specifies how `ScalingAdjustment` is
|
3970
|
-
# interpreted.
|
3971
|
-
# and `PercentChangeInCapacity`.
|
4077
|
+
# interpreted. The valid values are `ChangeInCapacity`,
|
4078
|
+
# `ExactCapacity`, and `PercentChangeInCapacity`.
|
3972
4079
|
# @return [String]
|
3973
4080
|
#
|
3974
4081
|
# @!attribute [rw] min_adjustment_step
|
@@ -4000,8 +4107,8 @@ module Aws::AutoScaling
|
|
4000
4107
|
# @return [Array<Types::StepAdjustment>]
|
4001
4108
|
#
|
4002
4109
|
# @!attribute [rw] metric_aggregation_type
|
4003
|
-
# The aggregation type for the CloudWatch metrics.
|
4004
|
-
# `Minimum`, `Maximum`, and `Average`.
|
4110
|
+
# The aggregation type for the CloudWatch metrics. The valid values
|
4111
|
+
# are `Minimum`, `Maximum`, and `Average`.
|
4005
4112
|
# @return [String]
|
4006
4113
|
#
|
4007
4114
|
# @!attribute [rw] estimated_instance_warmup
|
@@ -4014,7 +4121,7 @@ module Aws::AutoScaling
|
|
4014
4121
|
# @return [Array<Types::Alarm>]
|
4015
4122
|
#
|
4016
4123
|
# @!attribute [rw] target_tracking_configuration
|
4017
|
-
# A target tracking policy.
|
4124
|
+
# A target tracking scaling policy.
|
4018
4125
|
# @return [Types::TargetTrackingConfiguration]
|
4019
4126
|
#
|
4020
4127
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ScalingPolicy AWS API Documentation
|
@@ -4083,8 +4190,11 @@ module Aws::AutoScaling
|
|
4083
4190
|
# @return [Array<Types::ScheduledUpdateGroupAction>]
|
4084
4191
|
#
|
4085
4192
|
# @!attribute [rw] next_token
|
4086
|
-
#
|
4087
|
-
#
|
4193
|
+
# A string that indicates that the response contains more items than
|
4194
|
+
# can be returned in a single response. To receive additional items,
|
4195
|
+
# specify this string for the `NextToken` value when requesting the
|
4196
|
+
# next set of items. This value is null when there are no more items
|
4197
|
+
# to return.
|
4088
4198
|
# @return [String]
|
4089
4199
|
#
|
4090
4200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/ScheduledActionsType AWS API Documentation
|
@@ -4115,16 +4225,14 @@ module Aws::AutoScaling
|
|
4115
4225
|
# @return [Time]
|
4116
4226
|
#
|
4117
4227
|
# @!attribute [rw] start_time
|
4118
|
-
# The date and time that the action is scheduled to begin.
|
4119
|
-
# and time can be up to one month in the future.
|
4228
|
+
# The date and time that the action is scheduled to begin.
|
4120
4229
|
#
|
4121
4230
|
# When `StartTime` and `EndTime` are specified with `Recurrence`, they
|
4122
4231
|
# form the boundaries of when the recurring action starts and stops.
|
4123
4232
|
# @return [Time]
|
4124
4233
|
#
|
4125
4234
|
# @!attribute [rw] end_time
|
4126
|
-
# The date and time that the action is scheduled to end.
|
4127
|
-
# time can be up to one month in the future.
|
4235
|
+
# The date and time that the action is scheduled to end.
|
4128
4236
|
# @return [Time]
|
4129
4237
|
#
|
4130
4238
|
# @!attribute [rw] recurrence
|
@@ -4184,8 +4292,8 @@ module Aws::AutoScaling
|
|
4184
4292
|
# @return [String]
|
4185
4293
|
#
|
4186
4294
|
# @!attribute [rw] start_time
|
4187
|
-
# The time for the action to start, in
|
4188
|
-
#
|
4295
|
+
# The time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in
|
4296
|
+
# UTC/GMT only and in quotes (for example, `"2019-06-01T00:00:00Z"`).
|
4189
4297
|
#
|
4190
4298
|
# If you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling
|
4191
4299
|
# performs the action at this time, and then performs the action based
|
@@ -4204,7 +4312,8 @@ module Aws::AutoScaling
|
|
4204
4312
|
# The recurring schedule for the action, in Unix cron syntax format.
|
4205
4313
|
# This format consists of five fields separated by white spaces:
|
4206
4314
|
# \[Minute\] \[Hour\] \[Day\_of\_Month\] \[Month\_of\_Year\]
|
4207
|
-
# \[Day\_of\_Week\].
|
4315
|
+
# \[Day\_of\_Week\]. The value must be in quotes (for example, `"30 0
|
4316
|
+
# 1 1,6,12 *"`). For more information about this format, see
|
4208
4317
|
# [Crontab][1].
|
4209
4318
|
#
|
4210
4319
|
#
|
@@ -4348,7 +4457,7 @@ module Aws::AutoScaling
|
|
4348
4457
|
|
4349
4458
|
# Describes an adjustment based on the difference between the value of
|
4350
4459
|
# the aggregated CloudWatch metric and the breach threshold that you've
|
4351
|
-
# defined for the alarm.
|
4460
|
+
# defined for the alarm. Used in combination with PutScalingPolicy.
|
4352
4461
|
#
|
4353
4462
|
# For the following examples, suppose that you have an alarm with a
|
4354
4463
|
# breach threshold of 50:
|
@@ -4525,8 +4634,11 @@ module Aws::AutoScaling
|
|
4525
4634
|
# @return [Array<Types::TagDescription>]
|
4526
4635
|
#
|
4527
4636
|
# @!attribute [rw] next_token
|
4528
|
-
#
|
4529
|
-
#
|
4637
|
+
# A string that indicates that the response contains more items than
|
4638
|
+
# can be returned in a single response. To receive additional items,
|
4639
|
+
# specify this string for the `NextToken` value when requesting the
|
4640
|
+
# next set of items. This value is null when there are no more items
|
4641
|
+
# to return.
|
4530
4642
|
# @return [String]
|
4531
4643
|
#
|
4532
4644
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/TagsType AWS API Documentation
|
@@ -4537,8 +4649,8 @@ module Aws::AutoScaling
|
|
4537
4649
|
include Aws::Structure
|
4538
4650
|
end
|
4539
4651
|
|
4540
|
-
# Represents a target tracking policy configuration to use with
|
4541
|
-
# EC2 Auto Scaling.
|
4652
|
+
# Represents a target tracking scaling policy configuration to use with
|
4653
|
+
# Amazon EC2 Auto Scaling.
|
4542
4654
|
#
|
4543
4655
|
# @note When making an API call, you may pass TargetTrackingConfiguration
|
4544
4656
|
# data as a hash:
|
@@ -4570,7 +4682,8 @@ module Aws::AutoScaling
|
|
4570
4682
|
# @return [Types::PredefinedMetricSpecification]
|
4571
4683
|
#
|
4572
4684
|
# @!attribute [rw] customized_metric_specification
|
4573
|
-
# A customized metric.
|
4685
|
+
# A customized metric. You can specify either a predefined metric or a
|
4686
|
+
# customized metric.
|
4574
4687
|
# @return [Types::CustomizedMetricSpecification]
|
4575
4688
|
#
|
4576
4689
|
# @!attribute [rw] target_value
|
@@ -4578,11 +4691,11 @@ module Aws::AutoScaling
|
|
4578
4691
|
# @return [Float]
|
4579
4692
|
#
|
4580
4693
|
# @!attribute [rw] disable_scale_in
|
4581
|
-
# Indicates whether scaling in by the target tracking policy
|
4582
|
-
# disabled. If scaling in is disabled, the target tracking
|
4583
|
-
# doesn't remove instances from the Auto Scaling group.
|
4584
|
-
# the target tracking policy can remove instances
|
4585
|
-
# Scaling group. The default is disabled.
|
4694
|
+
# Indicates whether scaling in by the target tracking scaling policy
|
4695
|
+
# is disabled. If scaling in is disabled, the target tracking scaling
|
4696
|
+
# policy doesn't remove instances from the Auto Scaling group.
|
4697
|
+
# Otherwise, the target tracking scaling policy can remove instances
|
4698
|
+
# from the Auto Scaling group. The default is disabled.
|
4586
4699
|
# @return [Boolean]
|
4587
4700
|
#
|
4588
4701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/TargetTrackingConfiguration AWS API Documentation
|
@@ -4686,6 +4799,13 @@ module Aws::AutoScaling
|
|
4686
4799
|
# The mixed instances policy to use to specify the updates. If you
|
4687
4800
|
# specify this parameter, you can't specify a launch configuration or
|
4688
4801
|
# a launch template.
|
4802
|
+
#
|
4803
|
+
# For more information, see [Using Multiple Instance Types and
|
4804
|
+
# Purchase Options][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
4805
|
+
#
|
4806
|
+
#
|
4807
|
+
#
|
4808
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options
|
4689
4809
|
# @return [Types::MixedInstancesPolicy]
|
4690
4810
|
#
|
4691
4811
|
# @!attribute [rw] min_size
|
@@ -4705,14 +4825,15 @@ module Aws::AutoScaling
|
|
4705
4825
|
#
|
4706
4826
|
# @!attribute [rw] default_cooldown
|
4707
4827
|
# The amount of time, in seconds, after a scaling activity completes
|
4708
|
-
# before another scaling activity can start. The default is
|
4828
|
+
# before another scaling activity can start. The default value is
|
4829
|
+
# `300`.
|
4709
4830
|
#
|
4710
4831
|
# For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
|
4711
4832
|
# Auto Scaling User Guide*.
|
4712
4833
|
#
|
4713
4834
|
#
|
4714
4835
|
#
|
4715
|
-
# [1]:
|
4836
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
|
4716
4837
|
# @return [Integer]
|
4717
4838
|
#
|
4718
4839
|
# @!attribute [rw] availability_zones
|
@@ -4727,40 +4848,38 @@ module Aws::AutoScaling
|
|
4727
4848
|
# @!attribute [rw] health_check_grace_period
|
4728
4849
|
# The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
|
4729
4850
|
# before checking the health status of an EC2 instance that has come
|
4730
|
-
# into service. The default is 0
|
4851
|
+
# into service. The default value is `0`.
|
4731
4852
|
#
|
4732
|
-
# For more information, see [Health Checks
|
4733
|
-
# Scaling User Guide*.
|
4853
|
+
# For more information, see [Health Checks for Auto Scaling
|
4854
|
+
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
4734
4855
|
#
|
4856
|
+
# Conditional: This parameter is required if you are adding an `ELB`
|
4857
|
+
# health check.
|
4735
4858
|
#
|
4736
4859
|
#
|
4737
|
-
#
|
4860
|
+
#
|
4861
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
|
4738
4862
|
# @return [Integer]
|
4739
4863
|
#
|
4740
4864
|
# @!attribute [rw] placement_group
|
4741
4865
|
# The name of the placement group into which to launch your instances,
|
4742
|
-
# if any.
|
4743
|
-
#
|
4866
|
+
# if any. A placement group is a logical grouping of instances within
|
4867
|
+
# a single Availability Zone. You cannot specify multiple Availability
|
4868
|
+
# Zones and a placement group. For more information, see [Placement
|
4869
|
+
# Groups][1] in the *Amazon EC2 User Guide for Linux Instances*.
|
4744
4870
|
#
|
4745
4871
|
#
|
4746
4872
|
#
|
4747
|
-
# [1]:
|
4873
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
|
4748
4874
|
# @return [String]
|
4749
4875
|
#
|
4750
4876
|
# @!attribute [rw] vpc_zone_identifier
|
4751
|
-
#
|
4752
|
-
#
|
4753
|
-
#
|
4754
|
-
# When you specify `VPCZoneIdentifier` with `AvailabilityZones`,
|
4755
|
-
# ensure that the subnets' Availability Zones match the values you
|
4756
|
-
# specify for `AvailabilityZones`.
|
4757
|
-
#
|
4758
|
-
# For more information, see [Launching Auto Scaling Instances in a
|
4759
|
-
# VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
4760
|
-
#
|
4761
|
-
#
|
4877
|
+
# A comma-separated list of subnet IDs, if you are launching into a
|
4878
|
+
# VPC.
|
4762
4879
|
#
|
4763
|
-
#
|
4880
|
+
# If you specify `VPCZoneIdentifier` with `AvailabilityZones`, the
|
4881
|
+
# subnets that you specify for this parameter must reside in those
|
4882
|
+
# Availability Zones.
|
4764
4883
|
# @return [String]
|
4765
4884
|
#
|
4766
4885
|
# @!attribute [rw] termination_policies
|
@@ -4774,12 +4893,12 @@ module Aws::AutoScaling
|
|
4774
4893
|
#
|
4775
4894
|
#
|
4776
4895
|
#
|
4777
|
-
# [1]:
|
4896
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
|
4778
4897
|
# @return [Array<String>]
|
4779
4898
|
#
|
4780
4899
|
# @!attribute [rw] new_instances_protected_from_scale_in
|
4781
4900
|
# Indicates whether newly launched instances are protected from
|
4782
|
-
# termination by Auto Scaling when scaling in.
|
4901
|
+
# termination by Amazon EC2 Auto Scaling when scaling in.
|
4783
4902
|
#
|
4784
4903
|
# For more information about preventing instances from terminating on
|
4785
4904
|
# scale in, see [Instance Protection][1] in the *Amazon EC2 Auto
|
@@ -4787,12 +4906,18 @@ module Aws::AutoScaling
|
|
4787
4906
|
#
|
4788
4907
|
#
|
4789
4908
|
#
|
4790
|
-
# [1]:
|
4909
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
|
4791
4910
|
# @return [Boolean]
|
4792
4911
|
#
|
4793
4912
|
# @!attribute [rw] service_linked_role_arn
|
4794
4913
|
# The Amazon Resource Name (ARN) of the service-linked role that the
|
4795
4914
|
# Auto Scaling group uses to call other AWS services on your behalf.
|
4915
|
+
# For more information, see [Service-Linked Roles][1] in the *Amazon
|
4916
|
+
# EC2 Auto Scaling User Guide*.
|
4917
|
+
#
|
4918
|
+
#
|
4919
|
+
#
|
4920
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
|
4796
4921
|
# @return [String]
|
4797
4922
|
#
|
4798
4923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/UpdateAutoScalingGroupType AWS API Documentation
|