aws-sdk-autoscaling 1.35.0 → 1.36.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a6c183ad8f13fe8d2c9f1eb371ac7dc45bdc3efddb4f57b601b14dfd7fb8b1fb
4
- data.tar.gz: 1451b01dfef6d628fe7facc397a777e9f914158792ba3f0d8c4eb78a44f929a0
3
+ metadata.gz: c1ea8c327418e3423e234d451050995d1dab98486db36b5e8b2713196b87d3da
4
+ data.tar.gz: c3a6fe5e513a3c2af82e4aa6f6befef66f9c0463127ab48f89401ab72f3eae3e
5
5
  SHA512:
6
- metadata.gz: acce4076c25f60a05b3df662940e10b281db84ea962001b0598829ec74571c65023ba8e3c8d9212d7950605eb966b4c9c611dfac71ecdd0555e063b1dcd256bb
7
- data.tar.gz: 707f1264a32a115415df8e407f45db0d29172d78b4d6c5d9be37dc24117262e892126b3cd8075a8f6bb261c7e56554c7a02f005816e3e02d7a6fa97a6a147b99
6
+ metadata.gz: '04102821b6b81b72841cf084c219327a35aac9ae1d0d16473795edb68dd90409868651493db2616fa3fd333b114f8efbb371b2b4a964e5a54c512a5b8cba749b'
7
+ data.tar.gz: 3dd50231249f5e11319819eab74fe2eba9d928ac8703e3068e9603433dce0bc0e3dcda1e78529d06b27aa54828176820478b37906fb4043d71f7250f5a4b1815
@@ -56,6 +56,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
56
56
  # @service
57
57
  module Aws::AutoScaling
58
58
 
59
- GEM_VERSION = '1.35.0'
59
+ GEM_VERSION = '1.36.0'
60
60
 
61
61
  end
@@ -149,8 +149,8 @@ module Aws::AutoScaling
149
149
  data[:enabled_metrics]
150
150
  end
151
151
 
152
- # The current state of the group when DeleteAutoScalingGroup is in
153
- # progress.
152
+ # The current state of the group when the DeleteAutoScalingGroup
153
+ # operation is in progress.
154
154
  # @return [String]
155
155
  def status
156
156
  data[:status]
@@ -179,7 +179,7 @@ module Aws::AutoScaling
179
179
  # The maximum amount of time, in seconds, that an instance can be in
180
180
  # service.
181
181
  #
182
- # Valid Range: Minimum value of 604800.
182
+ # Valid Range: Minimum value of 0.
183
183
  # @return [Integer]
184
184
  def max_instance_lifetime
185
185
  data[:max_instance_lifetime]
@@ -451,8 +451,7 @@ module Aws::AutoScaling
451
451
  # })
452
452
  # @param [Hash] options ({})
453
453
  # @option options [Array<String>] :metrics
454
- # One or more of the following metrics. If you omit this parameter, all
455
- # metrics are disabled.
454
+ # Specifies one or more of the following metrics:
456
455
  #
457
456
  # * `GroupMinSize`
458
457
  #
@@ -469,6 +468,18 @@ module Aws::AutoScaling
469
468
  # * `GroupTerminatingInstances`
470
469
  #
471
470
  # * `GroupTotalInstances`
471
+ #
472
+ # * `GroupInServiceCapacity`
473
+ #
474
+ # * `GroupPendingCapacity`
475
+ #
476
+ # * `GroupStandbyCapacity`
477
+ #
478
+ # * `GroupTerminatingCapacity`
479
+ #
480
+ # * `GroupTotalCapacity`
481
+ #
482
+ # If you omit this parameter, all metrics are disabled.
472
483
  # @return [EmptyStructure]
473
484
  def disable_metrics_collection(options = {})
474
485
  options = options.merge(auto_scaling_group_name: @name)
@@ -484,8 +495,8 @@ module Aws::AutoScaling
484
495
  # })
485
496
  # @param [Hash] options ({})
486
497
  # @option options [Array<String>] :metrics
487
- # One or more of the following metrics. If you omit this parameter, all
488
- # metrics are enabled.
498
+ # Specifies which group-level metrics to start collecting. You can
499
+ # specify one or more of the following metrics:
489
500
  #
490
501
  # * `GroupMinSize`
491
502
  #
@@ -502,6 +513,21 @@ module Aws::AutoScaling
502
513
  # * `GroupTerminatingInstances`
503
514
  #
504
515
  # * `GroupTotalInstances`
516
+ #
517
+ # The instance weighting feature supports the following additional
518
+ # metrics:
519
+ #
520
+ # * `GroupInServiceCapacity`
521
+ #
522
+ # * `GroupPendingCapacity`
523
+ #
524
+ # * `GroupStandbyCapacity`
525
+ #
526
+ # * `GroupTerminatingCapacity`
527
+ #
528
+ # * `GroupTotalCapacity`
529
+ #
530
+ # If you omit this parameter, all metrics are enabled.
505
531
  # @option options [required, String] :granularity
506
532
  # The granularity to associate with the metrics to collect. The only
507
533
  # valid value is `1Minute`.
@@ -576,20 +602,22 @@ module Aws::AutoScaling
576
602
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
577
603
  # instead.
578
604
  # @option options [Integer] :min_adjustment_magnitude
579
- # The minimum number of instances to scale. If the value of
580
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
581
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
582
- # this many instances. Otherwise, the error is `ValidationError`.
583
- #
584
- # This property replaces the `MinAdjustmentStep` property. For example,
585
- # suppose that you create a step scaling policy to scale out an Auto
586
- # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
587
- # of 2. If the group has 4 instances and the scaling policy is
588
- # performed, 25 percent of 4 is 1. However, because you specified a
589
- # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
590
- # group by 2 instances.
591
- #
592
- # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
605
+ # The minimum value to scale by when scaling by percentages. For
606
+ # example, suppose that you create a step scaling policy to scale out an
607
+ # Auto Scaling group by 25 percent and you specify a
608
+ # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
609
+ # scaling policy is performed, 25 percent of 4 is 1. However, because
610
+ # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
611
+ # scales out the group by 2 instances.
612
+ #
613
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
614
+ # the adjustment type is `PercentChangeInCapacity`. For more
615
+ # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
616
+ # Scaling User Guide*.
617
+ #
618
+ #
619
+ #
620
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
593
621
  # @option options [Integer] :scaling_adjustment
594
622
  # The amount by which a simple scaling policy scales the Auto Scaling
595
623
  # group in response to an alarm breach. The adjustment is based on the
@@ -658,7 +686,7 @@ module Aws::AutoScaling
658
686
  # @return [ScalingPolicy]
659
687
  def put_scaling_policy(options = {})
660
688
  options = options.merge(auto_scaling_group_name: @name)
661
- resp = @client.put_scaling_policy(options)
689
+ @client.put_scaling_policy(options)
662
690
  ScalingPolicy.new(
663
691
  name: options[:policy_name],
664
692
  client: @client
@@ -710,16 +738,18 @@ module Aws::AutoScaling
710
738
  #
711
739
  # [1]: http://crontab.org
712
740
  # @option options [Integer] :min_size
713
- # The minimum number of instances in the Auto Scaling group.
741
+ # The minimum size of the Auto Scaling group.
714
742
  # @option options [Integer] :max_size
715
- # The maximum number of instances in the Auto Scaling group.
743
+ # The maximum size of the Auto Scaling group.
716
744
  # @option options [Integer] :desired_capacity
717
- # The number of EC2 instances that should be running in the Auto Scaling
718
- # group.
745
+ # The desired capacity is the initial capacity of the Auto Scaling group
746
+ # after the scheduled action runs and the capacity it attempts to
747
+ # maintain. It can scale beyond this capacity if you add more scaling
748
+ # conditions.
719
749
  # @return [ScheduledAction]
720
750
  def put_scheduled_update_group_action(options = {})
721
751
  options = options.merge(auto_scaling_group_name: @name)
722
- resp = @client.put_scheduled_update_group_action(options)
752
+ @client.put_scheduled_update_group_action(options)
723
753
  ScheduledAction.new(
724
754
  name: options[:scheduled_action_name],
725
755
  client: @client
@@ -766,8 +796,9 @@ module Aws::AutoScaling
766
796
  # })
767
797
  # @param [Hash] options ({})
768
798
  # @option options [required, Integer] :desired_capacity
769
- # The number of EC2 instances that should be running in the Auto Scaling
770
- # group.
799
+ # The desired capacity is the initial capacity of the Auto Scaling group
800
+ # after this operation completes and the capacity it attempts to
801
+ # maintain.
771
802
  # @option options [Boolean] :honor_cooldown
772
803
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
773
804
  # period to complete before initiating a scaling activity to set your
@@ -895,10 +926,22 @@ module Aws::AutoScaling
895
926
  # The minimum size of the Auto Scaling group.
896
927
  # @option options [Integer] :max_size
897
928
  # The maximum size of the Auto Scaling group.
929
+ #
930
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
931
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
932
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
933
+ # above `MaxSize` by more than your maximum instance weight (weights
934
+ # that define how many capacity units each instance contributes to the
935
+ # capacity of the group).
936
+ #
937
+ # </note>
898
938
  # @option options [Integer] :desired_capacity
899
- # The number of EC2 instances that should be running in the Auto Scaling
900
- # group. This number must be greater than or equal to the minimum size
901
- # of the group and less than or equal to the maximum size of the group.
939
+ # The desired capacity is the initial capacity of the Auto Scaling group
940
+ # after this operation completes and the capacity it attempts to
941
+ # maintain.
942
+ #
943
+ # This number must be greater than or equal to the minimum size of the
944
+ # group and less than or equal to the maximum size of the group.
902
945
  # @option options [Integer] :default_cooldown
903
946
  # The amount of time, in seconds, after a scaling activity completes
904
947
  # before another scaling activity can start. The default value is `300`.
@@ -984,13 +1027,17 @@ module Aws::AutoScaling
984
1027
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
985
1028
  # @option options [Integer] :max_instance_lifetime
986
1029
  # The maximum amount of time, in seconds, that an instance can be in
987
- # service.
1030
+ # service. The default is null.
1031
+ #
1032
+ # This parameter is optional, but if you specify a value for it, you
1033
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
1034
+ # previously set value, specify a new value of 0.
988
1035
  #
989
1036
  # For more information, see [Replacing Auto Scaling Instances Based on
990
1037
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
991
1038
  # Guide*.
992
1039
  #
993
- # Valid Range: Minimum value of 604800.
1040
+ # Valid Range: Minimum value of 0.
994
1041
  #
995
1042
  #
996
1043
  #
@@ -998,7 +1045,7 @@ module Aws::AutoScaling
998
1045
  # @return [AutoScalingGroup]
999
1046
  def update(options = {})
1000
1047
  options = options.merge(auto_scaling_group_name: @name)
1001
- resp = @client.update_auto_scaling_group(options)
1048
+ @client.update_auto_scaling_group(options)
1002
1049
  AutoScalingGroup.new(
1003
1050
  name: options[:auto_scaling_group_name],
1004
1051
  client: @client
@@ -368,9 +368,9 @@ module Aws::AutoScaling
368
368
  # Attaches one or more target groups to the specified Auto Scaling
369
369
  # group.
370
370
  #
371
- # To describe the target groups for an Auto Scaling group, use
372
- # DescribeLoadBalancerTargetGroups. To detach the target group from the
373
- # Auto Scaling group, use DetachLoadBalancerTargetGroups.
371
+ # To describe the target groups for an Auto Scaling group, call the
372
+ # DescribeLoadBalancerTargetGroups API. To detach the target group from
373
+ # the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
374
374
  #
375
375
  # With Application Load Balancers and Network Load Balancers, instances
376
376
  # are registered as targets with a target group. With Classic Load
@@ -419,15 +419,18 @@ module Aws::AutoScaling
419
419
  req.send_request(options)
420
420
  end
421
421
 
422
- # Attaches one or more Classic Load Balancers to the specified Auto
423
- # Scaling group.
422
+ # <note markdown="1"> To attach an Application Load Balancer or a Network Load Balancer, use
423
+ # the AttachLoadBalancerTargetGroups API operation instead.
424
424
  #
425
- # To attach an Application Load Balancer or a Network Load Balancer
426
- # instead, see AttachLoadBalancerTargetGroups.
425
+ # </note>
427
426
  #
428
- # To describe the load balancers for an Auto Scaling group, use
429
- # DescribeLoadBalancers. To detach the load balancer from the Auto
430
- # Scaling group, use DetachLoadBalancers.
427
+ # Attaches one or more Classic Load Balancers to the specified Auto
428
+ # Scaling group. Amazon EC2 Auto Scaling registers the running instances
429
+ # with these Classic Load Balancers.
430
+ #
431
+ # To describe the load balancers for an Auto Scaling group, call the
432
+ # DescribeLoadBalancers API. To detach the load balancer from the Auto
433
+ # Scaling group, call the DetachLoadBalancers API.
431
434
  #
432
435
  # For more information, see [Attaching a Load Balancer to Your Auto
433
436
  # Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -644,34 +647,49 @@ module Aws::AutoScaling
644
647
  # Creates an Auto Scaling group with the specified name and attributes.
645
648
  #
646
649
  # If you exceed your maximum limit of Auto Scaling groups, the call
647
- # fails. For information about viewing this limit, see
648
- # DescribeAccountLimits. For information about updating this limit, see
649
- # [Amazon EC2 Auto Scaling Service Quotas][1] in the *Amazon EC2 Auto
650
- # Scaling User Guide*.
650
+ # fails. To query this limit, call the DescribeAccountLimits API. For
651
+ # information about updating this limit, see [Amazon EC2 Auto Scaling
652
+ # Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
653
+ #
654
+ # For introductory exercises for creating an Auto Scaling group, see
655
+ # [Getting Started with Amazon EC2 Auto Scaling][2] and [Tutorial: Set
656
+ # Up a Scaled and Load-Balanced Application][3] in the *Amazon EC2 Auto
657
+ # Scaling User Guide*. For more information, see [Auto Scaling
658
+ # Groups][4] in the *Amazon EC2 Auto Scaling User Guide*.
651
659
  #
652
660
  #
653
661
  #
654
662
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
663
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html
664
+ # [3]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html
665
+ # [4]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html
655
666
  #
656
667
  # @option params [required, String] :auto_scaling_group_name
657
668
  # The name of the Auto Scaling group. This name must be unique per
658
669
  # Region per account.
659
670
  #
660
671
  # @option params [String] :launch_configuration_name
661
- # The name of the launch configuration.
672
+ # The name of the launch configuration to use when an instance is
673
+ # launched. To get the launch configuration name, use the
674
+ # DescribeLaunchConfigurations API operation. New launch configurations
675
+ # can be created with the CreateLaunchConfiguration API.
662
676
  #
663
- # If you do not specify `LaunchConfigurationName`, you must specify one
664
- # of the following parameters: `InstanceId`, `LaunchTemplate`, or
677
+ # You must specify one of the following parameters in your request:
678
+ # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
665
679
  # `MixedInstancesPolicy`.
666
680
  #
667
681
  # @option params [Types::LaunchTemplateSpecification] :launch_template
668
- # The launch template to use to launch instances.
682
+ # Parameters used to specify the launch template and version to use when
683
+ # an instance is launched.
669
684
  #
670
685
  # For more information, see [LaunchTemplateSpecification][1] in the
671
686
  # *Amazon EC2 Auto Scaling API Reference*.
672
687
  #
673
- # If you do not specify `LaunchTemplate`, you must specify one of the
674
- # following parameters: `InstanceId`, `LaunchConfigurationName`, or
688
+ # You can alternatively associate a launch template to the Auto Scaling
689
+ # group by using the `MixedInstancesPolicy` parameter.
690
+ #
691
+ # You must specify one of the following parameters in your request:
692
+ # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
675
693
  # `MixedInstancesPolicy`.
676
694
  #
677
695
  #
@@ -706,23 +724,21 @@ module Aws::AutoScaling
706
724
  #
707
725
  # @option params [String] :instance_id
708
726
  # The ID of the instance used to create a launch configuration for the
709
- # group.
727
+ # group. To get the instance ID, use the Amazon EC2
728
+ # [DescribeInstances][1] API operation.
710
729
  #
711
730
  # When you specify an ID of an instance, Amazon EC2 Auto Scaling creates
712
731
  # a new launch configuration and associates it with the group. This
713
732
  # launch configuration derives its attributes from the specified
714
733
  # instance, except for the block device mapping.
715
734
  #
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
735
  # You must specify one of the following parameters in your request:
720
736
  # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
721
737
  # `MixedInstancesPolicy`.
722
738
  #
723
739
  #
724
740
  #
725
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
741
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
726
742
  #
727
743
  # @option params [required, Integer] :min_size
728
744
  # The minimum size of the group.
@@ -730,12 +746,24 @@ module Aws::AutoScaling
730
746
  # @option params [required, Integer] :max_size
731
747
  # The maximum size of the group.
732
748
  #
749
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
750
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
751
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
752
+ # above `MaxSize` by more than your maximum instance weight (weights
753
+ # that define how many capacity units each instance contributes to the
754
+ # capacity of the group).
755
+ #
756
+ # </note>
757
+ #
733
758
  # @option params [Integer] :desired_capacity
734
- # The number of Amazon EC2 instances that the Auto Scaling group
735
- # attempts to maintain. This number must be greater than or equal to the
736
- # minimum size of the group and less than or equal to the maximum size
737
- # of the group. If you do not specify a desired capacity, the default is
738
- # the minimum size of the group.
759
+ # The desired capacity is the initial capacity of the Auto Scaling group
760
+ # at the time of its creation and the capacity it attempts to maintain.
761
+ # It can scale beyond this capacity if you configure automatic scaling.
762
+ #
763
+ # This number must be greater than or equal to the minimum size of the
764
+ # group and less than or equal to the maximum size of the group. If you
765
+ # do not specify a desired capacity, the default is the minimum size of
766
+ # the group.
739
767
  #
740
768
  # @option params [Integer] :default_cooldown
741
769
  # The amount of time, in seconds, after a scaling activity completes
@@ -861,7 +889,15 @@ module Aws::AutoScaling
861
889
  # One or more lifecycle hooks.
862
890
  #
863
891
  # @option params [Array<Types::Tag>] :tags
864
- # One or more tags.
892
+ # One or more tags. You can tag your Auto Scaling group and propagate
893
+ # the tags to the Amazon EC2 instances it launches.
894
+ #
895
+ # Tags are not propagated to Amazon EBS volumes. To add tags to Amazon
896
+ # EBS volumes, specify the tags in a launch template but use caution. If
897
+ # the launch template specifies an instance tag with a key that is also
898
+ # specified for the Auto Scaling group, Amazon EC2 Auto Scaling
899
+ # overrides the value of that instance tag with the value specified by
900
+ # the Auto Scaling group.
865
901
  #
866
902
  # For more information, see [Tagging Auto Scaling Groups and
867
903
  # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -884,13 +920,17 @@ module Aws::AutoScaling
884
920
  #
885
921
  # @option params [Integer] :max_instance_lifetime
886
922
  # The maximum amount of time, in seconds, that an instance can be in
887
- # service.
923
+ # service. The default is null.
924
+ #
925
+ # This parameter is optional, but if you specify a value for it, you
926
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
927
+ # previously set value, specify a new value of 0.
888
928
  #
889
929
  # For more information, see [Replacing Auto Scaling Instances Based on
890
930
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
891
931
  # Guide*.
892
932
  #
893
- # Valid Range: Minimum value of 604800.
933
+ # Valid Range: Minimum value of 0.
894
934
  #
895
935
  #
896
936
  #
@@ -1030,10 +1070,9 @@ module Aws::AutoScaling
1030
1070
  # Creates a launch configuration.
1031
1071
  #
1032
1072
  # If you exceed your maximum limit of launch configurations, the call
1033
- # fails. For information about viewing this limit, see
1034
- # DescribeAccountLimits. For information about updating this limit, see
1035
- # [Amazon EC2 Auto Scaling Service Quotas][1] in the *Amazon EC2 Auto
1036
- # Scaling User Guide*.
1073
+ # fails. To query this limit, call the DescribeAccountLimits API. For
1074
+ # information about updating this limit, see [Amazon EC2 Auto Scaling
1075
+ # Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
1037
1076
  #
1038
1077
  # For more information, see [Launch Configurations][2] in the *Amazon
1039
1078
  # EC2 Auto Scaling User Guide*.
@@ -1415,13 +1454,13 @@ module Aws::AutoScaling
1415
1454
  # associated action.
1416
1455
  #
1417
1456
  # To remove instances from the Auto Scaling group before deleting it,
1418
- # call DetachInstances with the list of instances and the option to
1419
- # decrement the desired capacity. This ensures that Amazon EC2 Auto
1457
+ # call the DetachInstances API with the list of instances and the option
1458
+ # to decrement the desired capacity. This ensures that Amazon EC2 Auto
1420
1459
  # Scaling does not launch replacement instances.
1421
1460
  #
1422
1461
  # To terminate all instances before deleting the Auto Scaling group,
1423
- # call UpdateAutoScalingGroup and set the minimum size and desired
1424
- # capacity of the Auto Scaling group to zero.
1462
+ # call the UpdateAutoScalingGroup API and set the minimum size and
1463
+ # desired capacity of the Auto Scaling group to zero.
1425
1464
  #
1426
1465
  # @option params [required, String] :auto_scaling_group_name
1427
1466
  # The name of the Auto Scaling group.
@@ -1759,7 +1798,18 @@ module Aws::AutoScaling
1759
1798
  req.send_request(options)
1760
1799
  end
1761
1800
 
1762
- # Describes the policy adjustment types for use with PutScalingPolicy.
1801
+ # Describes the available adjustment types for Amazon EC2 Auto Scaling
1802
+ # scaling policies. These settings apply to step scaling policies and
1803
+ # simple scaling policies; they do not apply to target tracking scaling
1804
+ # policies.
1805
+ #
1806
+ # The following adjustment types are supported:
1807
+ #
1808
+ # * ChangeInCapacity
1809
+ #
1810
+ # * ExactCapacity
1811
+ #
1812
+ # * PercentChangeInCapacity
1763
1813
  #
1764
1814
  # @return [Types::DescribeAdjustmentTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1765
1815
  #
@@ -2375,8 +2425,8 @@ module Aws::AutoScaling
2375
2425
  # Describes the load balancers for the specified Auto Scaling group.
2376
2426
  #
2377
2427
  # This operation describes only Classic Load Balancers. If you have
2378
- # Application Load Balancers or Network Load Balancers, use
2379
- # DescribeLoadBalancerTargetGroups instead.
2428
+ # Application Load Balancers or Network Load Balancers, use the
2429
+ # DescribeLoadBalancerTargetGroups API instead.
2380
2430
  #
2381
2431
  # @option params [required, String] :auto_scaling_group_name
2382
2432
  # The name of the Auto Scaling group.
@@ -2441,8 +2491,8 @@ module Aws::AutoScaling
2441
2491
  # Scaling.
2442
2492
  #
2443
2493
  # The `GroupStandbyInstances` metric is not returned by default. You
2444
- # must explicitly request this metric when calling
2445
- # EnableMetricsCollection.
2494
+ # must explicitly request this metric when calling the
2495
+ # EnableMetricsCollection API.
2446
2496
  #
2447
2497
  # @return [Types::DescribeMetricCollectionTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2448
2498
  #
@@ -2787,8 +2837,8 @@ module Aws::AutoScaling
2787
2837
  req.send_request(options)
2788
2838
  end
2789
2839
 
2790
- # Describes the scaling process types for use with ResumeProcesses and
2791
- # SuspendProcesses.
2840
+ # Describes the scaling process types for use with the ResumeProcesses
2841
+ # and SuspendProcesses APIs.
2792
2842
  #
2793
2843
  # @return [Types::ProcessesType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2794
2844
  #
@@ -2848,7 +2898,7 @@ module Aws::AutoScaling
2848
2898
 
2849
2899
  # Describes the actions scheduled for your Auto Scaling group that
2850
2900
  # haven't run or that have not reached their end time. To describe the
2851
- # actions that have already run, use DescribeScalingActivities.
2901
+ # actions that have already run, call the DescribeScalingActivities API.
2852
2902
  #
2853
2903
  # @option params [String] :auto_scaling_group_name
2854
2904
  # The name of the Auto Scaling group.
@@ -2954,6 +3004,13 @@ module Aws::AutoScaling
2954
3004
  # for a particular tag only if it matches all the filters. If there's
2955
3005
  # no match, no special message is returned.
2956
3006
  #
3007
+ # For more information, see [Tagging Auto Scaling Groups and
3008
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
3009
+ #
3010
+ #
3011
+ #
3012
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
3013
+ #
2957
3014
  # @option params [Array<Types::Filter>] :filters
2958
3015
  # One or more filters to scope the tags to return. The maximum number of
2959
3016
  # filters per filter type (for example, `auto-scaling-group`) is 1000.
@@ -3228,13 +3285,13 @@ module Aws::AutoScaling
3228
3285
  # Scaling group.
3229
3286
  #
3230
3287
  # This operation detaches only Classic Load Balancers. If you have
3231
- # Application Load Balancers or Network Load Balancers, use
3232
- # DetachLoadBalancerTargetGroups instead.
3288
+ # Application Load Balancers or Network Load Balancers, use the
3289
+ # DetachLoadBalancerTargetGroups API instead.
3233
3290
  #
3234
3291
  # When you detach a load balancer, it enters the `Removing` state while
3235
3292
  # deregistering the instances in the group. When all instances are
3236
3293
  # deregistered, then you can no longer describe the load balancer using
3237
- # DescribeLoadBalancers. The instances remain running.
3294
+ # the DescribeLoadBalancers API call. The instances remain running.
3238
3295
  #
3239
3296
  # @option params [required, String] :auto_scaling_group_name
3240
3297
  # The name of the Auto Scaling group.
@@ -3279,8 +3336,7 @@ module Aws::AutoScaling
3279
3336
  # The name of the Auto Scaling group.
3280
3337
  #
3281
3338
  # @option params [Array<String>] :metrics
3282
- # One or more of the following metrics. If you omit this parameter, all
3283
- # metrics are disabled.
3339
+ # Specifies one or more of the following metrics:
3284
3340
  #
3285
3341
  # * `GroupMinSize`
3286
3342
  #
@@ -3298,6 +3354,18 @@ module Aws::AutoScaling
3298
3354
  #
3299
3355
  # * `GroupTotalInstances`
3300
3356
  #
3357
+ # * `GroupInServiceCapacity`
3358
+ #
3359
+ # * `GroupPendingCapacity`
3360
+ #
3361
+ # * `GroupStandbyCapacity`
3362
+ #
3363
+ # * `GroupTerminatingCapacity`
3364
+ #
3365
+ # * `GroupTotalCapacity`
3366
+ #
3367
+ # If you omit this parameter, all metrics are disabled.
3368
+ #
3301
3369
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3302
3370
  #
3303
3371
  #
@@ -3340,8 +3408,8 @@ module Aws::AutoScaling
3340
3408
  # The name of the Auto Scaling group.
3341
3409
  #
3342
3410
  # @option params [Array<String>] :metrics
3343
- # One or more of the following metrics. If you omit this parameter, all
3344
- # metrics are enabled.
3411
+ # Specifies which group-level metrics to start collecting. You can
3412
+ # specify one or more of the following metrics:
3345
3413
  #
3346
3414
  # * `GroupMinSize`
3347
3415
  #
@@ -3359,6 +3427,21 @@ module Aws::AutoScaling
3359
3427
  #
3360
3428
  # * `GroupTotalInstances`
3361
3429
  #
3430
+ # The instance weighting feature supports the following additional
3431
+ # metrics:
3432
+ #
3433
+ # * `GroupInServiceCapacity`
3434
+ #
3435
+ # * `GroupPendingCapacity`
3436
+ #
3437
+ # * `GroupStandbyCapacity`
3438
+ #
3439
+ # * `GroupTerminatingCapacity`
3440
+ #
3441
+ # * `GroupTotalCapacity`
3442
+ #
3443
+ # If you omit this parameter, all metrics are enabled.
3444
+ #
3362
3445
  # @option params [required, String] :granularity
3363
3446
  # The granularity to associate with the metrics to collect. The only
3364
3447
  # valid value is `1Minute`.
@@ -3660,11 +3743,11 @@ module Aws::AutoScaling
3660
3743
  # the instances launch or terminate.**
3661
3744
  #
3662
3745
  # 4. If you need more time, record the lifecycle action heartbeat to
3663
- # keep the instance in a pending state using
3664
- # RecordLifecycleActionHeartbeat.
3746
+ # keep the instance in a pending state using the
3747
+ # RecordLifecycleActionHeartbeat API call.
3665
3748
  #
3666
3749
  # 5. If you finish before the timeout period ends, complete the
3667
- # lifecycle action using CompleteLifecycleAction.
3750
+ # lifecycle action using the CompleteLifecycleAction API call.
3668
3751
  #
3669
3752
  # For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
3670
3753
  # in the *Amazon EC2 Auto Scaling User Guide*.
@@ -3672,9 +3755,10 @@ module Aws::AutoScaling
3672
3755
  # If you exceed your maximum limit of lifecycle hooks, which by default
3673
3756
  # is 50 per Auto Scaling group, the call fails.
3674
3757
  #
3675
- # You can view the lifecycle hooks for an Auto Scaling group using
3676
- # DescribeLifecycleHooks. If you are no longer using a lifecycle hook,
3677
- # you can delete it using DeleteLifecycleHook.
3758
+ # You can view the lifecycle hooks for an Auto Scaling group using the
3759
+ # DescribeLifecycleHooks API call. If you are no longer using a
3760
+ # lifecycle hook, you can delete it by calling the DeleteLifecycleHook
3761
+ # API.
3678
3762
  #
3679
3763
  #
3680
3764
  #
@@ -3732,8 +3816,8 @@ module Aws::AutoScaling
3732
3816
  #
3733
3817
  # If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
3734
3818
  # action that you specified in the `DefaultResult` parameter. You can
3735
- # prevent the lifecycle hook from timing out by calling
3736
- # RecordLifecycleActionHeartbeat.
3819
+ # prevent the lifecycle hook from timing out by calling the
3820
+ # RecordLifecycleActionHeartbeat API.
3737
3821
  #
3738
3822
  # @option params [String] :default_result
3739
3823
  # Defines the action the Auto Scaling group should take when the
@@ -3801,9 +3885,9 @@ module Aws::AutoScaling
3801
3885
  # Service (Amazon SNS) topic.
3802
3886
  #
3803
3887
  # @option params [required, Array<String>] :notification_types
3804
- # The type of event that causes the notification to be sent. For more
3805
- # information about notification types supported by Amazon EC2 Auto
3806
- # Scaling, see DescribeAutoScalingNotificationTypes.
3888
+ # The type of event that causes the notification to be sent. To query
3889
+ # the notification types supported by Amazon EC2 Auto Scaling, call the
3890
+ # DescribeAutoScalingNotificationTypes API.
3807
3891
  #
3808
3892
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3809
3893
  #
@@ -3840,12 +3924,14 @@ module Aws::AutoScaling
3840
3924
  # Creates or updates a scaling policy for an Auto Scaling group.
3841
3925
  #
3842
3926
  # For more information about using scaling policies to scale your Auto
3843
- # Scaling group automatically, see [Dynamic Scaling][1] in the *Amazon
3844
- # EC2 Auto Scaling User Guide*.
3927
+ # Scaling group, see [Target Tracking Scaling Policies][1] and [Step and
3928
+ # Simple Scaling Policies][2] in the *Amazon EC2 Auto Scaling User
3929
+ # Guide*.
3845
3930
  #
3846
3931
  #
3847
3932
  #
3848
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3933
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html
3934
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
3849
3935
  #
3850
3936
  # @option params [required, String] :auto_scaling_group_name
3851
3937
  # The name of the Auto Scaling group.
@@ -3876,20 +3962,22 @@ module Aws::AutoScaling
3876
3962
  # instead.
3877
3963
  #
3878
3964
  # @option params [Integer] :min_adjustment_magnitude
3879
- # The minimum number of instances to scale. If the value of
3880
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
3881
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
3882
- # this many instances. Otherwise, the error is `ValidationError`.
3965
+ # The minimum value to scale by when scaling by percentages. For
3966
+ # example, suppose that you create a step scaling policy to scale out an
3967
+ # Auto Scaling group by 25 percent and you specify a
3968
+ # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
3969
+ # scaling policy is performed, 25 percent of 4 is 1. However, because
3970
+ # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
3971
+ # scales out the group by 2 instances.
3972
+ #
3973
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
3974
+ # the adjustment type is `PercentChangeInCapacity`. For more
3975
+ # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
3976
+ # Scaling User Guide*.
3883
3977
  #
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
3978
  #
3892
- # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
3979
+ #
3980
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
3893
3981
  #
3894
3982
  # @option params [Integer] :scaling_adjustment
3895
3983
  # The amount by which a simple scaling policy scales the Auto Scaling
@@ -4095,14 +4183,16 @@ module Aws::AutoScaling
4095
4183
  # [1]: http://crontab.org
4096
4184
  #
4097
4185
  # @option params [Integer] :min_size
4098
- # The minimum number of instances in the Auto Scaling group.
4186
+ # The minimum size of the Auto Scaling group.
4099
4187
  #
4100
4188
  # @option params [Integer] :max_size
4101
- # The maximum number of instances in the Auto Scaling group.
4189
+ # The maximum size of the Auto Scaling group.
4102
4190
  #
4103
4191
  # @option params [Integer] :desired_capacity
4104
- # The number of EC2 instances that should be running in the Auto Scaling
4105
- # group.
4192
+ # The desired capacity is the initial capacity of the Auto Scaling group
4193
+ # after the scheduled action runs and the capacity it attempts to
4194
+ # maintain. It can scale beyond this capacity if you add more scaling
4195
+ # conditions.
4106
4196
  #
4107
4197
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4108
4198
  #
@@ -4146,7 +4236,7 @@ module Aws::AutoScaling
4146
4236
 
4147
4237
  # Records a heartbeat for the lifecycle action associated with the
4148
4238
  # specified token or instance. This extends the timeout by the length of
4149
- # time defined using PutLifecycleHook.
4239
+ # time defined using the PutLifecycleHook API call.
4150
4240
  #
4151
4241
  # This step is a part of the procedure for adding a lifecycle hook to an
4152
4242
  # Auto Scaling group:
@@ -4287,19 +4377,25 @@ module Aws::AutoScaling
4287
4377
 
4288
4378
  # Sets the size of the specified Auto Scaling group.
4289
4379
  #
4290
- # For more information about desired capacity, see [What Is Amazon EC2
4291
- # Auto Scaling?][1] in the *Amazon EC2 Auto Scaling User Guide*.
4380
+ # If a scale-in activity occurs as a result of a new `DesiredCapacity`
4381
+ # value that is lower than the current size of the group, the Auto
4382
+ # Scaling group uses its termination policy to determine which instances
4383
+ # to terminate.
4292
4384
  #
4385
+ # For more information, see [Manual Scaling][1] in the *Amazon EC2 Auto
4386
+ # Scaling User Guide*.
4293
4387
  #
4294
4388
  #
4295
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html
4389
+ #
4390
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html
4296
4391
  #
4297
4392
  # @option params [required, String] :auto_scaling_group_name
4298
4393
  # The name of the Auto Scaling group.
4299
4394
  #
4300
4395
  # @option params [required, Integer] :desired_capacity
4301
- # The number of EC2 instances that should be running in the Auto Scaling
4302
- # group.
4396
+ # The desired capacity is the initial capacity of the Auto Scaling group
4397
+ # after this operation completes and the capacity it attempts to
4398
+ # maintain.
4303
4399
  #
4304
4400
  # @option params [Boolean] :honor_cooldown
4305
4401
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
@@ -4363,7 +4459,12 @@ module Aws::AutoScaling
4363
4459
  # not respect the grace period associated with the group.
4364
4460
  #
4365
4461
  # For more information about the health check grace period, see
4366
- # CreateAutoScalingGroup.
4462
+ # [CreateAutoScalingGroup][1] in the *Amazon EC2 Auto Scaling API
4463
+ # Reference*.
4464
+ #
4465
+ #
4466
+ #
4467
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html
4367
4468
  #
4368
4469
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4369
4470
  #
@@ -4462,12 +4563,12 @@ module Aws::AutoScaling
4462
4563
  # for the specified Auto Scaling group.
4463
4564
  #
4464
4565
  # If you suspend either the `Launch` or `Terminate` process types, it
4465
- # can prevent other process types from functioning properly.
4566
+ # can prevent other process types from functioning properly. For more
4567
+ # information, see [Suspending and Resuming Scaling Processes][1] in the
4568
+ # *Amazon EC2 Auto Scaling User Guide*.
4466
4569
  #
4467
- # To resume processes that have been suspended, use ResumeProcesses.
4468
- #
4469
- # For more information, see [Suspending and Resuming Scaling
4470
- # Processes][1] in the *Amazon EC2 Auto Scaling User Guide*.
4570
+ # To resume processes that have been suspended, call the ResumeProcesses
4571
+ # API.
4471
4572
  #
4472
4573
  #
4473
4574
  #
@@ -4527,10 +4628,12 @@ module Aws::AutoScaling
4527
4628
  end
4528
4629
 
4529
4630
  # Terminates the specified instance and optionally adjusts the desired
4530
- # group size. This call simply makes a termination request. The instance
4531
- # is not terminated immediately. When an instance is terminated, the
4532
- # instance status changes to `terminated`. You can't connect to or
4533
- # start an instance after you've terminated it.
4631
+ # group size.
4632
+ #
4633
+ # This call simply makes a termination request. The instance is not
4634
+ # terminated immediately. When an instance is terminated, the instance
4635
+ # status changes to `terminated`. You can't connect to or start an
4636
+ # instance after you've terminated it.
4534
4637
  #
4535
4638
  # If you do not specify the option to decrement the desired capacity,
4536
4639
  # Amazon EC2 Auto Scaling launches instances to replace the ones that
@@ -4623,7 +4726,7 @@ module Aws::AutoScaling
4623
4726
  # Note the following about changing `DesiredCapacity`, `MaxSize`, or
4624
4727
  # `MinSize`\:
4625
4728
  #
4626
- # * If a scale-in event occurs as a result of a new `DesiredCapacity`
4729
+ # * If a scale-in activity occurs as a result of a new `DesiredCapacity`
4627
4730
  # value that is lower than the current size of the group, the Auto
4628
4731
  # Scaling group uses its termination policy to determine which
4629
4732
  # instances to terminate.
@@ -4638,10 +4741,11 @@ module Aws::AutoScaling
4638
4741
  # current size of the group, this sets the group's `DesiredCapacity`
4639
4742
  # to the new `MaxSize` value.
4640
4743
  #
4641
- # To see which parameters have been set, use DescribeAutoScalingGroups.
4642
- # You can also view the scaling policies for an Auto Scaling group using
4643
- # DescribePolicies. If the group has scaling policies, you can update
4644
- # them using PutScalingPolicy.
4744
+ # To see which parameters have been set, call the
4745
+ # DescribeAutoScalingGroups API. To view the scaling policies for an
4746
+ # Auto Scaling group, call the DescribePolicies API. If the group has
4747
+ # scaling policies, you can update them by calling the PutScalingPolicy
4748
+ # API.
4645
4749
  #
4646
4750
  # @option params [required, String] :auto_scaling_group_name
4647
4751
  # The name of the Auto Scaling group.
@@ -4686,10 +4790,22 @@ module Aws::AutoScaling
4686
4790
  # @option params [Integer] :max_size
4687
4791
  # The maximum size of the Auto Scaling group.
4688
4792
  #
4793
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
4794
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
4795
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
4796
+ # above `MaxSize` by more than your maximum instance weight (weights
4797
+ # that define how many capacity units each instance contributes to the
4798
+ # capacity of the group).
4799
+ #
4800
+ # </note>
4801
+ #
4689
4802
  # @option params [Integer] :desired_capacity
4690
- # The number of EC2 instances that should be running in the Auto Scaling
4691
- # group. This number must be greater than or equal to the minimum size
4692
- # of the group and less than or equal to the maximum size of the group.
4803
+ # The desired capacity is the initial capacity of the Auto Scaling group
4804
+ # after this operation completes and the capacity it attempts to
4805
+ # maintain.
4806
+ #
4807
+ # This number must be greater than or equal to the minimum size of the
4808
+ # group and less than or equal to the maximum size of the group.
4693
4809
  #
4694
4810
  # @option params [Integer] :default_cooldown
4695
4811
  # The amount of time, in seconds, after a scaling activity completes
@@ -4785,13 +4901,17 @@ module Aws::AutoScaling
4785
4901
  #
4786
4902
  # @option params [Integer] :max_instance_lifetime
4787
4903
  # The maximum amount of time, in seconds, that an instance can be in
4788
- # service.
4904
+ # service. The default is null.
4905
+ #
4906
+ # This parameter is optional, but if you specify a value for it, you
4907
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
4908
+ # previously set value, specify a new value of 0.
4789
4909
  #
4790
4910
  # For more information, see [Replacing Auto Scaling Instances Based on
4791
4911
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
4792
4912
  # Guide*.
4793
4913
  #
4794
- # Valid Range: Minimum value of 604800.
4914
+ # Valid Range: Minimum value of 0.
4795
4915
  #
4796
4916
  #
4797
4917
  #
@@ -4898,7 +5018,7 @@ module Aws::AutoScaling
4898
5018
  params: params,
4899
5019
  config: config)
4900
5020
  context[:gem_name] = 'aws-sdk-autoscaling'
4901
- context[:gem_version] = '1.35.0'
5021
+ context[:gem_version] = '1.36.0'
4902
5022
  Seahorse::Client::Request.new(handlers, context)
4903
5023
  end
4904
5024