aws-sdk-autoscalingplans 1.24.1 → 1.29.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e7f935877cdec331dcfc2ee2e9f09a024375d43249f7bed0b6683bee4c06a201
4
- data.tar.gz: f05f5d4e62cd1a98830c720d6391d9bf43d345dc860c1011d4aaa85d6cde6bde
3
+ metadata.gz: 2244c6c0f84f30d5f250902174ca7165dceed5a69bb36aa74ef5cbff5d913f08
4
+ data.tar.gz: b4f22c3eadc90b0aa349086f9ec34384bbb86e5e4af791d50b133463e23162a6
5
5
  SHA512:
6
- metadata.gz: 349f630a8c838bc6c8eaf824e94815a00bb1e87798877341e23f55ac192238b1241e1616ab9d7b15a6fbcfd1dd13153e93dd21cdd4504af0072d97f3165a3bf1
7
- data.tar.gz: 795b419d267f4ccd309c42fe8789c56dc632747c46eba2953d3fae24b7d748a64b8099d269ba101dc0f1d6d38b910ceb7408681f1faee39e78f08de43c266171
6
+ metadata.gz: c1270d83f4c09b08e2409c074a6b24df7bc58fa8f48f1d701a452a3e8fd3a6f6883e5b58917da34e2b135672663592de2e081a0e4ad7edf1306be425455290a8
7
+ data.tar.gz: 4e487695a74f17fbec7c612b1df27056e45223a7b5a97811dd4d18e0deb7ce3ec3ce63f7f85565a30be9cea12ffb045522c05f2d8eadf5d675566e0cdc220596
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -5,6 +7,7 @@
5
7
  #
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
10
+
8
11
  require 'aws-sdk-core'
9
12
  require 'aws-sigv4'
10
13
 
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-autoscalingplans/customizations'
42
45
  #
43
46
  # See {Errors} for more information.
44
47
  #
45
- # @service
48
+ # @!group service
46
49
  module Aws::AutoScalingPlans
47
50
 
48
- GEM_VERSION = '1.24.1'
51
+ GEM_VERSION = '1.29.0'
49
52
 
50
53
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::AutoScalingPlans
83
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
84
86
  # credentials.
85
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
+ #
86
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
87
103
  # from an EC2 IMDS on an EC2 instance.
88
104
  #
89
- # * `Aws::SharedCredentials` - Used for loading credentials from a
90
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
91
107
  #
92
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
93
110
  #
94
111
  # When `:credentials` are not configured directly, the following
95
112
  # locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::AutoScalingPlans
99
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
100
117
  # * `~/.aws/credentials`
101
118
  # * `~/.aws/config`
102
- # * EC2 IMDS instance profile - When used by default, the timeouts are
103
- # very aggressive. Construct and pass an instance of
104
- # `Aws::InstanceProfileCredentails` to enable retries and extended
105
- # 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.
106
123
  #
107
124
  # @option options [required, String] :region
108
125
  # The AWS region to connect to. The configured `:region` is
@@ -330,9 +347,23 @@ module Aws::AutoScalingPlans
330
347
  # A CloudFormation stack or set of tags. You can create one scaling plan
331
348
  # per application source.
332
349
  #
350
+ # For more information, see [ApplicationSource][1] in the *AWS Auto
351
+ # Scaling API Reference*.
352
+ #
353
+ #
354
+ #
355
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html
356
+ #
333
357
  # @option params [required, Array<Types::ScalingInstruction>] :scaling_instructions
334
358
  # The scaling instructions.
335
359
  #
360
+ # For more information, see [ScalingInstruction][1] in the *AWS Auto
361
+ # Scaling API Reference*.
362
+ #
363
+ #
364
+ #
365
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html
366
+ #
336
367
  # @return [Types::CreateScalingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
337
368
  #
338
369
  # * {Types::CreateScalingPlanResponse#scaling_plan_version #scaling_plan_version} => Integer
@@ -433,7 +464,8 @@ module Aws::AutoScalingPlans
433
464
  # The name of the scaling plan.
434
465
  #
435
466
  # @option params [required, Integer] :scaling_plan_version
436
- # The version number of the scaling plan.
467
+ # The version number of the scaling plan. Currently, the only valid
468
+ # value is `1`.
437
469
  #
438
470
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
439
471
  #
@@ -459,7 +491,8 @@ module Aws::AutoScalingPlans
459
491
  # The name of the scaling plan.
460
492
  #
461
493
  # @option params [required, Integer] :scaling_plan_version
462
- # The version number of the scaling plan.
494
+ # The version number of the scaling plan. Currently, the only valid
495
+ # value is `1`.
463
496
  #
464
497
  # @option params [Integer] :max_results
465
498
  # The maximum number of scalable resources to return. The value must be
@@ -527,8 +560,13 @@ module Aws::AutoScalingPlans
527
560
  # sources, you cannot specify scaling plan names.
528
561
  #
529
562
  # @option params [Integer] :scaling_plan_version
530
- # The version number of the scaling plan. If you specify a scaling plan
531
- # version, you must also specify a scaling plan name.
563
+ # The version number of the scaling plan. Currently, the only valid
564
+ # value is `1`.
565
+ #
566
+ # <note markdown="1"> If you specify a scaling plan version, you must also specify a scaling
567
+ # plan name.
568
+ #
569
+ # </note>
532
570
  #
533
571
  # @option params [Array<Types::ApplicationSource>] :application_sources
534
572
  # The sources for the applications (up to 10). If you specify scaling
@@ -638,39 +676,21 @@ module Aws::AutoScalingPlans
638
676
  # The name of the scaling plan.
639
677
  #
640
678
  # @option params [required, Integer] :scaling_plan_version
641
- # The version number of the scaling plan.
679
+ # The version number of the scaling plan. Currently, the only valid
680
+ # value is `1`.
642
681
  #
643
682
  # @option params [required, String] :service_namespace
644
- # The namespace of the AWS service.
683
+ # The namespace of the AWS service. The only valid value is
684
+ # `autoscaling`.
645
685
  #
646
686
  # @option params [required, String] :resource_id
647
- # The ID of the resource. This string consists of the resource type and
648
- # unique identifier.
649
- #
650
- # * Auto Scaling group - The resource type is `autoScalingGroup` and the
651
- # unique identifier is the name of the Auto Scaling group. Example:
652
- # `autoScalingGroup/my-asg`.
653
- #
654
- # * ECS service - The resource type is `service` and the unique
655
- # identifier is the cluster name and service name. Example:
656
- # `service/default/sample-webapp`.
657
- #
658
- # * Spot Fleet request - The resource type is `spot-fleet-request` and
659
- # the unique identifier is the Spot Fleet request ID. Example:
660
- # `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
661
- #
662
- # * DynamoDB table - The resource type is `table` and the unique
663
- # identifier is the resource ID. Example: `table/my-table`.
664
- #
665
- # * DynamoDB global secondary index - The resource type is `index` and
666
- # the unique identifier is the resource ID. Example:
667
- # `table/my-table/index/my-table-index`.
668
- #
669
- # * Aurora DB cluster - The resource type is `cluster` and the unique
670
- # identifier is the cluster name. Example: `cluster:my-db-cluster`.
687
+ # The ID of the resource. This string consists of a prefix
688
+ # (`autoScalingGroup`) followed by the name of a specified Auto Scaling
689
+ # group (`my-asg`). Example: `autoScalingGroup/my-asg`.
671
690
  #
672
691
  # @option params [required, String] :scalable_dimension
673
- # The scalable dimension for the resource.
692
+ # The scalable dimension for the resource. The only valid value is
693
+ # `autoscaling:autoScalingGroup:DesiredCapacity`.
674
694
  #
675
695
  # @option params [required, String] :forecast_data_type
676
696
  # The type of forecast data to get.
@@ -745,14 +765,29 @@ module Aws::AutoScalingPlans
745
765
  # The name of the scaling plan.
746
766
  #
747
767
  # @option params [required, Integer] :scaling_plan_version
748
- # The version number of the scaling plan.
768
+ # The version number of the scaling plan. The only valid value is `1`.
769
+ # Currently, you cannot have multiple scaling plan versions.
749
770
  #
750
771
  # @option params [Types::ApplicationSource] :application_source
751
772
  # A CloudFormation stack or set of tags.
752
773
  #
774
+ # For more information, see [ApplicationSource][1] in the *AWS Auto
775
+ # Scaling API Reference*.
776
+ #
777
+ #
778
+ #
779
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html
780
+ #
753
781
  # @option params [Array<Types::ScalingInstruction>] :scaling_instructions
754
782
  # The scaling instructions.
755
783
  #
784
+ # For more information, see [ScalingInstruction][1] in the *AWS Auto
785
+ # Scaling API Reference*.
786
+ #
787
+ #
788
+ #
789
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html
790
+ #
756
791
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
757
792
  #
758
793
  # @example Request syntax with placeholder values
@@ -849,7 +884,7 @@ module Aws::AutoScalingPlans
849
884
  params: params,
850
885
  config: config)
851
886
  context[:gem_name] = 'aws-sdk-autoscalingplans'
852
- context[:gem_version] = '1.24.1'
887
+ context[:gem_version] = '1.29.0'
853
888
  Seahorse::Client::Request.new(handlers, context)
854
889
  end
855
890
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -36,6 +38,7 @@ module Aws::AutoScalingPlans
36
38
  class ApplicationSource < Struct.new(
37
39
  :cloud_formation_stack_arn,
38
40
  :tag_filters)
41
+ SENSITIVE = []
39
42
  include Aws::Structure
40
43
  end
41
44
 
@@ -49,6 +52,7 @@ module Aws::AutoScalingPlans
49
52
  #
50
53
  class ConcurrentUpdateException < Struct.new(
51
54
  :message)
55
+ SENSITIVE = []
52
56
  include Aws::Structure
53
57
  end
54
58
 
@@ -132,10 +136,24 @@ module Aws::AutoScalingPlans
132
136
  # @!attribute [rw] application_source
133
137
  # A CloudFormation stack or set of tags. You can create one scaling
134
138
  # plan per application source.
139
+ #
140
+ # For more information, see [ApplicationSource][1] in the *AWS Auto
141
+ # Scaling API Reference*.
142
+ #
143
+ #
144
+ #
145
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html
135
146
  # @return [Types::ApplicationSource]
136
147
  #
137
148
  # @!attribute [rw] scaling_instructions
138
149
  # The scaling instructions.
150
+ #
151
+ # For more information, see [ScalingInstruction][1] in the *AWS Auto
152
+ # Scaling API Reference*.
153
+ #
154
+ #
155
+ #
156
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html
139
157
  # @return [Array<Types::ScalingInstruction>]
140
158
  #
141
159
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlanRequest AWS API Documentation
@@ -144,19 +162,20 @@ module Aws::AutoScalingPlans
144
162
  :scaling_plan_name,
145
163
  :application_source,
146
164
  :scaling_instructions)
165
+ SENSITIVE = []
147
166
  include Aws::Structure
148
167
  end
149
168
 
150
169
  # @!attribute [rw] scaling_plan_version
151
- # The version number of the scaling plan. This value is always 1.
152
- #
153
- # Currently, you cannot specify multiple scaling plan versions.
170
+ # The version number of the scaling plan. This value is always `1`.
171
+ # Currently, you cannot have multiple scaling plan versions.
154
172
  # @return [Integer]
155
173
  #
156
174
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlanResponse AWS API Documentation
157
175
  #
158
176
  class CreateScalingPlanResponse < Struct.new(
159
177
  :scaling_plan_version)
178
+ SENSITIVE = []
160
179
  include Aws::Structure
161
180
  end
162
181
 
@@ -166,8 +185,6 @@ module Aws::AutoScalingPlans
166
185
  # For predictive scaling to work with a customized load metric
167
186
  # specification, AWS Auto Scaling needs access to the `Sum` and
168
187
  # `Average` statistics that CloudWatch computes from metric data.
169
- # Statistics are calculations used to aggregate data over specified time
170
- # periods.
171
188
  #
172
189
  # When you choose a load metric, make sure that the required `Sum` and
173
190
  # `Average` statistics for your metric are available in CloudWatch and
@@ -180,13 +197,25 @@ module Aws::AutoScalingPlans
180
197
  # then the `Average` statistic for the specified metric must represent
181
198
  # the average request count processed by each instance of the group.
182
199
  #
200
+ # If you publish your own metrics, you can aggregate the data points at
201
+ # a given interval and then publish the aggregated data points to
202
+ # CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up
203
+ # all the metric data points that occurred within each hour to match the
204
+ # granularity period that is used in the forecast (60 minutes).
205
+ #
183
206
  # For information about terminology, available metrics, or how to
184
207
  # publish new metrics, see [Amazon CloudWatch Concepts][1] in the
185
208
  # *Amazon CloudWatch User Guide*.
186
209
  #
210
+ # After creating your scaling plan, you can use the AWS Auto Scaling
211
+ # console to visualize forecasts for the specified metric. For more
212
+ # information, see [View Scaling Information for a Resource][2] in the
213
+ # *AWS Auto Scaling User Guide*.
214
+ #
187
215
  #
188
216
  #
189
217
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html
218
+ # [2]: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource
190
219
  #
191
220
  # @note When making an API call, you may pass CustomizedLoadMetricSpecification
192
221
  # data as a hash:
@@ -221,8 +250,7 @@ module Aws::AutoScalingPlans
221
250
  # @return [Array<Types::MetricDimension>]
222
251
  #
223
252
  # @!attribute [rw] statistic
224
- # The statistic of the metric. Currently, the value must always be
225
- # `Sum`.
253
+ # The statistic of the metric. The only valid value is `Sum`.
226
254
  # @return [String]
227
255
  #
228
256
  # @!attribute [rw] unit
@@ -237,6 +265,7 @@ module Aws::AutoScalingPlans
237
265
  :dimensions,
238
266
  :statistic,
239
267
  :unit)
268
+ SENSITIVE = []
240
269
  include Aws::Structure
241
270
  end
242
271
 
@@ -256,8 +285,9 @@ module Aws::AutoScalingPlans
256
285
  # the number of capacity units. That is, the value of the metric
257
286
  # should decrease when capacity increases.
258
287
  #
259
- # For more information about CloudWatch, see [Amazon CloudWatch
260
- # Concepts][2].
288
+ # For information about terminology, available metrics, or how to
289
+ # publish new metrics, see [Amazon CloudWatch Concepts][2] in the
290
+ # *Amazon CloudWatch User Guide*.
261
291
  #
262
292
  #
263
293
  #
@@ -312,6 +342,7 @@ module Aws::AutoScalingPlans
312
342
  :dimensions,
313
343
  :statistic,
314
344
  :unit)
345
+ SENSITIVE = []
315
346
  include Aws::Structure
316
347
  end
317
348
 
@@ -331,6 +362,7 @@ module Aws::AutoScalingPlans
331
362
  class Datapoint < Struct.new(
332
363
  :timestamp,
333
364
  :value)
365
+ SENSITIVE = []
334
366
  include Aws::Structure
335
367
  end
336
368
 
@@ -347,7 +379,8 @@ module Aws::AutoScalingPlans
347
379
  # @return [String]
348
380
  #
349
381
  # @!attribute [rw] scaling_plan_version
350
- # The version number of the scaling plan.
382
+ # The version number of the scaling plan. Currently, the only valid
383
+ # value is `1`.
351
384
  # @return [Integer]
352
385
  #
353
386
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DeleteScalingPlanRequest AWS API Documentation
@@ -355,6 +388,7 @@ module Aws::AutoScalingPlans
355
388
  class DeleteScalingPlanRequest < Struct.new(
356
389
  :scaling_plan_name,
357
390
  :scaling_plan_version)
391
+ SENSITIVE = []
358
392
  include Aws::Structure
359
393
  end
360
394
 
@@ -377,7 +411,8 @@ module Aws::AutoScalingPlans
377
411
  # @return [String]
378
412
  #
379
413
  # @!attribute [rw] scaling_plan_version
380
- # The version number of the scaling plan.
414
+ # The version number of the scaling plan. Currently, the only valid
415
+ # value is `1`.
381
416
  # @return [Integer]
382
417
  #
383
418
  # @!attribute [rw] max_results
@@ -396,6 +431,7 @@ module Aws::AutoScalingPlans
396
431
  :scaling_plan_version,
397
432
  :max_results,
398
433
  :next_token)
434
+ SENSITIVE = []
399
435
  include Aws::Structure
400
436
  end
401
437
 
@@ -413,6 +449,7 @@ module Aws::AutoScalingPlans
413
449
  class DescribeScalingPlanResourcesResponse < Struct.new(
414
450
  :scaling_plan_resources,
415
451
  :next_token)
452
+ SENSITIVE = []
416
453
  include Aws::Structure
417
454
  end
418
455
 
@@ -443,8 +480,13 @@ module Aws::AutoScalingPlans
443
480
  # @return [Array<String>]
444
481
  #
445
482
  # @!attribute [rw] scaling_plan_version
446
- # The version number of the scaling plan. If you specify a scaling
447
- # plan version, you must also specify a scaling plan name.
483
+ # The version number of the scaling plan. Currently, the only valid
484
+ # value is `1`.
485
+ #
486
+ # <note markdown="1"> If you specify a scaling plan version, you must also specify a
487
+ # scaling plan name.
488
+ #
489
+ # </note>
448
490
  # @return [Integer]
449
491
  #
450
492
  # @!attribute [rw] application_sources
@@ -469,6 +511,7 @@ module Aws::AutoScalingPlans
469
511
  :application_sources,
470
512
  :max_results,
471
513
  :next_token)
514
+ SENSITIVE = []
472
515
  include Aws::Structure
473
516
  end
474
517
 
@@ -486,6 +529,7 @@ module Aws::AutoScalingPlans
486
529
  class DescribeScalingPlansResponse < Struct.new(
487
530
  :scaling_plans,
488
531
  :next_token)
532
+ SENSITIVE = []
489
533
  include Aws::Structure
490
534
  end
491
535
 
@@ -508,42 +552,24 @@ module Aws::AutoScalingPlans
508
552
  # @return [String]
509
553
  #
510
554
  # @!attribute [rw] scaling_plan_version
511
- # The version number of the scaling plan.
555
+ # The version number of the scaling plan. Currently, the only valid
556
+ # value is `1`.
512
557
  # @return [Integer]
513
558
  #
514
559
  # @!attribute [rw] service_namespace
515
- # The namespace of the AWS service.
560
+ # The namespace of the AWS service. The only valid value is
561
+ # `autoscaling`.
516
562
  # @return [String]
517
563
  #
518
564
  # @!attribute [rw] resource_id
519
- # The ID of the resource. This string consists of the resource type
520
- # and unique identifier.
521
- #
522
- # * Auto Scaling group - The resource type is `autoScalingGroup` and
523
- # the unique identifier is the name of the Auto Scaling group.
524
- # Example: `autoScalingGroup/my-asg`.
525
- #
526
- # * ECS service - The resource type is `service` and the unique
527
- # identifier is the cluster name and service name. Example:
528
- # `service/default/sample-webapp`.
529
- #
530
- # * Spot Fleet request - The resource type is `spot-fleet-request` and
531
- # the unique identifier is the Spot Fleet request ID. Example:
532
- # `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
533
- #
534
- # * DynamoDB table - The resource type is `table` and the unique
535
- # identifier is the resource ID. Example: `table/my-table`.
536
- #
537
- # * DynamoDB global secondary index - The resource type is `index` and
538
- # the unique identifier is the resource ID. Example:
539
- # `table/my-table/index/my-table-index`.
540
- #
541
- # * Aurora DB cluster - The resource type is `cluster` and the unique
542
- # identifier is the cluster name. Example: `cluster:my-db-cluster`.
565
+ # The ID of the resource. This string consists of a prefix
566
+ # (`autoScalingGroup`) followed by the name of a specified Auto
567
+ # Scaling group (`my-asg`). Example: `autoScalingGroup/my-asg`.
543
568
  # @return [String]
544
569
  #
545
570
  # @!attribute [rw] scalable_dimension
546
- # The scalable dimension for the resource.
571
+ # The scalable dimension for the resource. The only valid value is
572
+ # `autoscaling:autoScalingGroup:DesiredCapacity`.
547
573
  # @return [String]
548
574
  #
549
575
  # @!attribute [rw] forecast_data_type
@@ -592,6 +618,7 @@ module Aws::AutoScalingPlans
592
618
  :forecast_data_type,
593
619
  :start_time,
594
620
  :end_time)
621
+ SENSITIVE = []
595
622
  include Aws::Structure
596
623
  end
597
624
 
@@ -603,6 +630,7 @@ module Aws::AutoScalingPlans
603
630
  #
604
631
  class GetScalingPlanResourceForecastDataResponse < Struct.new(
605
632
  :datapoints)
633
+ SENSITIVE = []
606
634
  include Aws::Structure
607
635
  end
608
636
 
@@ -615,6 +643,7 @@ module Aws::AutoScalingPlans
615
643
  #
616
644
  class InternalServiceException < Struct.new(
617
645
  :message)
646
+ SENSITIVE = []
618
647
  include Aws::Structure
619
648
  end
620
649
 
@@ -627,6 +656,7 @@ module Aws::AutoScalingPlans
627
656
  #
628
657
  class InvalidNextTokenException < Struct.new(
629
658
  :message)
659
+ SENSITIVE = []
630
660
  include Aws::Structure
631
661
  end
632
662
 
@@ -640,6 +670,7 @@ module Aws::AutoScalingPlans
640
670
  #
641
671
  class LimitExceededException < Struct.new(
642
672
  :message)
673
+ SENSITIVE = []
643
674
  include Aws::Structure
644
675
  end
645
676
 
@@ -666,6 +697,7 @@ module Aws::AutoScalingPlans
666
697
  class MetricDimension < Struct.new(
667
698
  :name,
668
699
  :value)
700
+ SENSITIVE = []
669
701
  include Aws::Structure
670
702
  end
671
703
 
@@ -678,12 +710,22 @@ module Aws::AutoScalingPlans
678
710
  #
679
711
  class ObjectNotFoundException < Struct.new(
680
712
  :message)
713
+ SENSITIVE = []
681
714
  include Aws::Structure
682
715
  end
683
716
 
684
717
  # Represents a predefined metric that can be used for predictive
685
718
  # scaling.
686
719
  #
720
+ # After creating your scaling plan, you can use the AWS Auto Scaling
721
+ # console to visualize forecasts for the specified metric. For more
722
+ # information, see [View Scaling Information for a Resource][1] in the
723
+ # *AWS Auto Scaling User Guide*.
724
+ #
725
+ #
726
+ #
727
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource
728
+ #
687
729
  # @note When making an API call, you may pass PredefinedLoadMetricSpecification
688
730
  # data as a hash:
689
731
  #
@@ -699,18 +741,32 @@ module Aws::AutoScalingPlans
699
741
  # @!attribute [rw] resource_label
700
742
  # Identifies the resource associated with the metric type. You can't
701
743
  # specify a resource label unless the metric type is
702
- # `ALBRequestCountPerTarget` and there is a target group for an
744
+ # `ALBTargetGroupRequestCount` and there is a target group for an
703
745
  # Application Load Balancer attached to the Auto Scaling group.
704
746
  #
705
- # The format is
747
+ # You create the resource label by appending the final portion of the
748
+ # load balancer ARN and the final portion of the target group ARN into
749
+ # a single value, separated by a forward slash (/). The format is
706
750
  # app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;,
707
751
  # where:
708
752
  #
709
753
  # * app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the
710
- # final portion of the load balancer ARN.
754
+ # final portion of the load balancer ARN
711
755
  #
712
756
  # * targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is
713
757
  # the final portion of the target group ARN.
758
+ #
759
+ # This is an example:
760
+ # app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
761
+ #
762
+ # To find the ARN for an Application Load Balancer, use the
763
+ # [DescribeLoadBalancers][1] API operation. To find the ARN for the
764
+ # target group, use the [DescribeTargetGroups][2] API operation.
765
+ #
766
+ #
767
+ #
768
+ # [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html
769
+ # [2]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html
714
770
  # @return [String]
715
771
  #
716
772
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/PredefinedLoadMetricSpecification AWS API Documentation
@@ -718,6 +774,7 @@ module Aws::AutoScalingPlans
718
774
  class PredefinedLoadMetricSpecification < Struct.new(
719
775
  :predefined_load_metric_type,
720
776
  :resource_label)
777
+ SENSITIVE = []
721
778
  include Aws::Structure
722
779
  end
723
780
 
@@ -744,15 +801,29 @@ module Aws::AutoScalingPlans
744
801
  # Application Load Balancer attached to the Auto Scaling group, Spot
745
802
  # Fleet request, or ECS service.
746
803
  #
747
- # The format is
804
+ # You create the resource label by appending the final portion of the
805
+ # load balancer ARN and the final portion of the target group ARN into
806
+ # a single value, separated by a forward slash (/). The format is
748
807
  # app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;,
749
808
  # where:
750
809
  #
751
810
  # * app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the
752
- # final portion of the load balancer ARN.
811
+ # final portion of the load balancer ARN
753
812
  #
754
813
  # * targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is
755
814
  # the final portion of the target group ARN.
815
+ #
816
+ # This is an example:
817
+ # app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
818
+ #
819
+ # To find the ARN for an Application Load Balancer, use the
820
+ # [DescribeLoadBalancers][1] API operation. To find the ARN for the
821
+ # target group, use the [DescribeTargetGroups][2] API operation.
822
+ #
823
+ #
824
+ #
825
+ # [1]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html
826
+ # [2]: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html
756
827
  # @return [String]
757
828
  #
758
829
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/PredefinedScalingMetricSpecification AWS API Documentation
@@ -760,15 +831,12 @@ module Aws::AutoScalingPlans
760
831
  class PredefinedScalingMetricSpecification < Struct.new(
761
832
  :predefined_scaling_metric_type,
762
833
  :resource_label)
834
+ SENSITIVE = []
763
835
  include Aws::Structure
764
836
  end
765
837
 
766
- # Describes a scaling instruction for a scalable resource.
767
- #
768
- # The scaling instruction is used in combination with a scaling plan,
769
- # which is a set of instructions for configuring dynamic scaling and
770
- # predictive scaling for the scalable resources in your application.
771
- # Each scaling instruction applies to one resource.
838
+ # Describes a scaling instruction for a scalable resource in a scaling
839
+ # plan. Each scaling instruction applies to one resource.
772
840
  #
773
841
  # AWS Auto Scaling creates target tracking scaling policies based on the
774
842
  # scaling instructions. Target tracking scaling policies adjust the
@@ -787,13 +855,13 @@ module Aws::AutoScalingPlans
787
855
  #
788
856
  # We recommend waiting a minimum of 24 hours after creating an Auto
789
857
  # Scaling group to configure predictive scaling. At minimum, there must
790
- # be 24 hours of historical data to generate a forecast.
858
+ # be 24 hours of historical data to generate a forecast. For more
859
+ # information, see [Best Practices for AWS Auto Scaling][1] in the *AWS
860
+ # Auto Scaling User Guide*.
791
861
  #
792
- # For more information, see [Getting Started with AWS Auto Scaling][1].
793
862
  #
794
863
  #
795
- #
796
- # [1]: https://docs.aws.amazon.com/autoscaling/plans/userguide/auto-scaling-getting-started.html
864
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-best-practices.html
797
865
  #
798
866
  # @note When making an API call, you may pass ScalingInstruction
799
867
  # data as a hash:
@@ -924,17 +992,9 @@ module Aws::AutoScalingPlans
924
992
  # @return [Integer]
925
993
  #
926
994
  # @!attribute [rw] target_tracking_configurations
927
- # The structure that defines new target tracking configurations (up to
928
- # 10). Each of these structures includes a specific scaling metric and
929
- # a target value for the metric, along with various parameters to use
930
- # with dynamic scaling.
931
- #
932
- # With predictive scaling and dynamic scaling, the resource scales
933
- # based on the target tracking configuration that provides the largest
934
- # capacity for both scale in and scale out.
935
- #
936
- # Condition: The scaling metric must be unique across target tracking
937
- # configurations.
995
+ # The target tracking configurations (up to 10). Each of these
996
+ # structures must specify a unique scaling metric and a target value
997
+ # for the metric.
938
998
  # @return [Array<Types::TargetTrackingConfiguration>]
939
999
  #
940
1000
  # @!attribute [rw] predefined_load_metric_specification
@@ -1054,6 +1114,7 @@ module Aws::AutoScalingPlans
1054
1114
  :predictive_scaling_mode,
1055
1115
  :scaling_policy_update_behavior,
1056
1116
  :disable_dynamic_scaling)
1117
+ SENSITIVE = []
1057
1118
  include Aws::Structure
1058
1119
  end
1059
1120
 
@@ -1068,7 +1129,8 @@ module Aws::AutoScalingPlans
1068
1129
  # @return [Integer]
1069
1130
  #
1070
1131
  # @!attribute [rw] application_source
1071
- # The application source.
1132
+ # A CloudFormation stack or a set of tags. You can create one scaling
1133
+ # plan per application source.
1072
1134
  # @return [Types::ApplicationSource]
1073
1135
  #
1074
1136
  # @!attribute [rw] scaling_instructions
@@ -1120,6 +1182,7 @@ module Aws::AutoScalingPlans
1120
1182
  :status_message,
1121
1183
  :status_start_time,
1122
1184
  :creation_time)
1185
+ SENSITIVE = []
1123
1186
  include Aws::Structure
1124
1187
  end
1125
1188
 
@@ -1227,6 +1290,7 @@ module Aws::AutoScalingPlans
1227
1290
  :scaling_policies,
1228
1291
  :scaling_status_code,
1229
1292
  :scaling_status_message)
1293
+ SENSITIVE = []
1230
1294
  include Aws::Structure
1231
1295
  end
1232
1296
 
@@ -1251,6 +1315,7 @@ module Aws::AutoScalingPlans
1251
1315
  :policy_name,
1252
1316
  :policy_type,
1253
1317
  :target_tracking_configuration)
1318
+ SENSITIVE = []
1254
1319
  include Aws::Structure
1255
1320
  end
1256
1321
 
@@ -1277,6 +1342,7 @@ module Aws::AutoScalingPlans
1277
1342
  class TagFilter < Struct.new(
1278
1343
  :key,
1279
1344
  :values)
1345
+ SENSITIVE = []
1280
1346
  include Aws::Structure
1281
1347
  end
1282
1348
 
@@ -1321,8 +1387,9 @@ module Aws::AutoScalingPlans
1321
1387
  # @return [Types::CustomizedScalingMetricSpecification]
1322
1388
  #
1323
1389
  # @!attribute [rw] target_value
1324
- # The target value for the metric. The range is 8.515920e-109 to
1325
- # 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
1390
+ # The target value for the metric. Although this property accepts
1391
+ # numbers of type Double, it won't accept values that are either too
1392
+ # small or too large. Values must be in the range of -2^360 to 2^360.
1326
1393
  # @return [Float]
1327
1394
  #
1328
1395
  # @!attribute [rw] disable_scale_in
@@ -1337,27 +1404,30 @@ module Aws::AutoScalingPlans
1337
1404
  # @return [Boolean]
1338
1405
  #
1339
1406
  # @!attribute [rw] scale_out_cooldown
1340
- # The amount of time, in seconds, after a scale-out activity completes
1341
- # before another scale-out activity can start. This value is not used
1342
- # if the scalable resource is an Auto Scaling group.
1343
- #
1344
- # While the cooldown period is in effect, the capacity that has been
1345
- # added by the previous scale-out event that initiated the cooldown is
1346
- # calculated as part of the desired capacity for the next scale out.
1347
- # The intention is to continuously (but not excessively) scale out.
1407
+ # The amount of time, in seconds, to wait for a previous scale-out
1408
+ # activity to take effect. This property is not used if the scalable
1409
+ # resource is an Auto Scaling group.
1410
+ #
1411
+ # With the *scale-out cooldown period*, the intention is to
1412
+ # continuously (but not excessively) scale out. After Auto Scaling
1413
+ # successfully scales out using a target tracking scaling policy, it
1414
+ # starts to calculate the cooldown time. The scaling policy won't
1415
+ # increase the desired capacity again unless either a larger scale out
1416
+ # is triggered or the cooldown period ends.
1348
1417
  # @return [Integer]
1349
1418
  #
1350
1419
  # @!attribute [rw] scale_in_cooldown
1351
- # The amount of time, in seconds, after a scale in activity completes
1352
- # before another scale in activity can start. This value is not used
1353
- # if the scalable resource is an Auto Scaling group.
1354
- #
1355
- # The cooldown period is used to block subsequent scale in requests
1356
- # until it has expired. The intention is to scale in conservatively to
1357
- # protect your application's availability. However, if another alarm
1358
- # triggers a scale-out policy during the cooldown period after a
1359
- # scale-in, AWS Auto Scaling scales out your scalable target
1360
- # immediately.
1420
+ # The amount of time, in seconds, after a scale-in activity completes
1421
+ # before another scale-in activity can start. This property is not
1422
+ # used if the scalable resource is an Auto Scaling group.
1423
+ #
1424
+ # With the *scale-in cooldown period*, the intention is to scale in
1425
+ # conservatively to protect your application’s availability, so
1426
+ # scale-in activities are blocked until the cooldown period has
1427
+ # expired. However, if another alarm triggers a scale-out activity
1428
+ # during the scale-in cooldown period, Auto Scaling scales out the
1429
+ # target immediately. In this case, the scale-in cooldown period stops
1430
+ # and doesn't complete.
1361
1431
  # @return [Integer]
1362
1432
  #
1363
1433
  # @!attribute [rw] estimated_instance_warmup
@@ -1376,6 +1446,7 @@ module Aws::AutoScalingPlans
1376
1446
  :scale_out_cooldown,
1377
1447
  :scale_in_cooldown,
1378
1448
  :estimated_instance_warmup)
1449
+ SENSITIVE = []
1379
1450
  include Aws::Structure
1380
1451
  end
1381
1452
 
@@ -1457,15 +1528,30 @@ module Aws::AutoScalingPlans
1457
1528
  # @return [String]
1458
1529
  #
1459
1530
  # @!attribute [rw] scaling_plan_version
1460
- # The version number of the scaling plan.
1531
+ # The version number of the scaling plan. The only valid value is `1`.
1532
+ # Currently, you cannot have multiple scaling plan versions.
1461
1533
  # @return [Integer]
1462
1534
  #
1463
1535
  # @!attribute [rw] application_source
1464
1536
  # A CloudFormation stack or set of tags.
1537
+ #
1538
+ # For more information, see [ApplicationSource][1] in the *AWS Auto
1539
+ # Scaling API Reference*.
1540
+ #
1541
+ #
1542
+ #
1543
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html
1465
1544
  # @return [Types::ApplicationSource]
1466
1545
  #
1467
1546
  # @!attribute [rw] scaling_instructions
1468
1547
  # The scaling instructions.
1548
+ #
1549
+ # For more information, see [ScalingInstruction][1] in the *AWS Auto
1550
+ # Scaling API Reference*.
1551
+ #
1552
+ #
1553
+ #
1554
+ # [1]: https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html
1469
1555
  # @return [Array<Types::ScalingInstruction>]
1470
1556
  #
1471
1557
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/UpdateScalingPlanRequest AWS API Documentation
@@ -1475,6 +1561,7 @@ module Aws::AutoScalingPlans
1475
1561
  :scaling_plan_version,
1476
1562
  :application_source,
1477
1563
  :scaling_instructions)
1564
+ SENSITIVE = []
1478
1565
  include Aws::Structure
1479
1566
  end
1480
1567
 
@@ -1492,6 +1579,7 @@ module Aws::AutoScalingPlans
1492
1579
  #
1493
1580
  class ValidationException < Struct.new(
1494
1581
  :message)
1582
+ SENSITIVE = []
1495
1583
  include Aws::Structure
1496
1584
  end
1497
1585
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-autoscalingplans
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.24.1
4
+ version: 1.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-11 00:00:00.000000000 Z
11
+ date: 2021-01-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.99.0
22
+ version: 3.109.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.99.0
32
+ version: 3.109.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement