aws-sdk-autoscaling 1.35.0 → 1.40.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 +3 -1
- data/lib/aws-sdk-autoscaling/activity.rb +2 -0
- data/lib/aws-sdk-autoscaling/auto_scaling_group.rb +102 -47
- data/lib/aws-sdk-autoscaling/client.rb +428 -127
- data/lib/aws-sdk-autoscaling/client_api.rb +99 -0
- data/lib/aws-sdk-autoscaling/customizations.rb +1 -0
- data/lib/aws-sdk-autoscaling/errors.rb +34 -0
- data/lib/aws-sdk-autoscaling/instance.rb +8 -1
- data/lib/aws-sdk-autoscaling/launch_configuration.rb +2 -0
- data/lib/aws-sdk-autoscaling/lifecycle_hook.rb +4 -2
- data/lib/aws-sdk-autoscaling/load_balancer.rb +2 -0
- data/lib/aws-sdk-autoscaling/notification_configuration.rb +2 -0
- data/lib/aws-sdk-autoscaling/resource.rb +52 -21
- data/lib/aws-sdk-autoscaling/scaling_policy.rb +2 -0
- data/lib/aws-sdk-autoscaling/scheduled_action.rb +7 -3
- data/lib/aws-sdk-autoscaling/tag.rb +2 -0
- data/lib/aws-sdk-autoscaling/types.rb +694 -117
- data/lib/aws-sdk-autoscaling/waiters.rb +2 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 21162b28994033fe0561bd454630f85ec3e09bfaf1d19030a2a600a2e9246b47
|
4
|
+
data.tar.gz: 20d545494b188d07ac04240ee6d7dffad9614b38d7a4c4f26de204d4d6762969
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d29d595273b5ab4103bdc7c01c128fe0f32b062b3e647303e9d4d1421d12d9ab5be3961295149216bbcd73ff97043c62250c21e1ce582abd2368ce7afbc9c218
|
7
|
+
data.tar.gz: 113b4092ff01627ad2e23a85869cca40bfe5bc2be421dc3055554b59b8a455b6843de3fc29ddb9d0b9a0a3eef983b31ff26702204d6535b6031b19631219c8a2
|
data/lib/aws-sdk-autoscaling.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -56,6 +58,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
|
|
56
58
|
# @service
|
57
59
|
module Aws::AutoScaling
|
58
60
|
|
59
|
-
GEM_VERSION = '1.
|
61
|
+
GEM_VERSION = '1.40.0'
|
60
62
|
|
61
63
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -149,8 +151,8 @@ module Aws::AutoScaling
|
|
149
151
|
data[:enabled_metrics]
|
150
152
|
end
|
151
153
|
|
152
|
-
# The current state of the group when DeleteAutoScalingGroup
|
153
|
-
# progress.
|
154
|
+
# The current state of the group when the DeleteAutoScalingGroup
|
155
|
+
# operation is in progress.
|
154
156
|
# @return [String]
|
155
157
|
def status
|
156
158
|
data[:status]
|
@@ -179,7 +181,7 @@ module Aws::AutoScaling
|
|
179
181
|
# The maximum amount of time, in seconds, that an instance can be in
|
180
182
|
# service.
|
181
183
|
#
|
182
|
-
# Valid Range: Minimum value of
|
184
|
+
# Valid Range: Minimum value of 0.
|
183
185
|
# @return [Integer]
|
184
186
|
def max_instance_lifetime
|
185
187
|
data[:max_instance_lifetime]
|
@@ -451,8 +453,7 @@ module Aws::AutoScaling
|
|
451
453
|
# })
|
452
454
|
# @param [Hash] options ({})
|
453
455
|
# @option options [Array<String>] :metrics
|
454
|
-
#
|
455
|
-
# metrics are disabled.
|
456
|
+
# Specifies one or more of the following metrics:
|
456
457
|
#
|
457
458
|
# * `GroupMinSize`
|
458
459
|
#
|
@@ -469,6 +470,18 @@ module Aws::AutoScaling
|
|
469
470
|
# * `GroupTerminatingInstances`
|
470
471
|
#
|
471
472
|
# * `GroupTotalInstances`
|
473
|
+
#
|
474
|
+
# * `GroupInServiceCapacity`
|
475
|
+
#
|
476
|
+
# * `GroupPendingCapacity`
|
477
|
+
#
|
478
|
+
# * `GroupStandbyCapacity`
|
479
|
+
#
|
480
|
+
# * `GroupTerminatingCapacity`
|
481
|
+
#
|
482
|
+
# * `GroupTotalCapacity`
|
483
|
+
#
|
484
|
+
# If you omit this parameter, all metrics are disabled.
|
472
485
|
# @return [EmptyStructure]
|
473
486
|
def disable_metrics_collection(options = {})
|
474
487
|
options = options.merge(auto_scaling_group_name: @name)
|
@@ -484,8 +497,8 @@ module Aws::AutoScaling
|
|
484
497
|
# })
|
485
498
|
# @param [Hash] options ({})
|
486
499
|
# @option options [Array<String>] :metrics
|
487
|
-
#
|
488
|
-
#
|
500
|
+
# Specifies which group-level metrics to start collecting. You can
|
501
|
+
# specify one or more of the following metrics:
|
489
502
|
#
|
490
503
|
# * `GroupMinSize`
|
491
504
|
#
|
@@ -502,6 +515,21 @@ module Aws::AutoScaling
|
|
502
515
|
# * `GroupTerminatingInstances`
|
503
516
|
#
|
504
517
|
# * `GroupTotalInstances`
|
518
|
+
#
|
519
|
+
# The instance weighting feature supports the following additional
|
520
|
+
# metrics:
|
521
|
+
#
|
522
|
+
# * `GroupInServiceCapacity`
|
523
|
+
#
|
524
|
+
# * `GroupPendingCapacity`
|
525
|
+
#
|
526
|
+
# * `GroupStandbyCapacity`
|
527
|
+
#
|
528
|
+
# * `GroupTerminatingCapacity`
|
529
|
+
#
|
530
|
+
# * `GroupTotalCapacity`
|
531
|
+
#
|
532
|
+
# If you omit this parameter, all metrics are enabled.
|
505
533
|
# @option options [required, String] :granularity
|
506
534
|
# The granularity to associate with the metrics to collect. The only
|
507
535
|
# valid value is `1Minute`.
|
@@ -576,20 +604,22 @@ module Aws::AutoScaling
|
|
576
604
|
# Available for backward compatibility. Use `MinAdjustmentMagnitude`
|
577
605
|
# instead.
|
578
606
|
# @option options [Integer] :min_adjustment_magnitude
|
579
|
-
# The minimum
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
607
|
+
# The minimum value to scale by when scaling by percentages. For
|
608
|
+
# example, suppose that you create a step scaling policy to scale out an
|
609
|
+
# Auto Scaling group by 25 percent and you specify a
|
610
|
+
# `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
|
611
|
+
# scaling policy is performed, 25 percent of 4 is 1. However, because
|
612
|
+
# you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
|
613
|
+
# scales out the group by 2 instances.
|
614
|
+
#
|
615
|
+
# Valid only if the policy type is `StepScaling` or `SimpleScaling` and
|
616
|
+
# the adjustment type is `PercentChangeInCapacity`. For more
|
617
|
+
# information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
|
618
|
+
# Scaling User Guide*.
|
619
|
+
#
|
620
|
+
#
|
621
|
+
#
|
622
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
|
593
623
|
# @option options [Integer] :scaling_adjustment
|
594
624
|
# The amount by which a simple scaling policy scales the Auto Scaling
|
595
625
|
# group in response to an alarm breach. The adjustment is based on the
|
@@ -658,7 +688,7 @@ module Aws::AutoScaling
|
|
658
688
|
# @return [ScalingPolicy]
|
659
689
|
def put_scaling_policy(options = {})
|
660
690
|
options = options.merge(auto_scaling_group_name: @name)
|
661
|
-
|
691
|
+
@client.put_scaling_policy(options)
|
662
692
|
ScalingPolicy.new(
|
663
693
|
name: options[:policy_name],
|
664
694
|
client: @client
|
@@ -710,16 +740,18 @@ module Aws::AutoScaling
|
|
710
740
|
#
|
711
741
|
# [1]: http://crontab.org
|
712
742
|
# @option options [Integer] :min_size
|
713
|
-
# The minimum
|
743
|
+
# The minimum size of the Auto Scaling group.
|
714
744
|
# @option options [Integer] :max_size
|
715
|
-
# The maximum
|
745
|
+
# The maximum size of the Auto Scaling group.
|
716
746
|
# @option options [Integer] :desired_capacity
|
717
|
-
# The
|
718
|
-
#
|
747
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
748
|
+
# after the scheduled action runs and the capacity it attempts to
|
749
|
+
# maintain. It can scale beyond this capacity if you add more scaling
|
750
|
+
# conditions.
|
719
751
|
# @return [ScheduledAction]
|
720
752
|
def put_scheduled_update_group_action(options = {})
|
721
753
|
options = options.merge(auto_scaling_group_name: @name)
|
722
|
-
|
754
|
+
@client.put_scheduled_update_group_action(options)
|
723
755
|
ScheduledAction.new(
|
724
756
|
name: options[:scheduled_action_name],
|
725
757
|
client: @client
|
@@ -733,24 +765,27 @@ module Aws::AutoScaling
|
|
733
765
|
# })
|
734
766
|
# @param [Hash] options ({})
|
735
767
|
# @option options [Array<String>] :scaling_processes
|
736
|
-
# One or more of the following processes
|
737
|
-
# all processes are specified.
|
768
|
+
# One or more of the following processes:
|
738
769
|
#
|
739
770
|
# * `Launch`
|
740
771
|
#
|
741
772
|
# * `Terminate`
|
742
773
|
#
|
743
|
-
# * `
|
774
|
+
# * `AddToLoadBalancer`
|
744
775
|
#
|
745
|
-
# * `
|
776
|
+
# * `AlarmNotification`
|
746
777
|
#
|
747
778
|
# * `AZRebalance`
|
748
779
|
#
|
749
|
-
# * `
|
780
|
+
# * `HealthCheck`
|
781
|
+
#
|
782
|
+
# * `InstanceRefresh`
|
783
|
+
#
|
784
|
+
# * `ReplaceUnhealthy`
|
750
785
|
#
|
751
786
|
# * `ScheduledActions`
|
752
787
|
#
|
753
|
-
#
|
788
|
+
# If you omit this parameter, all processes are specified.
|
754
789
|
# @return [EmptyStructure]
|
755
790
|
def resume_processes(options = {})
|
756
791
|
options = options.merge(auto_scaling_group_name: @name)
|
@@ -766,8 +801,9 @@ module Aws::AutoScaling
|
|
766
801
|
# })
|
767
802
|
# @param [Hash] options ({})
|
768
803
|
# @option options [required, Integer] :desired_capacity
|
769
|
-
# The
|
770
|
-
#
|
804
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
805
|
+
# after this operation completes and the capacity it attempts to
|
806
|
+
# maintain.
|
771
807
|
# @option options [Boolean] :honor_cooldown
|
772
808
|
# Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
|
773
809
|
# period to complete before initiating a scaling activity to set your
|
@@ -788,24 +824,27 @@ module Aws::AutoScaling
|
|
788
824
|
# })
|
789
825
|
# @param [Hash] options ({})
|
790
826
|
# @option options [Array<String>] :scaling_processes
|
791
|
-
# One or more of the following processes
|
792
|
-
# all processes are specified.
|
827
|
+
# One or more of the following processes:
|
793
828
|
#
|
794
829
|
# * `Launch`
|
795
830
|
#
|
796
831
|
# * `Terminate`
|
797
832
|
#
|
798
|
-
# * `
|
833
|
+
# * `AddToLoadBalancer`
|
799
834
|
#
|
800
|
-
# * `
|
835
|
+
# * `AlarmNotification`
|
801
836
|
#
|
802
837
|
# * `AZRebalance`
|
803
838
|
#
|
804
|
-
# * `
|
839
|
+
# * `HealthCheck`
|
840
|
+
#
|
841
|
+
# * `InstanceRefresh`
|
842
|
+
#
|
843
|
+
# * `ReplaceUnhealthy`
|
805
844
|
#
|
806
845
|
# * `ScheduledActions`
|
807
846
|
#
|
808
|
-
#
|
847
|
+
# If you omit this parameter, all processes are specified.
|
809
848
|
# @return [EmptyStructure]
|
810
849
|
def suspend_processes(options = {})
|
811
850
|
options = options.merge(auto_scaling_group_name: @name)
|
@@ -895,10 +934,22 @@ module Aws::AutoScaling
|
|
895
934
|
# The minimum size of the Auto Scaling group.
|
896
935
|
# @option options [Integer] :max_size
|
897
936
|
# The maximum size of the Auto Scaling group.
|
937
|
+
#
|
938
|
+
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
|
939
|
+
# Auto Scaling may need to go above `MaxSize` to meet your capacity
|
940
|
+
# requirements. In this event, Amazon EC2 Auto Scaling will never go
|
941
|
+
# above `MaxSize` by more than your maximum instance weight (weights
|
942
|
+
# that define how many capacity units each instance contributes to the
|
943
|
+
# capacity of the group).
|
944
|
+
#
|
945
|
+
# </note>
|
898
946
|
# @option options [Integer] :desired_capacity
|
899
|
-
# The
|
900
|
-
#
|
901
|
-
#
|
947
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
948
|
+
# after this operation completes and the capacity it attempts to
|
949
|
+
# maintain.
|
950
|
+
#
|
951
|
+
# This number must be greater than or equal to the minimum size of the
|
952
|
+
# group and less than or equal to the maximum size of the group.
|
902
953
|
# @option options [Integer] :default_cooldown
|
903
954
|
# The amount of time, in seconds, after a scaling activity completes
|
904
955
|
# before another scaling activity can start. The default value is `300`.
|
@@ -984,13 +1035,17 @@ module Aws::AutoScaling
|
|
984
1035
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
|
985
1036
|
# @option options [Integer] :max_instance_lifetime
|
986
1037
|
# The maximum amount of time, in seconds, that an instance can be in
|
987
|
-
# service.
|
1038
|
+
# service. The default is null.
|
1039
|
+
#
|
1040
|
+
# This parameter is optional, but if you specify a value for it, you
|
1041
|
+
# must specify a value of at least 604,800 seconds (7 days). To clear a
|
1042
|
+
# previously set value, specify a new value of 0.
|
988
1043
|
#
|
989
1044
|
# For more information, see [Replacing Auto Scaling Instances Based on
|
990
1045
|
# Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
|
991
1046
|
# Guide*.
|
992
1047
|
#
|
993
|
-
# Valid Range: Minimum value of
|
1048
|
+
# Valid Range: Minimum value of 0.
|
994
1049
|
#
|
995
1050
|
#
|
996
1051
|
#
|
@@ -998,7 +1053,7 @@ module Aws::AutoScaling
|
|
998
1053
|
# @return [AutoScalingGroup]
|
999
1054
|
def update(options = {})
|
1000
1055
|
options = options.merge(auto_scaling_group_name: @name)
|
1001
|
-
|
1056
|
+
@client.update_auto_scaling_group(options)
|
1002
1057
|
AutoScalingGroup.new(
|
1003
1058
|
name: options[:auto_scaling_group_name],
|
1004
1059
|
client: @client
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
29
32
|
|
@@ -69,6 +72,7 @@ module Aws::AutoScaling
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::Query)
|
74
78
|
|
@@ -161,7 +165,7 @@ module Aws::AutoScaling
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::AutoScaling
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -368,9 +372,9 @@ module Aws::AutoScaling
|
|
368
372
|
# Attaches one or more target groups to the specified Auto Scaling
|
369
373
|
# group.
|
370
374
|
#
|
371
|
-
# To describe the target groups for an Auto Scaling group,
|
372
|
-
# DescribeLoadBalancerTargetGroups. To detach the target group from
|
373
|
-
# Auto Scaling group,
|
375
|
+
# To describe the target groups for an Auto Scaling group, call the
|
376
|
+
# DescribeLoadBalancerTargetGroups API. To detach the target group from
|
377
|
+
# the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
|
374
378
|
#
|
375
379
|
# With Application Load Balancers and Network Load Balancers, instances
|
376
380
|
# are registered as targets with a target group. With Classic Load
|
@@ -419,15 +423,18 @@ module Aws::AutoScaling
|
|
419
423
|
req.send_request(options)
|
420
424
|
end
|
421
425
|
|
422
|
-
#
|
423
|
-
#
|
426
|
+
# <note markdown="1"> To attach an Application Load Balancer or a Network Load Balancer, use
|
427
|
+
# the AttachLoadBalancerTargetGroups API operation instead.
|
424
428
|
#
|
425
|
-
#
|
426
|
-
# instead, see AttachLoadBalancerTargetGroups.
|
429
|
+
# </note>
|
427
430
|
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
+
# Attaches one or more Classic Load Balancers to the specified Auto
|
432
|
+
# Scaling group. Amazon EC2 Auto Scaling registers the running instances
|
433
|
+
# with these Classic Load Balancers.
|
434
|
+
#
|
435
|
+
# To describe the load balancers for an Auto Scaling group, call the
|
436
|
+
# DescribeLoadBalancers API. To detach the load balancer from the Auto
|
437
|
+
# Scaling group, call the DetachLoadBalancers API.
|
431
438
|
#
|
432
439
|
# For more information, see [Attaching a Load Balancer to Your Auto
|
433
440
|
# Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
@@ -557,6 +564,43 @@ module Aws::AutoScaling
|
|
557
564
|
req.send_request(options)
|
558
565
|
end
|
559
566
|
|
567
|
+
# Cancels an instance refresh operation in progress. Cancellation does
|
568
|
+
# not roll back any replacements that have already been completed, but
|
569
|
+
# it prevents new replacements from being started.
|
570
|
+
#
|
571
|
+
# For more information, see [Replacing Auto Scaling Instances Based on
|
572
|
+
# an Instance Refresh][1].
|
573
|
+
#
|
574
|
+
#
|
575
|
+
#
|
576
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
|
577
|
+
#
|
578
|
+
# @option params [required, String] :auto_scaling_group_name
|
579
|
+
# The name of the Auto Scaling group.
|
580
|
+
#
|
581
|
+
# @return [Types::CancelInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
582
|
+
#
|
583
|
+
# * {Types::CancelInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
|
584
|
+
#
|
585
|
+
# @example Request syntax with placeholder values
|
586
|
+
#
|
587
|
+
# resp = client.cancel_instance_refresh({
|
588
|
+
# auto_scaling_group_name: "XmlStringMaxLen255", # required
|
589
|
+
# })
|
590
|
+
#
|
591
|
+
# @example Response structure
|
592
|
+
#
|
593
|
+
# resp.instance_refresh_id #=> String
|
594
|
+
#
|
595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CancelInstanceRefresh AWS API Documentation
|
596
|
+
#
|
597
|
+
# @overload cancel_instance_refresh(params = {})
|
598
|
+
# @param [Hash] params ({})
|
599
|
+
def cancel_instance_refresh(params = {}, options = {})
|
600
|
+
req = build_request(:cancel_instance_refresh, params)
|
601
|
+
req.send_request(options)
|
602
|
+
end
|
603
|
+
|
560
604
|
# Completes the lifecycle action for the specified token or instance
|
561
605
|
# with the specified result.
|
562
606
|
#
|
@@ -644,34 +688,49 @@ module Aws::AutoScaling
|
|
644
688
|
# Creates an Auto Scaling group with the specified name and attributes.
|
645
689
|
#
|
646
690
|
# If you exceed your maximum limit of Auto Scaling groups, the call
|
647
|
-
# fails.
|
648
|
-
#
|
649
|
-
#
|
650
|
-
#
|
691
|
+
# fails. To query this limit, call the DescribeAccountLimits API. For
|
692
|
+
# information about updating this limit, see [Amazon EC2 Auto Scaling
|
693
|
+
# Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
694
|
+
#
|
695
|
+
# For introductory exercises for creating an Auto Scaling group, see
|
696
|
+
# [Getting Started with Amazon EC2 Auto Scaling][2] and [Tutorial: Set
|
697
|
+
# Up a Scaled and Load-Balanced Application][3] in the *Amazon EC2 Auto
|
698
|
+
# Scaling User Guide*. For more information, see [Auto Scaling
|
699
|
+
# Groups][4] in the *Amazon EC2 Auto Scaling User Guide*.
|
651
700
|
#
|
652
701
|
#
|
653
702
|
#
|
654
703
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
|
704
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html
|
705
|
+
# [3]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html
|
706
|
+
# [4]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html
|
655
707
|
#
|
656
708
|
# @option params [required, String] :auto_scaling_group_name
|
657
709
|
# The name of the Auto Scaling group. This name must be unique per
|
658
710
|
# Region per account.
|
659
711
|
#
|
660
712
|
# @option params [String] :launch_configuration_name
|
661
|
-
# The name of the launch configuration
|
713
|
+
# The name of the launch configuration to use when an instance is
|
714
|
+
# launched. To get the launch configuration name, use the
|
715
|
+
# DescribeLaunchConfigurations API operation. New launch configurations
|
716
|
+
# can be created with the CreateLaunchConfiguration API.
|
662
717
|
#
|
663
|
-
#
|
664
|
-
#
|
718
|
+
# You must specify one of the following parameters in your request:
|
719
|
+
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
665
720
|
# `MixedInstancesPolicy`.
|
666
721
|
#
|
667
722
|
# @option params [Types::LaunchTemplateSpecification] :launch_template
|
668
|
-
#
|
723
|
+
# Parameters used to specify the launch template and version to use when
|
724
|
+
# an instance is launched.
|
669
725
|
#
|
670
726
|
# For more information, see [LaunchTemplateSpecification][1] in the
|
671
727
|
# *Amazon EC2 Auto Scaling API Reference*.
|
672
728
|
#
|
673
|
-
#
|
674
|
-
#
|
729
|
+
# You can alternatively associate a launch template to the Auto Scaling
|
730
|
+
# group by using the `MixedInstancesPolicy` parameter.
|
731
|
+
#
|
732
|
+
# You must specify one of the following parameters in your request:
|
733
|
+
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
675
734
|
# `MixedInstancesPolicy`.
|
676
735
|
#
|
677
736
|
#
|
@@ -706,23 +765,21 @@ module Aws::AutoScaling
|
|
706
765
|
#
|
707
766
|
# @option params [String] :instance_id
|
708
767
|
# The ID of the instance used to create a launch configuration for the
|
709
|
-
# group.
|
768
|
+
# group. To get the instance ID, use the Amazon EC2
|
769
|
+
# [DescribeInstances][1] API operation.
|
710
770
|
#
|
711
771
|
# When you specify an ID of an instance, Amazon EC2 Auto Scaling creates
|
712
772
|
# a new launch configuration and associates it with the group. This
|
713
773
|
# launch configuration derives its attributes from the specified
|
714
774
|
# instance, except for the block device mapping.
|
715
775
|
#
|
716
|
-
# For more information, see [Create an Auto Scaling Group Using an EC2
|
717
|
-
# Instance][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
718
|
-
#
|
719
776
|
# You must specify one of the following parameters in your request:
|
720
777
|
# `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
|
721
778
|
# `MixedInstancesPolicy`.
|
722
779
|
#
|
723
780
|
#
|
724
781
|
#
|
725
|
-
# [1]: https://docs.aws.amazon.com/
|
782
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
|
726
783
|
#
|
727
784
|
# @option params [required, Integer] :min_size
|
728
785
|
# The minimum size of the group.
|
@@ -730,12 +787,24 @@ module Aws::AutoScaling
|
|
730
787
|
# @option params [required, Integer] :max_size
|
731
788
|
# The maximum size of the group.
|
732
789
|
#
|
790
|
+
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
|
791
|
+
# Auto Scaling may need to go above `MaxSize` to meet your capacity
|
792
|
+
# requirements. In this event, Amazon EC2 Auto Scaling will never go
|
793
|
+
# above `MaxSize` by more than your maximum instance weight (weights
|
794
|
+
# that define how many capacity units each instance contributes to the
|
795
|
+
# capacity of the group).
|
796
|
+
#
|
797
|
+
# </note>
|
798
|
+
#
|
733
799
|
# @option params [Integer] :desired_capacity
|
734
|
-
# The
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
# the minimum size of the
|
800
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
801
|
+
# at the time of its creation and the capacity it attempts to maintain.
|
802
|
+
# It can scale beyond this capacity if you configure automatic scaling.
|
803
|
+
#
|
804
|
+
# This number must be greater than or equal to the minimum size of the
|
805
|
+
# group and less than or equal to the maximum size of the group. If you
|
806
|
+
# do not specify a desired capacity, the default is the minimum size of
|
807
|
+
# the group.
|
739
808
|
#
|
740
809
|
# @option params [Integer] :default_cooldown
|
741
810
|
# The amount of time, in seconds, after a scaling activity completes
|
@@ -861,7 +930,15 @@ module Aws::AutoScaling
|
|
861
930
|
# One or more lifecycle hooks.
|
862
931
|
#
|
863
932
|
# @option params [Array<Types::Tag>] :tags
|
864
|
-
# One or more tags.
|
933
|
+
# One or more tags. You can tag your Auto Scaling group and propagate
|
934
|
+
# the tags to the Amazon EC2 instances it launches.
|
935
|
+
#
|
936
|
+
# Tags are not propagated to Amazon EBS volumes. To add tags to Amazon
|
937
|
+
# EBS volumes, specify the tags in a launch template but use caution. If
|
938
|
+
# the launch template specifies an instance tag with a key that is also
|
939
|
+
# specified for the Auto Scaling group, Amazon EC2 Auto Scaling
|
940
|
+
# overrides the value of that instance tag with the value specified by
|
941
|
+
# the Auto Scaling group.
|
865
942
|
#
|
866
943
|
# For more information, see [Tagging Auto Scaling Groups and
|
867
944
|
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
@@ -884,13 +961,17 @@ module Aws::AutoScaling
|
|
884
961
|
#
|
885
962
|
# @option params [Integer] :max_instance_lifetime
|
886
963
|
# The maximum amount of time, in seconds, that an instance can be in
|
887
|
-
# service.
|
964
|
+
# service. The default is null.
|
965
|
+
#
|
966
|
+
# This parameter is optional, but if you specify a value for it, you
|
967
|
+
# must specify a value of at least 604,800 seconds (7 days). To clear a
|
968
|
+
# previously set value, specify a new value of 0.
|
888
969
|
#
|
889
970
|
# For more information, see [Replacing Auto Scaling Instances Based on
|
890
971
|
# Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
|
891
972
|
# Guide*.
|
892
973
|
#
|
893
|
-
# Valid Range: Minimum value of
|
974
|
+
# Valid Range: Minimum value of 0.
|
894
975
|
#
|
895
976
|
#
|
896
977
|
#
|
@@ -1030,10 +1111,9 @@ module Aws::AutoScaling
|
|
1030
1111
|
# Creates a launch configuration.
|
1031
1112
|
#
|
1032
1113
|
# If you exceed your maximum limit of launch configurations, the call
|
1033
|
-
# fails.
|
1034
|
-
#
|
1035
|
-
#
|
1036
|
-
# Scaling User Guide*.
|
1114
|
+
# fails. To query this limit, call the DescribeAccountLimits API. For
|
1115
|
+
# information about updating this limit, see [Amazon EC2 Auto Scaling
|
1116
|
+
# Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
1037
1117
|
#
|
1038
1118
|
# For more information, see [Launch Configurations][2] in the *Amazon
|
1039
1119
|
# EC2 Auto Scaling User Guide*.
|
@@ -1415,13 +1495,13 @@ module Aws::AutoScaling
|
|
1415
1495
|
# associated action.
|
1416
1496
|
#
|
1417
1497
|
# To remove instances from the Auto Scaling group before deleting it,
|
1418
|
-
# call DetachInstances with the list of instances and the option
|
1419
|
-
# decrement the desired capacity. This ensures that Amazon EC2 Auto
|
1498
|
+
# call the DetachInstances API with the list of instances and the option
|
1499
|
+
# to decrement the desired capacity. This ensures that Amazon EC2 Auto
|
1420
1500
|
# Scaling does not launch replacement instances.
|
1421
1501
|
#
|
1422
1502
|
# To terminate all instances before deleting the Auto Scaling group,
|
1423
|
-
# call UpdateAutoScalingGroup and set the minimum size and
|
1424
|
-
# capacity of the Auto Scaling group to zero.
|
1503
|
+
# call the UpdateAutoScalingGroup API and set the minimum size and
|
1504
|
+
# desired capacity of the Auto Scaling group to zero.
|
1425
1505
|
#
|
1426
1506
|
# @option params [required, String] :auto_scaling_group_name
|
1427
1507
|
# The name of the Auto Scaling group.
|
@@ -1759,7 +1839,18 @@ module Aws::AutoScaling
|
|
1759
1839
|
req.send_request(options)
|
1760
1840
|
end
|
1761
1841
|
|
1762
|
-
# Describes the
|
1842
|
+
# Describes the available adjustment types for Amazon EC2 Auto Scaling
|
1843
|
+
# scaling policies. These settings apply to step scaling policies and
|
1844
|
+
# simple scaling policies; they do not apply to target tracking scaling
|
1845
|
+
# policies.
|
1846
|
+
#
|
1847
|
+
# The following adjustment types are supported:
|
1848
|
+
#
|
1849
|
+
# * ChangeInCapacity
|
1850
|
+
#
|
1851
|
+
# * ExactCapacity
|
1852
|
+
#
|
1853
|
+
# * PercentChangeInCapacity
|
1763
1854
|
#
|
1764
1855
|
# @return [Types::DescribeAdjustmentTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1765
1856
|
#
|
@@ -2095,6 +2186,77 @@ module Aws::AutoScaling
|
|
2095
2186
|
req.send_request(options)
|
2096
2187
|
end
|
2097
2188
|
|
2189
|
+
# Describes one or more instance refreshes.
|
2190
|
+
#
|
2191
|
+
# You can determine the status of a request by looking at the `Status`
|
2192
|
+
# parameter. The following are the possible statuses:
|
2193
|
+
#
|
2194
|
+
# * `Pending` - The request was created, but the operation has not
|
2195
|
+
# started.
|
2196
|
+
#
|
2197
|
+
# * `InProgress` - The operation is in progress.
|
2198
|
+
#
|
2199
|
+
# * `Successful` - The operation completed successfully.
|
2200
|
+
#
|
2201
|
+
# * `Failed` - The operation failed to complete. You can troubleshoot
|
2202
|
+
# using the status reason and the scaling activities.
|
2203
|
+
#
|
2204
|
+
# * `Cancelling` - An ongoing operation is being cancelled. Cancellation
|
2205
|
+
# does not roll back any replacements that have already been
|
2206
|
+
# completed, but it prevents new replacements from being started.
|
2207
|
+
#
|
2208
|
+
# * `Cancelled` - The operation is cancelled.
|
2209
|
+
#
|
2210
|
+
# @option params [required, String] :auto_scaling_group_name
|
2211
|
+
# The name of the Auto Scaling group.
|
2212
|
+
#
|
2213
|
+
# @option params [Array<String>] :instance_refresh_ids
|
2214
|
+
# One or more instance refresh IDs.
|
2215
|
+
#
|
2216
|
+
# @option params [String] :next_token
|
2217
|
+
# The token for the next set of items to return. (You received this
|
2218
|
+
# token from a previous call.)
|
2219
|
+
#
|
2220
|
+
# @option params [Integer] :max_records
|
2221
|
+
# The maximum number of items to return with this call. The default
|
2222
|
+
# value is `50` and the maximum value is `100`.
|
2223
|
+
#
|
2224
|
+
# @return [Types::DescribeInstanceRefreshesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2225
|
+
#
|
2226
|
+
# * {Types::DescribeInstanceRefreshesAnswer#instance_refreshes #instance_refreshes} => Array<Types::InstanceRefresh>
|
2227
|
+
# * {Types::DescribeInstanceRefreshesAnswer#next_token #next_token} => String
|
2228
|
+
#
|
2229
|
+
# @example Request syntax with placeholder values
|
2230
|
+
#
|
2231
|
+
# resp = client.describe_instance_refreshes({
|
2232
|
+
# auto_scaling_group_name: "XmlStringMaxLen255", # required
|
2233
|
+
# instance_refresh_ids: ["XmlStringMaxLen255"],
|
2234
|
+
# next_token: "XmlString",
|
2235
|
+
# max_records: 1,
|
2236
|
+
# })
|
2237
|
+
#
|
2238
|
+
# @example Response structure
|
2239
|
+
#
|
2240
|
+
# resp.instance_refreshes #=> Array
|
2241
|
+
# resp.instance_refreshes[0].instance_refresh_id #=> String
|
2242
|
+
# resp.instance_refreshes[0].auto_scaling_group_name #=> String
|
2243
|
+
# resp.instance_refreshes[0].status #=> String, one of "Pending", "InProgress", "Successful", "Failed", "Cancelling", "Cancelled"
|
2244
|
+
# resp.instance_refreshes[0].status_reason #=> String
|
2245
|
+
# resp.instance_refreshes[0].start_time #=> Time
|
2246
|
+
# resp.instance_refreshes[0].end_time #=> Time
|
2247
|
+
# resp.instance_refreshes[0].percentage_complete #=> Integer
|
2248
|
+
# resp.instance_refreshes[0].instances_to_update #=> Integer
|
2249
|
+
# resp.next_token #=> String
|
2250
|
+
#
|
2251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeInstanceRefreshes AWS API Documentation
|
2252
|
+
#
|
2253
|
+
# @overload describe_instance_refreshes(params = {})
|
2254
|
+
# @param [Hash] params ({})
|
2255
|
+
def describe_instance_refreshes(params = {}, options = {})
|
2256
|
+
req = build_request(:describe_instance_refreshes, params)
|
2257
|
+
req.send_request(options)
|
2258
|
+
end
|
2259
|
+
|
2098
2260
|
# Describes one or more launch configurations.
|
2099
2261
|
#
|
2100
2262
|
# @option params [Array<String>] :launch_configuration_names
|
@@ -2375,8 +2537,8 @@ module Aws::AutoScaling
|
|
2375
2537
|
# Describes the load balancers for the specified Auto Scaling group.
|
2376
2538
|
#
|
2377
2539
|
# This operation describes only Classic Load Balancers. If you have
|
2378
|
-
# Application Load Balancers or Network Load Balancers, use
|
2379
|
-
# DescribeLoadBalancerTargetGroups instead.
|
2540
|
+
# Application Load Balancers or Network Load Balancers, use the
|
2541
|
+
# DescribeLoadBalancerTargetGroups API instead.
|
2380
2542
|
#
|
2381
2543
|
# @option params [required, String] :auto_scaling_group_name
|
2382
2544
|
# The name of the Auto Scaling group.
|
@@ -2441,8 +2603,8 @@ module Aws::AutoScaling
|
|
2441
2603
|
# Scaling.
|
2442
2604
|
#
|
2443
2605
|
# The `GroupStandbyInstances` metric is not returned by default. You
|
2444
|
-
# must explicitly request this metric when calling
|
2445
|
-
# EnableMetricsCollection.
|
2606
|
+
# must explicitly request this metric when calling the
|
2607
|
+
# EnableMetricsCollection API.
|
2446
2608
|
#
|
2447
2609
|
# @return [Types::DescribeMetricCollectionTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2448
2610
|
#
|
@@ -2787,8 +2949,8 @@ module Aws::AutoScaling
|
|
2787
2949
|
req.send_request(options)
|
2788
2950
|
end
|
2789
2951
|
|
2790
|
-
# Describes the scaling process types for use with ResumeProcesses
|
2791
|
-
# SuspendProcesses.
|
2952
|
+
# Describes the scaling process types for use with the ResumeProcesses
|
2953
|
+
# and SuspendProcesses APIs.
|
2792
2954
|
#
|
2793
2955
|
# @return [Types::ProcessesType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2794
2956
|
#
|
@@ -2848,7 +3010,7 @@ module Aws::AutoScaling
|
|
2848
3010
|
|
2849
3011
|
# Describes the actions scheduled for your Auto Scaling group that
|
2850
3012
|
# haven't run or that have not reached their end time. To describe the
|
2851
|
-
# actions that have already run,
|
3013
|
+
# actions that have already run, call the DescribeScalingActivities API.
|
2852
3014
|
#
|
2853
3015
|
# @option params [String] :auto_scaling_group_name
|
2854
3016
|
# The name of the Auto Scaling group.
|
@@ -2954,6 +3116,13 @@ module Aws::AutoScaling
|
|
2954
3116
|
# for a particular tag only if it matches all the filters. If there's
|
2955
3117
|
# no match, no special message is returned.
|
2956
3118
|
#
|
3119
|
+
# For more information, see [Tagging Auto Scaling Groups and
|
3120
|
+
# Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
|
3121
|
+
#
|
3122
|
+
#
|
3123
|
+
#
|
3124
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
|
3125
|
+
#
|
2957
3126
|
# @option params [Array<Types::Filter>] :filters
|
2958
3127
|
# One or more filters to scope the tags to return. The maximum number of
|
2959
3128
|
# filters per filter type (for example, `auto-scaling-group`) is 1000.
|
@@ -3228,13 +3397,13 @@ module Aws::AutoScaling
|
|
3228
3397
|
# Scaling group.
|
3229
3398
|
#
|
3230
3399
|
# This operation detaches only Classic Load Balancers. If you have
|
3231
|
-
# Application Load Balancers or Network Load Balancers, use
|
3232
|
-
# DetachLoadBalancerTargetGroups instead.
|
3400
|
+
# Application Load Balancers or Network Load Balancers, use the
|
3401
|
+
# DetachLoadBalancerTargetGroups API instead.
|
3233
3402
|
#
|
3234
3403
|
# When you detach a load balancer, it enters the `Removing` state while
|
3235
3404
|
# deregistering the instances in the group. When all instances are
|
3236
3405
|
# deregistered, then you can no longer describe the load balancer using
|
3237
|
-
# DescribeLoadBalancers. The instances remain running.
|
3406
|
+
# the DescribeLoadBalancers API call. The instances remain running.
|
3238
3407
|
#
|
3239
3408
|
# @option params [required, String] :auto_scaling_group_name
|
3240
3409
|
# The name of the Auto Scaling group.
|
@@ -3279,8 +3448,7 @@ module Aws::AutoScaling
|
|
3279
3448
|
# The name of the Auto Scaling group.
|
3280
3449
|
#
|
3281
3450
|
# @option params [Array<String>] :metrics
|
3282
|
-
#
|
3283
|
-
# metrics are disabled.
|
3451
|
+
# Specifies one or more of the following metrics:
|
3284
3452
|
#
|
3285
3453
|
# * `GroupMinSize`
|
3286
3454
|
#
|
@@ -3298,6 +3466,18 @@ module Aws::AutoScaling
|
|
3298
3466
|
#
|
3299
3467
|
# * `GroupTotalInstances`
|
3300
3468
|
#
|
3469
|
+
# * `GroupInServiceCapacity`
|
3470
|
+
#
|
3471
|
+
# * `GroupPendingCapacity`
|
3472
|
+
#
|
3473
|
+
# * `GroupStandbyCapacity`
|
3474
|
+
#
|
3475
|
+
# * `GroupTerminatingCapacity`
|
3476
|
+
#
|
3477
|
+
# * `GroupTotalCapacity`
|
3478
|
+
#
|
3479
|
+
# If you omit this parameter, all metrics are disabled.
|
3480
|
+
#
|
3301
3481
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3302
3482
|
#
|
3303
3483
|
#
|
@@ -3340,8 +3520,8 @@ module Aws::AutoScaling
|
|
3340
3520
|
# The name of the Auto Scaling group.
|
3341
3521
|
#
|
3342
3522
|
# @option params [Array<String>] :metrics
|
3343
|
-
#
|
3344
|
-
#
|
3523
|
+
# Specifies which group-level metrics to start collecting. You can
|
3524
|
+
# specify one or more of the following metrics:
|
3345
3525
|
#
|
3346
3526
|
# * `GroupMinSize`
|
3347
3527
|
#
|
@@ -3359,6 +3539,21 @@ module Aws::AutoScaling
|
|
3359
3539
|
#
|
3360
3540
|
# * `GroupTotalInstances`
|
3361
3541
|
#
|
3542
|
+
# The instance weighting feature supports the following additional
|
3543
|
+
# metrics:
|
3544
|
+
#
|
3545
|
+
# * `GroupInServiceCapacity`
|
3546
|
+
#
|
3547
|
+
# * `GroupPendingCapacity`
|
3548
|
+
#
|
3549
|
+
# * `GroupStandbyCapacity`
|
3550
|
+
#
|
3551
|
+
# * `GroupTerminatingCapacity`
|
3552
|
+
#
|
3553
|
+
# * `GroupTotalCapacity`
|
3554
|
+
#
|
3555
|
+
# If you omit this parameter, all metrics are enabled.
|
3556
|
+
#
|
3362
3557
|
# @option params [required, String] :granularity
|
3363
3558
|
# The granularity to associate with the metrics to collect. The only
|
3364
3559
|
# valid value is `1Minute`.
|
@@ -3660,11 +3855,11 @@ module Aws::AutoScaling
|
|
3660
3855
|
# the instances launch or terminate.**
|
3661
3856
|
#
|
3662
3857
|
# 4. If you need more time, record the lifecycle action heartbeat to
|
3663
|
-
# keep the instance in a pending state using
|
3664
|
-
# RecordLifecycleActionHeartbeat.
|
3858
|
+
# keep the instance in a pending state using the
|
3859
|
+
# RecordLifecycleActionHeartbeat API call.
|
3665
3860
|
#
|
3666
3861
|
# 5. If you finish before the timeout period ends, complete the
|
3667
|
-
# lifecycle action using CompleteLifecycleAction.
|
3862
|
+
# lifecycle action using the CompleteLifecycleAction API call.
|
3668
3863
|
#
|
3669
3864
|
# For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
|
3670
3865
|
# in the *Amazon EC2 Auto Scaling User Guide*.
|
@@ -3672,9 +3867,10 @@ module Aws::AutoScaling
|
|
3672
3867
|
# If you exceed your maximum limit of lifecycle hooks, which by default
|
3673
3868
|
# is 50 per Auto Scaling group, the call fails.
|
3674
3869
|
#
|
3675
|
-
# You can view the lifecycle hooks for an Auto Scaling group using
|
3676
|
-
# DescribeLifecycleHooks. If you are no longer using a
|
3677
|
-
# you can delete it
|
3870
|
+
# You can view the lifecycle hooks for an Auto Scaling group using the
|
3871
|
+
# DescribeLifecycleHooks API call. If you are no longer using a
|
3872
|
+
# lifecycle hook, you can delete it by calling the DeleteLifecycleHook
|
3873
|
+
# API.
|
3678
3874
|
#
|
3679
3875
|
#
|
3680
3876
|
#
|
@@ -3732,8 +3928,8 @@ module Aws::AutoScaling
|
|
3732
3928
|
#
|
3733
3929
|
# If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
|
3734
3930
|
# action that you specified in the `DefaultResult` parameter. You can
|
3735
|
-
# prevent the lifecycle hook from timing out by calling
|
3736
|
-
# RecordLifecycleActionHeartbeat.
|
3931
|
+
# prevent the lifecycle hook from timing out by calling the
|
3932
|
+
# RecordLifecycleActionHeartbeat API.
|
3737
3933
|
#
|
3738
3934
|
# @option params [String] :default_result
|
3739
3935
|
# Defines the action the Auto Scaling group should take when the
|
@@ -3801,9 +3997,9 @@ module Aws::AutoScaling
|
|
3801
3997
|
# Service (Amazon SNS) topic.
|
3802
3998
|
#
|
3803
3999
|
# @option params [required, Array<String>] :notification_types
|
3804
|
-
# The type of event that causes the notification to be sent.
|
3805
|
-
#
|
3806
|
-
#
|
4000
|
+
# The type of event that causes the notification to be sent. To query
|
4001
|
+
# the notification types supported by Amazon EC2 Auto Scaling, call the
|
4002
|
+
# DescribeAutoScalingNotificationTypes API.
|
3807
4003
|
#
|
3808
4004
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3809
4005
|
#
|
@@ -3840,12 +4036,14 @@ module Aws::AutoScaling
|
|
3840
4036
|
# Creates or updates a scaling policy for an Auto Scaling group.
|
3841
4037
|
#
|
3842
4038
|
# For more information about using scaling policies to scale your Auto
|
3843
|
-
# Scaling group
|
3844
|
-
# EC2 Auto Scaling User
|
4039
|
+
# Scaling group, see [Target Tracking Scaling Policies][1] and [Step and
|
4040
|
+
# Simple Scaling Policies][2] in the *Amazon EC2 Auto Scaling User
|
4041
|
+
# Guide*.
|
3845
4042
|
#
|
3846
4043
|
#
|
3847
4044
|
#
|
3848
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-
|
4045
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html
|
4046
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
|
3849
4047
|
#
|
3850
4048
|
# @option params [required, String] :auto_scaling_group_name
|
3851
4049
|
# The name of the Auto Scaling group.
|
@@ -3876,20 +4074,22 @@ module Aws::AutoScaling
|
|
3876
4074
|
# instead.
|
3877
4075
|
#
|
3878
4076
|
# @option params [Integer] :min_adjustment_magnitude
|
3879
|
-
# The minimum
|
3880
|
-
#
|
3881
|
-
#
|
3882
|
-
#
|
4077
|
+
# The minimum value to scale by when scaling by percentages. For
|
4078
|
+
# example, suppose that you create a step scaling policy to scale out an
|
4079
|
+
# Auto Scaling group by 25 percent and you specify a
|
4080
|
+
# `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
|
4081
|
+
# scaling policy is performed, 25 percent of 4 is 1. However, because
|
4082
|
+
# you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
|
4083
|
+
# scales out the group by 2 instances.
|
4084
|
+
#
|
4085
|
+
# Valid only if the policy type is `StepScaling` or `SimpleScaling` and
|
4086
|
+
# the adjustment type is `PercentChangeInCapacity`. For more
|
4087
|
+
# information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
|
4088
|
+
# Scaling User Guide*.
|
3883
4089
|
#
|
3884
|
-
# This property replaces the `MinAdjustmentStep` property. For example,
|
3885
|
-
# suppose that you create a step scaling policy to scale out an Auto
|
3886
|
-
# Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
|
3887
|
-
# of 2. If the group has 4 instances and the scaling policy is
|
3888
|
-
# performed, 25 percent of 4 is 1. However, because you specified a
|
3889
|
-
# `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
|
3890
|
-
# group by 2 instances.
|
3891
4090
|
#
|
3892
|
-
#
|
4091
|
+
#
|
4092
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
|
3893
4093
|
#
|
3894
4094
|
# @option params [Integer] :scaling_adjustment
|
3895
4095
|
# The amount by which a simple scaling policy scales the Auto Scaling
|
@@ -4095,14 +4295,16 @@ module Aws::AutoScaling
|
|
4095
4295
|
# [1]: http://crontab.org
|
4096
4296
|
#
|
4097
4297
|
# @option params [Integer] :min_size
|
4098
|
-
# The minimum
|
4298
|
+
# The minimum size of the Auto Scaling group.
|
4099
4299
|
#
|
4100
4300
|
# @option params [Integer] :max_size
|
4101
|
-
# The maximum
|
4301
|
+
# The maximum size of the Auto Scaling group.
|
4102
4302
|
#
|
4103
4303
|
# @option params [Integer] :desired_capacity
|
4104
|
-
# The
|
4105
|
-
#
|
4304
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
4305
|
+
# after the scheduled action runs and the capacity it attempts to
|
4306
|
+
# maintain. It can scale beyond this capacity if you add more scaling
|
4307
|
+
# conditions.
|
4106
4308
|
#
|
4107
4309
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4108
4310
|
#
|
@@ -4146,7 +4348,7 @@ module Aws::AutoScaling
|
|
4146
4348
|
|
4147
4349
|
# Records a heartbeat for the lifecycle action associated with the
|
4148
4350
|
# specified token or instance. This extends the timeout by the length of
|
4149
|
-
# time defined using PutLifecycleHook.
|
4351
|
+
# time defined using the PutLifecycleHook API call.
|
4150
4352
|
#
|
4151
4353
|
# This step is a part of the procedure for adding a lifecycle hook to an
|
4152
4354
|
# Auto Scaling group:
|
@@ -4236,24 +4438,27 @@ module Aws::AutoScaling
|
|
4236
4438
|
# The name of the Auto Scaling group.
|
4237
4439
|
#
|
4238
4440
|
# @option params [Array<String>] :scaling_processes
|
4239
|
-
# One or more of the following processes
|
4240
|
-
# all processes are specified.
|
4441
|
+
# One or more of the following processes:
|
4241
4442
|
#
|
4242
4443
|
# * `Launch`
|
4243
4444
|
#
|
4244
4445
|
# * `Terminate`
|
4245
4446
|
#
|
4246
|
-
# * `
|
4447
|
+
# * `AddToLoadBalancer`
|
4247
4448
|
#
|
4248
|
-
# * `
|
4449
|
+
# * `AlarmNotification`
|
4249
4450
|
#
|
4250
4451
|
# * `AZRebalance`
|
4251
4452
|
#
|
4252
|
-
# * `
|
4453
|
+
# * `HealthCheck`
|
4454
|
+
#
|
4455
|
+
# * `InstanceRefresh`
|
4456
|
+
#
|
4457
|
+
# * `ReplaceUnhealthy`
|
4253
4458
|
#
|
4254
4459
|
# * `ScheduledActions`
|
4255
4460
|
#
|
4256
|
-
#
|
4461
|
+
# If you omit this parameter, all processes are specified.
|
4257
4462
|
#
|
4258
4463
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4259
4464
|
#
|
@@ -4287,19 +4492,25 @@ module Aws::AutoScaling
|
|
4287
4492
|
|
4288
4493
|
# Sets the size of the specified Auto Scaling group.
|
4289
4494
|
#
|
4290
|
-
#
|
4291
|
-
#
|
4495
|
+
# If a scale-in activity occurs as a result of a new `DesiredCapacity`
|
4496
|
+
# value that is lower than the current size of the group, the Auto
|
4497
|
+
# Scaling group uses its termination policy to determine which instances
|
4498
|
+
# to terminate.
|
4499
|
+
#
|
4500
|
+
# For more information, see [Manual Scaling][1] in the *Amazon EC2 Auto
|
4501
|
+
# Scaling User Guide*.
|
4292
4502
|
#
|
4293
4503
|
#
|
4294
4504
|
#
|
4295
|
-
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/
|
4505
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html
|
4296
4506
|
#
|
4297
4507
|
# @option params [required, String] :auto_scaling_group_name
|
4298
4508
|
# The name of the Auto Scaling group.
|
4299
4509
|
#
|
4300
4510
|
# @option params [required, Integer] :desired_capacity
|
4301
|
-
# The
|
4302
|
-
#
|
4511
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
4512
|
+
# after this operation completes and the capacity it attempts to
|
4513
|
+
# maintain.
|
4303
4514
|
#
|
4304
4515
|
# @option params [Boolean] :honor_cooldown
|
4305
4516
|
# Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
|
@@ -4363,7 +4574,12 @@ module Aws::AutoScaling
|
|
4363
4574
|
# not respect the grace period associated with the group.
|
4364
4575
|
#
|
4365
4576
|
# For more information about the health check grace period, see
|
4366
|
-
# CreateAutoScalingGroup
|
4577
|
+
# [CreateAutoScalingGroup][1] in the *Amazon EC2 Auto Scaling API
|
4578
|
+
# Reference*.
|
4579
|
+
#
|
4580
|
+
#
|
4581
|
+
#
|
4582
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html
|
4367
4583
|
#
|
4368
4584
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4369
4585
|
#
|
@@ -4458,16 +4674,79 @@ module Aws::AutoScaling
|
|
4458
4674
|
req.send_request(options)
|
4459
4675
|
end
|
4460
4676
|
|
4677
|
+
# Starts a new instance refresh operation, which triggers a rolling
|
4678
|
+
# replacement of all previously launched instances in the Auto Scaling
|
4679
|
+
# group with a new group of instances.
|
4680
|
+
#
|
4681
|
+
# If successful, this call creates a new instance refresh request with a
|
4682
|
+
# unique ID that you can use to track its progress. To query its status,
|
4683
|
+
# call the DescribeInstanceRefreshes API. To describe the instance
|
4684
|
+
# refreshes that have already run, call the DescribeInstanceRefreshes
|
4685
|
+
# API. To cancel an active instance refresh operation, use the
|
4686
|
+
# CancelInstanceRefresh API.
|
4687
|
+
#
|
4688
|
+
# For more information, see [Replacing Auto Scaling Instances Based on
|
4689
|
+
# an Instance Refresh][1].
|
4690
|
+
#
|
4691
|
+
#
|
4692
|
+
#
|
4693
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
|
4694
|
+
#
|
4695
|
+
# @option params [required, String] :auto_scaling_group_name
|
4696
|
+
# The name of the Auto Scaling group.
|
4697
|
+
#
|
4698
|
+
# @option params [String] :strategy
|
4699
|
+
# The strategy to use for the instance refresh. The only valid value is
|
4700
|
+
# `Rolling`.
|
4701
|
+
#
|
4702
|
+
# A rolling update is an update that is applied to all instances in an
|
4703
|
+
# Auto Scaling group until all instances have been updated. A rolling
|
4704
|
+
# update can fail due to failed health checks or if instances are on
|
4705
|
+
# standby or are protected from scale-in. If the rolling update process
|
4706
|
+
# fails, any instances that were already replaced are not rolled back to
|
4707
|
+
# their previous configuration.
|
4708
|
+
#
|
4709
|
+
# @option params [Types::RefreshPreferences] :preferences
|
4710
|
+
# Set of preferences associated with the instance refresh request.
|
4711
|
+
#
|
4712
|
+
# @return [Types::StartInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4713
|
+
#
|
4714
|
+
# * {Types::StartInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
|
4715
|
+
#
|
4716
|
+
# @example Request syntax with placeholder values
|
4717
|
+
#
|
4718
|
+
# resp = client.start_instance_refresh({
|
4719
|
+
# auto_scaling_group_name: "XmlStringMaxLen255", # required
|
4720
|
+
# strategy: "Rolling", # accepts Rolling
|
4721
|
+
# preferences: {
|
4722
|
+
# min_healthy_percentage: 1,
|
4723
|
+
# instance_warmup: 1,
|
4724
|
+
# },
|
4725
|
+
# })
|
4726
|
+
#
|
4727
|
+
# @example Response structure
|
4728
|
+
#
|
4729
|
+
# resp.instance_refresh_id #=> String
|
4730
|
+
#
|
4731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/StartInstanceRefresh AWS API Documentation
|
4732
|
+
#
|
4733
|
+
# @overload start_instance_refresh(params = {})
|
4734
|
+
# @param [Hash] params ({})
|
4735
|
+
def start_instance_refresh(params = {}, options = {})
|
4736
|
+
req = build_request(:start_instance_refresh, params)
|
4737
|
+
req.send_request(options)
|
4738
|
+
end
|
4739
|
+
|
4461
4740
|
# Suspends the specified automatic scaling processes, or all processes,
|
4462
4741
|
# for the specified Auto Scaling group.
|
4463
4742
|
#
|
4464
4743
|
# If you suspend either the `Launch` or `Terminate` process types, it
|
4465
|
-
# can prevent other process types from functioning properly.
|
4466
|
-
#
|
4467
|
-
#
|
4744
|
+
# can prevent other process types from functioning properly. For more
|
4745
|
+
# information, see [Suspending and Resuming Scaling Processes][1] in the
|
4746
|
+
# *Amazon EC2 Auto Scaling User Guide*.
|
4468
4747
|
#
|
4469
|
-
#
|
4470
|
-
#
|
4748
|
+
# To resume processes that have been suspended, call the ResumeProcesses
|
4749
|
+
# API.
|
4471
4750
|
#
|
4472
4751
|
#
|
4473
4752
|
#
|
@@ -4477,24 +4756,27 @@ module Aws::AutoScaling
|
|
4477
4756
|
# The name of the Auto Scaling group.
|
4478
4757
|
#
|
4479
4758
|
# @option params [Array<String>] :scaling_processes
|
4480
|
-
# One or more of the following processes
|
4481
|
-
# all processes are specified.
|
4759
|
+
# One or more of the following processes:
|
4482
4760
|
#
|
4483
4761
|
# * `Launch`
|
4484
4762
|
#
|
4485
4763
|
# * `Terminate`
|
4486
4764
|
#
|
4487
|
-
# * `
|
4765
|
+
# * `AddToLoadBalancer`
|
4488
4766
|
#
|
4489
|
-
# * `
|
4767
|
+
# * `AlarmNotification`
|
4490
4768
|
#
|
4491
4769
|
# * `AZRebalance`
|
4492
4770
|
#
|
4493
|
-
# * `
|
4771
|
+
# * `HealthCheck`
|
4772
|
+
#
|
4773
|
+
# * `InstanceRefresh`
|
4774
|
+
#
|
4775
|
+
# * `ReplaceUnhealthy`
|
4494
4776
|
#
|
4495
4777
|
# * `ScheduledActions`
|
4496
4778
|
#
|
4497
|
-
#
|
4779
|
+
# If you omit this parameter, all processes are specified.
|
4498
4780
|
#
|
4499
4781
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4500
4782
|
#
|
@@ -4527,10 +4809,12 @@ module Aws::AutoScaling
|
|
4527
4809
|
end
|
4528
4810
|
|
4529
4811
|
# Terminates the specified instance and optionally adjusts the desired
|
4530
|
-
# group size.
|
4531
|
-
#
|
4532
|
-
#
|
4533
|
-
#
|
4812
|
+
# group size.
|
4813
|
+
#
|
4814
|
+
# This call simply makes a termination request. The instance is not
|
4815
|
+
# terminated immediately. When an instance is terminated, the instance
|
4816
|
+
# status changes to `terminated`. You can't connect to or start an
|
4817
|
+
# instance after you've terminated it.
|
4534
4818
|
#
|
4535
4819
|
# If you do not specify the option to decrement the desired capacity,
|
4536
4820
|
# Amazon EC2 Auto Scaling launches instances to replace the ones that
|
@@ -4623,7 +4907,7 @@ module Aws::AutoScaling
|
|
4623
4907
|
# Note the following about changing `DesiredCapacity`, `MaxSize`, or
|
4624
4908
|
# `MinSize`\:
|
4625
4909
|
#
|
4626
|
-
# * If a scale-in
|
4910
|
+
# * If a scale-in activity occurs as a result of a new `DesiredCapacity`
|
4627
4911
|
# value that is lower than the current size of the group, the Auto
|
4628
4912
|
# Scaling group uses its termination policy to determine which
|
4629
4913
|
# instances to terminate.
|
@@ -4638,10 +4922,11 @@ module Aws::AutoScaling
|
|
4638
4922
|
# current size of the group, this sets the group's `DesiredCapacity`
|
4639
4923
|
# to the new `MaxSize` value.
|
4640
4924
|
#
|
4641
|
-
# To see which parameters have been set,
|
4642
|
-
#
|
4643
|
-
# DescribePolicies. If the group has
|
4644
|
-
# them
|
4925
|
+
# To see which parameters have been set, call the
|
4926
|
+
# DescribeAutoScalingGroups API. To view the scaling policies for an
|
4927
|
+
# Auto Scaling group, call the DescribePolicies API. If the group has
|
4928
|
+
# scaling policies, you can update them by calling the PutScalingPolicy
|
4929
|
+
# API.
|
4645
4930
|
#
|
4646
4931
|
# @option params [required, String] :auto_scaling_group_name
|
4647
4932
|
# The name of the Auto Scaling group.
|
@@ -4686,10 +4971,22 @@ module Aws::AutoScaling
|
|
4686
4971
|
# @option params [Integer] :max_size
|
4687
4972
|
# The maximum size of the Auto Scaling group.
|
4688
4973
|
#
|
4974
|
+
# <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
|
4975
|
+
# Auto Scaling may need to go above `MaxSize` to meet your capacity
|
4976
|
+
# requirements. In this event, Amazon EC2 Auto Scaling will never go
|
4977
|
+
# above `MaxSize` by more than your maximum instance weight (weights
|
4978
|
+
# that define how many capacity units each instance contributes to the
|
4979
|
+
# capacity of the group).
|
4980
|
+
#
|
4981
|
+
# </note>
|
4982
|
+
#
|
4689
4983
|
# @option params [Integer] :desired_capacity
|
4690
|
-
# The
|
4691
|
-
#
|
4692
|
-
#
|
4984
|
+
# The desired capacity is the initial capacity of the Auto Scaling group
|
4985
|
+
# after this operation completes and the capacity it attempts to
|
4986
|
+
# maintain.
|
4987
|
+
#
|
4988
|
+
# This number must be greater than or equal to the minimum size of the
|
4989
|
+
# group and less than or equal to the maximum size of the group.
|
4693
4990
|
#
|
4694
4991
|
# @option params [Integer] :default_cooldown
|
4695
4992
|
# The amount of time, in seconds, after a scaling activity completes
|
@@ -4785,13 +5082,17 @@ module Aws::AutoScaling
|
|
4785
5082
|
#
|
4786
5083
|
# @option params [Integer] :max_instance_lifetime
|
4787
5084
|
# The maximum amount of time, in seconds, that an instance can be in
|
4788
|
-
# service.
|
5085
|
+
# service. The default is null.
|
5086
|
+
#
|
5087
|
+
# This parameter is optional, but if you specify a value for it, you
|
5088
|
+
# must specify a value of at least 604,800 seconds (7 days). To clear a
|
5089
|
+
# previously set value, specify a new value of 0.
|
4789
5090
|
#
|
4790
5091
|
# For more information, see [Replacing Auto Scaling Instances Based on
|
4791
5092
|
# Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
|
4792
5093
|
# Guide*.
|
4793
5094
|
#
|
4794
|
-
# Valid Range: Minimum value of
|
5095
|
+
# Valid Range: Minimum value of 0.
|
4795
5096
|
#
|
4796
5097
|
#
|
4797
5098
|
#
|
@@ -4898,7 +5199,7 @@ module Aws::AutoScaling
|
|
4898
5199
|
params: params,
|
4899
5200
|
config: config)
|
4900
5201
|
context[:gem_name] = 'aws-sdk-autoscaling'
|
4901
|
-
context[:gem_version] = '1.
|
5202
|
+
context[:gem_version] = '1.40.0'
|
4902
5203
|
Seahorse::Client::Request.new(handlers, context)
|
4903
5204
|
end
|
4904
5205
|
|