aws-sdk-autoscaling 1.39.0 → 1.44.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-autoscaling.rb +1 -1
- data/lib/aws-sdk-autoscaling/auto_scaling_group.rb +69 -54
- data/lib/aws-sdk-autoscaling/client.rb +245 -101
- data/lib/aws-sdk-autoscaling/client_api.rb +11 -0
- data/lib/aws-sdk-autoscaling/customizations.rb +1 -0
- data/lib/aws-sdk-autoscaling/launch_configuration.rb +12 -0
- data/lib/aws-sdk-autoscaling/lifecycle_hook.rb +4 -4
- data/lib/aws-sdk-autoscaling/resource.rb +20 -6
- data/lib/aws-sdk-autoscaling/scaling_policy.rb +29 -20
- data/lib/aws-sdk-autoscaling/types.rb +366 -113
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d9338aef7407ed1a6a177b908711fdb67c437ebb2f6665583ba9ad4e1b47b77b
|
4
|
+
data.tar.gz: 822b50f1ae3f3c8a26e10516402a1d415c48c45acee361af5ec7169bea64d2f2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7d8d5844e9c901ddacc8a8fdef0d4d38c7db11e387e381c13b22b1a58dc6ca428fee5e46d49a56cd50bc1b3d87632627ba32be52d0681aa4441c73ccce73f52b
|
7
|
+
data.tar.gz: 7a10202d63836e53c5aea8474401f123bfe717bbc8bfa45161957fc0f8f6a94f2f1048d209c9f17f09d51ae3513528c675191b047cd786dc449cc39a5ae932f6
|
data/lib/aws-sdk-autoscaling.rb
CHANGED
@@ -77,8 +77,7 @@ module Aws::AutoScaling
|
|
77
77
|
data[:desired_capacity]
|
78
78
|
end
|
79
79
|
|
80
|
-
# The
|
81
|
-
# before another scaling activity can start.
|
80
|
+
# The duration of the default cooldown period, in seconds.
|
82
81
|
# @return [Integer]
|
83
82
|
def default_cooldown
|
84
83
|
data[:default_cooldown]
|
@@ -585,15 +584,19 @@ module Aws::AutoScaling
|
|
585
584
|
# @option options [required, String] :policy_name
|
586
585
|
# The name of the policy.
|
587
586
|
# @option options [String] :policy_type
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
587
|
+
# One of the following policy types:
|
588
|
+
#
|
589
|
+
# * `TargetTrackingScaling`
|
590
|
+
#
|
591
|
+
# * `StepScaling`
|
592
|
+
#
|
593
|
+
# * `SimpleScaling` (default)
|
591
594
|
# @option options [String] :adjustment_type
|
592
|
-
# Specifies
|
593
|
-
# number or a percentage
|
595
|
+
# Specifies how the scaling adjustment is interpreted (for example, an
|
596
|
+
# absolute number or a percentage). The valid values are
|
594
597
|
# `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
|
595
598
|
#
|
596
|
-
#
|
599
|
+
# Required if the policy type is `StepScaling` or `SimpleScaling`. For
|
597
600
|
# more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
|
598
601
|
# Auto Scaling User Guide*.
|
599
602
|
#
|
@@ -604,41 +607,43 @@ module Aws::AutoScaling
|
|
604
607
|
# Available for backward compatibility. Use `MinAdjustmentMagnitude`
|
605
608
|
# instead.
|
606
609
|
# @option options [Integer] :min_adjustment_magnitude
|
607
|
-
# The minimum value to scale by when
|
608
|
-
# example, suppose that you create a step
|
609
|
-
# Auto Scaling group by 25 percent and
|
610
|
-
# `MinAdjustmentMagnitude` of 2. If the group has 4
|
611
|
-
# scaling policy is performed, 25 percent of 4 is 1.
|
612
|
-
# you specified a `MinAdjustmentMagnitude` of 2, Amazon
|
613
|
-
# scales out the group by 2 instances.
|
614
|
-
#
|
615
|
-
# Valid only if the policy type is `StepScaling` or `SimpleScaling
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
610
|
+
# The minimum value to scale by when the adjustment type is
|
611
|
+
# `PercentChangeInCapacity`. For example, suppose that you create a step
|
612
|
+
# scaling policy to scale out an Auto Scaling group by 25 percent and
|
613
|
+
# you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
|
614
|
+
# instances and the scaling policy is performed, 25 percent of 4 is 1.
|
615
|
+
# However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon
|
616
|
+
# EC2 Auto Scaling scales out the group by 2 instances.
|
617
|
+
#
|
618
|
+
# Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
|
619
|
+
# more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
|
620
|
+
# Auto Scaling User Guide*.
|
621
|
+
#
|
622
|
+
# <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
|
623
|
+
# `MinAdjustmentMagnitude` to a value that is at least as large as your
|
624
|
+
# largest instance weight.
|
625
|
+
#
|
626
|
+
# </note>
|
619
627
|
#
|
620
628
|
#
|
621
629
|
#
|
622
630
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
|
623
631
|
# @option options [Integer] :scaling_adjustment
|
624
|
-
# The amount by which
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
# Conditional: If you specify `SimpleScaling` for the policy type, you
|
632
|
-
# must specify this parameter. (Not used with any other policy type.)
|
632
|
+
# The amount by which to scale, based on the specified adjustment type.
|
633
|
+
# A positive value adds to the current capacity while a negative number
|
634
|
+
# removes from the current capacity. For exact capacity, you must
|
635
|
+
# specify a positive value.
|
636
|
+
#
|
637
|
+
# Required if the policy type is `SimpleScaling`. (Not used with any
|
638
|
+
# other policy type.)
|
633
639
|
# @option options [Integer] :cooldown
|
634
|
-
# The
|
635
|
-
#
|
636
|
-
#
|
637
|
-
# applies.
|
640
|
+
# The duration of the policy's cooldown period, in seconds. When a
|
641
|
+
# cooldown period is specified here, it overrides the default cooldown
|
642
|
+
# period defined for the Auto Scaling group.
|
638
643
|
#
|
639
644
|
# Valid only if the policy type is `SimpleScaling`. For more
|
640
|
-
# information, see [Scaling Cooldowns
|
641
|
-
# Scaling User Guide*.
|
645
|
+
# information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
|
646
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
642
647
|
#
|
643
648
|
#
|
644
649
|
#
|
@@ -653,25 +658,38 @@ module Aws::AutoScaling
|
|
653
658
|
# A set of adjustments that enable you to scale based on the size of the
|
654
659
|
# alarm breach.
|
655
660
|
#
|
656
|
-
#
|
657
|
-
#
|
661
|
+
# Required if the policy type is `StepScaling`. (Not used with any other
|
662
|
+
# policy type.)
|
658
663
|
# @option options [Integer] :estimated_instance_warmup
|
659
664
|
# The estimated time, in seconds, until a newly launched instance can
|
660
|
-
# contribute to the CloudWatch metrics.
|
661
|
-
#
|
665
|
+
# contribute to the CloudWatch metrics. If not provided, the default is
|
666
|
+
# to use the value from the default cooldown period for the Auto Scaling
|
667
|
+
# group.
|
662
668
|
#
|
663
|
-
# Valid only if the policy type is `
|
664
|
-
# `
|
669
|
+
# Valid only if the policy type is `TargetTrackingScaling` or
|
670
|
+
# `StepScaling`.
|
665
671
|
# @option options [Types::TargetTrackingConfiguration] :target_tracking_configuration
|
666
672
|
# A target tracking scaling policy. Includes support for predefined or
|
667
673
|
# customized metrics.
|
668
674
|
#
|
675
|
+
# The following predefined metrics are available:
|
676
|
+
#
|
677
|
+
# * `ASGAverageCPUUtilization`
|
678
|
+
#
|
679
|
+
# * `ASGAverageNetworkIn`
|
680
|
+
#
|
681
|
+
# * `ASGAverageNetworkOut`
|
682
|
+
#
|
683
|
+
# * `ALBRequestCountPerTarget`
|
684
|
+
#
|
685
|
+
# If you specify `ALBRequestCountPerTarget` for the metric, you must
|
686
|
+
# specify the `ResourceLabel` parameter with the
|
687
|
+
# `PredefinedMetricSpecification`.
|
688
|
+
#
|
669
689
|
# For more information, see [TargetTrackingConfiguration][1] in the
|
670
690
|
# *Amazon EC2 Auto Scaling API Reference*.
|
671
691
|
#
|
672
|
-
#
|
673
|
-
# type, you must specify this parameter. (Not used with any other policy
|
674
|
-
# type.)
|
692
|
+
# Required if the policy type is `TargetTrackingScaling`.
|
675
693
|
#
|
676
694
|
#
|
677
695
|
#
|
@@ -938,8 +956,8 @@ module Aws::AutoScaling
|
|
938
956
|
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
|
939
957
|
# Auto Scaling may need to go above `MaxSize` to meet your capacity
|
940
958
|
# requirements. In this event, Amazon EC2 Auto Scaling will never go
|
941
|
-
# above `MaxSize` by more than your
|
942
|
-
# that define how many
|
959
|
+
# above `MaxSize` by more than your largest instance weight (weights
|
960
|
+
# that define how many units each instance contributes to the desired
|
943
961
|
# capacity of the group).
|
944
962
|
#
|
945
963
|
# </note>
|
@@ -953,13 +971,11 @@ module Aws::AutoScaling
|
|
953
971
|
# @option options [Integer] :default_cooldown
|
954
972
|
# The amount of time, in seconds, after a scaling activity completes
|
955
973
|
# before another scaling activity can start. The default value is `300`.
|
956
|
-
# This cooldown period is not used when a scaling-specific cooldown is
|
957
|
-
# specified.
|
958
974
|
#
|
959
|
-
#
|
960
|
-
#
|
961
|
-
# information, see [Scaling Cooldowns
|
962
|
-
# Scaling User Guide*.
|
975
|
+
# This setting applies when using simple scaling policies, but not when
|
976
|
+
# using other scaling policies or scheduled scaling. For more
|
977
|
+
# information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
|
978
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
963
979
|
#
|
964
980
|
#
|
965
981
|
#
|
@@ -979,8 +995,7 @@ module Aws::AutoScaling
|
|
979
995
|
# For more information, see [Health Check Grace Period][1] in the
|
980
996
|
# *Amazon EC2 Auto Scaling User Guide*.
|
981
997
|
#
|
982
|
-
#
|
983
|
-
# health check.
|
998
|
+
# Required if you are adding an `ELB` health check.
|
984
999
|
#
|
985
1000
|
#
|
986
1001
|
#
|
@@ -582,6 +582,20 @@ module Aws::AutoScaling
|
|
582
582
|
#
|
583
583
|
# * {Types::CancelInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
|
584
584
|
#
|
585
|
+
#
|
586
|
+
# @example Example: To cancel an instance refresh
|
587
|
+
#
|
588
|
+
# # This example cancels an instance refresh operation in progress.
|
589
|
+
#
|
590
|
+
# resp = client.cancel_instance_refresh({
|
591
|
+
# auto_scaling_group_name: "my-auto-scaling-group",
|
592
|
+
# })
|
593
|
+
#
|
594
|
+
# resp.to_h outputs the following:
|
595
|
+
# {
|
596
|
+
# instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
|
597
|
+
# }
|
598
|
+
#
|
585
599
|
# @example Request syntax with placeholder values
|
586
600
|
#
|
587
601
|
# resp = client.cancel_instance_refresh({
|
@@ -698,6 +712,13 @@ module Aws::AutoScaling
|
|
698
712
|
# Scaling User Guide*. For more information, see [Auto Scaling
|
699
713
|
# Groups][4] in the *Amazon EC2 Auto Scaling User Guide*.
|
700
714
|
#
|
715
|
+
# Every Auto Scaling group has three size parameters (`DesiredCapacity`,
|
716
|
+
# `MaxSize`, and `MinSize`). Usually, you set these sizes based on a
|
717
|
+
# specific number of instances. However, if you configure a mixed
|
718
|
+
# instances policy that defines weights for the instance types, you must
|
719
|
+
# specify these sizes with the same units that you use for weighting
|
720
|
+
# instances.
|
721
|
+
#
|
701
722
|
#
|
702
723
|
#
|
703
724
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
|
@@ -790,8 +811,8 @@ module Aws::AutoScaling
|
|
790
811
|
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
|
791
812
|
# Auto Scaling may need to go above `MaxSize` to meet your capacity
|
792
813
|
# requirements. In this event, Amazon EC2 Auto Scaling will never go
|
793
|
-
# above `MaxSize` by more than your
|
794
|
-
# that define how many
|
814
|
+
# above `MaxSize` by more than your largest instance weight (weights
|
815
|
+
# that define how many units each instance contributes to the desired
|
795
816
|
# capacity of the group).
|
796
817
|
#
|
797
818
|
# </note>
|
@@ -810,8 +831,10 @@ module Aws::AutoScaling
|
|
810
831
|
# The amount of time, in seconds, after a scaling activity completes
|
811
832
|
# before another scaling activity can start. The default value is `300`.
|
812
833
|
#
|
813
|
-
#
|
814
|
-
#
|
834
|
+
# This setting applies when using simple scaling policies, but not when
|
835
|
+
# using other scaling policies or scheduled scaling. For more
|
836
|
+
# information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
|
837
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
815
838
|
#
|
816
839
|
#
|
817
840
|
#
|
@@ -872,8 +895,7 @@ module Aws::AutoScaling
|
|
872
895
|
# For more information, see [Health Check Grace Period][1] in the
|
873
896
|
# *Amazon EC2 Auto Scaling User Guide*.
|
874
897
|
#
|
875
|
-
#
|
876
|
-
# health check.
|
898
|
+
# Required if you are adding an `ELB` health check.
|
877
899
|
#
|
878
900
|
#
|
879
901
|
#
|
@@ -986,46 +1008,50 @@ module Aws::AutoScaling
|
|
986
1008
|
#
|
987
1009
|
# resp = client.create_auto_scaling_group({
|
988
1010
|
# auto_scaling_group_name: "my-auto-scaling-group",
|
989
|
-
#
|
1011
|
+
# launch_template: {
|
1012
|
+
# launch_template_id: "lt-0a20c965061f64abc",
|
1013
|
+
# version: "$Latest",
|
1014
|
+
# },
|
1015
|
+
# max_instance_lifetime: 2592000,
|
990
1016
|
# max_size: 3,
|
991
1017
|
# min_size: 1,
|
992
|
-
# vpc_zone_identifier: "subnet-
|
1018
|
+
# vpc_zone_identifier: "subnet-057fa0918fEXAMPLE",
|
993
1019
|
# })
|
994
1020
|
#
|
995
|
-
# @example Example: To create an Auto Scaling group with an attached
|
1021
|
+
# @example Example: To create an Auto Scaling group with an attached target group
|
996
1022
|
#
|
997
|
-
# # This example creates an Auto Scaling group and attaches the specified
|
1023
|
+
# # This example creates an Auto Scaling group and attaches the specified target group.
|
998
1024
|
#
|
999
1025
|
# resp = client.create_auto_scaling_group({
|
1000
1026
|
# auto_scaling_group_name: "my-auto-scaling-group",
|
1001
|
-
# availability_zones: [
|
1002
|
-
# "us-west-2c",
|
1003
|
-
# ],
|
1004
1027
|
# health_check_grace_period: 120,
|
1005
1028
|
# health_check_type: "ELB",
|
1006
1029
|
# launch_configuration_name: "my-launch-config",
|
1007
|
-
# load_balancer_names: [
|
1008
|
-
# "my-load-balancer",
|
1009
|
-
# ],
|
1010
1030
|
# max_size: 3,
|
1011
1031
|
# min_size: 1,
|
1032
|
+
# target_group_arns: [
|
1033
|
+
# "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
|
1034
|
+
# ],
|
1035
|
+
# vpc_zone_identifier: "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE",
|
1012
1036
|
# })
|
1013
1037
|
#
|
1014
|
-
# @example Example: To create an Auto Scaling group with an attached
|
1038
|
+
# @example Example: To create an Auto Scaling group with an attached load balancer
|
1015
1039
|
#
|
1016
|
-
# # This example creates an Auto Scaling group and attaches the specified
|
1040
|
+
# # This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.
|
1017
1041
|
#
|
1018
1042
|
# resp = client.create_auto_scaling_group({
|
1019
1043
|
# auto_scaling_group_name: "my-auto-scaling-group",
|
1044
|
+
# availability_zones: [
|
1045
|
+
# "us-west-2c",
|
1046
|
+
# ],
|
1020
1047
|
# health_check_grace_period: 120,
|
1021
1048
|
# health_check_type: "ELB",
|
1022
1049
|
# launch_configuration_name: "my-launch-config",
|
1050
|
+
# load_balancer_names: [
|
1051
|
+
# "my-load-balancer",
|
1052
|
+
# ],
|
1023
1053
|
# max_size: 3,
|
1024
1054
|
# min_size: 1,
|
1025
|
-
# target_group_arns: [
|
1026
|
-
# "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
|
1027
|
-
# ],
|
1028
|
-
# vpc_zone_identifier: "subnet-4176792c, subnet-65ea5f08",
|
1029
1055
|
# })
|
1030
1056
|
#
|
1031
1057
|
# @example Request syntax with placeholder values
|
@@ -1355,6 +1381,15 @@ module Aws::AutoScaling
|
|
1355
1381
|
#
|
1356
1382
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy
|
1357
1383
|
#
|
1384
|
+
# @option params [Types::InstanceMetadataOptions] :metadata_options
|
1385
|
+
# The metadata options for the instances. For more information, see
|
1386
|
+
# [Instance Metadata and User Data][1] in the *Amazon EC2 User Guide for
|
1387
|
+
# Linux Instances*.
|
1388
|
+
#
|
1389
|
+
#
|
1390
|
+
#
|
1391
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
|
1392
|
+
#
|
1358
1393
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1359
1394
|
#
|
1360
1395
|
#
|
@@ -1409,6 +1444,11 @@ module Aws::AutoScaling
|
|
1409
1444
|
# ebs_optimized: false,
|
1410
1445
|
# associate_public_ip_address: false,
|
1411
1446
|
# placement_tenancy: "XmlStringMaxLen64",
|
1447
|
+
# metadata_options: {
|
1448
|
+
# http_tokens: "optional", # accepts optional, required
|
1449
|
+
# http_put_response_hop_limit: 1,
|
1450
|
+
# http_endpoint: "disabled", # accepts disabled, enabled
|
1451
|
+
# },
|
1412
1452
|
# })
|
1413
1453
|
#
|
1414
1454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateLaunchConfiguration AWS API Documentation
|
@@ -1688,7 +1728,7 @@ module Aws::AutoScaling
|
|
1688
1728
|
#
|
1689
1729
|
# resp = client.delete_policy({
|
1690
1730
|
# auto_scaling_group_name: "my-auto-scaling-group",
|
1691
|
-
# policy_name: "
|
1731
|
+
# policy_name: "my-step-scale-out-policy",
|
1692
1732
|
# })
|
1693
1733
|
#
|
1694
1734
|
# @example Request syntax with placeholder values
|
@@ -1857,7 +1897,7 @@ module Aws::AutoScaling
|
|
1857
1897
|
# * {Types::DescribeAdjustmentTypesAnswer#adjustment_types #adjustment_types} => Array<Types::AdjustmentType>
|
1858
1898
|
#
|
1859
1899
|
#
|
1860
|
-
# @example Example: To describe the Auto Scaling adjustment types
|
1900
|
+
# @example Example: To describe the Amazon EC2 Auto Scaling adjustment types
|
1861
1901
|
#
|
1862
1902
|
# # This example describes the available adjustment types.
|
1863
1903
|
#
|
@@ -2207,6 +2247,13 @@ module Aws::AutoScaling
|
|
2207
2247
|
#
|
2208
2248
|
# * `Cancelled` - The operation is cancelled.
|
2209
2249
|
#
|
2250
|
+
# For more information, see [Replacing Auto Scaling Instances Based on
|
2251
|
+
# an Instance Refresh][1].
|
2252
|
+
#
|
2253
|
+
#
|
2254
|
+
#
|
2255
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
|
2256
|
+
#
|
2210
2257
|
# @option params [required, String] :auto_scaling_group_name
|
2211
2258
|
# The name of the Auto Scaling group.
|
2212
2259
|
#
|
@@ -2226,6 +2273,38 @@ module Aws::AutoScaling
|
|
2226
2273
|
# * {Types::DescribeInstanceRefreshesAnswer#instance_refreshes #instance_refreshes} => Array<Types::InstanceRefresh>
|
2227
2274
|
# * {Types::DescribeInstanceRefreshesAnswer#next_token #next_token} => String
|
2228
2275
|
#
|
2276
|
+
#
|
2277
|
+
# @example Example: To list instance refreshes
|
2278
|
+
#
|
2279
|
+
# # This example describes the instance refreshes for the specified Auto Scaling group.
|
2280
|
+
#
|
2281
|
+
# resp = client.describe_instance_refreshes({
|
2282
|
+
# auto_scaling_group_name: "my-auto-scaling-group",
|
2283
|
+
# })
|
2284
|
+
#
|
2285
|
+
# resp.to_h outputs the following:
|
2286
|
+
# {
|
2287
|
+
# instance_refreshes: [
|
2288
|
+
# {
|
2289
|
+
# auto_scaling_group_name: "my-auto-scaling-group",
|
2290
|
+
# instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
|
2291
|
+
# instances_to_update: 5,
|
2292
|
+
# percentage_complete: 0,
|
2293
|
+
# start_time: Time.parse("2020-06-02T18:11:27Z"),
|
2294
|
+
# status: "InProgress",
|
2295
|
+
# },
|
2296
|
+
# {
|
2297
|
+
# auto_scaling_group_name: "my-auto-scaling-group",
|
2298
|
+
# end_time: Time.parse("2020-06-02T16:53:37Z"),
|
2299
|
+
# instance_refresh_id: "dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1",
|
2300
|
+
# instances_to_update: 0,
|
2301
|
+
# percentage_complete: 100,
|
2302
|
+
# start_time: Time.parse("2020-06-02T16:43:19Z"),
|
2303
|
+
# status: "Successful",
|
2304
|
+
# },
|
2305
|
+
# ],
|
2306
|
+
# }
|
2307
|
+
#
|
2229
2308
|
# @example Request syntax with placeholder values
|
2230
2309
|
#
|
2231
2310
|
# resp = client.describe_instance_refreshes({
|
@@ -2353,6 +2432,9 @@ module Aws::AutoScaling
|
|
2353
2432
|
# resp.launch_configurations[0].ebs_optimized #=> Boolean
|
2354
2433
|
# resp.launch_configurations[0].associate_public_ip_address #=> Boolean
|
2355
2434
|
# resp.launch_configurations[0].placement_tenancy #=> String
|
2435
|
+
# resp.launch_configurations[0].metadata_options.http_tokens #=> String, one of "optional", "required"
|
2436
|
+
# resp.launch_configurations[0].metadata_options.http_put_response_hop_limit #=> Integer
|
2437
|
+
# resp.launch_configurations[0].metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
|
2356
2438
|
# resp.next_token #=> String
|
2357
2439
|
#
|
2358
2440
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLaunchConfigurations AWS API Documentation
|
@@ -2774,7 +2856,7 @@ module Aws::AutoScaling
|
|
2774
2856
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2775
2857
|
#
|
2776
2858
|
#
|
2777
|
-
# @example Example: To describe
|
2859
|
+
# @example Example: To describe scaling policies
|
2778
2860
|
#
|
2779
2861
|
# # This example describes the policies for the specified Auto Scaling group.
|
2780
2862
|
#
|
@@ -3679,7 +3761,8 @@ module Aws::AutoScaling
|
|
3679
3761
|
req.send_request(options)
|
3680
3762
|
end
|
3681
3763
|
|
3682
|
-
# Executes the specified policy.
|
3764
|
+
# Executes the specified policy. This can be useful for testing the
|
3765
|
+
# design of your scaling policy.
|
3683
3766
|
#
|
3684
3767
|
# @option params [String] :auto_scaling_group_name
|
3685
3768
|
# The name of the Auto Scaling group.
|
@@ -3691,11 +3774,9 @@ module Aws::AutoScaling
|
|
3691
3774
|
# Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
|
3692
3775
|
# period to complete before executing the policy.
|
3693
3776
|
#
|
3694
|
-
#
|
3695
|
-
#
|
3696
|
-
#
|
3697
|
-
# For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
|
3698
|
-
# Auto Scaling User Guide*.
|
3777
|
+
# Valid only if the policy type is `SimpleScaling`. For more
|
3778
|
+
# information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
|
3779
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
3699
3780
|
#
|
3700
3781
|
#
|
3701
3782
|
#
|
@@ -3711,26 +3792,27 @@ module Aws::AutoScaling
|
|
3711
3792
|
# If you specify a metric value that doesn't correspond to a step
|
3712
3793
|
# adjustment for the policy, the call returns an error.
|
3713
3794
|
#
|
3714
|
-
#
|
3715
|
-
#
|
3795
|
+
# Required if the policy type is `StepScaling` and not supported
|
3796
|
+
# otherwise.
|
3716
3797
|
#
|
3717
3798
|
# @option params [Float] :breach_threshold
|
3718
3799
|
# The breach threshold for the alarm.
|
3719
3800
|
#
|
3720
|
-
#
|
3721
|
-
#
|
3801
|
+
# Required if the policy type is `StepScaling` and not supported
|
3802
|
+
# otherwise.
|
3722
3803
|
#
|
3723
3804
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3724
3805
|
#
|
3725
3806
|
#
|
3726
|
-
# @example Example: To execute
|
3807
|
+
# @example Example: To execute a scaling policy
|
3727
3808
|
#
|
3728
|
-
# # This example executes the specified
|
3809
|
+
# # This example executes the specified policy.
|
3729
3810
|
#
|
3730
3811
|
# resp = client.execute_policy({
|
3731
3812
|
# auto_scaling_group_name: "my-auto-scaling-group",
|
3732
|
-
#
|
3733
|
-
#
|
3813
|
+
# breach_threshold: 50.0,
|
3814
|
+
# metric_value: 59.0,
|
3815
|
+
# policy_name: "my-step-scale-out-policy",
|
3734
3816
|
# })
|
3735
3817
|
#
|
3736
3818
|
# @example Request syntax with placeholder values
|
@@ -3890,16 +3972,16 @@ module Aws::AutoScaling
|
|
3890
3972
|
#
|
3891
3973
|
# * autoscaling:EC2\_INSTANCE\_TERMINATING
|
3892
3974
|
#
|
3893
|
-
#
|
3894
|
-
#
|
3975
|
+
# Required for new lifecycle hooks, but optional when updating existing
|
3976
|
+
# hooks.
|
3895
3977
|
#
|
3896
3978
|
# @option params [String] :role_arn
|
3897
3979
|
# The ARN of the IAM role that allows the Auto Scaling group to publish
|
3898
3980
|
# to the specified notification target, for example, an Amazon SNS topic
|
3899
3981
|
# or an Amazon SQS queue.
|
3900
3982
|
#
|
3901
|
-
#
|
3902
|
-
#
|
3983
|
+
# Required for new lifecycle hooks, but optional when updating existing
|
3984
|
+
# hooks.
|
3903
3985
|
#
|
3904
3986
|
# @option params [String] :notification_target_arn
|
3905
3987
|
# The ARN of the notification target that Amazon EC2 Auto Scaling uses
|
@@ -4052,16 +4134,20 @@ module Aws::AutoScaling
|
|
4052
4134
|
# The name of the policy.
|
4053
4135
|
#
|
4054
4136
|
# @option params [String] :policy_type
|
4055
|
-
#
|
4056
|
-
#
|
4057
|
-
#
|
4137
|
+
# One of the following policy types:
|
4138
|
+
#
|
4139
|
+
# * `TargetTrackingScaling`
|
4140
|
+
#
|
4141
|
+
# * `StepScaling`
|
4142
|
+
#
|
4143
|
+
# * `SimpleScaling` (default)
|
4058
4144
|
#
|
4059
4145
|
# @option params [String] :adjustment_type
|
4060
|
-
# Specifies
|
4061
|
-
# number or a percentage
|
4146
|
+
# Specifies how the scaling adjustment is interpreted (for example, an
|
4147
|
+
# absolute number or a percentage). The valid values are
|
4062
4148
|
# `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
|
4063
4149
|
#
|
4064
|
-
#
|
4150
|
+
# Required if the policy type is `StepScaling` or `SimpleScaling`. For
|
4065
4151
|
# more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
|
4066
4152
|
# Auto Scaling User Guide*.
|
4067
4153
|
#
|
@@ -4074,43 +4160,45 @@ module Aws::AutoScaling
|
|
4074
4160
|
# instead.
|
4075
4161
|
#
|
4076
4162
|
# @option params [Integer] :min_adjustment_magnitude
|
4077
|
-
# The minimum value to scale by when
|
4078
|
-
# example, suppose that you create a step
|
4079
|
-
# Auto Scaling group by 25 percent and
|
4080
|
-
# `MinAdjustmentMagnitude` of 2. If the group has 4
|
4081
|
-
# scaling policy is performed, 25 percent of 4 is 1.
|
4082
|
-
# you specified a `MinAdjustmentMagnitude` of 2, Amazon
|
4083
|
-
# scales out the group by 2 instances.
|
4084
|
-
#
|
4085
|
-
# Valid only if the policy type is `StepScaling` or `SimpleScaling
|
4086
|
-
#
|
4087
|
-
#
|
4088
|
-
#
|
4163
|
+
# The minimum value to scale by when the adjustment type is
|
4164
|
+
# `PercentChangeInCapacity`. For example, suppose that you create a step
|
4165
|
+
# scaling policy to scale out an Auto Scaling group by 25 percent and
|
4166
|
+
# you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
|
4167
|
+
# instances and the scaling policy is performed, 25 percent of 4 is 1.
|
4168
|
+
# However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon
|
4169
|
+
# EC2 Auto Scaling scales out the group by 2 instances.
|
4170
|
+
#
|
4171
|
+
# Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
|
4172
|
+
# more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
|
4173
|
+
# Auto Scaling User Guide*.
|
4174
|
+
#
|
4175
|
+
# <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
|
4176
|
+
# `MinAdjustmentMagnitude` to a value that is at least as large as your
|
4177
|
+
# largest instance weight.
|
4178
|
+
#
|
4179
|
+
# </note>
|
4089
4180
|
#
|
4090
4181
|
#
|
4091
4182
|
#
|
4092
4183
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
|
4093
4184
|
#
|
4094
4185
|
# @option params [Integer] :scaling_adjustment
|
4095
|
-
# The amount by which
|
4096
|
-
#
|
4097
|
-
#
|
4098
|
-
#
|
4099
|
-
# capacity and a negative value subtracts from the current capacity. For
|
4100
|
-
# exact capacity, you must specify a positive value.
|
4186
|
+
# The amount by which to scale, based on the specified adjustment type.
|
4187
|
+
# A positive value adds to the current capacity while a negative number
|
4188
|
+
# removes from the current capacity. For exact capacity, you must
|
4189
|
+
# specify a positive value.
|
4101
4190
|
#
|
4102
|
-
#
|
4103
|
-
#
|
4191
|
+
# Required if the policy type is `SimpleScaling`. (Not used with any
|
4192
|
+
# other policy type.)
|
4104
4193
|
#
|
4105
4194
|
# @option params [Integer] :cooldown
|
4106
|
-
# The
|
4107
|
-
#
|
4108
|
-
#
|
4109
|
-
# applies.
|
4195
|
+
# The duration of the policy's cooldown period, in seconds. When a
|
4196
|
+
# cooldown period is specified here, it overrides the default cooldown
|
4197
|
+
# period defined for the Auto Scaling group.
|
4110
4198
|
#
|
4111
4199
|
# Valid only if the policy type is `SimpleScaling`. For more
|
4112
|
-
# information, see [Scaling Cooldowns
|
4113
|
-
# Scaling User Guide*.
|
4200
|
+
# information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
|
4201
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
4114
4202
|
#
|
4115
4203
|
#
|
4116
4204
|
#
|
@@ -4127,27 +4215,40 @@ module Aws::AutoScaling
|
|
4127
4215
|
# A set of adjustments that enable you to scale based on the size of the
|
4128
4216
|
# alarm breach.
|
4129
4217
|
#
|
4130
|
-
#
|
4131
|
-
#
|
4218
|
+
# Required if the policy type is `StepScaling`. (Not used with any other
|
4219
|
+
# policy type.)
|
4132
4220
|
#
|
4133
4221
|
# @option params [Integer] :estimated_instance_warmup
|
4134
4222
|
# The estimated time, in seconds, until a newly launched instance can
|
4135
|
-
# contribute to the CloudWatch metrics.
|
4136
|
-
#
|
4223
|
+
# contribute to the CloudWatch metrics. If not provided, the default is
|
4224
|
+
# to use the value from the default cooldown period for the Auto Scaling
|
4225
|
+
# group.
|
4137
4226
|
#
|
4138
|
-
# Valid only if the policy type is `
|
4139
|
-
# `
|
4227
|
+
# Valid only if the policy type is `TargetTrackingScaling` or
|
4228
|
+
# `StepScaling`.
|
4140
4229
|
#
|
4141
4230
|
# @option params [Types::TargetTrackingConfiguration] :target_tracking_configuration
|
4142
4231
|
# A target tracking scaling policy. Includes support for predefined or
|
4143
4232
|
# customized metrics.
|
4144
4233
|
#
|
4234
|
+
# The following predefined metrics are available:
|
4235
|
+
#
|
4236
|
+
# * `ASGAverageCPUUtilization`
|
4237
|
+
#
|
4238
|
+
# * `ASGAverageNetworkIn`
|
4239
|
+
#
|
4240
|
+
# * `ASGAverageNetworkOut`
|
4241
|
+
#
|
4242
|
+
# * `ALBRequestCountPerTarget`
|
4243
|
+
#
|
4244
|
+
# If you specify `ALBRequestCountPerTarget` for the metric, you must
|
4245
|
+
# specify the `ResourceLabel` parameter with the
|
4246
|
+
# `PredefinedMetricSpecification`.
|
4247
|
+
#
|
4145
4248
|
# For more information, see [TargetTrackingConfiguration][1] in the
|
4146
4249
|
# *Amazon EC2 Auto Scaling API Reference*.
|
4147
4250
|
#
|
4148
|
-
#
|
4149
|
-
# type, you must specify this parameter. (Not used with any other policy
|
4150
|
-
# type.)
|
4251
|
+
# Required if the policy type is `TargetTrackingScaling`.
|
4151
4252
|
#
|
4152
4253
|
#
|
4153
4254
|
#
|
@@ -4174,15 +4275,31 @@ module Aws::AutoScaling
|
|
4174
4275
|
# # This example adds the specified policy to the specified Auto Scaling group.
|
4175
4276
|
#
|
4176
4277
|
# resp = client.put_scaling_policy({
|
4177
|
-
# adjustment_type: "ChangeInCapacity",
|
4178
4278
|
# auto_scaling_group_name: "my-auto-scaling-group",
|
4179
|
-
# policy_name: "
|
4180
|
-
#
|
4279
|
+
# policy_name: "alb1000-target-tracking-scaling-policy",
|
4280
|
+
# policy_type: "TargetTrackingScaling",
|
4281
|
+
# target_tracking_configuration: {
|
4282
|
+
# predefined_metric_specification: {
|
4283
|
+
# predefined_metric_type: "ALBRequestCountPerTarget",
|
4284
|
+
# resource_label: "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d",
|
4285
|
+
# },
|
4286
|
+
# target_value: 1000.0,
|
4287
|
+
# },
|
4181
4288
|
# })
|
4182
4289
|
#
|
4183
4290
|
# resp.to_h outputs the following:
|
4184
4291
|
# {
|
4185
|
-
#
|
4292
|
+
# alarms: [
|
4293
|
+
# {
|
4294
|
+
# alarm_arn: "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e",
|
4295
|
+
# alarm_name: "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e",
|
4296
|
+
# },
|
4297
|
+
# {
|
4298
|
+
# alarm_arn: "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2",
|
4299
|
+
# alarm_name: "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2",
|
4300
|
+
# },
|
4301
|
+
# ],
|
4302
|
+
# policy_arn: "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy",
|
4186
4303
|
# }
|
4187
4304
|
#
|
4188
4305
|
# @example Request syntax with placeholder values
|
@@ -4682,7 +4799,7 @@ module Aws::AutoScaling
|
|
4682
4799
|
# unique ID that you can use to track its progress. To query its status,
|
4683
4800
|
# call the DescribeInstanceRefreshes API. To describe the instance
|
4684
4801
|
# refreshes that have already run, call the DescribeInstanceRefreshes
|
4685
|
-
# API. To cancel an
|
4802
|
+
# API. To cancel an instance refresh operation in progress, use the
|
4686
4803
|
# CancelInstanceRefresh API.
|
4687
4804
|
#
|
4688
4805
|
# For more information, see [Replacing Auto Scaling Instances Based on
|
@@ -4702,17 +4819,47 @@ module Aws::AutoScaling
|
|
4702
4819
|
# A rolling update is an update that is applied to all instances in an
|
4703
4820
|
# Auto Scaling group until all instances have been updated. A rolling
|
4704
4821
|
# update can fail due to failed health checks or if instances are on
|
4705
|
-
# standby or are protected from scale
|
4822
|
+
# standby or are protected from scale in. If the rolling update process
|
4706
4823
|
# fails, any instances that were already replaced are not rolled back to
|
4707
4824
|
# their previous configuration.
|
4708
4825
|
#
|
4709
4826
|
# @option params [Types::RefreshPreferences] :preferences
|
4710
4827
|
# Set of preferences associated with the instance refresh request.
|
4711
4828
|
#
|
4829
|
+
# If not provided, the default values are used. For
|
4830
|
+
# `MinHealthyPercentage`, the default value is `90`. For
|
4831
|
+
# `InstanceWarmup`, the default is to use the value specified for the
|
4832
|
+
# health check grace period for the Auto Scaling group.
|
4833
|
+
#
|
4834
|
+
# For more information, see [RefreshPreferences][1] in the *Amazon EC2
|
4835
|
+
# Auto Scaling API Reference*.
|
4836
|
+
#
|
4837
|
+
#
|
4838
|
+
#
|
4839
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html
|
4840
|
+
#
|
4712
4841
|
# @return [Types::StartInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4713
4842
|
#
|
4714
4843
|
# * {Types::StartInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
|
4715
4844
|
#
|
4845
|
+
#
|
4846
|
+
# @example Example: To start an instance refresh
|
4847
|
+
#
|
4848
|
+
# # This example starts an instance refresh for the specified Auto Scaling group.
|
4849
|
+
#
|
4850
|
+
# resp = client.start_instance_refresh({
|
4851
|
+
# auto_scaling_group_name: "my-auto-scaling-group",
|
4852
|
+
# preferences: {
|
4853
|
+
# instance_warmup: 400,
|
4854
|
+
# min_healthy_percentage: 50,
|
4855
|
+
# },
|
4856
|
+
# })
|
4857
|
+
#
|
4858
|
+
# resp.to_h outputs the following:
|
4859
|
+
# {
|
4860
|
+
# instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
|
4861
|
+
# }
|
4862
|
+
#
|
4716
4863
|
# @example Request syntax with placeholder values
|
4717
4864
|
#
|
4718
4865
|
# resp = client.start_instance_refresh({
|
@@ -4974,8 +5121,8 @@ module Aws::AutoScaling
|
|
4974
5121
|
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
|
4975
5122
|
# Auto Scaling may need to go above `MaxSize` to meet your capacity
|
4976
5123
|
# requirements. In this event, Amazon EC2 Auto Scaling will never go
|
4977
|
-
# above `MaxSize` by more than your
|
4978
|
-
# that define how many
|
5124
|
+
# above `MaxSize` by more than your largest instance weight (weights
|
5125
|
+
# that define how many units each instance contributes to the desired
|
4979
5126
|
# capacity of the group).
|
4980
5127
|
#
|
4981
5128
|
# </note>
|
@@ -4991,13 +5138,11 @@ module Aws::AutoScaling
|
|
4991
5138
|
# @option params [Integer] :default_cooldown
|
4992
5139
|
# The amount of time, in seconds, after a scaling activity completes
|
4993
5140
|
# before another scaling activity can start. The default value is `300`.
|
4994
|
-
# This cooldown period is not used when a scaling-specific cooldown is
|
4995
|
-
# specified.
|
4996
5141
|
#
|
4997
|
-
#
|
4998
|
-
#
|
4999
|
-
# information, see [Scaling Cooldowns
|
5000
|
-
# Scaling User Guide*.
|
5142
|
+
# This setting applies when using simple scaling policies, but not when
|
5143
|
+
# using other scaling policies or scheduled scaling. For more
|
5144
|
+
# information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
|
5145
|
+
# the *Amazon EC2 Auto Scaling User Guide*.
|
5001
5146
|
#
|
5002
5147
|
#
|
5003
5148
|
#
|
@@ -5020,8 +5165,7 @@ module Aws::AutoScaling
|
|
5020
5165
|
# For more information, see [Health Check Grace Period][1] in the
|
5021
5166
|
# *Amazon EC2 Auto Scaling User Guide*.
|
5022
5167
|
#
|
5023
|
-
#
|
5024
|
-
# health check.
|
5168
|
+
# Required if you are adding an `ELB` health check.
|
5025
5169
|
#
|
5026
5170
|
#
|
5027
5171
|
#
|
@@ -5199,7 +5343,7 @@ module Aws::AutoScaling
|
|
5199
5343
|
params: params,
|
5200
5344
|
config: config)
|
5201
5345
|
context[:gem_name] = 'aws-sdk-autoscaling'
|
5202
|
-
context[:gem_version] = '1.
|
5346
|
+
context[:gem_version] = '1.44.0'
|
5203
5347
|
Seahorse::Client::Request.new(handlers, context)
|
5204
5348
|
end
|
5205
5349
|
|