aws-sdk-autoscaling 1.27.0 → 1.28.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
  SHA1:
3
- metadata.gz: 22004100c58befed07d8c5a72ce837d8cd354512
4
- data.tar.gz: 75bfe38485e59508c92fd6eb350fcc88663d449d
3
+ metadata.gz: fc9cfcf1c80b06fe8ec62b373a6203001af2715e
4
+ data.tar.gz: 318e7f33712a838c412523ccf7b92ed86ece1a24
5
5
  SHA512:
6
- metadata.gz: 5134de05b3de036ab3fb2f1a54be509bcd58ae5c0b7eea2bc24924a70940669c2e6219eefe72656efb8642a9ecc30e1088038343d9f98beb6ceae0a6578e6551
7
- data.tar.gz: dd33bd10e58d7bdd2b24ce58a8dd5e363a30c3c1a04bd9b6d36da0cf53b230e487c679f6038fc7946b4ff38e5f66c1ae6cd74e60a399719714d14b88af5f14dd
6
+ metadata.gz: 7fa1c18bf465e1355b9a7b1cf278161cb7e1122d2624eebbacced38428de433cbe37b2ed5d413201a8fa20f3a0e1c6300821486e1f8dcd644d9dc504ceb6c70d
7
+ data.tar.gz: eb8086597c1f219e44d2f75dcbace266f0701ec78965f19af1cfaaabcc29e9107b4196556f4e391b2fff33c921ac14a9716907a2e91339ec2176e35e3cf261f8
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
53
53
  # @service
54
54
  module Aws::AutoScaling
55
55
 
56
- GEM_VERSION = '1.27.0'
56
+ GEM_VERSION = '1.28.0'
57
57
 
58
58
  end
@@ -547,18 +547,17 @@ module Aws::AutoScaling
547
547
  # and `TargetTrackingScaling`. If the policy type is null, the value is
548
548
  # treated as `SimpleScaling`.
549
549
  # @option options [String] :adjustment_type
550
- # The adjustment type. The valid values are `ChangeInCapacity`,
551
- # `ExactCapacity`, and `PercentChangeInCapacity`.
550
+ # Specifies whether the `ScalingAdjustment` parameter is an absolute
551
+ # number or a percentage of the current capacity. The valid values are
552
+ # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
552
553
  #
553
- # This parameter is supported if the policy type is `SimpleScaling` or
554
- # `StepScaling`.
555
- #
556
- # For more information, see [Dynamic Scaling][1] in the *Amazon EC2 Auto
557
- # Scaling User Guide*.
554
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
555
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
556
+ # Auto Scaling User Guide*.
558
557
  #
559
558
  #
560
559
  #
561
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
560
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
562
561
  # @option options [Integer] :min_adjustment_step
563
562
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
564
563
  # instead.
@@ -568,24 +567,34 @@ module Aws::AutoScaling
568
567
  # changes the `DesiredCapacity` of the Auto Scaling group by at least
569
568
  # this many instances. Otherwise, the error is `ValidationError`.
570
569
  #
571
- # This parameter is supported if the policy type is `SimpleScaling` or
572
- # `StepScaling`.
573
- # @option options [Integer] :scaling_adjustment
574
- # The amount by which to scale, based on the specified adjustment type.
575
- # A positive value adds to the current capacity while a negative number
576
- # removes from the current capacity.
570
+ # This property replaces the `MinAdjustmentStep` property. For example,
571
+ # suppose that you create a step scaling policy to scale out an Auto
572
+ # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
573
+ # of 2. If the group has 4 instances and the scaling policy is
574
+ # performed, 25 percent of 4 is 1. However, because you specified a
575
+ # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
576
+ # group by 2 instances.
577
577
  #
578
- # Conditional: This parameter is required if the policy type is
579
- # `SimpleScaling` and not supported otherwise.
578
+ # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
579
+ # @option options [Integer] :scaling_adjustment
580
+ # The amount by which a simple scaling policy scales the Auto Scaling
581
+ # group in response to an alarm breach. The adjustment is based on the
582
+ # value that you specified in the `AdjustmentType` parameter (either an
583
+ # absolute number or a percentage). A positive value adds to the current
584
+ # capacity and a negative value subtracts from the current capacity. For
585
+ # exact capacity, you must specify a positive value.
586
+ #
587
+ # Conditional: If you specify `SimpleScaling` for the policy type, you
588
+ # must specify this parameter. (Not used with any other policy type.)
580
589
  # @option options [Integer] :cooldown
581
- # The amount of time, in seconds, after a scaling activity completes and
582
- # before the next scaling activity can start. If this parameter is not
583
- # specified, the default cooldown period for the group applies.
584
- #
585
- # This parameter is supported if the policy type is `SimpleScaling`.
590
+ # The amount of time, in seconds, after a scaling activity completes
591
+ # before any further dynamic scaling activities can start. If this
592
+ # parameter is not specified, the default cooldown period for the group
593
+ # applies.
586
594
  #
587
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
588
- # Auto Scaling User Guide*.
595
+ # Valid only if the policy type is `SimpleScaling`. For more
596
+ # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
597
+ # Scaling User Guide*.
589
598
  #
590
599
  #
591
600
  #
@@ -595,26 +604,34 @@ module Aws::AutoScaling
595
604
  # `Minimum`, `Maximum`, and `Average`. If the aggregation type is null,
596
605
  # the value is treated as `Average`.
597
606
  #
598
- # This parameter is supported if the policy type is `StepScaling`.
607
+ # Valid only if the policy type is `StepScaling`.
599
608
  # @option options [Array<Types::StepAdjustment>] :step_adjustments
600
609
  # A set of adjustments that enable you to scale based on the size of the
601
610
  # alarm breach.
602
611
  #
603
- # Conditional: This parameter is required if the policy type is
604
- # `StepScaling` and not supported otherwise.
612
+ # Conditional: If you specify `StepScaling` for the policy type, you
613
+ # must specify this parameter. (Not used with any other policy type.)
605
614
  # @option options [Integer] :estimated_instance_warmup
606
615
  # The estimated time, in seconds, until a newly launched instance can
607
616
  # contribute to the CloudWatch metrics. The default is to use the value
608
617
  # specified for the default cooldown period for the group.
609
618
  #
610
- # This parameter is supported if the policy type is `StepScaling` or
619
+ # Valid only if the policy type is `StepScaling` or
611
620
  # `TargetTrackingScaling`.
612
621
  # @option options [Types::TargetTrackingConfiguration] :target_tracking_configuration
613
622
  # A target tracking scaling policy. Includes support for predefined or
614
623
  # customized metrics.
615
624
  #
616
- # Conditional: This parameter is required if the policy type is
617
- # `TargetTrackingScaling` and not supported otherwise.
625
+ # For more information, see [TargetTrackingConfiguration][1] in the
626
+ # *Amazon EC2 Auto Scaling API Reference*.
627
+ #
628
+ # Conditional: If you specify `TargetTrackingScaling` for the policy
629
+ # type, you must specify this parameter. (Not used with any other policy
630
+ # type.)
631
+ #
632
+ #
633
+ #
634
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html
618
635
  # @return [ScalingPolicy]
619
636
  def put_scaling_policy(options = {})
620
637
  options = options.merge(auto_scaling_group_name: @name)
@@ -641,7 +658,7 @@ module Aws::AutoScaling
641
658
  # @option options [required, String] :scheduled_action_name
642
659
  # The name of this scaling action.
643
660
  # @option options [Time,DateTime,Date,Integer,String] :time
644
- # This parameter is deprecated.
661
+ # This parameter is no longer used.
645
662
  # @option options [Time,DateTime,Date,Integer,String] :start_time
646
663
  # The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ
647
664
  # format in UTC/GMT only and in quotes (for example,
@@ -823,17 +840,22 @@ module Aws::AutoScaling
823
840
  # `LaunchConfigurationName` in your update request, you can't specify
824
841
  # `LaunchTemplate` or `MixedInstancesPolicy`.
825
842
  #
826
- # <note markdown="1"> To update an Auto Scaling group with a launch configuration with
843
+ # To update an Auto Scaling group with a launch configuration with
827
844
  # `InstanceMonitoring` set to `false`, you must first disable the
828
845
  # collection of group metrics. Otherwise, you get an error. If you have
829
846
  # previously enabled the collection of group metrics, you can disable it
830
847
  # using DisableMetricsCollection.
831
- #
832
- # </note>
833
848
  # @option options [Types::LaunchTemplateSpecification] :launch_template
834
849
  # The launch template and version to use to specify the updates. If you
835
850
  # specify `LaunchTemplate` in your update request, you can't specify
836
851
  # `LaunchConfigurationName` or `MixedInstancesPolicy`.
852
+ #
853
+ # For more information, see [LaunchTemplateSpecification][1] in the
854
+ # *Amazon EC2 Auto Scaling API Reference*.
855
+ #
856
+ #
857
+ #
858
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html
837
859
  # @option options [Types::MixedInstancesPolicy] :mixed_instances_policy
838
860
  # An embedded object that specifies a mixed instances policy.
839
861
  #
@@ -841,13 +863,15 @@ module Aws::AutoScaling
841
863
  # policy that is specified. All optional parameters are left unchanged
842
864
  # if not specified.
843
865
  #
844
- # For more information, see [Auto Scaling Groups with Multiple Instance
845
- # Types and Purchase Options][1] in the *Amazon EC2 Auto Scaling User
846
- # Guide*.
866
+ # For more information, see [MixedInstancesPolicy][1] in the *Amazon EC2
867
+ # Auto Scaling API Reference* and [Auto Scaling Groups with Multiple
868
+ # Instance Types and Purchase Options][2] in the *Amazon EC2 Auto
869
+ # Scaling User Guide*.
847
870
  #
848
871
  #
849
872
  #
850
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
873
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html
874
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
851
875
  # @option options [Integer] :min_size
852
876
  # The minimum size of the Auto Scaling group.
853
877
  # @option options [Integer] :max_size
@@ -882,15 +906,15 @@ module Aws::AutoScaling
882
906
  # before checking the health status of an EC2 instance that has come
883
907
  # into service. The default value is `0`.
884
908
  #
885
- # For more information, see [Health Checks for Auto Scaling
886
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
909
+ # For more information, see [Health Check Grace Period][1] in the
910
+ # *Amazon EC2 Auto Scaling User Guide*.
887
911
  #
888
912
  # Conditional: This parameter is required if you are adding an `ELB`
889
913
  # health check.
890
914
  #
891
915
  #
892
916
  #
893
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
917
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period
894
918
  # @option options [String] :placement_group
895
919
  # The name of the placement group into which to launch your instances,
896
920
  # if any. A placement group is a logical grouping of instances within a
@@ -606,22 +606,15 @@ module Aws::AutoScaling
606
606
  # @option params [String] :launch_configuration_name
607
607
  # The name of the launch configuration.
608
608
  #
609
- # For more information, see [Creating an Auto Scaling Group Using a
610
- # Launch Configuration][1] in the *Amazon EC2 Auto Scaling User Guide*.
611
- #
612
609
  # If you do not specify `LaunchConfigurationName`, you must specify one
613
610
  # of the following parameters: `InstanceId`, `LaunchTemplate`, or
614
611
  # `MixedInstancesPolicy`.
615
612
  #
616
- #
617
- #
618
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg.html
619
- #
620
613
  # @option params [Types::LaunchTemplateSpecification] :launch_template
621
614
  # The launch template to use to launch instances.
622
615
  #
623
- # For more information, see [Creating an Auto Scaling Group Using a
624
- # Launch Template][1] in the *Amazon EC2 Auto Scaling User Guide*.
616
+ # For more information, see [LaunchTemplateSpecification][1] in the
617
+ # *Amazon EC2 Auto Scaling API Reference*.
625
618
  #
626
619
  # If you do not specify `LaunchTemplate`, you must specify one of the
627
620
  # following parameters: `InstanceId`, `LaunchConfigurationName`, or
@@ -629,7 +622,7 @@ module Aws::AutoScaling
629
622
  #
630
623
  #
631
624
  #
632
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-launch-template.html
625
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html
633
626
  #
634
627
  # @option params [Types::MixedInstancesPolicy] :mixed_instances_policy
635
628
  # An embedded object that specifies a mixed instances policy. The
@@ -638,14 +631,15 @@ module Aws::AutoScaling
638
631
  #
639
632
  # The policy includes parameters that not only define the distribution
640
633
  # of On-Demand Instances and Spot Instances, the maximum price to pay
641
- # for Spot instances, and how the Auto Scaling group allocates instance
634
+ # for Spot Instances, and how the Auto Scaling group allocates instance
642
635
  # types to fulfill On-Demand and Spot capacity, but also the parameters
643
636
  # that specify the instance configuration information—the launch
644
637
  # template and instance types.
645
638
  #
646
- # For more information, see [Auto Scaling Groups with Multiple Instance
647
- # Types and Purchase Options][1] in the *Amazon EC2 Auto Scaling User
648
- # Guide*.
639
+ # For more information, see [MixedInstancesPolicy][1] in the *Amazon EC2
640
+ # Auto Scaling API Reference* and [Auto Scaling Groups with Multiple
641
+ # Instance Types and Purchase Options][2] in the *Amazon EC2 Auto
642
+ # Scaling User Guide*.
649
643
  #
650
644
  # You must specify one of the following parameters in your request:
651
645
  # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
@@ -653,7 +647,8 @@ module Aws::AutoScaling
653
647
  #
654
648
  #
655
649
  #
656
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
650
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html
651
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
657
652
  #
658
653
  # @option params [String] :instance_id
659
654
  # The ID of the instance used to create a launch configuration for the
@@ -751,15 +746,15 @@ module Aws::AutoScaling
751
746
  # into service. During this time, any health check failures for the
752
747
  # instance are ignored. The default value is `0`.
753
748
  #
754
- # For more information, see [Health Checks for Auto Scaling
755
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
749
+ # For more information, see [Health Check Grace Period][1] in the
750
+ # *Amazon EC2 Auto Scaling User Guide*.
756
751
  #
757
752
  # Conditional: This parameter is required if you are adding an `ELB`
758
753
  # health check.
759
754
  #
760
755
  #
761
756
  #
762
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
757
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period
763
758
  #
764
759
  # @option params [String] :placement_group
765
760
  # The name of the placement group into which to launch your instances,
@@ -983,14 +978,12 @@ module Aws::AutoScaling
983
978
  # Region per account.
984
979
  #
985
980
  # @option params [String] :image_id
986
- # The ID of the Amazon Machine Image (AMI) to use to launch your EC2
987
- # instances.
981
+ # The ID of the Amazon Machine Image (AMI) that was assigned during
982
+ # registration. For more information, see [Finding an AMI][1] in the
983
+ # *Amazon EC2 User Guide for Linux Instances*.
988
984
  #
989
985
  # If you do not specify `InstanceId`, you must specify `ImageId`.
990
986
  #
991
- # For more information, see [Finding an AMI][1] in the *Amazon EC2 User
992
- # Guide for Linux Instances*.
993
- #
994
987
  #
995
988
  #
996
989
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html
@@ -1004,28 +997,30 @@ module Aws::AutoScaling
1004
997
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html
1005
998
  #
1006
999
  # @option params [Array<String>] :security_groups
1007
- # One or more security groups with which to associate the instances.
1000
+ # A list that contains the security groups to assign to the instances in
1001
+ # the Auto Scaling group.
1008
1002
  #
1009
- # If your instances are launched in EC2-Classic, you can either specify
1010
- # security group names or the security group IDs. For more information,
1011
- # see [Amazon EC2 Security Groups][1] in the *Amazon EC2 User Guide for
1012
- # Linux Instances*.
1003
+ # \[EC2-VPC\] Specify the security group IDs. For more information, see
1004
+ # [Security Groups for Your VPC][1] in the *Amazon Virtual Private Cloud
1005
+ # User Guide*.
1013
1006
  #
1014
- # If your instances are launched into a VPC, specify security group IDs.
1015
- # For more information, see [Security Groups for Your VPC][2] in the
1016
- # *Amazon Virtual Private Cloud User Guide*.
1007
+ # \[EC2-Classic\] Specify either the security group names or the
1008
+ # security group IDs. For more information, see [Amazon EC2 Security
1009
+ # Groups][2] in the *Amazon EC2 User Guide for Linux Instances*.
1017
1010
  #
1018
1011
  #
1019
1012
  #
1020
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
1021
- # [2]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
1013
+ # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html
1014
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
1022
1015
  #
1023
1016
  # @option params [String] :classic_link_vpc_id
1024
1017
  # The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances
1025
- # to. This parameter is supported only if you are launching EC2-Classic
1026
- # instances. For more information, see [ClassicLink][1] in the *Amazon
1027
- # EC2 User Guide for Linux Instances* and [Linking EC2-Classic Instances
1028
- # to a VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
1018
+ # to. For more information, see [ClassicLink][1] in the *Amazon EC2 User
1019
+ # Guide for Linux Instances* and [Linking EC2-Classic Instances to a
1020
+ # VPC][2] in the *Amazon EC2 Auto Scaling User Guide*.
1021
+ #
1022
+ # This parameter can only be used if you are launching EC2-Classic
1023
+ # instances.
1029
1024
  #
1030
1025
  #
1031
1026
  #
@@ -1039,8 +1034,8 @@ module Aws::AutoScaling
1039
1034
  # EC2-Classic Instances to a VPC][2] in the *Amazon EC2 Auto Scaling
1040
1035
  # User Guide*.
1041
1036
  #
1042
- # Conditional: This parameter is required if you specify a
1043
- # ClassicLink-enabled VPC, and is not supported otherwise.
1037
+ # If you specify the `ClassicLinkVPCId` parameter, you must specify this
1038
+ # parameter.
1044
1039
  #
1045
1040
  #
1046
1041
  #
@@ -1048,9 +1043,9 @@ module Aws::AutoScaling
1048
1043
  # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink
1049
1044
  #
1050
1045
  # @option params [String] :user_data
1051
- # The user data to make available to the launched EC2 instances. For
1052
- # more information, see [Instance Metadata and User Data][1] in the
1053
- # *Amazon EC2 User Guide for Linux Instances*.
1046
+ # The Base64-encoded user data to make available to the launched EC2
1047
+ # instances. For more information, see [Instance Metadata and User
1048
+ # Data][1] in the *Amazon EC2 User Guide for Linux Instances*.
1054
1049
  #
1055
1050
  #
1056
1051
  #
@@ -1076,7 +1071,7 @@ module Aws::AutoScaling
1076
1071
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html
1077
1072
  #
1078
1073
  # @option params [String] :instance_type
1079
- # The instance type of the EC2 instance.
1074
+ # Specifies the instance type of the EC2 instance.
1080
1075
  #
1081
1076
  # For information about available instance types, see [Available
1082
1077
  # Instance Types][1] in the *Amazon EC2 User Guide for Linux Instances.*
@@ -1091,20 +1086,33 @@ module Aws::AutoScaling
1091
1086
  # The ID of the kernel associated with the AMI.
1092
1087
  #
1093
1088
  # @option params [String] :ramdisk_id
1094
- # The ID of the RAM disk associated with the AMI.
1089
+ # The ID of the RAM disk to select.
1095
1090
  #
1096
1091
  # @option params [Array<Types::BlockDeviceMapping>] :block_device_mappings
1097
- # One or more mappings that specify how block devices are exposed to the
1098
- # instance. For more information, see [Block Device Mapping][1] in the
1099
- # *Amazon EC2 User Guide for Linux Instances*.
1092
+ # A block device mapping, which specifies the block devices for the
1093
+ # instance. You can specify virtual devices and EBS volumes. For more
1094
+ # information, see [Block Device Mapping][1] in the *Amazon EC2 User
1095
+ # Guide for Linux Instances*.
1100
1096
  #
1101
1097
  #
1102
1098
  #
1103
1099
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
1104
1100
  #
1105
1101
  # @option params [Types::InstanceMonitoring] :instance_monitoring
1106
- # Enables detailed monitoring (`true`) or basic monitoring (`false`) for
1107
- # the Auto Scaling instances. The default value is `true`.
1102
+ # Controls whether instances in this group are launched with detailed
1103
+ # (`true`) or basic (`false`) monitoring.
1104
+ #
1105
+ # The default value is `true` (enabled).
1106
+ #
1107
+ # When detailed monitoring is enabled, Amazon CloudWatch generates
1108
+ # metrics every minute and your account is charged a fee. When you
1109
+ # disable detailed monitoring, CloudWatch generates metrics every 5
1110
+ # minutes. For more information, see [Configure Monitoring for Auto
1111
+ # Scaling Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
1112
+ #
1113
+ #
1114
+ #
1115
+ # [1]: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics
1108
1116
  #
1109
1117
  # @option params [String] :spot_price
1110
1118
  # The maximum hourly price to be paid for any Spot Instance launched to
@@ -1113,66 +1121,84 @@ module Aws::AutoScaling
1113
1121
  # see [Launching Spot Instances in Your Auto Scaling Group][1] in the
1114
1122
  # *Amazon EC2 Auto Scaling User Guide*.
1115
1123
  #
1124
+ # If a Spot price is set, then the Auto Scaling group will only launch
1125
+ # instances when the Spot price has been met, regardless of the setting
1126
+ # in the Auto Scaling group's `DesiredCapacity`.
1127
+ #
1128
+ # <note markdown="1"> When you change your Spot price by creating a new launch
1129
+ # configuration, running instances will continue to run as long as the
1130
+ # Spot price for those running instances is higher than the current Spot
1131
+ # market price.
1132
+ #
1133
+ # </note>
1134
+ #
1116
1135
  #
1117
1136
  #
1118
1137
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html
1119
1138
  #
1120
1139
  # @option params [String] :iam_instance_profile
1121
1140
  # The name or the Amazon Resource Name (ARN) of the instance profile
1122
- # associated with the IAM role for the instance.
1141
+ # associated with the IAM role for the instance. The instance profile
1142
+ # contains the IAM role.
1123
1143
  #
1124
- # EC2 instances launched with an IAM role automatically have AWS
1125
- # security credentials available. You can use IAM roles with Amazon EC2
1126
- # Auto Scaling to automatically enable applications running on your EC2
1127
- # instances to securely access other AWS resources. For more
1128
- # information, see [IAM Role for Applications That Run on Amazon EC2
1129
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
1144
+ # For more information, see [IAM Role for Applications That Run on
1145
+ # Amazon EC2 Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
1130
1146
  #
1131
1147
  #
1132
1148
  #
1133
1149
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html
1134
1150
  #
1135
1151
  # @option params [Boolean] :ebs_optimized
1136
- # Indicates whether the instance is optimized for Amazon EBS I/O. By
1137
- # default, the instance is not optimized for EBS I/O. The optimization
1138
- # provides dedicated throughput to Amazon EBS and an optimized
1139
- # configuration stack to provide optimal I/O performance. This
1140
- # optimization is not available with all instance types. Additional
1141
- # usage charges apply. For more information, see [Amazon EBS-Optimized
1142
- # Instances][1] in the *Amazon EC2 User Guide for Linux Instances*.
1152
+ # Specifies whether the launch configuration is optimized for EBS I/O
1153
+ # (`true`) or not (`false`). The optimization provides dedicated
1154
+ # throughput to Amazon EBS and an optimized configuration stack to
1155
+ # provide optimal I/O performance. This optimization is not available
1156
+ # with all instance types. Additional fees are incurred when you enable
1157
+ # EBS optimization for an instance type that is not EBS-optimized by
1158
+ # default. For more information, see [Amazon EBS-Optimized Instances][1]
1159
+ # in the *Amazon EC2 User Guide for Linux Instances*.
1160
+ #
1161
+ # The default value is `false`.
1143
1162
  #
1144
1163
  #
1145
1164
  #
1146
1165
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html
1147
1166
  #
1148
1167
  # @option params [Boolean] :associate_public_ip_address
1149
- # Used for groups that launch instances into a virtual private cloud
1150
- # (VPC). Specifies whether to assign a public IP address to each
1151
- # instance. For more information, see [Launching Auto Scaling Instances
1152
- # in a VPC][1] in the *Amazon EC2 Auto Scaling User Guide*.
1168
+ # For Auto Scaling groups that are running in a virtual private cloud
1169
+ # (VPC), specifies whether to assign a public IP address to the group's
1170
+ # instances. If you specify `true`, each instance in the Auto Scaling
1171
+ # group receives a unique public IP address. For more information, see
1172
+ # [Launching Auto Scaling Instances in a VPC][1] in the *Amazon EC2 Auto
1173
+ # Scaling User Guide*.
1153
1174
  #
1154
- # If you specify this parameter, be sure to specify at least one subnet
1155
- # when you create your group.
1175
+ # If you specify this parameter, you must specify at least one subnet
1176
+ # for `VPCZoneIdentifier` when you create your group.
1156
1177
  #
1157
- # Default: If the instance is launched into a default subnet, the
1158
- # default is to assign a public IP address. If the instance is launched
1159
- # into a nondefault subnet, the default is not to assign a public IP
1160
- # address.
1178
+ # <note markdown="1"> If the instance is launched into a default subnet, the default is to
1179
+ # assign a public IP address, unless you disabled the option to assign a
1180
+ # public IP address on the subnet. If the instance is launched into a
1181
+ # nondefault subnet, the default is not to assign a public IP address,
1182
+ # unless you enabled the option to assign a public IP address on the
1183
+ # subnet.
1184
+ #
1185
+ # </note>
1161
1186
  #
1162
1187
  #
1163
1188
  #
1164
1189
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html
1165
1190
  #
1166
1191
  # @option params [String] :placement_tenancy
1167
- # The tenancy of the instance. An instance with a tenancy of `dedicated`
1168
- # runs on single-tenant hardware and can only be launched into a VPC.
1192
+ # The tenancy of the instance. An instance with `dedicated` tenancy runs
1193
+ # on isolated, single-tenant hardware and can only be launched into a
1194
+ # VPC.
1169
1195
  #
1170
- # To launch Dedicated Instances into a shared tenancy VPC (a VPC with
1196
+ # To launch dedicated instances into a shared tenancy VPC (a VPC with
1171
1197
  # the instance placement tenancy attribute set to `default`), you must
1172
1198
  # set the value of this parameter to `dedicated`.
1173
1199
  #
1174
- # If you specify `PlacementTenancy`, be sure to specify at least one
1175
- # subnet when you create your group.
1200
+ # If you specify `PlacementTenancy`, you must specify at least one
1201
+ # subnet for `VPCZoneIdentifier` when you create your group.
1176
1202
  #
1177
1203
  # For more information, see [Instance Placement Tenancy][1] in the
1178
1204
  # *Amazon EC2 Auto Scaling User Guide*.
@@ -3526,7 +3552,7 @@ module Aws::AutoScaling
3526
3552
  # the instances launch or terminate.**
3527
3553
  #
3528
3554
  # 4. If you need more time, record the lifecycle action heartbeat to
3529
- # keep the instance in a pending state using using
3555
+ # keep the instance in a pending state using
3530
3556
  # RecordLifecycleActionHeartbeat.
3531
3557
  #
3532
3558
  # 5. If you finish before the timeout period ends, complete the
@@ -3703,10 +3729,18 @@ module Aws::AutoScaling
3703
3729
  req.send_request(options)
3704
3730
  end
3705
3731
 
3706
- # Creates or updates a policy for an Auto Scaling group. To update an
3707
- # existing policy, use the existing policy name and set the parameters
3708
- # to change. Any existing parameter not changed in an update to an
3709
- # existing policy is not changed in this update request.
3732
+ # Creates or updates a scaling policy for an Auto Scaling group. To
3733
+ # update an existing scaling policy, use the existing policy name and
3734
+ # set the parameters to change. Any existing parameter not changed in an
3735
+ # update to an existing policy is not changed in this update request.
3736
+ #
3737
+ # For more information about using scaling policies to scale your Auto
3738
+ # Scaling group automatically, see [Dynamic Scaling][1] in the *Amazon
3739
+ # EC2 Auto Scaling User Guide*.
3740
+ #
3741
+ #
3742
+ #
3743
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3710
3744
  #
3711
3745
  # @option params [required, String] :auto_scaling_group_name
3712
3746
  # The name of the Auto Scaling group.
@@ -3720,18 +3754,17 @@ module Aws::AutoScaling
3720
3754
  # treated as `SimpleScaling`.
3721
3755
  #
3722
3756
  # @option params [String] :adjustment_type
3723
- # The adjustment type. The valid values are `ChangeInCapacity`,
3724
- # `ExactCapacity`, and `PercentChangeInCapacity`.
3757
+ # Specifies whether the `ScalingAdjustment` parameter is an absolute
3758
+ # number or a percentage of the current capacity. The valid values are
3759
+ # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
3725
3760
  #
3726
- # This parameter is supported if the policy type is `SimpleScaling` or
3727
- # `StepScaling`.
3728
- #
3729
- # For more information, see [Dynamic Scaling][1] in the *Amazon EC2 Auto
3730
- # Scaling User Guide*.
3761
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
3762
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
3763
+ # Auto Scaling User Guide*.
3731
3764
  #
3732
3765
  #
3733
3766
  #
3734
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3767
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
3735
3768
  #
3736
3769
  # @option params [Integer] :min_adjustment_step
3737
3770
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
@@ -3743,26 +3776,36 @@ module Aws::AutoScaling
3743
3776
  # changes the `DesiredCapacity` of the Auto Scaling group by at least
3744
3777
  # this many instances. Otherwise, the error is `ValidationError`.
3745
3778
  #
3746
- # This parameter is supported if the policy type is `SimpleScaling` or
3747
- # `StepScaling`.
3779
+ # This property replaces the `MinAdjustmentStep` property. For example,
3780
+ # suppose that you create a step scaling policy to scale out an Auto
3781
+ # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
3782
+ # of 2. If the group has 4 instances and the scaling policy is
3783
+ # performed, 25 percent of 4 is 1. However, because you specified a
3784
+ # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
3785
+ # group by 2 instances.
3786
+ #
3787
+ # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
3748
3788
  #
3749
3789
  # @option params [Integer] :scaling_adjustment
3750
- # The amount by which to scale, based on the specified adjustment type.
3751
- # A positive value adds to the current capacity while a negative number
3752
- # removes from the current capacity.
3790
+ # The amount by which a simple scaling policy scales the Auto Scaling
3791
+ # group in response to an alarm breach. The adjustment is based on the
3792
+ # value that you specified in the `AdjustmentType` parameter (either an
3793
+ # absolute number or a percentage). A positive value adds to the current
3794
+ # capacity and a negative value subtracts from the current capacity. For
3795
+ # exact capacity, you must specify a positive value.
3753
3796
  #
3754
- # Conditional: This parameter is required if the policy type is
3755
- # `SimpleScaling` and not supported otherwise.
3797
+ # Conditional: If you specify `SimpleScaling` for the policy type, you
3798
+ # must specify this parameter. (Not used with any other policy type.)
3756
3799
  #
3757
3800
  # @option params [Integer] :cooldown
3758
- # The amount of time, in seconds, after a scaling activity completes and
3759
- # before the next scaling activity can start. If this parameter is not
3760
- # specified, the default cooldown period for the group applies.
3761
- #
3762
- # This parameter is supported if the policy type is `SimpleScaling`.
3801
+ # The amount of time, in seconds, after a scaling activity completes
3802
+ # before any further dynamic scaling activities can start. If this
3803
+ # parameter is not specified, the default cooldown period for the group
3804
+ # applies.
3763
3805
  #
3764
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
3765
- # Auto Scaling User Guide*.
3806
+ # Valid only if the policy type is `SimpleScaling`. For more
3807
+ # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
3808
+ # Scaling User Guide*.
3766
3809
  #
3767
3810
  #
3768
3811
  #
@@ -3773,29 +3816,37 @@ module Aws::AutoScaling
3773
3816
  # `Minimum`, `Maximum`, and `Average`. If the aggregation type is null,
3774
3817
  # the value is treated as `Average`.
3775
3818
  #
3776
- # This parameter is supported if the policy type is `StepScaling`.
3819
+ # Valid only if the policy type is `StepScaling`.
3777
3820
  #
3778
3821
  # @option params [Array<Types::StepAdjustment>] :step_adjustments
3779
3822
  # A set of adjustments that enable you to scale based on the size of the
3780
3823
  # alarm breach.
3781
3824
  #
3782
- # Conditional: This parameter is required if the policy type is
3783
- # `StepScaling` and not supported otherwise.
3825
+ # Conditional: If you specify `StepScaling` for the policy type, you
3826
+ # must specify this parameter. (Not used with any other policy type.)
3784
3827
  #
3785
3828
  # @option params [Integer] :estimated_instance_warmup
3786
3829
  # The estimated time, in seconds, until a newly launched instance can
3787
3830
  # contribute to the CloudWatch metrics. The default is to use the value
3788
3831
  # specified for the default cooldown period for the group.
3789
3832
  #
3790
- # This parameter is supported if the policy type is `StepScaling` or
3833
+ # Valid only if the policy type is `StepScaling` or
3791
3834
  # `TargetTrackingScaling`.
3792
3835
  #
3793
3836
  # @option params [Types::TargetTrackingConfiguration] :target_tracking_configuration
3794
3837
  # A target tracking scaling policy. Includes support for predefined or
3795
3838
  # customized metrics.
3796
3839
  #
3797
- # Conditional: This parameter is required if the policy type is
3798
- # `TargetTrackingScaling` and not supported otherwise.
3840
+ # For more information, see [TargetTrackingConfiguration][1] in the
3841
+ # *Amazon EC2 Auto Scaling API Reference*.
3842
+ #
3843
+ # Conditional: If you specify `TargetTrackingScaling` for the policy
3844
+ # type, you must specify this parameter. (Not used with any other policy
3845
+ # type.)
3846
+ #
3847
+ #
3848
+ #
3849
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html
3799
3850
  #
3800
3851
  # @return [Types::PolicyARNType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3801
3852
  #
@@ -3895,7 +3946,7 @@ module Aws::AutoScaling
3895
3946
  # The name of this scaling action.
3896
3947
  #
3897
3948
  # @option params [Time,DateTime,Date,Integer,String] :time
3898
- # This parameter is deprecated.
3949
+ # This parameter is no longer used.
3899
3950
  #
3900
3951
  # @option params [Time,DateTime,Date,Integer,String] :start_time
3901
3952
  # The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ
@@ -4425,18 +4476,18 @@ module Aws::AutoScaling
4425
4476
  # activities that are currently in progress aren't affected.
4426
4477
  #
4427
4478
  # If you associate a new launch configuration or template with an Auto
4428
- # Scaling group, all new instances will get the updated configuration,
4429
- # but existing instances continue to run with the configuration that
4430
- # they were originally launched with. When you update a group to specify
4431
- # a mixed instances policy instead of a launch configuration or
4432
- # template, existing instances may be replaced to match the new
4433
- # purchasing options that you specified in the policy. For example, if
4434
- # the group currently has 100% On-Demand capacity and the policy
4435
- # specifies 50% Spot capacity, this means that half of your instances
4436
- # will be gradually terminated and relaunched as Spot Instances. When
4437
- # replacing instances, Amazon EC2 Auto Scaling launches new instances
4438
- # before terminating the old ones, so that updating your group does not
4439
- # compromise the performance or availability of your application.
4479
+ # Scaling group, all new instances will get the updated configuration.
4480
+ # Existing instances continue to run with the configuration that they
4481
+ # were originally launched with. When you update a group to specify a
4482
+ # mixed instances policy instead of a launch configuration or template,
4483
+ # existing instances may be replaced to match the new purchasing options
4484
+ # that you specified in the policy. For example, if the group currently
4485
+ # has 100% On-Demand capacity and the policy specifies 50% Spot
4486
+ # capacity, this means that half of your instances will be gradually
4487
+ # terminated and relaunched as Spot Instances. When replacing instances,
4488
+ # Amazon EC2 Auto Scaling launches new instances before terminating the
4489
+ # old ones, so that updating your group does not compromise the
4490
+ # performance or availability of your application.
4440
4491
  #
4441
4492
  # Note the following about changing `DesiredCapacity`, `MaxSize`, or
4442
4493
  # `MinSize`\:
@@ -4469,19 +4520,24 @@ module Aws::AutoScaling
4469
4520
  # `LaunchConfigurationName` in your update request, you can't specify
4470
4521
  # `LaunchTemplate` or `MixedInstancesPolicy`.
4471
4522
  #
4472
- # <note markdown="1"> To update an Auto Scaling group with a launch configuration with
4523
+ # To update an Auto Scaling group with a launch configuration with
4473
4524
  # `InstanceMonitoring` set to `false`, you must first disable the
4474
4525
  # collection of group metrics. Otherwise, you get an error. If you have
4475
4526
  # previously enabled the collection of group metrics, you can disable it
4476
4527
  # using DisableMetricsCollection.
4477
4528
  #
4478
- # </note>
4479
- #
4480
4529
  # @option params [Types::LaunchTemplateSpecification] :launch_template
4481
4530
  # The launch template and version to use to specify the updates. If you
4482
4531
  # specify `LaunchTemplate` in your update request, you can't specify
4483
4532
  # `LaunchConfigurationName` or `MixedInstancesPolicy`.
4484
4533
  #
4534
+ # For more information, see [LaunchTemplateSpecification][1] in the
4535
+ # *Amazon EC2 Auto Scaling API Reference*.
4536
+ #
4537
+ #
4538
+ #
4539
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_LaunchTemplateSpecification.html
4540
+ #
4485
4541
  # @option params [Types::MixedInstancesPolicy] :mixed_instances_policy
4486
4542
  # An embedded object that specifies a mixed instances policy.
4487
4543
  #
@@ -4489,13 +4545,15 @@ module Aws::AutoScaling
4489
4545
  # policy that is specified. All optional parameters are left unchanged
4490
4546
  # if not specified.
4491
4547
  #
4492
- # For more information, see [Auto Scaling Groups with Multiple Instance
4493
- # Types and Purchase Options][1] in the *Amazon EC2 Auto Scaling User
4494
- # Guide*.
4548
+ # For more information, see [MixedInstancesPolicy][1] in the *Amazon EC2
4549
+ # Auto Scaling API Reference* and [Auto Scaling Groups with Multiple
4550
+ # Instance Types and Purchase Options][2] in the *Amazon EC2 Auto
4551
+ # Scaling User Guide*.
4495
4552
  #
4496
4553
  #
4497
4554
  #
4498
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
4555
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_MixedInstancesPolicy.html
4556
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html
4499
4557
  #
4500
4558
  # @option params [Integer] :min_size
4501
4559
  # The minimum size of the Auto Scaling group.
@@ -4537,15 +4595,15 @@ module Aws::AutoScaling
4537
4595
  # before checking the health status of an EC2 instance that has come
4538
4596
  # into service. The default value is `0`.
4539
4597
  #
4540
- # For more information, see [Health Checks for Auto Scaling
4541
- # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
4598
+ # For more information, see [Health Check Grace Period][1] in the
4599
+ # *Amazon EC2 Auto Scaling User Guide*.
4542
4600
  #
4543
4601
  # Conditional: This parameter is required if you are adding an `ELB`
4544
4602
  # health check.
4545
4603
  #
4546
4604
  #
4547
4605
  #
4548
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html
4606
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period
4549
4607
  #
4550
4608
  # @option params [String] :placement_group
4551
4609
  # The name of the placement group into which to launch your instances,
@@ -4699,7 +4757,7 @@ module Aws::AutoScaling
4699
4757
  params: params,
4700
4758
  config: config)
4701
4759
  context[:gem_name] = 'aws-sdk-autoscaling'
4702
- context[:gem_version] = '1.27.0'
4760
+ context[:gem_version] = '1.28.0'
4703
4761
  Seahorse::Client::Request.new(handlers, context)
4704
4762
  end
4705
4763