aws-sdk-autoscaling 1.40.0 → 1.45.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
  SHA256:
3
- metadata.gz: 21162b28994033fe0561bd454630f85ec3e09bfaf1d19030a2a600a2e9246b47
4
- data.tar.gz: 20d545494b188d07ac04240ee6d7dffad9614b38d7a4c4f26de204d4d6762969
3
+ metadata.gz: 49f61c96c0e1335511bafaeab330a090cc8762b3f3ea328210bb2fe47d36bdaf
4
+ data.tar.gz: a766f6338b30fd0f293d70f563113e1c364fd1f8d3c8241c8f31bb521ffa792c
5
5
  SHA512:
6
- metadata.gz: d29d595273b5ab4103bdc7c01c128fe0f32b062b3e647303e9d4d1421d12d9ab5be3961295149216bbcd73ff97043c62250c21e1ce582abd2368ce7afbc9c218
7
- data.tar.gz: 113b4092ff01627ad2e23a85869cca40bfe5bc2be421dc3055554b59b8a455b6843de3fc29ddb9d0b9a0a3eef983b31ff26702204d6535b6031b19631219c8a2
6
+ metadata.gz: f79d129000173f7ea8affaf93511b0066546f6d6c155e0c9da5e5cd8ff90d5c4af6004db128e61d65a796584ae01e561d2f2d54cbee6fa60593fd64cc3c0b9cf
7
+ data.tar.gz: c120c9a2e71e6825d6cfbcf83380035a4f7533ccc8dcca89f146a799d4dc4bb3dc41d3fc84bc1855e5c2e91179e0e3d1509ac467b5891fd31f850860c80944b7
@@ -55,9 +55,9 @@ require_relative 'aws-sdk-autoscaling/customizations'
55
55
  #
56
56
  # See {Errors} for more information.
57
57
  #
58
- # @service
58
+ # @!group service
59
59
  module Aws::AutoScaling
60
60
 
61
- GEM_VERSION = '1.40.0'
61
+ GEM_VERSION = '1.45.0'
62
62
 
63
63
  end
@@ -77,8 +77,7 @@ module Aws::AutoScaling
77
77
  data[:desired_capacity]
78
78
  end
79
79
 
80
- # The amount of time, in seconds, after a scaling activity completes
81
- # before another scaling activity can start.
80
+ # The duration of the default cooldown period, in seconds.
82
81
  # @return [Integer]
83
82
  def default_cooldown
84
83
  data[:default_cooldown]
@@ -585,15 +584,19 @@ module Aws::AutoScaling
585
584
  # @option options [required, String] :policy_name
586
585
  # The name of the policy.
587
586
  # @option options [String] :policy_type
588
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
589
- # and `TargetTrackingScaling`. If the policy type is null, the value is
590
- # treated as `SimpleScaling`.
587
+ # One of the following policy types:
588
+ #
589
+ # * `TargetTrackingScaling`
590
+ #
591
+ # * `StepScaling`
592
+ #
593
+ # * `SimpleScaling` (default)
591
594
  # @option options [String] :adjustment_type
592
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
593
- # number or a percentage of the current capacity. The valid values are
595
+ # Specifies how the scaling adjustment is interpreted (for example, an
596
+ # absolute number or a percentage). The valid values are
594
597
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
595
598
  #
596
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
599
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
597
600
  # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
598
601
  # Auto Scaling User Guide*.
599
602
  #
@@ -604,41 +607,43 @@ module Aws::AutoScaling
604
607
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
605
608
  # instead.
606
609
  # @option options [Integer] :min_adjustment_magnitude
607
- # The minimum value to scale by when scaling by percentages. For
608
- # example, suppose that you create a step scaling policy to scale out an
609
- # Auto Scaling group by 25 percent and you specify a
610
- # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
611
- # scaling policy is performed, 25 percent of 4 is 1. However, because
612
- # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
613
- # scales out the group by 2 instances.
614
- #
615
- # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
616
- # the adjustment type is `PercentChangeInCapacity`. For more
617
- # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
618
- # Scaling User Guide*.
610
+ # The minimum value to scale by when the adjustment type is
611
+ # `PercentChangeInCapacity`. For example, suppose that you create a step
612
+ # scaling policy to scale out an Auto Scaling group by 25 percent and
613
+ # you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
614
+ # instances and the scaling policy is performed, 25 percent of 4 is 1.
615
+ # However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon
616
+ # EC2 Auto Scaling scales out the group by 2 instances.
617
+ #
618
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
619
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
620
+ # Auto Scaling User Guide*.
621
+ #
622
+ # <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
623
+ # `MinAdjustmentMagnitude` to a value that is at least as large as your
624
+ # largest instance weight.
625
+ #
626
+ # </note>
619
627
  #
620
628
  #
621
629
  #
622
630
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
623
631
  # @option options [Integer] :scaling_adjustment
624
- # The amount by which a simple scaling policy scales the Auto Scaling
625
- # group in response to an alarm breach. The adjustment is based on the
626
- # value that you specified in the `AdjustmentType` parameter (either an
627
- # absolute number or a percentage). A positive value adds to the current
628
- # capacity and a negative value subtracts from the current capacity. For
629
- # exact capacity, you must specify a positive value.
630
- #
631
- # Conditional: If you specify `SimpleScaling` for the policy type, you
632
- # must specify this parameter. (Not used with any other policy type.)
632
+ # The amount by which to scale, based on the specified adjustment type.
633
+ # A positive value adds to the current capacity while a negative number
634
+ # removes from the current capacity. For exact capacity, you must
635
+ # specify a positive value.
636
+ #
637
+ # Required if the policy type is `SimpleScaling`. (Not used with any
638
+ # other policy type.)
633
639
  # @option options [Integer] :cooldown
634
- # The amount of time, in seconds, after a scaling activity completes
635
- # before any further dynamic scaling activities can start. If this
636
- # parameter is not specified, the default cooldown period for the group
637
- # applies.
640
+ # The duration of the policy's cooldown period, in seconds. When a
641
+ # cooldown period is specified here, it overrides the default cooldown
642
+ # period defined for the Auto Scaling group.
638
643
  #
639
644
  # Valid only if the policy type is `SimpleScaling`. For more
640
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
641
- # Scaling User Guide*.
645
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
646
+ # the *Amazon EC2 Auto Scaling User Guide*.
642
647
  #
643
648
  #
644
649
  #
@@ -653,25 +658,38 @@ module Aws::AutoScaling
653
658
  # A set of adjustments that enable you to scale based on the size of the
654
659
  # alarm breach.
655
660
  #
656
- # Conditional: If you specify `StepScaling` for the policy type, you
657
- # must specify this parameter. (Not used with any other policy type.)
661
+ # Required if the policy type is `StepScaling`. (Not used with any other
662
+ # policy type.)
658
663
  # @option options [Integer] :estimated_instance_warmup
659
664
  # The estimated time, in seconds, until a newly launched instance can
660
- # contribute to the CloudWatch metrics. The default is to use the value
661
- # specified for the default cooldown period for the group.
665
+ # contribute to the CloudWatch metrics. If not provided, the default is
666
+ # to use the value from the default cooldown period for the Auto Scaling
667
+ # group.
662
668
  #
663
- # Valid only if the policy type is `StepScaling` or
664
- # `TargetTrackingScaling`.
669
+ # Valid only if the policy type is `TargetTrackingScaling` or
670
+ # `StepScaling`.
665
671
  # @option options [Types::TargetTrackingConfiguration] :target_tracking_configuration
666
672
  # A target tracking scaling policy. Includes support for predefined or
667
673
  # customized metrics.
668
674
  #
675
+ # The following predefined metrics are available:
676
+ #
677
+ # * `ASGAverageCPUUtilization`
678
+ #
679
+ # * `ASGAverageNetworkIn`
680
+ #
681
+ # * `ASGAverageNetworkOut`
682
+ #
683
+ # * `ALBRequestCountPerTarget`
684
+ #
685
+ # If you specify `ALBRequestCountPerTarget` for the metric, you must
686
+ # specify the `ResourceLabel` parameter with the
687
+ # `PredefinedMetricSpecification`.
688
+ #
669
689
  # For more information, see [TargetTrackingConfiguration][1] in the
670
690
  # *Amazon EC2 Auto Scaling API Reference*.
671
691
  #
672
- # Conditional: If you specify `TargetTrackingScaling` for the policy
673
- # type, you must specify this parameter. (Not used with any other policy
674
- # type.)
692
+ # Required if the policy type is `TargetTrackingScaling`.
675
693
  #
676
694
  #
677
695
  #
@@ -938,8 +956,8 @@ module Aws::AutoScaling
938
956
  # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
939
957
  # Auto Scaling may need to go above `MaxSize` to meet your capacity
940
958
  # requirements. In this event, Amazon EC2 Auto Scaling will never go
941
- # above `MaxSize` by more than your maximum instance weight (weights
942
- # that define how many capacity units each instance contributes to the
959
+ # above `MaxSize` by more than your largest instance weight (weights
960
+ # that define how many units each instance contributes to the desired
943
961
  # capacity of the group).
944
962
  #
945
963
  # </note>
@@ -953,13 +971,11 @@ module Aws::AutoScaling
953
971
  # @option options [Integer] :default_cooldown
954
972
  # The amount of time, in seconds, after a scaling activity completes
955
973
  # before another scaling activity can start. The default value is `300`.
956
- # This cooldown period is not used when a scaling-specific cooldown is
957
- # specified.
958
974
  #
959
- # Cooldown periods are not supported for target tracking scaling
960
- # policies, step scaling policies, or scheduled scaling. For more
961
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
962
- # Scaling User Guide*.
975
+ # This setting applies when using simple scaling policies, but not when
976
+ # using other scaling policies or scheduled scaling. For more
977
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
978
+ # the *Amazon EC2 Auto Scaling User Guide*.
963
979
  #
964
980
  #
965
981
  #
@@ -979,8 +995,7 @@ module Aws::AutoScaling
979
995
  # For more information, see [Health Check Grace Period][1] in the
980
996
  # *Amazon EC2 Auto Scaling User Guide*.
981
997
  #
982
- # Conditional: This parameter is required if you are adding an `ELB`
983
- # health check.
998
+ # Required if you are adding an `ELB` health check.
984
999
  #
985
1000
  #
986
1001
  #
@@ -85,13 +85,28 @@ module Aws::AutoScaling
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::AutoScaling
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -582,6 +597,20 @@ module Aws::AutoScaling
582
597
  #
583
598
  # * {Types::CancelInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
584
599
  #
600
+ #
601
+ # @example Example: To cancel an instance refresh
602
+ #
603
+ # # This example cancels an instance refresh operation in progress.
604
+ #
605
+ # resp = client.cancel_instance_refresh({
606
+ # auto_scaling_group_name: "my-auto-scaling-group",
607
+ # })
608
+ #
609
+ # resp.to_h outputs the following:
610
+ # {
611
+ # instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
612
+ # }
613
+ #
585
614
  # @example Request syntax with placeholder values
586
615
  #
587
616
  # resp = client.cancel_instance_refresh({
@@ -698,6 +727,13 @@ module Aws::AutoScaling
698
727
  # Scaling User Guide*. For more information, see [Auto Scaling
699
728
  # Groups][4] in the *Amazon EC2 Auto Scaling User Guide*.
700
729
  #
730
+ # Every Auto Scaling group has three size parameters (`DesiredCapacity`,
731
+ # `MaxSize`, and `MinSize`). Usually, you set these sizes based on a
732
+ # specific number of instances. However, if you configure a mixed
733
+ # instances policy that defines weights for the instance types, you must
734
+ # specify these sizes with the same units that you use for weighting
735
+ # instances.
736
+ #
701
737
  #
702
738
  #
703
739
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
@@ -790,8 +826,8 @@ module Aws::AutoScaling
790
826
  # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
791
827
  # Auto Scaling may need to go above `MaxSize` to meet your capacity
792
828
  # requirements. In this event, Amazon EC2 Auto Scaling will never go
793
- # above `MaxSize` by more than your maximum instance weight (weights
794
- # that define how many capacity units each instance contributes to the
829
+ # above `MaxSize` by more than your largest instance weight (weights
830
+ # that define how many units each instance contributes to the desired
795
831
  # capacity of the group).
796
832
  #
797
833
  # </note>
@@ -810,8 +846,10 @@ module Aws::AutoScaling
810
846
  # The amount of time, in seconds, after a scaling activity completes
811
847
  # before another scaling activity can start. The default value is `300`.
812
848
  #
813
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
814
- # Auto Scaling User Guide*.
849
+ # This setting applies when using simple scaling policies, but not when
850
+ # using other scaling policies or scheduled scaling. For more
851
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
852
+ # the *Amazon EC2 Auto Scaling User Guide*.
815
853
  #
816
854
  #
817
855
  #
@@ -872,8 +910,7 @@ module Aws::AutoScaling
872
910
  # For more information, see [Health Check Grace Period][1] in the
873
911
  # *Amazon EC2 Auto Scaling User Guide*.
874
912
  #
875
- # Conditional: This parameter is required if you are adding an `ELB`
876
- # health check.
913
+ # Required if you are adding an `ELB` health check.
877
914
  #
878
915
  #
879
916
  #
@@ -986,46 +1023,50 @@ module Aws::AutoScaling
986
1023
  #
987
1024
  # resp = client.create_auto_scaling_group({
988
1025
  # auto_scaling_group_name: "my-auto-scaling-group",
989
- # launch_configuration_name: "my-launch-config",
1026
+ # launch_template: {
1027
+ # launch_template_id: "lt-0a20c965061f64abc",
1028
+ # version: "$Latest",
1029
+ # },
1030
+ # max_instance_lifetime: 2592000,
990
1031
  # max_size: 3,
991
1032
  # min_size: 1,
992
- # vpc_zone_identifier: "subnet-4176792c",
1033
+ # vpc_zone_identifier: "subnet-057fa0918fEXAMPLE",
993
1034
  # })
994
1035
  #
995
- # @example Example: To create an Auto Scaling group with an attached load balancer
1036
+ # @example Example: To create an Auto Scaling group with an attached target group
996
1037
  #
997
- # # This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.
1038
+ # # This example creates an Auto Scaling group and attaches the specified target group.
998
1039
  #
999
1040
  # resp = client.create_auto_scaling_group({
1000
1041
  # auto_scaling_group_name: "my-auto-scaling-group",
1001
- # availability_zones: [
1002
- # "us-west-2c",
1003
- # ],
1004
1042
  # health_check_grace_period: 120,
1005
1043
  # health_check_type: "ELB",
1006
1044
  # launch_configuration_name: "my-launch-config",
1007
- # load_balancer_names: [
1008
- # "my-load-balancer",
1009
- # ],
1010
1045
  # max_size: 3,
1011
1046
  # min_size: 1,
1047
+ # target_group_arns: [
1048
+ # "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
1049
+ # ],
1050
+ # vpc_zone_identifier: "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE",
1012
1051
  # })
1013
1052
  #
1014
- # @example Example: To create an Auto Scaling group with an attached target group
1053
+ # @example Example: To create an Auto Scaling group with an attached load balancer
1015
1054
  #
1016
- # # This example creates an Auto Scaling group and attaches the specified target group.
1055
+ # # This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.
1017
1056
  #
1018
1057
  # resp = client.create_auto_scaling_group({
1019
1058
  # auto_scaling_group_name: "my-auto-scaling-group",
1059
+ # availability_zones: [
1060
+ # "us-west-2c",
1061
+ # ],
1020
1062
  # health_check_grace_period: 120,
1021
1063
  # health_check_type: "ELB",
1022
1064
  # launch_configuration_name: "my-launch-config",
1065
+ # load_balancer_names: [
1066
+ # "my-load-balancer",
1067
+ # ],
1023
1068
  # max_size: 3,
1024
1069
  # min_size: 1,
1025
- # target_group_arns: [
1026
- # "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
1027
- # ],
1028
- # vpc_zone_identifier: "subnet-4176792c, subnet-65ea5f08",
1029
1070
  # })
1030
1071
  #
1031
1072
  # @example Request syntax with placeholder values
@@ -1355,6 +1396,15 @@ module Aws::AutoScaling
1355
1396
  #
1356
1397
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-vpc-tenancy
1357
1398
  #
1399
+ # @option params [Types::InstanceMetadataOptions] :metadata_options
1400
+ # The metadata options for the instances. For more information, see
1401
+ # [Instance Metadata and User Data][1] in the *Amazon EC2 User Guide for
1402
+ # Linux Instances*.
1403
+ #
1404
+ #
1405
+ #
1406
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
1407
+ #
1358
1408
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1359
1409
  #
1360
1410
  #
@@ -1409,6 +1459,11 @@ module Aws::AutoScaling
1409
1459
  # ebs_optimized: false,
1410
1460
  # associate_public_ip_address: false,
1411
1461
  # placement_tenancy: "XmlStringMaxLen64",
1462
+ # metadata_options: {
1463
+ # http_tokens: "optional", # accepts optional, required
1464
+ # http_put_response_hop_limit: 1,
1465
+ # http_endpoint: "disabled", # accepts disabled, enabled
1466
+ # },
1412
1467
  # })
1413
1468
  #
1414
1469
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/CreateLaunchConfiguration AWS API Documentation
@@ -1688,7 +1743,7 @@ module Aws::AutoScaling
1688
1743
  #
1689
1744
  # resp = client.delete_policy({
1690
1745
  # auto_scaling_group_name: "my-auto-scaling-group",
1691
- # policy_name: "ScaleIn",
1746
+ # policy_name: "my-step-scale-out-policy",
1692
1747
  # })
1693
1748
  #
1694
1749
  # @example Request syntax with placeholder values
@@ -1857,7 +1912,7 @@ module Aws::AutoScaling
1857
1912
  # * {Types::DescribeAdjustmentTypesAnswer#adjustment_types #adjustment_types} => Array&lt;Types::AdjustmentType&gt;
1858
1913
  #
1859
1914
  #
1860
- # @example Example: To describe the Auto Scaling adjustment types
1915
+ # @example Example: To describe the Amazon EC2 Auto Scaling adjustment types
1861
1916
  #
1862
1917
  # # This example describes the available adjustment types.
1863
1918
  #
@@ -2207,6 +2262,13 @@ module Aws::AutoScaling
2207
2262
  #
2208
2263
  # * `Cancelled` - The operation is cancelled.
2209
2264
  #
2265
+ # For more information, see [Replacing Auto Scaling Instances Based on
2266
+ # an Instance Refresh][1].
2267
+ #
2268
+ #
2269
+ #
2270
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html
2271
+ #
2210
2272
  # @option params [required, String] :auto_scaling_group_name
2211
2273
  # The name of the Auto Scaling group.
2212
2274
  #
@@ -2226,6 +2288,38 @@ module Aws::AutoScaling
2226
2288
  # * {Types::DescribeInstanceRefreshesAnswer#instance_refreshes #instance_refreshes} => Array&lt;Types::InstanceRefresh&gt;
2227
2289
  # * {Types::DescribeInstanceRefreshesAnswer#next_token #next_token} => String
2228
2290
  #
2291
+ #
2292
+ # @example Example: To list instance refreshes
2293
+ #
2294
+ # # This example describes the instance refreshes for the specified Auto Scaling group.
2295
+ #
2296
+ # resp = client.describe_instance_refreshes({
2297
+ # auto_scaling_group_name: "my-auto-scaling-group",
2298
+ # })
2299
+ #
2300
+ # resp.to_h outputs the following:
2301
+ # {
2302
+ # instance_refreshes: [
2303
+ # {
2304
+ # auto_scaling_group_name: "my-auto-scaling-group",
2305
+ # instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
2306
+ # instances_to_update: 5,
2307
+ # percentage_complete: 0,
2308
+ # start_time: Time.parse("2020-06-02T18:11:27Z"),
2309
+ # status: "InProgress",
2310
+ # },
2311
+ # {
2312
+ # auto_scaling_group_name: "my-auto-scaling-group",
2313
+ # end_time: Time.parse("2020-06-02T16:53:37Z"),
2314
+ # instance_refresh_id: "dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1",
2315
+ # instances_to_update: 0,
2316
+ # percentage_complete: 100,
2317
+ # start_time: Time.parse("2020-06-02T16:43:19Z"),
2318
+ # status: "Successful",
2319
+ # },
2320
+ # ],
2321
+ # }
2322
+ #
2229
2323
  # @example Request syntax with placeholder values
2230
2324
  #
2231
2325
  # resp = client.describe_instance_refreshes({
@@ -2353,6 +2447,9 @@ module Aws::AutoScaling
2353
2447
  # resp.launch_configurations[0].ebs_optimized #=> Boolean
2354
2448
  # resp.launch_configurations[0].associate_public_ip_address #=> Boolean
2355
2449
  # resp.launch_configurations[0].placement_tenancy #=> String
2450
+ # resp.launch_configurations[0].metadata_options.http_tokens #=> String, one of "optional", "required"
2451
+ # resp.launch_configurations[0].metadata_options.http_put_response_hop_limit #=> Integer
2452
+ # resp.launch_configurations[0].metadata_options.http_endpoint #=> String, one of "disabled", "enabled"
2356
2453
  # resp.next_token #=> String
2357
2454
  #
2358
2455
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeLaunchConfigurations AWS API Documentation
@@ -2774,7 +2871,7 @@ module Aws::AutoScaling
2774
2871
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2775
2872
  #
2776
2873
  #
2777
- # @example Example: To describe Auto Scaling policies
2874
+ # @example Example: To describe scaling policies
2778
2875
  #
2779
2876
  # # This example describes the policies for the specified Auto Scaling group.
2780
2877
  #
@@ -3679,7 +3776,8 @@ module Aws::AutoScaling
3679
3776
  req.send_request(options)
3680
3777
  end
3681
3778
 
3682
- # Executes the specified policy.
3779
+ # Executes the specified policy. This can be useful for testing the
3780
+ # design of your scaling policy.
3683
3781
  #
3684
3782
  # @option params [String] :auto_scaling_group_name
3685
3783
  # The name of the Auto Scaling group.
@@ -3691,11 +3789,9 @@ module Aws::AutoScaling
3691
3789
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
3692
3790
  # period to complete before executing the policy.
3693
3791
  #
3694
- # This parameter is not supported if the policy type is `StepScaling` or
3695
- # `TargetTrackingScaling`.
3696
- #
3697
- # For more information, see [Scaling Cooldowns][1] in the *Amazon EC2
3698
- # Auto Scaling User Guide*.
3792
+ # Valid only if the policy type is `SimpleScaling`. For more
3793
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
3794
+ # the *Amazon EC2 Auto Scaling User Guide*.
3699
3795
  #
3700
3796
  #
3701
3797
  #
@@ -3711,26 +3807,27 @@ module Aws::AutoScaling
3711
3807
  # If you specify a metric value that doesn't correspond to a step
3712
3808
  # adjustment for the policy, the call returns an error.
3713
3809
  #
3714
- # Conditional: This parameter is required if the policy type is
3715
- # `StepScaling` and not supported otherwise.
3810
+ # Required if the policy type is `StepScaling` and not supported
3811
+ # otherwise.
3716
3812
  #
3717
3813
  # @option params [Float] :breach_threshold
3718
3814
  # The breach threshold for the alarm.
3719
3815
  #
3720
- # Conditional: This parameter is required if the policy type is
3721
- # `StepScaling` and not supported otherwise.
3816
+ # Required if the policy type is `StepScaling` and not supported
3817
+ # otherwise.
3722
3818
  #
3723
3819
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3724
3820
  #
3725
3821
  #
3726
- # @example Example: To execute an Auto Scaling policy
3822
+ # @example Example: To execute a scaling policy
3727
3823
  #
3728
- # # This example executes the specified Auto Scaling policy for the specified Auto Scaling group.
3824
+ # # This example executes the specified policy.
3729
3825
  #
3730
3826
  # resp = client.execute_policy({
3731
3827
  # auto_scaling_group_name: "my-auto-scaling-group",
3732
- # honor_cooldown: true,
3733
- # policy_name: "ScaleIn",
3828
+ # breach_threshold: 50.0,
3829
+ # metric_value: 59.0,
3830
+ # policy_name: "my-step-scale-out-policy",
3734
3831
  # })
3735
3832
  #
3736
3833
  # @example Request syntax with placeholder values
@@ -3890,16 +3987,16 @@ module Aws::AutoScaling
3890
3987
  #
3891
3988
  # * autoscaling:EC2\_INSTANCE\_TERMINATING
3892
3989
  #
3893
- # Conditional: This parameter is required for new lifecycle hooks, but
3894
- # optional when updating existing hooks.
3990
+ # Required for new lifecycle hooks, but optional when updating existing
3991
+ # hooks.
3895
3992
  #
3896
3993
  # @option params [String] :role_arn
3897
3994
  # The ARN of the IAM role that allows the Auto Scaling group to publish
3898
3995
  # to the specified notification target, for example, an Amazon SNS topic
3899
3996
  # or an Amazon SQS queue.
3900
3997
  #
3901
- # Conditional: This parameter is required for new lifecycle hooks, but
3902
- # optional when updating existing hooks.
3998
+ # Required for new lifecycle hooks, but optional when updating existing
3999
+ # hooks.
3903
4000
  #
3904
4001
  # @option params [String] :notification_target_arn
3905
4002
  # The ARN of the notification target that Amazon EC2 Auto Scaling uses
@@ -4052,16 +4149,20 @@ module Aws::AutoScaling
4052
4149
  # The name of the policy.
4053
4150
  #
4054
4151
  # @option params [String] :policy_type
4055
- # The policy type. The valid values are `SimpleScaling`, `StepScaling`,
4056
- # and `TargetTrackingScaling`. If the policy type is null, the value is
4057
- # treated as `SimpleScaling`.
4152
+ # One of the following policy types:
4153
+ #
4154
+ # * `TargetTrackingScaling`
4155
+ #
4156
+ # * `StepScaling`
4157
+ #
4158
+ # * `SimpleScaling` (default)
4058
4159
  #
4059
4160
  # @option params [String] :adjustment_type
4060
- # Specifies whether the `ScalingAdjustment` parameter is an absolute
4061
- # number or a percentage of the current capacity. The valid values are
4161
+ # Specifies how the scaling adjustment is interpreted (for example, an
4162
+ # absolute number or a percentage). The valid values are
4062
4163
  # `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`.
4063
4164
  #
4064
- # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
4165
+ # Required if the policy type is `StepScaling` or `SimpleScaling`. For
4065
4166
  # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
4066
4167
  # Auto Scaling User Guide*.
4067
4168
  #
@@ -4074,43 +4175,45 @@ module Aws::AutoScaling
4074
4175
  # instead.
4075
4176
  #
4076
4177
  # @option params [Integer] :min_adjustment_magnitude
4077
- # The minimum value to scale by when scaling by percentages. For
4078
- # example, suppose that you create a step scaling policy to scale out an
4079
- # Auto Scaling group by 25 percent and you specify a
4080
- # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
4081
- # scaling policy is performed, 25 percent of 4 is 1. However, because
4082
- # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
4083
- # scales out the group by 2 instances.
4084
- #
4085
- # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
4086
- # the adjustment type is `PercentChangeInCapacity`. For more
4087
- # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
4088
- # Scaling User Guide*.
4178
+ # The minimum value to scale by when the adjustment type is
4179
+ # `PercentChangeInCapacity`. For example, suppose that you create a step
4180
+ # scaling policy to scale out an Auto Scaling group by 25 percent and
4181
+ # you specify a `MinAdjustmentMagnitude` of 2. If the group has 4
4182
+ # instances and the scaling policy is performed, 25 percent of 4 is 1.
4183
+ # However, because you specified a `MinAdjustmentMagnitude` of 2, Amazon
4184
+ # EC2 Auto Scaling scales out the group by 2 instances.
4185
+ #
4186
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling`. For
4187
+ # more information, see [Scaling Adjustment Types][1] in the *Amazon EC2
4188
+ # Auto Scaling User Guide*.
4189
+ #
4190
+ # <note markdown="1"> Some Auto Scaling groups use instance weights. In this case, set the
4191
+ # `MinAdjustmentMagnitude` to a value that is at least as large as your
4192
+ # largest instance weight.
4193
+ #
4194
+ # </note>
4089
4195
  #
4090
4196
  #
4091
4197
  #
4092
4198
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
4093
4199
  #
4094
4200
  # @option params [Integer] :scaling_adjustment
4095
- # The amount by which a simple scaling policy scales the Auto Scaling
4096
- # group in response to an alarm breach. The adjustment is based on the
4097
- # value that you specified in the `AdjustmentType` parameter (either an
4098
- # absolute number or a percentage). A positive value adds to the current
4099
- # capacity and a negative value subtracts from the current capacity. For
4100
- # exact capacity, you must specify a positive value.
4201
+ # The amount by which to scale, based on the specified adjustment type.
4202
+ # A positive value adds to the current capacity while a negative number
4203
+ # removes from the current capacity. For exact capacity, you must
4204
+ # specify a positive value.
4101
4205
  #
4102
- # Conditional: If you specify `SimpleScaling` for the policy type, you
4103
- # must specify this parameter. (Not used with any other policy type.)
4206
+ # Required if the policy type is `SimpleScaling`. (Not used with any
4207
+ # other policy type.)
4104
4208
  #
4105
4209
  # @option params [Integer] :cooldown
4106
- # The amount of time, in seconds, after a scaling activity completes
4107
- # before any further dynamic scaling activities can start. If this
4108
- # parameter is not specified, the default cooldown period for the group
4109
- # applies.
4210
+ # The duration of the policy's cooldown period, in seconds. When a
4211
+ # cooldown period is specified here, it overrides the default cooldown
4212
+ # period defined for the Auto Scaling group.
4110
4213
  #
4111
4214
  # Valid only if the policy type is `SimpleScaling`. For more
4112
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
4113
- # Scaling User Guide*.
4215
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
4216
+ # the *Amazon EC2 Auto Scaling User Guide*.
4114
4217
  #
4115
4218
  #
4116
4219
  #
@@ -4127,27 +4230,40 @@ module Aws::AutoScaling
4127
4230
  # A set of adjustments that enable you to scale based on the size of the
4128
4231
  # alarm breach.
4129
4232
  #
4130
- # Conditional: If you specify `StepScaling` for the policy type, you
4131
- # must specify this parameter. (Not used with any other policy type.)
4233
+ # Required if the policy type is `StepScaling`. (Not used with any other
4234
+ # policy type.)
4132
4235
  #
4133
4236
  # @option params [Integer] :estimated_instance_warmup
4134
4237
  # The estimated time, in seconds, until a newly launched instance can
4135
- # contribute to the CloudWatch metrics. The default is to use the value
4136
- # specified for the default cooldown period for the group.
4238
+ # contribute to the CloudWatch metrics. If not provided, the default is
4239
+ # to use the value from the default cooldown period for the Auto Scaling
4240
+ # group.
4137
4241
  #
4138
- # Valid only if the policy type is `StepScaling` or
4139
- # `TargetTrackingScaling`.
4242
+ # Valid only if the policy type is `TargetTrackingScaling` or
4243
+ # `StepScaling`.
4140
4244
  #
4141
4245
  # @option params [Types::TargetTrackingConfiguration] :target_tracking_configuration
4142
4246
  # A target tracking scaling policy. Includes support for predefined or
4143
4247
  # customized metrics.
4144
4248
  #
4249
+ # The following predefined metrics are available:
4250
+ #
4251
+ # * `ASGAverageCPUUtilization`
4252
+ #
4253
+ # * `ASGAverageNetworkIn`
4254
+ #
4255
+ # * `ASGAverageNetworkOut`
4256
+ #
4257
+ # * `ALBRequestCountPerTarget`
4258
+ #
4259
+ # If you specify `ALBRequestCountPerTarget` for the metric, you must
4260
+ # specify the `ResourceLabel` parameter with the
4261
+ # `PredefinedMetricSpecification`.
4262
+ #
4145
4263
  # For more information, see [TargetTrackingConfiguration][1] in the
4146
4264
  # *Amazon EC2 Auto Scaling API Reference*.
4147
4265
  #
4148
- # Conditional: If you specify `TargetTrackingScaling` for the policy
4149
- # type, you must specify this parameter. (Not used with any other policy
4150
- # type.)
4266
+ # Required if the policy type is `TargetTrackingScaling`.
4151
4267
  #
4152
4268
  #
4153
4269
  #
@@ -4174,15 +4290,31 @@ module Aws::AutoScaling
4174
4290
  # # This example adds the specified policy to the specified Auto Scaling group.
4175
4291
  #
4176
4292
  # resp = client.put_scaling_policy({
4177
- # adjustment_type: "ChangeInCapacity",
4178
4293
  # auto_scaling_group_name: "my-auto-scaling-group",
4179
- # policy_name: "ScaleIn",
4180
- # scaling_adjustment: -1,
4294
+ # policy_name: "alb1000-target-tracking-scaling-policy",
4295
+ # policy_type: "TargetTrackingScaling",
4296
+ # target_tracking_configuration: {
4297
+ # predefined_metric_specification: {
4298
+ # predefined_metric_type: "ALBRequestCountPerTarget",
4299
+ # resource_label: "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d",
4300
+ # },
4301
+ # target_value: 1000.0,
4302
+ # },
4181
4303
  # })
4182
4304
  #
4183
4305
  # resp.to_h outputs the following:
4184
4306
  # {
4185
- # policy_arn: "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
4307
+ # alarms: [
4308
+ # {
4309
+ # alarm_arn: "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e",
4310
+ # alarm_name: "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e",
4311
+ # },
4312
+ # {
4313
+ # alarm_arn: "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2",
4314
+ # alarm_name: "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2",
4315
+ # },
4316
+ # ],
4317
+ # policy_arn: "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy",
4186
4318
  # }
4187
4319
  #
4188
4320
  # @example Request syntax with placeholder values
@@ -4682,7 +4814,7 @@ module Aws::AutoScaling
4682
4814
  # unique ID that you can use to track its progress. To query its status,
4683
4815
  # call the DescribeInstanceRefreshes API. To describe the instance
4684
4816
  # refreshes that have already run, call the DescribeInstanceRefreshes
4685
- # API. To cancel an active instance refresh operation, use the
4817
+ # API. To cancel an instance refresh operation in progress, use the
4686
4818
  # CancelInstanceRefresh API.
4687
4819
  #
4688
4820
  # For more information, see [Replacing Auto Scaling Instances Based on
@@ -4702,17 +4834,47 @@ module Aws::AutoScaling
4702
4834
  # A rolling update is an update that is applied to all instances in an
4703
4835
  # Auto Scaling group until all instances have been updated. A rolling
4704
4836
  # update can fail due to failed health checks or if instances are on
4705
- # standby or are protected from scale-in. If the rolling update process
4837
+ # standby or are protected from scale in. If the rolling update process
4706
4838
  # fails, any instances that were already replaced are not rolled back to
4707
4839
  # their previous configuration.
4708
4840
  #
4709
4841
  # @option params [Types::RefreshPreferences] :preferences
4710
4842
  # Set of preferences associated with the instance refresh request.
4711
4843
  #
4844
+ # If not provided, the default values are used. For
4845
+ # `MinHealthyPercentage`, the default value is `90`. For
4846
+ # `InstanceWarmup`, the default is to use the value specified for the
4847
+ # health check grace period for the Auto Scaling group.
4848
+ #
4849
+ # For more information, see [RefreshPreferences][1] in the *Amazon EC2
4850
+ # Auto Scaling API Reference*.
4851
+ #
4852
+ #
4853
+ #
4854
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html
4855
+ #
4712
4856
  # @return [Types::StartInstanceRefreshAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4713
4857
  #
4714
4858
  # * {Types::StartInstanceRefreshAnswer#instance_refresh_id #instance_refresh_id} => String
4715
4859
  #
4860
+ #
4861
+ # @example Example: To start an instance refresh
4862
+ #
4863
+ # # This example starts an instance refresh for the specified Auto Scaling group.
4864
+ #
4865
+ # resp = client.start_instance_refresh({
4866
+ # auto_scaling_group_name: "my-auto-scaling-group",
4867
+ # preferences: {
4868
+ # instance_warmup: 400,
4869
+ # min_healthy_percentage: 50,
4870
+ # },
4871
+ # })
4872
+ #
4873
+ # resp.to_h outputs the following:
4874
+ # {
4875
+ # instance_refresh_id: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b",
4876
+ # }
4877
+ #
4716
4878
  # @example Request syntax with placeholder values
4717
4879
  #
4718
4880
  # resp = client.start_instance_refresh({
@@ -4974,8 +5136,8 @@ module Aws::AutoScaling
4974
5136
  # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
4975
5137
  # Auto Scaling may need to go above `MaxSize` to meet your capacity
4976
5138
  # requirements. In this event, Amazon EC2 Auto Scaling will never go
4977
- # above `MaxSize` by more than your maximum instance weight (weights
4978
- # that define how many capacity units each instance contributes to the
5139
+ # above `MaxSize` by more than your largest instance weight (weights
5140
+ # that define how many units each instance contributes to the desired
4979
5141
  # capacity of the group).
4980
5142
  #
4981
5143
  # </note>
@@ -4991,13 +5153,11 @@ module Aws::AutoScaling
4991
5153
  # @option params [Integer] :default_cooldown
4992
5154
  # The amount of time, in seconds, after a scaling activity completes
4993
5155
  # before another scaling activity can start. The default value is `300`.
4994
- # This cooldown period is not used when a scaling-specific cooldown is
4995
- # specified.
4996
5156
  #
4997
- # Cooldown periods are not supported for target tracking scaling
4998
- # policies, step scaling policies, or scheduled scaling. For more
4999
- # information, see [Scaling Cooldowns][1] in the *Amazon EC2 Auto
5000
- # Scaling User Guide*.
5157
+ # This setting applies when using simple scaling policies, but not when
5158
+ # using other scaling policies or scheduled scaling. For more
5159
+ # information, see [Scaling Cooldowns for Amazon EC2 Auto Scaling][1] in
5160
+ # the *Amazon EC2 Auto Scaling User Guide*.
5001
5161
  #
5002
5162
  #
5003
5163
  #
@@ -5020,8 +5180,7 @@ module Aws::AutoScaling
5020
5180
  # For more information, see [Health Check Grace Period][1] in the
5021
5181
  # *Amazon EC2 Auto Scaling User Guide*.
5022
5182
  #
5023
- # Conditional: This parameter is required if you are adding an `ELB`
5024
- # health check.
5183
+ # Required if you are adding an `ELB` health check.
5025
5184
  #
5026
5185
  #
5027
5186
  #
@@ -5199,7 +5358,7 @@ module Aws::AutoScaling
5199
5358
  params: params,
5200
5359
  config: config)
5201
5360
  context[:gem_name] = 'aws-sdk-autoscaling'
5202
- context[:gem_version] = '1.40.0'
5361
+ context[:gem_version] = '1.45.0'
5203
5362
  Seahorse::Client::Request.new(handlers, context)
5204
5363
  end
5205
5364