aws-sdk-autoscalingplans 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 505aa2da091ea523ece408a1949c6783d16865f0
4
- data.tar.gz: 78c37f02d8ae87838e751fb96ea2251751ae622b
3
+ metadata.gz: 5c5e38e99110ee12a515c9c33ce1239688582158
4
+ data.tar.gz: 55083f60a624a37d35b33e711dcfdb3c29b725d4
5
5
  SHA512:
6
- metadata.gz: 92482b926b043a365f2da3b5eff1ad97ae7a4ac88f0b2f032a19540cd5848b8e6bb90b3e7dad6c48b2e20e504f9651360a6820affdb6e0e4d1ed0dfef6f40395
7
- data.tar.gz: 72791373a6ef2b864a26e807a745dc8b2a3ebc1358ee5b0798db37040474ea04f74eee028afbba26a1bda5acc4d1feeb3b04eb5e53906591f6e9ba8d8c5f69f3
6
+ metadata.gz: 20e00a3184458e56b3b77e165b4ab2109538fef838e543237e62e5e10e547531231ff356239cf21d11f14990afa31dff6523dd29fa8d32d49ad0987eac8ce1ce
7
+ data.tar.gz: 520d35e5c847aadbd01feddd116f03fb0fadc7cfd46f6b769c6eecec84719ee71387644283cb5e6cd58415a798bcdd23847b4add3e3b4d80465a67c9e632efb1
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-autoscalingplans/customizations'
42
42
  # @service
43
43
  module Aws::AutoScalingPlans
44
44
 
45
- GEM_VERSION = '1.0.0'
45
+ GEM_VERSION = '1.1.0'
46
46
 
47
47
  end
@@ -155,11 +155,21 @@ module Aws::AutoScalingPlans
155
155
 
156
156
  # @!group API Operations
157
157
 
158
+ # Creates a scaling plan.
159
+ #
160
+ # A scaling plan contains a set of instructions used to configure
161
+ # dynamic scaling for the scalable resources in your application. AWS
162
+ # Auto Scaling creates target tracking scaling policies based on the
163
+ # scaling instructions in your scaling plan.
164
+ #
158
165
  # @option params [required, String] :scaling_plan_name
166
+ # The name of the scaling plan.
159
167
  #
160
168
  # @option params [required, Types::ApplicationSource] :application_source
169
+ # The source for the application.
161
170
  #
162
171
  # @option params [required, Array<Types::ScalingInstruction>] :scaling_instructions
172
+ # The scaling instructions.
163
173
  #
164
174
  # @return [Types::CreateScalingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
165
175
  #
@@ -221,9 +231,13 @@ module Aws::AutoScalingPlans
221
231
  req.send_request(options)
222
232
  end
223
233
 
234
+ # Deletes the specified scaling plan.
235
+ #
224
236
  # @option params [required, String] :scaling_plan_name
237
+ # The name of the scaling plan.
225
238
  #
226
239
  # @option params [required, Integer] :scaling_plan_version
240
+ # The version of the scaling plan.
227
241
  #
228
242
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
229
243
  #
@@ -243,13 +257,20 @@ module Aws::AutoScalingPlans
243
257
  req.send_request(options)
244
258
  end
245
259
 
260
+ # Describes the scalable resources in the specified scaling plan.
261
+ #
246
262
  # @option params [required, String] :scaling_plan_name
263
+ # The name of the scaling plan.
247
264
  #
248
265
  # @option params [required, Integer] :scaling_plan_version
266
+ # The version of the scaling plan.
249
267
  #
250
268
  # @option params [Integer] :max_results
269
+ # The maximum number of scalable resources to return. This value can be
270
+ # between 1 and 50. The default value is 50.
251
271
  #
252
272
  # @option params [String] :next_token
273
+ # The token for the next set of results.
253
274
  #
254
275
  # @return [Types::DescribeScalingPlanResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
255
276
  #
@@ -303,15 +324,26 @@ module Aws::AutoScalingPlans
303
324
  req.send_request(options)
304
325
  end
305
326
 
327
+ # Describes the specified scaling plans or all of your scaling plans.
328
+ #
306
329
  # @option params [Array<String>] :scaling_plan_names
330
+ # The names of the scaling plans (up to 10). If you specify application
331
+ # sources, you cannot specify scaling plan names.
307
332
  #
308
333
  # @option params [Integer] :scaling_plan_version
334
+ # The version of the scaling plan. If you specify a scaling plan
335
+ # version, you must also specify a scaling plan name.
309
336
  #
310
337
  # @option params [Array<Types::ApplicationSource>] :application_sources
338
+ # The sources for the applications (up to 10). If you specify scaling
339
+ # plan names, you cannot specify application sources.
311
340
  #
312
341
  # @option params [Integer] :max_results
342
+ # The maximum number of scalable resources to return. This value can be
343
+ # between 1 and 50. The default value is 50.
313
344
  #
314
345
  # @option params [String] :next_token
346
+ # The token for the next set of results.
315
347
  #
316
348
  # @return [Types::DescribeScalingPlansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
317
349
  #
@@ -386,7 +418,7 @@ module Aws::AutoScalingPlans
386
418
  params: params,
387
419
  config: config)
388
420
  context[:gem_name] = 'aws-sdk-autoscalingplans'
389
- context[:gem_version] = '1.0.0'
421
+ context[:gem_version] = '1.1.0'
390
422
  Seahorse::Client::Request.new(handlers, context)
391
423
  end
392
424
 
@@ -8,6 +8,8 @@
8
8
  module Aws::AutoScalingPlans
9
9
  module Types
10
10
 
11
+ # Represents an application source.
12
+ #
11
13
  # @note When making an API call, you may pass ApplicationSource
12
14
  # data as a hash:
13
15
  #
@@ -16,6 +18,7 @@ module Aws::AutoScalingPlans
16
18
  # }
17
19
  #
18
20
  # @!attribute [rw] cloud_formation_stack_arn
21
+ # The Amazon Resource Name (ARN) of a CloudFormation stack.
19
22
  # @return [String]
20
23
  #
21
24
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ApplicationSource AWS API Documentation
@@ -70,12 +73,15 @@ module Aws::AutoScalingPlans
70
73
  # }
71
74
  #
72
75
  # @!attribute [rw] scaling_plan_name
76
+ # The name of the scaling plan.
73
77
  # @return [String]
74
78
  #
75
79
  # @!attribute [rw] application_source
80
+ # The source for the application.
76
81
  # @return [Types::ApplicationSource]
77
82
  #
78
83
  # @!attribute [rw] scaling_instructions
84
+ # The scaling instructions.
79
85
  # @return [Array<Types::ScalingInstruction>]
80
86
  #
81
87
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlanRequest AWS API Documentation
@@ -88,6 +94,7 @@ module Aws::AutoScalingPlans
88
94
  end
89
95
 
90
96
  # @!attribute [rw] scaling_plan_version
97
+ # The version of the scaling plan. This value is always 1.
91
98
  # @return [Integer]
92
99
  #
93
100
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CreateScalingPlanResponse AWS API Documentation
@@ -97,6 +104,8 @@ module Aws::AutoScalingPlans
97
104
  include Aws::Structure
98
105
  end
99
106
 
107
+ # Represents a customized metric for a target tracking policy.
108
+ #
100
109
  # @note When making an API call, you may pass CustomizedScalingMetricSpecification
101
110
  # data as a hash:
102
111
  #
@@ -114,18 +123,23 @@ module Aws::AutoScalingPlans
114
123
  # }
115
124
  #
116
125
  # @!attribute [rw] metric_name
126
+ # The name of the metric.
117
127
  # @return [String]
118
128
  #
119
129
  # @!attribute [rw] namespace
130
+ # The namespace of the metric.
120
131
  # @return [String]
121
132
  #
122
133
  # @!attribute [rw] dimensions
134
+ # The dimensions of the metric.
123
135
  # @return [Array<Types::MetricDimension>]
124
136
  #
125
137
  # @!attribute [rw] statistic
138
+ # The statistic of the metric.
126
139
  # @return [String]
127
140
  #
128
141
  # @!attribute [rw] unit
142
+ # The unit of the metric.
129
143
  # @return [String]
130
144
  #
131
145
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/CustomizedScalingMetricSpecification AWS API Documentation
@@ -148,9 +162,11 @@ module Aws::AutoScalingPlans
148
162
  # }
149
163
  #
150
164
  # @!attribute [rw] scaling_plan_name
165
+ # The name of the scaling plan.
151
166
  # @return [String]
152
167
  #
153
168
  # @!attribute [rw] scaling_plan_version
169
+ # The version of the scaling plan.
154
170
  # @return [Integer]
155
171
  #
156
172
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DeleteScalingPlanRequest AWS API Documentation
@@ -176,15 +192,20 @@ module Aws::AutoScalingPlans
176
192
  # }
177
193
  #
178
194
  # @!attribute [rw] scaling_plan_name
195
+ # The name of the scaling plan.
179
196
  # @return [String]
180
197
  #
181
198
  # @!attribute [rw] scaling_plan_version
199
+ # The version of the scaling plan.
182
200
  # @return [Integer]
183
201
  #
184
202
  # @!attribute [rw] max_results
203
+ # The maximum number of scalable resources to return. This value can
204
+ # be between 1 and 50. The default value is 50.
185
205
  # @return [Integer]
186
206
  #
187
207
  # @!attribute [rw] next_token
208
+ # The token for the next set of results.
188
209
  # @return [String]
189
210
  #
190
211
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlanResourcesRequest AWS API Documentation
@@ -198,9 +219,12 @@ module Aws::AutoScalingPlans
198
219
  end
199
220
 
200
221
  # @!attribute [rw] scaling_plan_resources
222
+ # Information about the scalable resources.
201
223
  # @return [Array<Types::ScalingPlanResource>]
202
224
  #
203
225
  # @!attribute [rw] next_token
226
+ # The token required to get the next set of results. This value is
227
+ # `null` if there are no more results to return.
204
228
  # @return [String]
205
229
  #
206
230
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlanResourcesResponse AWS API Documentation
@@ -227,18 +251,27 @@ module Aws::AutoScalingPlans
227
251
  # }
228
252
  #
229
253
  # @!attribute [rw] scaling_plan_names
254
+ # The names of the scaling plans (up to 10). If you specify
255
+ # application sources, you cannot specify scaling plan names.
230
256
  # @return [Array<String>]
231
257
  #
232
258
  # @!attribute [rw] scaling_plan_version
259
+ # The version of the scaling plan. If you specify a scaling plan
260
+ # version, you must also specify a scaling plan name.
233
261
  # @return [Integer]
234
262
  #
235
263
  # @!attribute [rw] application_sources
264
+ # The sources for the applications (up to 10). If you specify scaling
265
+ # plan names, you cannot specify application sources.
236
266
  # @return [Array<Types::ApplicationSource>]
237
267
  #
238
268
  # @!attribute [rw] max_results
269
+ # The maximum number of scalable resources to return. This value can
270
+ # be between 1 and 50. The default value is 50.
239
271
  # @return [Integer]
240
272
  #
241
273
  # @!attribute [rw] next_token
274
+ # The token for the next set of results.
242
275
  # @return [String]
243
276
  #
244
277
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlansRequest AWS API Documentation
@@ -253,9 +286,12 @@ module Aws::AutoScalingPlans
253
286
  end
254
287
 
255
288
  # @!attribute [rw] scaling_plans
289
+ # Information about the scaling plans.
256
290
  # @return [Array<Types::ScalingPlan>]
257
291
  #
258
292
  # @!attribute [rw] next_token
293
+ # The token required to get the next set of results. This value is
294
+ # `null` if there are no more results to return.
259
295
  # @return [String]
260
296
  #
261
297
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/DescribeScalingPlansResponse AWS API Documentation
@@ -266,6 +302,8 @@ module Aws::AutoScalingPlans
266
302
  include Aws::Structure
267
303
  end
268
304
 
305
+ # Represents a dimension for a customized metric.
306
+ #
269
307
  # @note When making an API call, you may pass MetricDimension
270
308
  # data as a hash:
271
309
  #
@@ -275,9 +313,11 @@ module Aws::AutoScalingPlans
275
313
  # }
276
314
  #
277
315
  # @!attribute [rw] name
316
+ # The name of the dimension.
278
317
  # @return [String]
279
318
  #
280
319
  # @!attribute [rw] value
320
+ # The value of the dimension.
281
321
  # @return [String]
282
322
  #
283
323
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/MetricDimension AWS API Documentation
@@ -288,6 +328,8 @@ module Aws::AutoScalingPlans
288
328
  include Aws::Structure
289
329
  end
290
330
 
331
+ # Represents a predefined metric for a target tracking policy.
332
+ #
291
333
  # @note When making an API call, you may pass PredefinedScalingMetricSpecification
292
334
  # data as a hash:
293
335
  #
@@ -297,9 +339,25 @@ module Aws::AutoScalingPlans
297
339
  # }
298
340
  #
299
341
  # @!attribute [rw] predefined_scaling_metric_type
342
+ # The metric type. The `ALBRequestCountPerTarget` metric type applies
343
+ # only to Auto Scaling groups, Sport Fleet requests, and ECS services.
300
344
  # @return [String]
301
345
  #
302
346
  # @!attribute [rw] resource_label
347
+ # Identifies the resource associated with the metric type. You can't
348
+ # specify a resource label unless the metric type is
349
+ # `ALBRequestCountPerTarget` and there is a target group attached to
350
+ # the Auto Scaling group, Spot Fleet request, or ECS service.
351
+ #
352
+ # The format is
353
+ # app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;,
354
+ # where:
355
+ #
356
+ # * app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the
357
+ # final portion of the load balancer ARN
358
+ #
359
+ # * targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is
360
+ # the final portion of the target group ARN.
303
361
  # @return [String]
304
362
  #
305
363
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/PredefinedScalingMetricSpecification AWS API Documentation
@@ -310,6 +368,8 @@ module Aws::AutoScalingPlans
310
368
  include Aws::Structure
311
369
  end
312
370
 
371
+ # Specifies the scaling configuration for a scalable resource.
372
+ #
313
373
  # @note When making an API call, you may pass ScalingInstruction
314
374
  # data as a hash:
315
375
  #
@@ -347,21 +407,75 @@ module Aws::AutoScalingPlans
347
407
  # }
348
408
  #
349
409
  # @!attribute [rw] service_namespace
410
+ # The namespace of the AWS service.
350
411
  # @return [String]
351
412
  #
352
413
  # @!attribute [rw] resource_id
414
+ # The ID of the resource. This string consists of the resource type
415
+ # and unique identifier.
416
+ #
417
+ # * Auto Scaling group - The resource type is `autoScalingGroup` and
418
+ # the unique identifier is the name of the Auto Scaling group.
419
+ # Example: `autoScalingGroup/my-asg`.
420
+ #
421
+ # * ECS service - The resource type is `service` and the unique
422
+ # identifier is the cluster name and service name. Example:
423
+ # `service/default/sample-webapp`.
424
+ #
425
+ # * Spot fleet request - The resource type is `spot-fleet-request` and
426
+ # the unique identifier is the Spot fleet request ID. Example:
427
+ # `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
428
+ #
429
+ # * DynamoDB table - The resource type is `table` and the unique
430
+ # identifier is the resource ID. Example: `table/my-table`.
431
+ #
432
+ # * DynamoDB global secondary index - The resource type is `index` and
433
+ # the unique identifier is the resource ID. Example:
434
+ # `table/my-table/index/my-table-index`.
435
+ #
436
+ # * Aurora DB cluster - The resource type is `cluster` and the unique
437
+ # identifier is the cluster name. Example: `cluster:my-db-cluster`.
353
438
  # @return [String]
354
439
  #
355
440
  # @!attribute [rw] scalable_dimension
441
+ # The scalable dimension associated with the resource.
442
+ #
443
+ # * `autoscaling:autoScalingGroup:DesiredCapacity` - The desired
444
+ # capacity of an Auto Scaling group.
445
+ #
446
+ # * `ecs:service:DesiredCount` - The desired task count of an ECS
447
+ # service.
448
+ #
449
+ # * `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a
450
+ # Spot fleet request.
451
+ #
452
+ # * `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity
453
+ # for a DynamoDB table.
454
+ #
455
+ # * `dynamodb:table:WriteCapacityUnits` - The provisioned write
456
+ # capacity for a DynamoDB table.
457
+ #
458
+ # * `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity
459
+ # for a DynamoDB global secondary index.
460
+ #
461
+ # * `dynamodb:index:WriteCapacityUnits` - The provisioned write
462
+ # capacity for a DynamoDB global secondary index.
463
+ #
464
+ # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in
465
+ # an Aurora DB cluster. Available for Aurora MySQL-compatible
466
+ # edition.
356
467
  # @return [String]
357
468
  #
358
469
  # @!attribute [rw] min_capacity
470
+ # The minimum value to scale to in response to a scale in event.
359
471
  # @return [Integer]
360
472
  #
361
473
  # @!attribute [rw] max_capacity
474
+ # The maximum value to scale to in response to a scale out event.
362
475
  # @return [Integer]
363
476
  #
364
477
  # @!attribute [rw] target_tracking_configurations
478
+ # The target tracking scaling policies (up to 10).
365
479
  # @return [Array<Types::TargetTrackingConfiguration>]
366
480
  #
367
481
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingInstruction AWS API Documentation
@@ -376,25 +490,47 @@ module Aws::AutoScalingPlans
376
490
  include Aws::Structure
377
491
  end
378
492
 
493
+ # Represents a scaling plan.
494
+ #
379
495
  # @!attribute [rw] scaling_plan_name
496
+ # The name of the scaling plan.
380
497
  # @return [String]
381
498
  #
382
499
  # @!attribute [rw] scaling_plan_version
500
+ # The version of the scaling plan.
383
501
  # @return [Integer]
384
502
  #
385
503
  # @!attribute [rw] application_source
504
+ # The application source.
386
505
  # @return [Types::ApplicationSource]
387
506
  #
388
507
  # @!attribute [rw] scaling_instructions
508
+ # The scaling instructions.
389
509
  # @return [Array<Types::ScalingInstruction>]
390
510
  #
391
511
  # @!attribute [rw] status_code
512
+ # The status of the scaling plan.
513
+ #
514
+ # * `Active` - The scaling plan is active.
515
+ #
516
+ # * `ActiveWithProblems` - The scaling plan is active, but the scaling
517
+ # configuration for one or more resources could not be applied.
518
+ #
519
+ # * `CreationInProgress` - The scaling plan is being created.
520
+ #
521
+ # * `CreationFailed` - The scaling plan could not be created.
522
+ #
523
+ # * `DeletionInProgress` - The scaling plan is being deleted.
524
+ #
525
+ # * `DeletionFailed` - The scaling plan could not be deleted.
392
526
  # @return [String]
393
527
  #
394
528
  # @!attribute [rw] status_message
529
+ # A simple message about the current status of the scaling plan.
395
530
  # @return [String]
396
531
  #
397
532
  # @!attribute [rw] creation_time
533
+ # The Unix timestamp when the scaling plan was created.
398
534
  # @return [Time]
399
535
  #
400
536
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingPlan AWS API Documentation
@@ -410,28 +546,97 @@ module Aws::AutoScalingPlans
410
546
  include Aws::Structure
411
547
  end
412
548
 
549
+ # Represents a scalable resource.
550
+ #
413
551
  # @!attribute [rw] scaling_plan_name
552
+ # The name of the scaling plan.
414
553
  # @return [String]
415
554
  #
416
555
  # @!attribute [rw] scaling_plan_version
556
+ # The version of the scaling plan.
417
557
  # @return [Integer]
418
558
  #
419
559
  # @!attribute [rw] service_namespace
560
+ # The namespace of the AWS service.
420
561
  # @return [String]
421
562
  #
422
563
  # @!attribute [rw] resource_id
564
+ # The ID of the resource. This string consists of the resource type
565
+ # and unique identifier.
566
+ #
567
+ # * Auto Scaling group - The resource type is `autoScalingGroup` and
568
+ # the unique identifier is the name of the Auto Scaling group.
569
+ # Example: `autoScalingGroup/my-asg`.
570
+ #
571
+ # * ECS service - The resource type is `service` and the unique
572
+ # identifier is the cluster name and service name. Example:
573
+ # `service/default/sample-webapp`.
574
+ #
575
+ # * Spot fleet request - The resource type is `spot-fleet-request` and
576
+ # the unique identifier is the Spot fleet request ID. Example:
577
+ # `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
578
+ #
579
+ # * DynamoDB table - The resource type is `table` and the unique
580
+ # identifier is the resource ID. Example: `table/my-table`.
581
+ #
582
+ # * DynamoDB global secondary index - The resource type is `index` and
583
+ # the unique identifier is the resource ID. Example:
584
+ # `table/my-table/index/my-table-index`.
585
+ #
586
+ # * Aurora DB cluster - The resource type is `cluster` and the unique
587
+ # identifier is the cluster name. Example: `cluster:my-db-cluster`.
423
588
  # @return [String]
424
589
  #
425
590
  # @!attribute [rw] scalable_dimension
591
+ # The scalable dimension for the resource.
592
+ #
593
+ # * `autoscaling:autoScalingGroup:DesiredCapacity` - The desired
594
+ # capacity of an Auto Scaling group.
595
+ #
596
+ # * `ecs:service:DesiredCount` - The desired task count of an ECS
597
+ # service.
598
+ #
599
+ # * `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a
600
+ # Spot fleet request.
601
+ #
602
+ # * `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity
603
+ # for a DynamoDB table.
604
+ #
605
+ # * `dynamodb:table:WriteCapacityUnits` - The provisioned write
606
+ # capacity for a DynamoDB table.
607
+ #
608
+ # * `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity
609
+ # for a DynamoDB global secondary index.
610
+ #
611
+ # * `dynamodb:index:WriteCapacityUnits` - The provisioned write
612
+ # capacity for a DynamoDB global secondary index.
613
+ #
614
+ # * `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in
615
+ # an Aurora DB cluster. Available for Aurora MySQL-compatible
616
+ # edition.
426
617
  # @return [String]
427
618
  #
428
619
  # @!attribute [rw] scaling_policies
620
+ # The scaling policies.
429
621
  # @return [Array<Types::ScalingPolicy>]
430
622
  #
431
623
  # @!attribute [rw] scaling_status_code
624
+ # The scaling status of the resource.
625
+ #
626
+ # * `Active` - The scaling configuration is active.
627
+ #
628
+ # * `Inactive` - The scaling configuration is not active because the
629
+ # scaling plan is being created or the scaling configuration could
630
+ # not be applied. Check the status message for more information.
631
+ #
632
+ # * `PartiallyActive` - The scaling configuration is partially active
633
+ # because the scaling plan is being created or deleted or the
634
+ # scaling configuration could not be fully applied. Check the status
635
+ # message for more information.
432
636
  # @return [String]
433
637
  #
434
638
  # @!attribute [rw] scaling_status_message
639
+ # A simple message about the current scaling status of the resource.
435
640
  # @return [String]
436
641
  #
437
642
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingPlanResource AWS API Documentation
@@ -448,13 +653,18 @@ module Aws::AutoScalingPlans
448
653
  include Aws::Structure
449
654
  end
450
655
 
656
+ # Represents a scaling policy.
657
+ #
451
658
  # @!attribute [rw] policy_name
659
+ # The name of the scaling policy.
452
660
  # @return [String]
453
661
  #
454
662
  # @!attribute [rw] policy_type
663
+ # The type of scaling policy.
455
664
  # @return [String]
456
665
  #
457
666
  # @!attribute [rw] target_tracking_configuration
667
+ # The target tracking scaling policy.
458
668
  # @return [Types::TargetTrackingConfiguration]
459
669
  #
460
670
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/ScalingPolicy AWS API Documentation
@@ -466,6 +676,8 @@ module Aws::AutoScalingPlans
466
676
  include Aws::Structure
467
677
  end
468
678
 
679
+ # Represents a target tracking scaling policy.
680
+ #
469
681
  # @note When making an API call, you may pass TargetTrackingConfiguration
470
682
  # data as a hash:
471
683
  #
@@ -494,24 +706,55 @@ module Aws::AutoScalingPlans
494
706
  # }
495
707
  #
496
708
  # @!attribute [rw] predefined_scaling_metric_specification
709
+ # A predefined metric.
497
710
  # @return [Types::PredefinedScalingMetricSpecification]
498
711
  #
499
712
  # @!attribute [rw] customized_scaling_metric_specification
713
+ # A customized metric.
500
714
  # @return [Types::CustomizedScalingMetricSpecification]
501
715
  #
502
716
  # @!attribute [rw] target_value
717
+ # The target value for the metric. The range is 8.515920e-109 to
718
+ # 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
503
719
  # @return [Float]
504
720
  #
505
721
  # @!attribute [rw] disable_scale_in
722
+ # Indicates whether scale in by the target tracking policy is
723
+ # disabled. If the value is `true`, scale in is disabled and the
724
+ # target tracking policy won't remove capacity from the scalable
725
+ # resource. Otherwise, scale in is enabled and the target tracking
726
+ # policy can remove capacity from the scalable resource. The default
727
+ # value is `false`.
506
728
  # @return [Boolean]
507
729
  #
508
730
  # @!attribute [rw] scale_out_cooldown
731
+ # The amount of time, in seconds, after a scale out activity completes
732
+ # before another scale out activity can start. This value is not used
733
+ # if the scalable resource is an Auto Scaling group.
734
+ #
735
+ # While the cooldown period is in effect, the capacity that has been
736
+ # added by the previous scale out event that initiated the cooldown is
737
+ # calculated as part of the desired capacity for the next scale out.
738
+ # The intention is to continuously (but not excessively) scale out.
509
739
  # @return [Integer]
510
740
  #
511
741
  # @!attribute [rw] scale_in_cooldown
742
+ # The amount of time, in seconds, after a scale in activity completes
743
+ # before another scale in activity can start. This value is not used
744
+ # if the scalable resource is an Auto Scaling group.
745
+ #
746
+ # The cooldown period is used to block subsequent scale in requests
747
+ # until it has expired. The intention is to scale in conservatively to
748
+ # protect your application's availability. However, if another alarm
749
+ # triggers a scale out policy during the cooldown period after a
750
+ # scale-in, AWS Auto Scaling scales out your scalable target
751
+ # immediately.
512
752
  # @return [Integer]
513
753
  #
514
754
  # @!attribute [rw] estimated_instance_warmup
755
+ # The estimated time, in seconds, until a newly launched instance can
756
+ # contribute to the CloudWatch metrics. This value is used only if the
757
+ # resource is an Auto Scaling group.
515
758
  # @return [Integer]
516
759
  #
517
760
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans-2018-01-06/TargetTrackingConfiguration AWS API Documentation
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-autoscalingplans
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services