aws-sdk-autoscalingplans 1.28.0 → 1.29.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 +4 -4
- data/lib/aws-sdk-autoscalingplans.rb +1 -1
- data/lib/aws-sdk-autoscalingplans/client.rb +51 -33
- data/lib/aws-sdk-autoscalingplans/types.rb +145 -88
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2244c6c0f84f30d5f250902174ca7165dceed5a69bb36aa74ef5cbff5d913f08
|
4
|
+
data.tar.gz: b4f22c3eadc90b0aa349086f9ec34384bbb86e5e4af791d50b133463e23162a6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c1270d83f4c09b08e2409c074a6b24df7bc58fa8f48f1d701a452a3e8fd3a6f6883e5b58917da34e2b135672663592de2e081a0e4ad7edf1306be425455290a8
|
7
|
+
data.tar.gz: 4e487695a74f17fbec7c612b1df27056e45223a7b5a97811dd4d18e0deb7ce3ec3ce63f7f85565a30be9cea12ffb045522c05f2d8eadf5d675566e0cdc220596
|
@@ -347,9 +347,23 @@ module Aws::AutoScalingPlans
|
|
347
347
|
# A CloudFormation stack or set of tags. You can create one scaling plan
|
348
348
|
# per application source.
|
349
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
|
+
#
|
350
357
|
# @option params [required, Array<Types::ScalingInstruction>] :scaling_instructions
|
351
358
|
# The scaling instructions.
|
352
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
|
+
#
|
353
367
|
# @return [Types::CreateScalingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
354
368
|
#
|
355
369
|
# * {Types::CreateScalingPlanResponse#scaling_plan_version #scaling_plan_version} => Integer
|
@@ -450,7 +464,8 @@ module Aws::AutoScalingPlans
|
|
450
464
|
# The name of the scaling plan.
|
451
465
|
#
|
452
466
|
# @option params [required, Integer] :scaling_plan_version
|
453
|
-
# The version number of the scaling plan.
|
467
|
+
# The version number of the scaling plan. Currently, the only valid
|
468
|
+
# value is `1`.
|
454
469
|
#
|
455
470
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
456
471
|
#
|
@@ -476,7 +491,8 @@ module Aws::AutoScalingPlans
|
|
476
491
|
# The name of the scaling plan.
|
477
492
|
#
|
478
493
|
# @option params [required, Integer] :scaling_plan_version
|
479
|
-
# The version number of the scaling plan.
|
494
|
+
# The version number of the scaling plan. Currently, the only valid
|
495
|
+
# value is `1`.
|
480
496
|
#
|
481
497
|
# @option params [Integer] :max_results
|
482
498
|
# The maximum number of scalable resources to return. The value must be
|
@@ -544,8 +560,13 @@ module Aws::AutoScalingPlans
|
|
544
560
|
# sources, you cannot specify scaling plan names.
|
545
561
|
#
|
546
562
|
# @option params [Integer] :scaling_plan_version
|
547
|
-
# The version number of the scaling plan.
|
548
|
-
#
|
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>
|
549
570
|
#
|
550
571
|
# @option params [Array<Types::ApplicationSource>] :application_sources
|
551
572
|
# The sources for the applications (up to 10). If you specify scaling
|
@@ -655,39 +676,21 @@ module Aws::AutoScalingPlans
|
|
655
676
|
# The name of the scaling plan.
|
656
677
|
#
|
657
678
|
# @option params [required, Integer] :scaling_plan_version
|
658
|
-
# The version number of the scaling plan.
|
679
|
+
# The version number of the scaling plan. Currently, the only valid
|
680
|
+
# value is `1`.
|
659
681
|
#
|
660
682
|
# @option params [required, String] :service_namespace
|
661
|
-
# The namespace of the AWS service.
|
683
|
+
# The namespace of the AWS service. The only valid value is
|
684
|
+
# `autoscaling`.
|
662
685
|
#
|
663
686
|
# @option params [required, String] :resource_id
|
664
|
-
# The ID of the resource. This string consists of
|
665
|
-
#
|
666
|
-
#
|
667
|
-
# * Auto Scaling group - The resource type is `autoScalingGroup` and the
|
668
|
-
# unique identifier is the name of the Auto Scaling group. Example:
|
669
|
-
# `autoScalingGroup/my-asg`.
|
670
|
-
#
|
671
|
-
# * ECS service - The resource type is `service` and the unique
|
672
|
-
# identifier is the cluster name and service name. Example:
|
673
|
-
# `service/default/sample-webapp`.
|
674
|
-
#
|
675
|
-
# * Spot Fleet request - The resource type is `spot-fleet-request` and
|
676
|
-
# the unique identifier is the Spot Fleet request ID. Example:
|
677
|
-
# `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
|
678
|
-
#
|
679
|
-
# * DynamoDB table - The resource type is `table` and the unique
|
680
|
-
# identifier is the resource ID. Example: `table/my-table`.
|
681
|
-
#
|
682
|
-
# * DynamoDB global secondary index - The resource type is `index` and
|
683
|
-
# the unique identifier is the resource ID. Example:
|
684
|
-
# `table/my-table/index/my-table-index`.
|
685
|
-
#
|
686
|
-
# * Aurora DB cluster - The resource type is `cluster` and the unique
|
687
|
-
# 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`.
|
688
690
|
#
|
689
691
|
# @option params [required, String] :scalable_dimension
|
690
|
-
# The scalable dimension for the resource.
|
692
|
+
# The scalable dimension for the resource. The only valid value is
|
693
|
+
# `autoscaling:autoScalingGroup:DesiredCapacity`.
|
691
694
|
#
|
692
695
|
# @option params [required, String] :forecast_data_type
|
693
696
|
# The type of forecast data to get.
|
@@ -762,14 +765,29 @@ module Aws::AutoScalingPlans
|
|
762
765
|
# The name of the scaling plan.
|
763
766
|
#
|
764
767
|
# @option params [required, Integer] :scaling_plan_version
|
765
|
-
# 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.
|
766
770
|
#
|
767
771
|
# @option params [Types::ApplicationSource] :application_source
|
768
772
|
# A CloudFormation stack or set of tags.
|
769
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
|
+
#
|
770
781
|
# @option params [Array<Types::ScalingInstruction>] :scaling_instructions
|
771
782
|
# The scaling instructions.
|
772
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
|
+
#
|
773
791
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
774
792
|
#
|
775
793
|
# @example Request syntax with placeholder values
|
@@ -866,7 +884,7 @@ module Aws::AutoScalingPlans
|
|
866
884
|
params: params,
|
867
885
|
config: config)
|
868
886
|
context[:gem_name] = 'aws-sdk-autoscalingplans'
|
869
|
-
context[:gem_version] = '1.
|
887
|
+
context[:gem_version] = '1.29.0'
|
870
888
|
Seahorse::Client::Request.new(handlers, context)
|
871
889
|
end
|
872
890
|
|
@@ -136,10 +136,24 @@ module Aws::AutoScalingPlans
|
|
136
136
|
# @!attribute [rw] application_source
|
137
137
|
# A CloudFormation stack or set of tags. You can create one scaling
|
138
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
|
139
146
|
# @return [Types::ApplicationSource]
|
140
147
|
#
|
141
148
|
# @!attribute [rw] scaling_instructions
|
142
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
|
143
157
|
# @return [Array<Types::ScalingInstruction>]
|
144
158
|
#
|
145
159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlanRequest AWS API Documentation
|
@@ -153,9 +167,8 @@ module Aws::AutoScalingPlans
|
|
153
167
|
end
|
154
168
|
|
155
169
|
# @!attribute [rw] scaling_plan_version
|
156
|
-
# The version number of the scaling plan. This value is always 1
|
157
|
-
#
|
158
|
-
# 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.
|
159
172
|
# @return [Integer]
|
160
173
|
#
|
161
174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlanResponse AWS API Documentation
|
@@ -172,8 +185,6 @@ module Aws::AutoScalingPlans
|
|
172
185
|
# For predictive scaling to work with a customized load metric
|
173
186
|
# specification, AWS Auto Scaling needs access to the `Sum` and
|
174
187
|
# `Average` statistics that CloudWatch computes from metric data.
|
175
|
-
# Statistics are calculations used to aggregate data over specified time
|
176
|
-
# periods.
|
177
188
|
#
|
178
189
|
# When you choose a load metric, make sure that the required `Sum` and
|
179
190
|
# `Average` statistics for your metric are available in CloudWatch and
|
@@ -186,13 +197,25 @@ module Aws::AutoScalingPlans
|
|
186
197
|
# then the `Average` statistic for the specified metric must represent
|
187
198
|
# the average request count processed by each instance of the group.
|
188
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
|
+
#
|
189
206
|
# For information about terminology, available metrics, or how to
|
190
207
|
# publish new metrics, see [Amazon CloudWatch Concepts][1] in the
|
191
208
|
# *Amazon CloudWatch User Guide*.
|
192
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
|
+
#
|
193
215
|
#
|
194
216
|
#
|
195
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
|
196
219
|
#
|
197
220
|
# @note When making an API call, you may pass CustomizedLoadMetricSpecification
|
198
221
|
# data as a hash:
|
@@ -227,8 +250,7 @@ module Aws::AutoScalingPlans
|
|
227
250
|
# @return [Array<Types::MetricDimension>]
|
228
251
|
#
|
229
252
|
# @!attribute [rw] statistic
|
230
|
-
# The statistic of the metric.
|
231
|
-
# `Sum`.
|
253
|
+
# The statistic of the metric. The only valid value is `Sum`.
|
232
254
|
# @return [String]
|
233
255
|
#
|
234
256
|
# @!attribute [rw] unit
|
@@ -263,8 +285,9 @@ module Aws::AutoScalingPlans
|
|
263
285
|
# the number of capacity units. That is, the value of the metric
|
264
286
|
# should decrease when capacity increases.
|
265
287
|
#
|
266
|
-
# For
|
267
|
-
# 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*.
|
268
291
|
#
|
269
292
|
#
|
270
293
|
#
|
@@ -356,7 +379,8 @@ module Aws::AutoScalingPlans
|
|
356
379
|
# @return [String]
|
357
380
|
#
|
358
381
|
# @!attribute [rw] scaling_plan_version
|
359
|
-
# The version number of the scaling plan.
|
382
|
+
# The version number of the scaling plan. Currently, the only valid
|
383
|
+
# value is `1`.
|
360
384
|
# @return [Integer]
|
361
385
|
#
|
362
386
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DeleteScalingPlanRequest AWS API Documentation
|
@@ -387,7 +411,8 @@ module Aws::AutoScalingPlans
|
|
387
411
|
# @return [String]
|
388
412
|
#
|
389
413
|
# @!attribute [rw] scaling_plan_version
|
390
|
-
# The version number of the scaling plan.
|
414
|
+
# The version number of the scaling plan. Currently, the only valid
|
415
|
+
# value is `1`.
|
391
416
|
# @return [Integer]
|
392
417
|
#
|
393
418
|
# @!attribute [rw] max_results
|
@@ -455,8 +480,13 @@ module Aws::AutoScalingPlans
|
|
455
480
|
# @return [Array<String>]
|
456
481
|
#
|
457
482
|
# @!attribute [rw] scaling_plan_version
|
458
|
-
# The version number of the scaling plan.
|
459
|
-
#
|
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>
|
460
490
|
# @return [Integer]
|
461
491
|
#
|
462
492
|
# @!attribute [rw] application_sources
|
@@ -522,42 +552,24 @@ module Aws::AutoScalingPlans
|
|
522
552
|
# @return [String]
|
523
553
|
#
|
524
554
|
# @!attribute [rw] scaling_plan_version
|
525
|
-
# The version number of the scaling plan.
|
555
|
+
# The version number of the scaling plan. Currently, the only valid
|
556
|
+
# value is `1`.
|
526
557
|
# @return [Integer]
|
527
558
|
#
|
528
559
|
# @!attribute [rw] service_namespace
|
529
|
-
# The namespace of the AWS service.
|
560
|
+
# The namespace of the AWS service. The only valid value is
|
561
|
+
# `autoscaling`.
|
530
562
|
# @return [String]
|
531
563
|
#
|
532
564
|
# @!attribute [rw] resource_id
|
533
|
-
# The ID of the resource. This string consists of
|
534
|
-
#
|
535
|
-
#
|
536
|
-
# * Auto Scaling group - The resource type is `autoScalingGroup` and
|
537
|
-
# the unique identifier is the name of the Auto Scaling group.
|
538
|
-
# Example: `autoScalingGroup/my-asg`.
|
539
|
-
#
|
540
|
-
# * ECS service - The resource type is `service` and the unique
|
541
|
-
# identifier is the cluster name and service name. Example:
|
542
|
-
# `service/default/sample-webapp`.
|
543
|
-
#
|
544
|
-
# * Spot Fleet request - The resource type is `spot-fleet-request` and
|
545
|
-
# the unique identifier is the Spot Fleet request ID. Example:
|
546
|
-
# `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
|
547
|
-
#
|
548
|
-
# * DynamoDB table - The resource type is `table` and the unique
|
549
|
-
# identifier is the resource ID. Example: `table/my-table`.
|
550
|
-
#
|
551
|
-
# * DynamoDB global secondary index - The resource type is `index` and
|
552
|
-
# the unique identifier is the resource ID. Example:
|
553
|
-
# `table/my-table/index/my-table-index`.
|
554
|
-
#
|
555
|
-
# * Aurora DB cluster - The resource type is `cluster` and the unique
|
556
|
-
# 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`.
|
557
568
|
# @return [String]
|
558
569
|
#
|
559
570
|
# @!attribute [rw] scalable_dimension
|
560
|
-
# The scalable dimension for the resource.
|
571
|
+
# The scalable dimension for the resource. The only valid value is
|
572
|
+
# `autoscaling:autoScalingGroup:DesiredCapacity`.
|
561
573
|
# @return [String]
|
562
574
|
#
|
563
575
|
# @!attribute [rw] forecast_data_type
|
@@ -705,6 +717,15 @@ module Aws::AutoScalingPlans
|
|
705
717
|
# Represents a predefined metric that can be used for predictive
|
706
718
|
# scaling.
|
707
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
|
+
#
|
708
729
|
# @note When making an API call, you may pass PredefinedLoadMetricSpecification
|
709
730
|
# data as a hash:
|
710
731
|
#
|
@@ -720,18 +741,32 @@ module Aws::AutoScalingPlans
|
|
720
741
|
# @!attribute [rw] resource_label
|
721
742
|
# Identifies the resource associated with the metric type. You can't
|
722
743
|
# specify a resource label unless the metric type is
|
723
|
-
# `
|
744
|
+
# `ALBTargetGroupRequestCount` and there is a target group for an
|
724
745
|
# Application Load Balancer attached to the Auto Scaling group.
|
725
746
|
#
|
726
|
-
#
|
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
|
727
750
|
# app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>,
|
728
751
|
# where:
|
729
752
|
#
|
730
753
|
# * app/<load-balancer-name>/<load-balancer-id> is the
|
731
|
-
# final portion of the load balancer ARN
|
754
|
+
# final portion of the load balancer ARN
|
732
755
|
#
|
733
756
|
# * targetgroup/<target-group-name>/<target-group-id> is
|
734
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
|
735
770
|
# @return [String]
|
736
771
|
#
|
737
772
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/PredefinedLoadMetricSpecification AWS API Documentation
|
@@ -766,15 +801,29 @@ module Aws::AutoScalingPlans
|
|
766
801
|
# Application Load Balancer attached to the Auto Scaling group, Spot
|
767
802
|
# Fleet request, or ECS service.
|
768
803
|
#
|
769
|
-
#
|
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
|
770
807
|
# app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>,
|
771
808
|
# where:
|
772
809
|
#
|
773
810
|
# * app/<load-balancer-name>/<load-balancer-id> is the
|
774
|
-
# final portion of the load balancer ARN
|
811
|
+
# final portion of the load balancer ARN
|
775
812
|
#
|
776
813
|
# * targetgroup/<target-group-name>/<target-group-id> is
|
777
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
|
778
827
|
# @return [String]
|
779
828
|
#
|
780
829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/PredefinedScalingMetricSpecification AWS API Documentation
|
@@ -786,12 +835,8 @@ module Aws::AutoScalingPlans
|
|
786
835
|
include Aws::Structure
|
787
836
|
end
|
788
837
|
|
789
|
-
# Describes a scaling instruction for a scalable resource
|
790
|
-
#
|
791
|
-
# The scaling instruction is used in combination with a scaling plan,
|
792
|
-
# which is a set of instructions for configuring dynamic scaling and
|
793
|
-
# predictive scaling for the scalable resources in your application.
|
794
|
-
# 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.
|
795
840
|
#
|
796
841
|
# AWS Auto Scaling creates target tracking scaling policies based on the
|
797
842
|
# scaling instructions. Target tracking scaling policies adjust the
|
@@ -810,13 +855,13 @@ module Aws::AutoScalingPlans
|
|
810
855
|
#
|
811
856
|
# We recommend waiting a minimum of 24 hours after creating an Auto
|
812
857
|
# Scaling group to configure predictive scaling. At minimum, there must
|
813
|
-
# 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*.
|
814
861
|
#
|
815
|
-
# For more information, see [Getting Started with AWS Auto Scaling][1].
|
816
862
|
#
|
817
863
|
#
|
818
|
-
#
|
819
|
-
# [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
|
820
865
|
#
|
821
866
|
# @note When making an API call, you may pass ScalingInstruction
|
822
867
|
# data as a hash:
|
@@ -947,17 +992,9 @@ module Aws::AutoScalingPlans
|
|
947
992
|
# @return [Integer]
|
948
993
|
#
|
949
994
|
# @!attribute [rw] target_tracking_configurations
|
950
|
-
# The
|
951
|
-
#
|
952
|
-
#
|
953
|
-
# with dynamic scaling.
|
954
|
-
#
|
955
|
-
# With predictive scaling and dynamic scaling, the resource scales
|
956
|
-
# based on the target tracking configuration that provides the largest
|
957
|
-
# capacity for both scale in and scale out.
|
958
|
-
#
|
959
|
-
# Condition: The scaling metric must be unique across target tracking
|
960
|
-
# 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.
|
961
998
|
# @return [Array<Types::TargetTrackingConfiguration>]
|
962
999
|
#
|
963
1000
|
# @!attribute [rw] predefined_load_metric_specification
|
@@ -1092,7 +1129,8 @@ module Aws::AutoScalingPlans
|
|
1092
1129
|
# @return [Integer]
|
1093
1130
|
#
|
1094
1131
|
# @!attribute [rw] application_source
|
1095
|
-
#
|
1132
|
+
# A CloudFormation stack or a set of tags. You can create one scaling
|
1133
|
+
# plan per application source.
|
1096
1134
|
# @return [Types::ApplicationSource]
|
1097
1135
|
#
|
1098
1136
|
# @!attribute [rw] scaling_instructions
|
@@ -1349,8 +1387,9 @@ module Aws::AutoScalingPlans
|
|
1349
1387
|
# @return [Types::CustomizedScalingMetricSpecification]
|
1350
1388
|
#
|
1351
1389
|
# @!attribute [rw] target_value
|
1352
|
-
# The target value for the metric.
|
1353
|
-
#
|
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.
|
1354
1393
|
# @return [Float]
|
1355
1394
|
#
|
1356
1395
|
# @!attribute [rw] disable_scale_in
|
@@ -1365,27 +1404,30 @@ module Aws::AutoScalingPlans
|
|
1365
1404
|
# @return [Boolean]
|
1366
1405
|
#
|
1367
1406
|
# @!attribute [rw] scale_out_cooldown
|
1368
|
-
# The amount of time, in seconds,
|
1369
|
-
#
|
1370
|
-
#
|
1371
|
-
#
|
1372
|
-
#
|
1373
|
-
#
|
1374
|
-
#
|
1375
|
-
#
|
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.
|
1376
1417
|
# @return [Integer]
|
1377
1418
|
#
|
1378
1419
|
# @!attribute [rw] scale_in_cooldown
|
1379
|
-
# The amount of time, in seconds, after a scale
|
1380
|
-
# before another scale
|
1381
|
-
# if the scalable resource is an Auto Scaling group.
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
#
|
1385
|
-
#
|
1386
|
-
# triggers a scale-out
|
1387
|
-
# scale-in,
|
1388
|
-
# 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.
|
1389
1431
|
# @return [Integer]
|
1390
1432
|
#
|
1391
1433
|
# @!attribute [rw] estimated_instance_warmup
|
@@ -1486,15 +1528,30 @@ module Aws::AutoScalingPlans
|
|
1486
1528
|
# @return [String]
|
1487
1529
|
#
|
1488
1530
|
# @!attribute [rw] scaling_plan_version
|
1489
|
-
# 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.
|
1490
1533
|
# @return [Integer]
|
1491
1534
|
#
|
1492
1535
|
# @!attribute [rw] application_source
|
1493
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
|
1494
1544
|
# @return [Types::ApplicationSource]
|
1495
1545
|
#
|
1496
1546
|
# @!attribute [rw] scaling_instructions
|
1497
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
|
1498
1555
|
# @return [Array<Types::ScalingInstruction>]
|
1499
1556
|
#
|
1500
1557
|
# @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/UpdateScalingPlanRequest AWS API Documentation
|
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.
|
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:
|
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
|