aws-sdk-autoscaling 1.14.0 → 1.15.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9b8425bef187ae713a5ca2425662c0bc8d845698
4
- data.tar.gz: 3fc222273282fda029ffc43b67806f47a8b889f8
3
+ metadata.gz: 3139cb3b6393d83f123d95e38bcaa2246b49b77c
4
+ data.tar.gz: 915bfe2c246a4c8a5b093abfb4cb10e25642c393
5
5
  SHA512:
6
- metadata.gz: 11c2b3d4892107ae733be4996334b26ca8f5d3a8ecedc14245b382d2c51ba3ae2c553f25d3aac68c542db7b8d7534c0a27d7b25a25cea2393b776d790c03ff5e
7
- data.tar.gz: ec9c72ed1d465ed0c2bc7fc1d8cedcf2dd562629f5f1b091f6cc9a2cb9da9ac4336518c03eb26faf34aa9e60a9b5e1d95d859c1686c423c6bfbe4da9a6dc458e
6
+ metadata.gz: c5a491d3e32528c3aa9c8eb52586d2a922ca474f8e125870e1e22a4eada73d35653a8e34673c2a2a369c097b363dec9b5d723febf12adfc4258928edbe8171d3
7
+ data.tar.gz: b491de1a62621f4fb139a61c6312c2e2674640c5cbb4cd4828709c635e6109056355fba1f58290763bab73125f9d731af70d72f326aaa1f6f03b75b70438ad90
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
53
53
  # @service
54
54
  module Aws::AutoScaling
55
55
 
56
- GEM_VERSION = '1.14.0'
56
+ GEM_VERSION = '1.15.0'
57
57
 
58
58
  end
@@ -127,22 +127,13 @@ module Aws::AutoScaling
127
127
  end
128
128
 
129
129
  # The name of the placement group into which to launch your instances,
130
- # if any. For more information, see [Placement Groups][1] in the *Amazon
131
- # EC2 User Guide for Linux Instances*.
132
- #
133
- #
134
- #
135
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
130
+ # if any.
136
131
  # @return [String]
137
132
  def placement_group
138
133
  data[:placement_group]
139
134
  end
140
135
 
141
136
  # One or more subnet IDs, if applicable, separated by commas.
142
- #
143
- # If you specify `VPCZoneIdentifier` and `AvailabilityZones`, ensure
144
- # that the Availability Zones of the subnets match the values for
145
- # `AvailabilityZones`.
146
137
  # @return [String]
147
138
  def vpc_zone_identifier
148
139
  data[:vpc_zone_identifier]
@@ -168,14 +159,7 @@ module Aws::AutoScaling
168
159
  end
169
160
 
170
161
  # Indicates whether newly launched instances are protected from
171
- # termination by Auto Scaling when scaling in.
172
- #
173
- # For more information, see [Instance Protection][1] in the *Amazon EC2
174
- # Auto Scaling User Guide*.
175
- #
176
- #
177
- #
178
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
162
+ # termination by Amazon EC2 Auto Scaling when scaling in.
179
163
  # @return [Boolean]
180
164
  def new_instances_protected_from_scale_in
181
165
  data[:new_instances_protected_from_scale_in]
@@ -572,7 +556,7 @@ module Aws::AutoScaling
572
556
  #
573
557
  #
574
558
  #
575
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
559
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
576
560
  # @option options [Integer] :min_adjustment_step
577
561
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
578
562
  # instead.
@@ -589,8 +573,8 @@ module Aws::AutoScaling
589
573
  # A positive value adds to the current capacity while a negative number
590
574
  # removes from the current capacity.
591
575
  #
592
- # This parameter is required if the policy type is `SimpleScaling` and
593
- # not supported otherwise.
576
+ # Conditional: This parameter is required if the policy type is
577
+ # `SimpleScaling` and not supported otherwise.
594
578
  # @option options [Integer] :cooldown
595
579
  # The amount of time, in seconds, after a scaling activity completes and
596
580
  # before the next scaling activity can start. If this parameter is not
@@ -603,7 +587,7 @@ module Aws::AutoScaling
603
587
  #
604
588
  #
605
589
  #
606
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
590
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
607
591
  # @option options [String] :metric_aggregation_type
608
592
  # The aggregation type for the CloudWatch metrics. The valid values are
609
593
  # `Minimum`, `Maximum`, and `Average`. If the aggregation type is null,
@@ -614,8 +598,8 @@ module Aws::AutoScaling
614
598
  # A set of adjustments that enable you to scale based on the size of the
615
599
  # alarm breach.
616
600
  #
617
- # This parameter is required if the policy type is `StepScaling` and not
618
- # supported otherwise.
601
+ # Conditional: This parameter is required if the policy type is
602
+ # `StepScaling` and not supported otherwise.
619
603
  # @option options [Integer] :estimated_instance_warmup
620
604
  # The estimated time, in seconds, until a newly launched instance can
621
605
  # contribute to the CloudWatch metrics. The default is to use the value
@@ -624,9 +608,10 @@ module Aws::AutoScaling
624
608
  # This parameter is supported if the policy type is `StepScaling` or
625
609
  # `TargetTrackingScaling`.
626
610
  # @option options [Types::TargetTrackingConfiguration] :target_tracking_configuration
627
- # A target tracking policy.
611
+ # A target tracking scaling policy. Includes support for predefined or
612
+ # customized metrics.
628
613
  #
629
- # This parameter is required if the policy type is
614
+ # Conditional: This parameter is required if the policy type is
630
615
  # `TargetTrackingScaling` and not supported otherwise.
631
616
  # @return [ScalingPolicy]
632
617
  def put_scaling_policy(options = {})
@@ -656,8 +641,8 @@ module Aws::AutoScaling
656
641
  # @option options [Time,DateTime,Date,Integer,String] :time
657
642
  # This parameter is deprecated.
658
643
  # @option options [Time,DateTime,Date,Integer,String] :start_time
659
- # The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format
660
- # in UTC/GMT only (for example, `2014-06-01T00:00:00Z`).
644
+ # The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in
645
+ # UTC/GMT only and in quotes (for example, `"2019-06-01T00:00:00Z"`).
661
646
  #
662
647
  # If you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling
663
648
  # performs the action at this time, and then performs the action based
@@ -672,8 +657,8 @@ module Aws::AutoScaling
672
657
  # The recurring schedule for this action, in Unix cron syntax format.
673
658
  # This format consists of five fields separated by white spaces:
674
659
  # \[Minute\] \[Hour\] \[Day\_of\_Month\] \[Month\_of\_Year\]
675
- # \[Day\_of\_Week\]. For more information about this format, see
676
- # [Crontab][1].
660
+ # \[Day\_of\_Week\]. The value must be in quotes (for example, `"30 0 1
661
+ # 1,6,12 *"`). For more information about this format, see [Crontab][1].
677
662
  #
678
663
  #
679
664
  #
@@ -837,6 +822,13 @@ module Aws::AutoScaling
837
822
  # The mixed instances policy to use to specify the updates. If you
838
823
  # specify this parameter, you can't specify a launch configuration or a
839
824
  # launch template.
825
+ #
826
+ # For more information, see [Using Multiple Instance Types and Purchase
827
+ # Options][1] in the *Amazon EC2 Auto Scaling User Guide*.
828
+ #
829
+ #
830
+ #
831
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options
840
832
  # @option options [Integer] :min_size
841
833
  # The minimum size of the Auto Scaling group.
842
834
  # @option options [Integer] :max_size
@@ -847,14 +839,14 @@ module Aws::AutoScaling
847
839
  # of the group and less than or equal to the maximum size of the group.
848
840
  # @option options [Integer] :default_cooldown
849
841
  # The amount of time, in seconds, after a scaling activity completes
850
- # before another scaling activity can start. The default is 300.
842
+ # before another scaling activity can start. The default value is `300`.
851
843
  #
852
844
  # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
853
845
  # Auto Scaling User Guide*.
854
846
  #
855
847
  #
856
848
  #
857
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
849
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
858
850
  # @option options [Array<String>] :availability_zones
859
851
  # One or more Availability Zones for the group.
860
852
  # @option options [String] :health_check_type
@@ -863,36 +855,33 @@ module Aws::AutoScaling
863
855
  # @option options [Integer] :health_check_grace_period
864
856
  # The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
865
857
  # before checking the health status of an EC2 instance that has come
866
- # into service. The default is 0.
858
+ # into service. The default value is `0`.
867
859
  #
868
- # For more information, see [Health Checks][1] in the *Amazon EC2 Auto
869
- # Scaling User Guide*.
860
+ # For more information, see [Health Checks for Auto Scaling
861
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
862
+ #
863
+ # Conditional: This parameter is required if you are adding an `ELB`
864
+ # health check.
870
865
  #
871
866
  #
872
867
  #
873
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
868
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
874
869
  # @option options [String] :placement_group
875
870
  # The name of the placement group into which to launch your instances,
876
- # if any. For more information, see [Placement Groups][1] in the *Amazon
877
- # EC2 User Guide for Linux Instances*.
871
+ # if any. A placement group is a logical grouping of instances within a
872
+ # single Availability Zone. You cannot specify multiple Availability
873
+ # Zones and a placement group. For more information, see [Placement
874
+ # Groups][1] in the *Amazon EC2 User Guide for Linux Instances*.
878
875
  #
879
876
  #
880
877
  #
881
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
878
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
882
879
  # @option options [String] :vpc_zone_identifier
883
- # The ID of the subnet, if you are launching into a VPC. You can specify
884
- # several subnets in a comma-separated list.
885
- #
886
- # When you specify `VPCZoneIdentifier` with `AvailabilityZones`, ensure
887
- # that the subnets' Availability Zones match the values you specify for
888
- # `AvailabilityZones`.
889
- #
890
- # For more information, see [Launching Auto Scaling Instances in a
891
- # VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
892
- #
893
- #
880
+ # A comma-separated list of subnet IDs, if you are launching into a VPC.
894
881
  #
895
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
882
+ # If you specify `VPCZoneIdentifier` with `AvailabilityZones`, the
883
+ # subnets that you specify for this parameter must reside in those
884
+ # Availability Zones.
896
885
  # @option options [Array<String>] :termination_policies
897
886
  # A standalone termination policy or a list of termination policies used
898
887
  # to select the instance to terminate. The policies are executed in the
@@ -904,10 +893,10 @@ module Aws::AutoScaling
904
893
  #
905
894
  #
906
895
  #
907
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
896
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
908
897
  # @option options [Boolean] :new_instances_protected_from_scale_in
909
898
  # Indicates whether newly launched instances are protected from
910
- # termination by Auto Scaling when scaling in.
899
+ # termination by Amazon EC2 Auto Scaling when scaling in.
911
900
  #
912
901
  # For more information about preventing instances from terminating on
913
902
  # scale in, see [Instance Protection][1] in the *Amazon EC2 Auto Scaling
@@ -915,10 +904,16 @@ module Aws::AutoScaling
915
904
  #
916
905
  #
917
906
  #
918
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
907
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
919
908
  # @option options [String] :service_linked_role_arn
920
909
  # The Amazon Resource Name (ARN) of the service-linked role that the
921
- # Auto Scaling group uses to call other AWS services on your behalf.
910
+ # Auto Scaling group uses to call other AWS services on your behalf. For
911
+ # more information, see [Service-Linked Roles][1] in the *Amazon EC2
912
+ # Auto Scaling User Guide*.
913
+ #
914
+ #
915
+ #
916
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
922
917
  # @return [AutoScalingGroup]
923
918
  def update(options = {})
924
919
  options = options.merge(auto_scaling_group_name: @name)
@@ -1049,7 +1044,7 @@ module Aws::AutoScaling
1049
1044
  # token from a previous call.)
1050
1045
  # @option options [Integer] :max_records
1051
1046
  # The maximum number of items to return with this call. The default
1052
- # value is 100 and the maximum value is 100.
1047
+ # value is `100` and the maximum value is `100`.
1053
1048
  # @return [LoadBalancer::Collection]
1054
1049
  def load_balancers(options = {})
1055
1050
  batches = Enumerator.new do |y|
@@ -1108,8 +1103,8 @@ module Aws::AutoScaling
1108
1103
  # limited to that group. This list is limited to 50 items. If you
1109
1104
  # specify an unknown policy name, it is ignored with no error.
1110
1105
  # @option options [Array<String>] :policy_types
1111
- # One or more policy types. Valid values are `SimpleScaling` and
1112
- # `StepScaling`.
1106
+ # One or more policy types. The valid values are `SimpleScaling`,
1107
+ # `StepScaling`, and `TargetTrackingScaling`.
1113
1108
  # @return [ScalingPolicy::Collection]
1114
1109
  def policies(options = {})
1115
1110
  batches = Enumerator.new do |y|
@@ -224,7 +224,7 @@ module Aws::AutoScaling
224
224
  #
225
225
  #
226
226
  #
227
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html
227
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html
228
228
  #
229
229
  # @option params [Array<String>] :instance_ids
230
230
  # The IDs of the instances. You can specify up to 20 instances.
@@ -277,7 +277,7 @@ module Aws::AutoScaling
277
277
  #
278
278
  #
279
279
  #
280
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html
280
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html
281
281
  #
282
282
  # @option params [required, String] :auto_scaling_group_name
283
283
  # The name of the Auto Scaling group.
@@ -331,7 +331,7 @@ module Aws::AutoScaling
331
331
  #
332
332
  #
333
333
  #
334
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html
334
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html
335
335
  #
336
336
  # @option params [required, String] :auto_scaling_group_name
337
337
  # The name of the Auto Scaling group.
@@ -478,12 +478,12 @@ module Aws::AutoScaling
478
478
  # 5. **If you finish before the timeout period ends, complete the
479
479
  # lifecycle action.**
480
480
  #
481
- # For more information, see [Auto Scaling Lifecycle][1] in the *Amazon
482
- # EC2 Auto Scaling User Guide*.
481
+ # For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
482
+ # in the *Amazon EC2 Auto Scaling User Guide*.
483
483
  #
484
484
  #
485
485
  #
486
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html
486
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
487
487
  #
488
488
  # @option params [required, String] :lifecycle_hook_name
489
489
  # The name of the lifecycle hook.
@@ -546,13 +546,9 @@ module Aws::AutoScaling
546
546
  # [Amazon EC2 Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling
547
547
  # User Guide*.
548
548
  #
549
- # For more information, see [Auto Scaling Groups][2] in the *Amazon EC2
550
- # Auto Scaling User Guide*.
551
- #
552
549
  #
553
550
  #
554
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
555
- # [2]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html
551
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
556
552
  #
557
553
  # @option params [required, String] :auto_scaling_group_name
558
554
  # The name of the Auto Scaling group. This name must be unique within
@@ -563,16 +559,37 @@ module Aws::AutoScaling
563
559
  # template, a mixed instances policy, or an EC2 instance must be
564
560
  # specified.
565
561
  #
562
+ # For more information, see [Creating an Auto Scaling Group Using a
563
+ # Launch Configuration][1] in the *Amazon EC2 Auto Scaling User Guide*.
564
+ #
565
+ #
566
+ #
567
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg.html
568
+ #
566
569
  # @option params [Types::LaunchTemplateSpecification] :launch_template
567
570
  # The launch template to use to launch instances. This parameter, a
568
571
  # launch configuration, a mixed instances policy, or an EC2 instance
569
572
  # must be specified.
570
573
  #
574
+ # For more information, see [Creating an Auto Scaling Group Using a
575
+ # Launch Template][1] in the *Amazon EC2 Auto Scaling User Guide*.
576
+ #
577
+ #
578
+ #
579
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-launch-template.html
580
+ #
571
581
  # @option params [Types::MixedInstancesPolicy] :mixed_instances_policy
572
582
  # The mixed instances policy to use to launch instances. This parameter,
573
583
  # a launch template, a launch configuration, or an EC2 instance must be
574
584
  # specified.
575
585
  #
586
+ # For more information, see [Using Multiple Instance Types and Purchase
587
+ # Options][1] in the *Amazon EC2 Auto Scaling User Guide*.
588
+ #
589
+ #
590
+ #
591
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options
592
+ #
576
593
  # @option params [String] :instance_id
577
594
  # The ID of the instance used to create a launch configuration for the
578
595
  # group. This parameter, a launch configuration, a launch template, or a
@@ -588,7 +605,7 @@ module Aws::AutoScaling
588
605
  #
589
606
  #
590
607
  #
591
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
608
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
592
609
  #
593
610
  # @option params [required, Integer] :min_size
594
611
  # The minimum size of the group.
@@ -605,18 +622,21 @@ module Aws::AutoScaling
605
622
  #
606
623
  # @option params [Integer] :default_cooldown
607
624
  # The amount of time, in seconds, after a scaling activity completes
608
- # before another scaling activity can start. The default is 300.
625
+ # before another scaling activity can start. The default value is `300`.
609
626
  #
610
627
  # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
611
628
  # Auto Scaling User Guide*.
612
629
  #
613
630
  #
614
631
  #
615
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
632
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
616
633
  #
617
634
  # @option params [Array<String>] :availability_zones
618
635
  # One or more Availability Zones for the group. This parameter is
619
- # optional if you specify one or more subnets.
636
+ # optional if you specify one or more subnets for `VPCZoneIdentifier`.
637
+ #
638
+ # Conditional: If your account supports EC2-Classic and VPC, this
639
+ # parameter is required to launch instances into EC2-Classic.
620
640
  #
621
641
  # @option params [Array<String>] :load_balancer_names
622
642
  # One or more Classic Load Balancers. To specify an Application Load
@@ -627,61 +647,59 @@ module Aws::AutoScaling
627
647
  #
628
648
  #
629
649
  #
630
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html
650
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html
631
651
  #
632
652
  # @option params [Array<String>] :target_group_arns
633
653
  # The Amazon Resource Names (ARN) of the target groups.
634
654
  #
635
655
  # @option params [String] :health_check_type
636
656
  # The service to use for the health checks. The valid values are `EC2`
637
- # and `ELB`.
657
+ # and `ELB`. The default value is `EC2`.
638
658
  #
639
- # By default, health checks use Amazon EC2 instance status checks to
640
- # determine the health of an instance. For more information, see [Health
641
- # Checks][1] in the *Amazon EC2 Auto Scaling User Guide*.
659
+ # For more information, see [Health Checks for Auto Scaling
660
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
642
661
  #
643
662
  #
644
663
  #
645
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
664
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
646
665
  #
647
666
  # @option params [Integer] :health_check_grace_period
648
667
  # The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
649
668
  # before checking the health status of an EC2 instance that has come
650
669
  # into service. During this time, any health check failures for the
651
- # instance are ignored. The default is 0.
670
+ # instance are ignored. The default value is `0`.
652
671
  #
653
- # This parameter is required if you are adding an `ELB` health check.
672
+ # For more information, see [Health Checks for Auto Scaling
673
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
654
674
  #
655
- # For more information, see [Health Checks][1] in the *Amazon EC2 Auto
656
- # Scaling User Guide*.
675
+ # Conditional: This parameter is required if you are adding an `ELB`
676
+ # health check.
657
677
  #
658
678
  #
659
679
  #
660
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
680
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
661
681
  #
662
682
  # @option params [String] :placement_group
663
683
  # The name of the placement group into which to launch your instances,
664
- # if any. For more information, see [Placement Groups][1] in the *Amazon
665
- # EC2 User Guide for Linux Instances*.
684
+ # if any. A placement group is a logical grouping of instances within a
685
+ # single Availability Zone. You cannot specify multiple Availability
686
+ # Zones and a placement group. For more information, see [Placement
687
+ # Groups][1] in the *Amazon EC2 User Guide for Linux Instances*.
666
688
  #
667
689
  #
668
690
  #
669
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
691
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
670
692
  #
671
693
  # @option params [String] :vpc_zone_identifier
672
- # A comma-separated list of subnet identifiers for your virtual private
673
- # cloud (VPC).
674
- #
675
- # If you specify subnets and Availability Zones with this call, ensure
676
- # that the subnets' Availability Zones match the Availability Zones
677
- # specified.
678
- #
679
- # For more information, see [Launching Auto Scaling Instances in a
680
- # VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
681
- #
694
+ # A comma-separated list of subnet IDs for your virtual private cloud
695
+ # (VPC).
682
696
  #
697
+ # If you specify `VPCZoneIdentifier` with `AvailabilityZones`, the
698
+ # subnets that you specify for this parameter must reside in those
699
+ # Availability Zones.
683
700
  #
684
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
701
+ # Conditional: If your account supports EC2-Classic and VPC, this
702
+ # parameter is required to launch instances into a VPC.
685
703
  #
686
704
  # @option params [Array<String>] :termination_policies
687
705
  # One or more termination policies used to select the instance to
@@ -694,11 +712,11 @@ module Aws::AutoScaling
694
712
  #
695
713
  #
696
714
  #
697
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
715
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
698
716
  #
699
717
  # @option params [Boolean] :new_instances_protected_from_scale_in
700
718
  # Indicates whether newly launched instances are protected from
701
- # termination by Auto Scaling when scaling in.
719
+ # termination by Amazon EC2 Auto Scaling when scaling in.
702
720
  #
703
721
  # For more information about preventing instances from terminating on
704
722
  # scale in, see [Instance Protection][1] in the *Amazon EC2 Auto Scaling
@@ -706,7 +724,7 @@ module Aws::AutoScaling
706
724
  #
707
725
  #
708
726
  #
709
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
727
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
710
728
  #
711
729
  # @option params [Array<Types::LifecycleHookSpecification>] :lifecycle_hook_specification_list
712
730
  # One or more lifecycle hooks.
@@ -719,13 +737,19 @@ module Aws::AutoScaling
719
737
  #
720
738
  #
721
739
  #
722
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
740
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
723
741
  #
724
742
  # @option params [String] :service_linked_role_arn
725
743
  # The Amazon Resource Name (ARN) of the service-linked role that the
726
744
  # Auto Scaling group uses to call other AWS services on your behalf. By
727
745
  # default, Amazon EC2 Auto Scaling uses a service-linked role named
728
746
  # AWSServiceRoleForAutoScaling, which it creates if it does not exist.
747
+ # For more information, see [Service-Linked Roles][1] in the *Amazon EC2
748
+ # Auto Scaling User Guide*.
749
+ #
750
+ #
751
+ #
752
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
729
753
  #
730
754
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
731
755
  #
@@ -869,8 +893,8 @@ module Aws::AutoScaling
869
893
  #
870
894
  #
871
895
  #
872
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
873
- # [2]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html
896
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
897
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html
874
898
  #
875
899
  # @option params [required, String] :launch_configuration_name
876
900
  # The name of the launch configuration. This name must be unique within
@@ -887,7 +911,7 @@ module Aws::AutoScaling
887
911
  #
888
912
  #
889
913
  #
890
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
914
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
891
915
  #
892
916
  # @option params [String] :key_name
893
917
  # The name of the key pair. For more information, see [Amazon EC2 Key
@@ -895,7 +919,7 @@ module Aws::AutoScaling
895
919
  #
896
920
  #
897
921
  #
898
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
922
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
899
923
  #
900
924
  # @option params [Array<String>] :security_groups
901
925
  # One or more security groups with which to associate the instances.
@@ -911,8 +935,8 @@ module Aws::AutoScaling
911
935
  #
912
936
  #
913
937
  #
914
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
915
- # [2]: http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
938
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
939
+ # [2]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
916
940
  #
917
941
  # @option params [String] :classic_link_vpc_id
918
942
  # The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances
@@ -923,21 +947,23 @@ module Aws::AutoScaling
923
947
  #
924
948
  #
925
949
  #
926
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
927
- # [2]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
950
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
951
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
928
952
  #
929
953
  # @option params [Array<String>] :classic_link_vpc_security_groups
930
954
  # The IDs of one or more security groups for the specified
931
- # ClassicLink-enabled VPC. This parameter is required if you specify a
932
- # ClassicLink-enabled VPC, and is not supported otherwise. For more
933
- # information, see [ClassicLink][1] in the *Amazon EC2 User Guide for
934
- # Linux Instances* and [Linking EC2-Classic Instances to a VPC][2] in
935
- # the *Amazon EC2 Auto Scaling User Guide*.
955
+ # ClassicLink-enabled VPC. For more information, see [ClassicLink][1] in
956
+ # the *Amazon EC2 User Guide for Linux Instances* and [Linking
957
+ # EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
958
+ # User Guide*.
959
+ #
960
+ # Conditional: This parameter is required if you specify a
961
+ # ClassicLink-enabled VPC, and is not supported otherwise.
936
962
  #
937
963
  #
938
964
  #
939
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
940
- # [2]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
965
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
966
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
941
967
  #
942
968
  # @option params [String] :user_data
943
969
  # The user data to make available to the launched EC2 instances. For
@@ -946,7 +972,7 @@ module Aws::AutoScaling
946
972
  #
947
973
  #
948
974
  #
949
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
975
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
950
976
  #
951
977
  # @option params [String] :instance_id
952
978
  # The ID of the instance to use to create the launch configuration. The
@@ -965,7 +991,7 @@ module Aws::AutoScaling
965
991
  #
966
992
  #
967
993
  #
968
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
994
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
969
995
  #
970
996
  # @option params [String] :instance_type
971
997
  # The instance type of the EC2 instance.
@@ -977,7 +1003,7 @@ module Aws::AutoScaling
977
1003
  #
978
1004
  #
979
1005
  #
980
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
1006
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes
981
1007
  #
982
1008
  # @option params [String] :kernel_id
983
1009
  # The ID of the kernel associated with the AMI.
@@ -992,11 +1018,11 @@ module Aws::AutoScaling
992
1018
  #
993
1019
  #
994
1020
  #
995
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
1021
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
996
1022
  #
997
1023
  # @option params [Types::InstanceMonitoring] :instance_monitoring
998
1024
  # Enables detailed monitoring (`true`) or basic monitoring (`false`) for
999
- # the Auto Scaling instances. The default is `true`.
1025
+ # the Auto Scaling instances. The default value is `true`.
1000
1026
  #
1001
1027
  # @option params [String] :spot_price
1002
1028
  # The maximum hourly price to be paid for any Spot Instance launched to
@@ -1007,7 +1033,7 @@ module Aws::AutoScaling
1007
1033
  #
1008
1034
  #
1009
1035
  #
1010
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
1036
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
1011
1037
  #
1012
1038
  # @option params [String] :iam_instance_profile
1013
1039
  # The name or the Amazon Resource Name (ARN) of the instance profile
@@ -1022,7 +1048,7 @@ module Aws::AutoScaling
1022
1048
  #
1023
1049
  #
1024
1050
  #
1025
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
1051
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
1026
1052
  #
1027
1053
  # @option params [Boolean] :ebs_optimized
1028
1054
  # Indicates whether the instance is optimized for Amazon EBS I/O. By
@@ -1035,7 +1061,7 @@ module Aws::AutoScaling
1035
1061
  #
1036
1062
  #
1037
1063
  #
1038
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
1064
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
1039
1065
  #
1040
1066
  # @option params [Boolean] :associate_public_ip_address
1041
1067
  # Used for groups that launch instances into a virtual private cloud
@@ -1053,7 +1079,7 @@ module Aws::AutoScaling
1053
1079
  #
1054
1080
  #
1055
1081
  #
1056
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
1082
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
1057
1083
  #
1058
1084
  # @option params [String] :placement_tenancy
1059
1085
  # The tenancy of the instance. An instance with a tenancy of `dedicated`
@@ -1073,7 +1099,7 @@ module Aws::AutoScaling
1073
1099
  #
1074
1100
  #
1075
1101
  #
1076
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
1102
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
1077
1103
  #
1078
1104
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1079
1105
  #
@@ -1151,7 +1177,7 @@ module Aws::AutoScaling
1151
1177
  #
1152
1178
  #
1153
1179
  #
1154
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
1180
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
1155
1181
  #
1156
1182
  # @option params [required, Array<Types::Tag>] :tags
1157
1183
  # One or more tags.
@@ -1380,7 +1406,7 @@ module Aws::AutoScaling
1380
1406
  req.send_request(options)
1381
1407
  end
1382
1408
 
1383
- # Deletes the specified Auto Scaling policy.
1409
+ # Deletes the specified scaling policy.
1384
1410
  #
1385
1411
  # Deleting a policy deletes the underlying alarm action, but does not
1386
1412
  # delete the alarm, even if it no longer has an associated action.
@@ -1501,8 +1527,8 @@ module Aws::AutoScaling
1501
1527
  req.send_request(options)
1502
1528
  end
1503
1529
 
1504
- # Describes the current Auto Scaling resource limits for your AWS
1505
- # account.
1530
+ # Describes the current Amazon EC2 Auto Scaling resource limits for your
1531
+ # AWS account.
1506
1532
  #
1507
1533
  # For information about requesting an increase in these limits, see
1508
1534
  # [Amazon EC2 Auto Scaling Limits][1] in the *Amazon EC2 Auto Scaling
@@ -1510,7 +1536,7 @@ module Aws::AutoScaling
1510
1536
  #
1511
1537
  #
1512
1538
  #
1513
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
1539
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
1514
1540
  #
1515
1541
  # @return [Types::DescribeAccountLimitsAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1516
1542
  #
@@ -1609,7 +1635,7 @@ module Aws::AutoScaling
1609
1635
  #
1610
1636
  # @option params [Integer] :max_records
1611
1637
  # The maximum number of items to return with this call. The default
1612
- # value is 50 and the maximum value is 100.
1638
+ # value is `50` and the maximum value is `100`.
1613
1639
  #
1614
1640
  # @return [Types::AutoScalingGroupsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1615
1641
  #
@@ -1761,7 +1787,7 @@ module Aws::AutoScaling
1761
1787
  #
1762
1788
  # @option params [Integer] :max_records
1763
1789
  # The maximum number of items to return with this call. The default
1764
- # value is 50 and the maximum value is 50.
1790
+ # value is `50` and the maximum value is `50`.
1765
1791
  #
1766
1792
  # @option params [String] :next_token
1767
1793
  # The token for the next set of items to return. (You received this
@@ -1882,7 +1908,7 @@ module Aws::AutoScaling
1882
1908
  #
1883
1909
  # @option params [Integer] :max_records
1884
1910
  # The maximum number of items to return with this call. The default
1885
- # value is 50 and the maximum value is 100.
1911
+ # value is `50` and the maximum value is `100`.
1886
1912
  #
1887
1913
  # @return [Types::LaunchConfigurationsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1888
1914
  #
@@ -2095,7 +2121,7 @@ module Aws::AutoScaling
2095
2121
  #
2096
2122
  # @option params [Integer] :max_records
2097
2123
  # The maximum number of items to return with this call. The default
2098
- # value is 100 and the maximum value is 100.
2124
+ # value is `100` and the maximum value is `100`.
2099
2125
  #
2100
2126
  # @return [Types::DescribeLoadBalancerTargetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2101
2127
  #
@@ -2160,7 +2186,7 @@ module Aws::AutoScaling
2160
2186
  #
2161
2187
  # @option params [Integer] :max_records
2162
2188
  # The maximum number of items to return with this call. The default
2163
- # value is 100 and the maximum value is 100.
2189
+ # value is `100` and the maximum value is `100`.
2164
2190
  #
2165
2191
  # @return [Types::DescribeLoadBalancersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2166
2192
  #
@@ -2293,7 +2319,7 @@ module Aws::AutoScaling
2293
2319
  #
2294
2320
  # @option params [Integer] :max_records
2295
2321
  # The maximum number of items to return with this call. The default
2296
- # value is 50 and the maximum value is 100.
2322
+ # value is `50` and the maximum value is `100`.
2297
2323
  #
2298
2324
  # @return [Types::DescribeNotificationConfigurationsAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2299
2325
  #
@@ -2364,8 +2390,8 @@ module Aws::AutoScaling
2364
2390
  # specify an unknown policy name, it is ignored with no error.
2365
2391
  #
2366
2392
  # @option params [Array<String>] :policy_types
2367
- # One or more policy types. Valid values are `SimpleScaling` and
2368
- # `StepScaling`.
2393
+ # One or more policy types. The valid values are `SimpleScaling`,
2394
+ # `StepScaling`, and `TargetTrackingScaling`.
2369
2395
  #
2370
2396
  # @option params [String] :next_token
2371
2397
  # The token for the next set of items to return. (You received this
@@ -2373,7 +2399,7 @@ module Aws::AutoScaling
2373
2399
  #
2374
2400
  # @option params [Integer] :max_records
2375
2401
  # The maximum number of items to be returned with each call. The default
2376
- # value is 50 and the maximum value is 100.
2402
+ # value is `50` and the maximum value is `100`.
2377
2403
  #
2378
2404
  # @return [Types::PoliciesType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2379
2405
  #
@@ -2483,7 +2509,7 @@ module Aws::AutoScaling
2483
2509
  #
2484
2510
  # @option params [Integer] :max_records
2485
2511
  # The maximum number of items to return with this call. The default
2486
- # value is 100 and the maximum value is 100.
2512
+ # value is `100` and the maximum value is `100`.
2487
2513
  #
2488
2514
  # @option params [String] :next_token
2489
2515
  # The token for the next set of items to return. (You received this
@@ -2639,7 +2665,7 @@ module Aws::AutoScaling
2639
2665
  #
2640
2666
  # @option params [Integer] :max_records
2641
2667
  # The maximum number of items to return with this call. The default
2642
- # value is 50 and the maximum value is 100.
2668
+ # value is `50` and the maximum value is `100`.
2643
2669
  #
2644
2670
  # @return [Types::ScheduledActionsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2645
2671
  #
@@ -2728,7 +2754,7 @@ module Aws::AutoScaling
2728
2754
  #
2729
2755
  # @option params [Integer] :max_records
2730
2756
  # The maximum number of items to return with this call. The default
2731
- # value is 50 and the maximum value is 100.
2757
+ # value is `50` and the maximum value is `100`.
2732
2758
  #
2733
2759
  # @return [Types::TagsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2734
2760
  #
@@ -2812,7 +2838,7 @@ module Aws::AutoScaling
2812
2838
  #
2813
2839
  #
2814
2840
  #
2815
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
2841
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
2816
2842
  #
2817
2843
  # @return [Types::DescribeTerminationPolicyTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2818
2844
  #
@@ -2870,7 +2896,7 @@ module Aws::AutoScaling
2870
2896
  #
2871
2897
  #
2872
2898
  #
2873
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html
2899
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html
2874
2900
  #
2875
2901
  # @option params [Array<String>] :instance_ids
2876
2902
  # The IDs of the instances. You can specify up to 20 instances.
@@ -3096,7 +3122,7 @@ module Aws::AutoScaling
3096
3122
  #
3097
3123
  #
3098
3124
  #
3099
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html
3125
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html
3100
3126
  #
3101
3127
  # @option params [required, String] :auto_scaling_group_name
3102
3128
  # The name of the Auto Scaling group.
@@ -3161,7 +3187,7 @@ module Aws::AutoScaling
3161
3187
  #
3162
3188
  #
3163
3189
  #
3164
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html
3190
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html
3165
3191
  #
3166
3192
  # @option params [Array<String>] :instance_ids
3167
3193
  # The IDs of the instances. You can specify up to 20 instances.
@@ -3256,7 +3282,7 @@ module Aws::AutoScaling
3256
3282
  #
3257
3283
  #
3258
3284
  #
3259
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
3285
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
3260
3286
  #
3261
3287
  # @option params [Float] :metric_value
3262
3288
  # The metric value to compare to `BreachThreshold`. This enables you to
@@ -3268,14 +3294,14 @@ module Aws::AutoScaling
3268
3294
  # If you specify a metric value that doesn't correspond to a step
3269
3295
  # adjustment for the policy, the call returns an error.
3270
3296
  #
3271
- # This parameter is required if the policy type is `StepScaling` and not
3272
- # supported otherwise.
3297
+ # Conditional: This parameter is required if the policy type is
3298
+ # `StepScaling` and not supported otherwise.
3273
3299
  #
3274
3300
  # @option params [Float] :breach_threshold
3275
3301
  # The breach threshold for the alarm.
3276
3302
  #
3277
- # This parameter is required if the policy type is `StepScaling` and not
3278
- # supported otherwise.
3303
+ # Conditional: This parameter is required if the policy type is
3304
+ # `StepScaling` and not supported otherwise.
3279
3305
  #
3280
3306
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3281
3307
  #
@@ -3316,7 +3342,7 @@ module Aws::AutoScaling
3316
3342
  #
3317
3343
  #
3318
3344
  #
3319
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html
3345
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html
3320
3346
  #
3321
3347
  # @option params [Array<String>] :instance_ids
3322
3348
  # The IDs of the instances. You can specify up to 20 instances.
@@ -3390,8 +3416,8 @@ module Aws::AutoScaling
3390
3416
  # group.
3391
3417
  #
3392
3418
  # A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on
3393
- # an instance that is not actively in service; for example, either when
3394
- # the instance launches or before the instance terminates.
3419
+ # an instance when the instance launches (before it is put into service)
3420
+ # or as the instance terminates (before it is fully terminated).
3395
3421
  #
3396
3422
  # This step is a part of the procedure for adding a lifecycle hook to an
3397
3423
  # Auto Scaling group:
@@ -3409,10 +3435,11 @@ module Aws::AutoScaling
3409
3435
  # the instances launch or terminate.**
3410
3436
  #
3411
3437
  # 4. If you need more time, record the lifecycle action heartbeat to
3412
- # keep the instance in a pending state.
3438
+ # keep the instance in a pending state using using
3439
+ # RecordLifecycleActionHeartbeat.
3413
3440
  #
3414
3441
  # 5. If you finish before the timeout period ends, complete the
3415
- # lifecycle action.
3442
+ # lifecycle action using CompleteLifecycleAction.
3416
3443
  #
3417
3444
  # For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
3418
3445
  # in the *Amazon EC2 Auto Scaling User Guide*.
@@ -3420,9 +3447,13 @@ module Aws::AutoScaling
3420
3447
  # If you exceed your maximum limit of lifecycle hooks, which by default
3421
3448
  # is 50 per Auto Scaling group, the call fails.
3422
3449
  #
3450
+ # You can view the lifecycle hooks for an Auto Scaling group using
3451
+ # DescribeLifecycleHooks. If you are no longer using a lifecycle hook,
3452
+ # you can delete it using DeleteLifecycleHook.
3453
+ #
3423
3454
  #
3424
3455
  #
3425
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
3456
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html
3426
3457
  #
3427
3458
  # @option params [required, String] :lifecycle_hook_name
3428
3459
  # The name of the lifecycle hook.
@@ -3432,27 +3463,30 @@ module Aws::AutoScaling
3432
3463
  #
3433
3464
  # @option params [String] :lifecycle_transition
3434
3465
  # The instance state to which you want to attach the lifecycle hook. The
3435
- # possible values are:
3466
+ # valid values are:
3436
3467
  #
3437
3468
  # * autoscaling:EC2\_INSTANCE\_LAUNCHING
3438
3469
  #
3439
3470
  # * autoscaling:EC2\_INSTANCE\_TERMINATING
3440
3471
  #
3441
- # This parameter is required for new lifecycle hooks, but optional when
3442
- # updating existing hooks.
3472
+ # Conditional: This parameter is required for new lifecycle hooks, but
3473
+ # optional when updating existing hooks.
3443
3474
  #
3444
3475
  # @option params [String] :role_arn
3445
3476
  # The ARN of the IAM role that allows the Auto Scaling group to publish
3446
- # to the specified notification target.
3477
+ # to the specified notification target, for example, an Amazon SNS topic
3478
+ # or an Amazon SQS queue.
3447
3479
  #
3448
- # This parameter is required for new lifecycle hooks, but optional when
3449
- # updating existing hooks.
3480
+ # Conditional: This parameter is required for new lifecycle hooks, but
3481
+ # optional when updating existing hooks.
3450
3482
  #
3451
3483
  # @option params [String] :notification_target_arn
3452
3484
  # The ARN of the notification target that Amazon EC2 Auto Scaling uses
3453
3485
  # to notify you when an instance is in the transition state for the
3454
3486
  # lifecycle hook. This target can be either an SQS queue or an SNS
3455
- # topic. If you specify an empty string, this overrides the current ARN.
3487
+ # topic.
3488
+ #
3489
+ # If you specify an empty string, this overrides the current ARN.
3456
3490
  #
3457
3491
  # This operation uses the JSON format when sending notifications to an
3458
3492
  # Amazon SQS queue, and an email key-value pair format when sending
@@ -3463,17 +3497,18 @@ module Aws::AutoScaling
3463
3497
  # key-value pair: `"Event": "autoscaling:TEST_NOTIFICATION"`.
3464
3498
  #
3465
3499
  # @option params [String] :notification_metadata
3466
- # Contains additional information that you want to include any time
3467
- # Amazon EC2 Auto Scaling sends a message to the notification target.
3500
+ # Additional information that you want to include any time Amazon EC2
3501
+ # Auto Scaling sends a message to the notification target.
3468
3502
  #
3469
3503
  # @option params [Integer] :heartbeat_timeout
3470
3504
  # The maximum time, in seconds, that can elapse before the lifecycle
3471
- # hook times out. The range is from 30 to 7200 seconds. The default is
3472
- # 3600 seconds (1 hour).
3505
+ # hook times out. The range is from `30` to `7200` seconds. The default
3506
+ # value is `3600` seconds (1 hour).
3473
3507
  #
3474
3508
  # If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
3475
- # default action. You can prevent the lifecycle hook from timing out by
3476
- # calling RecordLifecycleActionHeartbeat.
3509
+ # action that you specified in the `DefaultResult` parameter. You can
3510
+ # prevent the lifecycle hook from timing out by calling
3511
+ # RecordLifecycleActionHeartbeat.
3477
3512
  #
3478
3513
  # @option params [String] :default_result
3479
3514
  # Defines the action the Auto Scaling group should take when the
@@ -3531,7 +3566,7 @@ module Aws::AutoScaling
3531
3566
  #
3532
3567
  #
3533
3568
  #
3534
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html
3569
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html
3535
3570
  #
3536
3571
  # @option params [required, String] :auto_scaling_group_name
3537
3572
  # The name of the Auto Scaling group.
@@ -3605,7 +3640,7 @@ module Aws::AutoScaling
3605
3640
  #
3606
3641
  #
3607
3642
  #
3608
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3643
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3609
3644
  #
3610
3645
  # @option params [Integer] :min_adjustment_step
3611
3646
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
@@ -3625,8 +3660,8 @@ module Aws::AutoScaling
3625
3660
  # A positive value adds to the current capacity while a negative number
3626
3661
  # removes from the current capacity.
3627
3662
  #
3628
- # This parameter is required if the policy type is `SimpleScaling` and
3629
- # not supported otherwise.
3663
+ # Conditional: This parameter is required if the policy type is
3664
+ # `SimpleScaling` and not supported otherwise.
3630
3665
  #
3631
3666
  # @option params [Integer] :cooldown
3632
3667
  # The amount of time, in seconds, after a scaling activity completes and
@@ -3640,7 +3675,7 @@ module Aws::AutoScaling
3640
3675
  #
3641
3676
  #
3642
3677
  #
3643
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
3678
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
3644
3679
  #
3645
3680
  # @option params [String] :metric_aggregation_type
3646
3681
  # The aggregation type for the CloudWatch metrics. The valid values are
@@ -3653,8 +3688,8 @@ module Aws::AutoScaling
3653
3688
  # A set of adjustments that enable you to scale based on the size of the
3654
3689
  # alarm breach.
3655
3690
  #
3656
- # This parameter is required if the policy type is `StepScaling` and not
3657
- # supported otherwise.
3691
+ # Conditional: This parameter is required if the policy type is
3692
+ # `StepScaling` and not supported otherwise.
3658
3693
  #
3659
3694
  # @option params [Integer] :estimated_instance_warmup
3660
3695
  # The estimated time, in seconds, until a newly launched instance can
@@ -3665,9 +3700,10 @@ module Aws::AutoScaling
3665
3700
  # `TargetTrackingScaling`.
3666
3701
  #
3667
3702
  # @option params [Types::TargetTrackingConfiguration] :target_tracking_configuration
3668
- # A target tracking policy.
3703
+ # A target tracking scaling policy. Includes support for predefined or
3704
+ # customized metrics.
3669
3705
  #
3670
- # This parameter is required if the policy type is
3706
+ # Conditional: This parameter is required if the policy type is
3671
3707
  # `TargetTrackingScaling` and not supported otherwise.
3672
3708
  #
3673
3709
  # @return [Types::PolicyARNType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -3759,7 +3795,7 @@ module Aws::AutoScaling
3759
3795
  #
3760
3796
  #
3761
3797
  #
3762
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html
3798
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html
3763
3799
  #
3764
3800
  # @option params [required, String] :auto_scaling_group_name
3765
3801
  # The name of the Auto Scaling group.
@@ -3771,8 +3807,8 @@ module Aws::AutoScaling
3771
3807
  # This parameter is deprecated.
3772
3808
  #
3773
3809
  # @option params [Time,DateTime,Date,Integer,String] :start_time
3774
- # The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format
3775
- # in UTC/GMT only (for example, `2014-06-01T00:00:00Z`).
3810
+ # The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in
3811
+ # UTC/GMT only and in quotes (for example, `"2019-06-01T00:00:00Z"`).
3776
3812
  #
3777
3813
  # If you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling
3778
3814
  # performs the action at this time, and then performs the action based
@@ -3789,8 +3825,8 @@ module Aws::AutoScaling
3789
3825
  # The recurring schedule for this action, in Unix cron syntax format.
3790
3826
  # This format consists of five fields separated by white spaces:
3791
3827
  # \[Minute\] \[Hour\] \[Day\_of\_Month\] \[Month\_of\_Year\]
3792
- # \[Day\_of\_Week\]. For more information about this format, see
3793
- # [Crontab][1].
3828
+ # \[Day\_of\_Week\]. The value must be in quotes (for example, `"30 0 1
3829
+ # 1,6,12 *"`). For more information about this format, see [Crontab][1].
3794
3830
  #
3795
3831
  #
3796
3832
  #
@@ -3875,7 +3911,7 @@ module Aws::AutoScaling
3875
3911
  #
3876
3912
  #
3877
3913
  #
3878
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html
3914
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html
3879
3915
  #
3880
3916
  # @option params [required, String] :lifecycle_hook_name
3881
3917
  # The name of the lifecycle hook.
@@ -3931,7 +3967,7 @@ module Aws::AutoScaling
3931
3967
  #
3932
3968
  #
3933
3969
  #
3934
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html
3970
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html
3935
3971
  #
3936
3972
  # @option params [required, String] :auto_scaling_group_name
3937
3973
  # The name of the Auto Scaling group.
@@ -3993,7 +4029,7 @@ module Aws::AutoScaling
3993
4029
  #
3994
4030
  #
3995
4031
  #
3996
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html
4032
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html
3997
4033
  #
3998
4034
  # @option params [required, String] :auto_scaling_group_name
3999
4035
  # The name of the Auto Scaling group.
@@ -4041,12 +4077,12 @@ module Aws::AutoScaling
4041
4077
 
4042
4078
  # Sets the health status of the specified instance.
4043
4079
  #
4044
- # For more information, see [Health Checks][1] in the *Amazon EC2 Auto
4045
- # Scaling User Guide*.
4080
+ # For more information, see [Health Checks for Auto Scaling
4081
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
4046
4082
  #
4047
4083
  #
4048
4084
  #
4049
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
4085
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
4050
4086
  #
4051
4087
  # @option params [required, String] :instance_id
4052
4088
  # The ID of the instance.
@@ -4103,7 +4139,7 @@ module Aws::AutoScaling
4103
4139
  #
4104
4140
  #
4105
4141
  #
4106
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
4142
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
4107
4143
  #
4108
4144
  # @option params [required, Array<String>] :instance_ids
4109
4145
  # One or more instance IDs.
@@ -4172,7 +4208,7 @@ module Aws::AutoScaling
4172
4208
  #
4173
4209
  #
4174
4210
  #
4175
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html
4211
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html
4176
4212
  #
4177
4213
  # @option params [required, String] :auto_scaling_group_name
4178
4214
  # The name of the Auto Scaling group.
@@ -4327,6 +4363,13 @@ module Aws::AutoScaling
4327
4363
  # specify this parameter, you can't specify a launch configuration or a
4328
4364
  # launch template.
4329
4365
  #
4366
+ # For more information, see [Using Multiple Instance Types and Purchase
4367
+ # Options][1] in the *Amazon EC2 Auto Scaling User Guide*.
4368
+ #
4369
+ #
4370
+ #
4371
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html#asg-purchase-options
4372
+ #
4330
4373
  # @option params [Integer] :min_size
4331
4374
  # The minimum size of the Auto Scaling group.
4332
4375
  #
@@ -4340,14 +4383,14 @@ module Aws::AutoScaling
4340
4383
  #
4341
4384
  # @option params [Integer] :default_cooldown
4342
4385
  # The amount of time, in seconds, after a scaling activity completes
4343
- # before another scaling activity can start. The default is 300.
4386
+ # before another scaling activity can start. The default value is `300`.
4344
4387
  #
4345
4388
  # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
4346
4389
  # Auto Scaling User Guide*.
4347
4390
  #
4348
4391
  #
4349
4392
  #
4350
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
4393
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html
4351
4394
  #
4352
4395
  # @option params [Array<String>] :availability_zones
4353
4396
  # One or more Availability Zones for the group.
@@ -4359,38 +4402,35 @@ module Aws::AutoScaling
4359
4402
  # @option params [Integer] :health_check_grace_period
4360
4403
  # The amount of time, in seconds, that Amazon EC2 Auto Scaling waits
4361
4404
  # before checking the health status of an EC2 instance that has come
4362
- # into service. The default is 0.
4405
+ # into service. The default value is `0`.
4363
4406
  #
4364
- # For more information, see [Health Checks][1] in the *Amazon EC2 Auto
4365
- # Scaling User Guide*.
4407
+ # For more information, see [Health Checks for Auto Scaling
4408
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
4409
+ #
4410
+ # Conditional: This parameter is required if you are adding an `ELB`
4411
+ # health check.
4366
4412
  #
4367
4413
  #
4368
4414
  #
4369
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
4415
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
4370
4416
  #
4371
4417
  # @option params [String] :placement_group
4372
4418
  # The name of the placement group into which to launch your instances,
4373
- # if any. For more information, see [Placement Groups][1] in the *Amazon
4374
- # EC2 User Guide for Linux Instances*.
4419
+ # if any. A placement group is a logical grouping of instances within a
4420
+ # single Availability Zone. You cannot specify multiple Availability
4421
+ # Zones and a placement group. For more information, see [Placement
4422
+ # Groups][1] in the *Amazon EC2 User Guide for Linux Instances*.
4375
4423
  #
4376
4424
  #
4377
4425
  #
4378
- # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
4426
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
4379
4427
  #
4380
4428
  # @option params [String] :vpc_zone_identifier
4381
- # The ID of the subnet, if you are launching into a VPC. You can specify
4382
- # several subnets in a comma-separated list.
4383
- #
4384
- # When you specify `VPCZoneIdentifier` with `AvailabilityZones`, ensure
4385
- # that the subnets' Availability Zones match the values you specify for
4386
- # `AvailabilityZones`.
4387
- #
4388
- # For more information, see [Launching Auto Scaling Instances in a
4389
- # VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
4390
- #
4429
+ # A comma-separated list of subnet IDs, if you are launching into a VPC.
4391
4430
  #
4392
- #
4393
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
4431
+ # If you specify `VPCZoneIdentifier` with `AvailabilityZones`, the
4432
+ # subnets that you specify for this parameter must reside in those
4433
+ # Availability Zones.
4394
4434
  #
4395
4435
  # @option params [Array<String>] :termination_policies
4396
4436
  # A standalone termination policy or a list of termination policies used
@@ -4403,11 +4443,11 @@ module Aws::AutoScaling
4403
4443
  #
4404
4444
  #
4405
4445
  #
4406
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
4446
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html
4407
4447
  #
4408
4448
  # @option params [Boolean] :new_instances_protected_from_scale_in
4409
4449
  # Indicates whether newly launched instances are protected from
4410
- # termination by Auto Scaling when scaling in.
4450
+ # termination by Amazon EC2 Auto Scaling when scaling in.
4411
4451
  #
4412
4452
  # For more information about preventing instances from terminating on
4413
4453
  # scale in, see [Instance Protection][1] in the *Amazon EC2 Auto Scaling
@@ -4415,11 +4455,17 @@ module Aws::AutoScaling
4415
4455
  #
4416
4456
  #
4417
4457
  #
4418
- # [1]: http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
4458
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection
4419
4459
  #
4420
4460
  # @option params [String] :service_linked_role_arn
4421
4461
  # The Amazon Resource Name (ARN) of the service-linked role that the
4422
- # Auto Scaling group uses to call other AWS services on your behalf.
4462
+ # Auto Scaling group uses to call other AWS services on your behalf. For
4463
+ # more information, see [Service-Linked Roles][1] in the *Amazon EC2
4464
+ # Auto Scaling User Guide*.
4465
+ #
4466
+ #
4467
+ #
4468
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
4423
4469
  #
4424
4470
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4425
4471
  #
@@ -4520,7 +4566,7 @@ module Aws::AutoScaling
4520
4566
  params: params,
4521
4567
  config: config)
4522
4568
  context[:gem_name] = 'aws-sdk-autoscaling'
4523
- context[:gem_version] = '1.14.0'
4569
+ context[:gem_version] = '1.15.0'
4524
4570
  Seahorse::Client::Request.new(handlers, context)
4525
4571
  end
4526
4572