@aws-sdk/client-auto-scaling 3.379.1 → 3.382.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.
Files changed (9) hide show
  1. package/dist-cjs/endpoint/ruleset.js +1 -1
  2. package/dist-cjs/protocols/Aws_query.js +53 -0
  3. package/dist-es/endpoint/ruleset.js +1 -1
  4. package/dist-es/protocols/Aws_query.js +53 -0
  5. package/dist-types/commands/DescribeInstanceRefreshesCommand.d.ts +5 -0
  6. package/dist-types/commands/StartInstanceRefreshCommand.d.ts +5 -0
  7. package/dist-types/models/models_0.d.ts +668 -3
  8. package/dist-types/ts3.4/models/models_0.d.ts +4 -0
  9. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -7,10 +7,12 @@ import { AutoScalingServiceException as __BaseException } from "./AutoScalingSer
7
7
  */
8
8
  export interface AcceleratorCountRequest {
9
9
  /**
10
+ * @public
10
11
  * <p>The minimum value.</p>
11
12
  */
12
13
  Min?: number;
13
14
  /**
15
+ * @public
14
16
  * <p>The maximum value.</p>
15
17
  */
16
18
  Max?: number;
@@ -53,10 +55,12 @@ export type AcceleratorName = (typeof AcceleratorName)[keyof typeof AcceleratorN
53
55
  */
54
56
  export interface AcceleratorTotalMemoryMiBRequest {
55
57
  /**
58
+ * @public
56
59
  * <p>The memory minimum in MiB.</p>
57
60
  */
58
61
  Min?: number;
59
62
  /**
63
+ * @public
60
64
  * <p>The memory maximum in MiB.</p>
61
65
  */
62
66
  Max?: number;
@@ -117,51 +121,63 @@ export type ScalingActivityStatusCode = (typeof ScalingActivityStatusCode)[keyof
117
121
  */
118
122
  export interface Activity {
119
123
  /**
124
+ * @public
120
125
  * <p>The ID of the activity.</p>
121
126
  */
122
127
  ActivityId: string | undefined;
123
128
  /**
129
+ * @public
124
130
  * <p>The name of the Auto Scaling group.</p>
125
131
  */
126
132
  AutoScalingGroupName: string | undefined;
127
133
  /**
134
+ * @public
128
135
  * <p>A friendly, more verbose description of the activity.</p>
129
136
  */
130
137
  Description?: string;
131
138
  /**
139
+ * @public
132
140
  * <p>The reason the activity began.</p>
133
141
  */
134
142
  Cause: string | undefined;
135
143
  /**
144
+ * @public
136
145
  * <p>The start time of the activity.</p>
137
146
  */
138
147
  StartTime: Date | undefined;
139
148
  /**
149
+ * @public
140
150
  * <p>The end time of the activity.</p>
141
151
  */
142
152
  EndTime?: Date;
143
153
  /**
154
+ * @public
144
155
  * <p>The current status of the activity.</p>
145
156
  */
146
157
  StatusCode: ScalingActivityStatusCode | string | undefined;
147
158
  /**
159
+ * @public
148
160
  * <p>A friendly, more verbose description of the activity status.</p>
149
161
  */
150
162
  StatusMessage?: string;
151
163
  /**
164
+ * @public
152
165
  * <p>A value between 0 and 100 that indicates the progress of the activity.</p>
153
166
  */
154
167
  Progress?: number;
155
168
  /**
169
+ * @public
156
170
  * <p>The details about the activity.</p>
157
171
  */
158
172
  Details?: string;
159
173
  /**
174
+ * @public
160
175
  * <p>The state of the Auto Scaling group, which is either <code>InService</code> or
161
176
  * <code>Deleted</code>.</p>
162
177
  */
163
178
  AutoScalingGroupState?: string;
164
179
  /**
180
+ * @public
165
181
  * <p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>
166
182
  */
167
183
  AutoScalingGroupARN?: string;
@@ -171,11 +187,13 @@ export interface Activity {
171
187
  */
172
188
  export interface ActivitiesType {
173
189
  /**
190
+ * @public
174
191
  * <p>The scaling activities. Activities are sorted by start time. Activities still in
175
192
  * progress are described first.</p>
176
193
  */
177
194
  Activities: Activity[] | undefined;
178
195
  /**
196
+ * @public
179
197
  * <p>A string that indicates that the response contains more items than can be returned in
180
198
  * a single response. To receive additional items, specify this string for the
181
199
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -188,6 +206,7 @@ export interface ActivitiesType {
188
206
  */
189
207
  export interface ActivityType {
190
208
  /**
209
+ * @public
191
210
  * <p>A scaling activity.</p>
192
211
  */
193
212
  Activity?: Activity;
@@ -198,6 +217,7 @@ export interface ActivityType {
198
217
  */
199
218
  export interface AdjustmentType {
200
219
  /**
220
+ * @public
201
221
  * <p>The policy adjustment type. The valid values are <code>ChangeInCapacity</code>,
202
222
  * <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
203
223
  */
@@ -209,14 +229,27 @@ export interface AdjustmentType {
209
229
  */
210
230
  export interface Alarm {
211
231
  /**
232
+ * @public
212
233
  * <p>The name of the alarm.</p>
213
234
  */
214
235
  AlarmName?: string;
215
236
  /**
237
+ * @public
216
238
  * <p>The Amazon Resource Name (ARN) of the alarm.</p>
217
239
  */
218
240
  AlarmARN?: string;
219
241
  }
242
+ /**
243
+ * @public
244
+ * <p>Specifies the CloudWatch alarm specification to use in an instance refresh.</p>
245
+ */
246
+ export interface AlarmSpecification {
247
+ /**
248
+ * @public
249
+ * <p>The names of one or more CloudWatch alarms to monitor for the instance refresh.</p>
250
+ */
251
+ Alarms?: string[];
252
+ }
220
253
  /**
221
254
  * @public
222
255
  * <p>You already have an Auto Scaling group or launch configuration with this name.</p>
@@ -234,10 +267,12 @@ export declare class AlreadyExistsFault extends __BaseException {
234
267
  */
235
268
  export interface AttachInstancesQuery {
236
269
  /**
270
+ * @public
237
271
  * <p>The IDs of the instances. You can specify up to 20 instances.</p>
238
272
  */
239
273
  InstanceIds?: string[];
240
274
  /**
275
+ * @public
241
276
  * <p>The name of the Auto Scaling group.</p>
242
277
  */
243
278
  AutoScalingGroupName: string | undefined;
@@ -277,10 +312,12 @@ export interface AttachLoadBalancersResultType {
277
312
  */
278
313
  export interface AttachLoadBalancersType {
279
314
  /**
315
+ * @public
280
316
  * <p>The name of the Auto Scaling group.</p>
281
317
  */
282
318
  AutoScalingGroupName: string | undefined;
283
319
  /**
320
+ * @public
284
321
  * <p>The names of the load balancers. You can specify up to 10 load balancers.</p>
285
322
  */
286
323
  LoadBalancerNames: string[] | undefined;
@@ -295,10 +332,12 @@ export interface AttachLoadBalancerTargetGroupsResultType {
295
332
  */
296
333
  export interface AttachLoadBalancerTargetGroupsType {
297
334
  /**
335
+ * @public
298
336
  * <p>The name of the Auto Scaling group.</p>
299
337
  */
300
338
  AutoScalingGroupName: string | undefined;
301
339
  /**
340
+ * @public
302
341
  * <p>The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target
303
342
  * groups. To get the ARN of a target group, use the Elastic Load Balancing <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a> API operation.</p>
304
343
  */
@@ -315,6 +354,7 @@ export interface AttachTrafficSourcesResultType {
315
354
  */
316
355
  export interface TrafficSourceIdentifier {
317
356
  /**
357
+ * @public
318
358
  * <p>Identifies the traffic source.</p>
319
359
  * <p>For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name
320
360
  * (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name
@@ -342,6 +382,7 @@ export interface TrafficSourceIdentifier {
342
382
  */
343
383
  Identifier: string | undefined;
344
384
  /**
385
+ * @public
345
386
  * <p>Provides additional context for the value of <code>Identifier</code>.</p>
346
387
  * <p>The following lists the valid values:</p>
347
388
  * <ul>
@@ -369,10 +410,12 @@ export interface TrafficSourceIdentifier {
369
410
  */
370
411
  export interface AttachTrafficSourcesType {
371
412
  /**
413
+ * @public
372
414
  * <p>The name of the Auto Scaling group.</p>
373
415
  */
374
416
  AutoScalingGroupName: string | undefined;
375
417
  /**
418
+ * @public
376
419
  * <p>The unique identifiers of one or more traffic sources. You can specify up to 10
377
420
  * traffic sources.</p>
378
421
  */
@@ -384,14 +427,17 @@ export interface AttachTrafficSourcesType {
384
427
  */
385
428
  export interface FailedScheduledUpdateGroupActionRequest {
386
429
  /**
430
+ * @public
387
431
  * <p>The name of the scheduled action.</p>
388
432
  */
389
433
  ScheduledActionName: string | undefined;
390
434
  /**
435
+ * @public
391
436
  * <p>The error code.</p>
392
437
  */
393
438
  ErrorCode?: string;
394
439
  /**
440
+ * @public
395
441
  * <p>The error message accompanying the error code.</p>
396
442
  */
397
443
  ErrorMessage?: string;
@@ -401,6 +447,7 @@ export interface FailedScheduledUpdateGroupActionRequest {
401
447
  */
402
448
  export interface BatchDeleteScheduledActionAnswer {
403
449
  /**
450
+ * @public
404
451
  * <p>The names of the scheduled actions that could not be deleted, including an error
405
452
  * message.</p>
406
453
  */
@@ -411,10 +458,12 @@ export interface BatchDeleteScheduledActionAnswer {
411
458
  */
412
459
  export interface BatchDeleteScheduledActionType {
413
460
  /**
461
+ * @public
414
462
  * <p>The name of the Auto Scaling group.</p>
415
463
  */
416
464
  AutoScalingGroupName: string | undefined;
417
465
  /**
466
+ * @public
418
467
  * <p>The names of the scheduled actions to delete. The maximum number allowed is 50.
419
468
  * </p>
420
469
  */
@@ -425,6 +474,7 @@ export interface BatchDeleteScheduledActionType {
425
474
  */
426
475
  export interface BatchPutScheduledUpdateGroupActionAnswer {
427
476
  /**
477
+ * @public
428
478
  * <p>The names of the scheduled actions that could not be created or updated, including an
429
479
  * error message.</p>
430
480
  */
@@ -436,10 +486,12 @@ export interface BatchPutScheduledUpdateGroupActionAnswer {
436
486
  */
437
487
  export interface ScheduledUpdateGroupActionRequest {
438
488
  /**
489
+ * @public
439
490
  * <p>The name of the scaling action.</p>
440
491
  */
441
492
  ScheduledActionName: string | undefined;
442
493
  /**
494
+ * @public
443
495
  * <p>The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT
444
496
  * only and in quotes (for example, <code>"2019-06-01T00:00:00Z"</code>).</p>
445
497
  * <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs
@@ -450,10 +502,12 @@ export interface ScheduledUpdateGroupActionRequest {
450
502
  */
451
503
  StartTime?: Date;
452
504
  /**
505
+ * @public
453
506
  * <p>The date and time for the recurring schedule to end, in UTC.</p>
454
507
  */
455
508
  EndTime?: Date;
456
509
  /**
510
+ * @public
457
511
  * <p>The recurring schedule for the action, in Unix cron syntax format. This format
458
512
  * consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]
459
513
  * [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>"30 0 1
@@ -465,19 +519,23 @@ export interface ScheduledUpdateGroupActionRequest {
465
519
  */
466
520
  Recurrence?: string;
467
521
  /**
522
+ * @public
468
523
  * <p>The minimum size of the Auto Scaling group.</p>
469
524
  */
470
525
  MinSize?: number;
471
526
  /**
527
+ * @public
472
528
  * <p>The maximum size of the Auto Scaling group.</p>
473
529
  */
474
530
  MaxSize?: number;
475
531
  /**
532
+ * @public
476
533
  * <p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled
477
534
  * action runs and the capacity it attempts to maintain.</p>
478
535
  */
479
536
  DesiredCapacity?: number;
480
537
  /**
538
+ * @public
481
539
  * <p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is
482
540
  * used by default. </p>
483
541
  * <p>Valid values are the canonical names of the IANA time zones, derived from the IANA
@@ -491,10 +549,12 @@ export interface ScheduledUpdateGroupActionRequest {
491
549
  */
492
550
  export interface BatchPutScheduledUpdateGroupActionType {
493
551
  /**
552
+ * @public
494
553
  * <p>The name of the Auto Scaling group.</p>
495
554
  */
496
555
  AutoScalingGroupName: string | undefined;
497
556
  /**
557
+ * @public
498
558
  * <p>One or more scheduled actions. The maximum number allowed is 50.</p>
499
559
  */
500
560
  ScheduledUpdateGroupActions: ScheduledUpdateGroupActionRequest[] | undefined;
@@ -519,6 +579,7 @@ export declare class LimitExceededFault extends __BaseException {
519
579
  */
520
580
  export interface CancelInstanceRefreshAnswer {
521
581
  /**
582
+ * @public
522
583
  * <p>The instance refresh ID associated with the request. This is the unique ID assigned to
523
584
  * the instance refresh when it was started.</p>
524
585
  */
@@ -529,6 +590,7 @@ export interface CancelInstanceRefreshAnswer {
529
590
  */
530
591
  export interface CancelInstanceRefreshType {
531
592
  /**
593
+ * @public
532
594
  * <p>The name of the Auto Scaling group.</p>
533
595
  */
534
596
  AutoScalingGroupName: string | undefined;
@@ -543,25 +605,30 @@ export interface CompleteLifecycleActionAnswer {
543
605
  */
544
606
  export interface CompleteLifecycleActionType {
545
607
  /**
608
+ * @public
546
609
  * <p>The name of the lifecycle hook.</p>
547
610
  */
548
611
  LifecycleHookName: string | undefined;
549
612
  /**
613
+ * @public
550
614
  * <p>The name of the Auto Scaling group.</p>
551
615
  */
552
616
  AutoScalingGroupName: string | undefined;
553
617
  /**
618
+ * @public
554
619
  * <p>A universally unique identifier (UUID) that identifies a specific lifecycle action
555
620
  * associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you
556
621
  * specified when you created the lifecycle hook.</p>
557
622
  */
558
623
  LifecycleActionToken?: string;
559
624
  /**
625
+ * @public
560
626
  * <p>The action for the group to take. You can specify either <code>CONTINUE</code> or
561
627
  * <code>ABANDON</code>.</p>
562
628
  */
563
629
  LifecycleActionResult: string | undefined;
564
630
  /**
631
+ * @public
565
632
  * <p>The ID of the instance.</p>
566
633
  */
567
634
  InstanceId?: string;
@@ -574,6 +641,7 @@ export interface CompleteLifecycleActionType {
574
641
  */
575
642
  export interface LaunchTemplateSpecification {
576
643
  /**
644
+ * @public
577
645
  * <p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a> API operation. New launch templates can be created
578
646
  * using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p>
579
647
  * <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a
@@ -581,6 +649,7 @@ export interface LaunchTemplateSpecification {
581
649
  */
582
650
  LaunchTemplateId?: string;
583
651
  /**
652
+ * @public
584
653
  * <p>The name of the launch template. To get the template name, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a> API operation. New launch templates can be created
585
654
  * using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p>
586
655
  * <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a
@@ -588,6 +657,7 @@ export interface LaunchTemplateSpecification {
588
657
  */
589
658
  LaunchTemplateName?: string;
590
659
  /**
660
+ * @public
591
661
  * <p>The version number, <code>$Latest</code>, or <code>$Default</code>. To get the version
592
662
  * number, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a> API operation. New launch template versions
593
663
  * can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a> API. If the value is <code>$Latest</code>,
@@ -606,10 +676,12 @@ export interface LaunchTemplateSpecification {
606
676
  */
607
677
  export interface LifecycleHookSpecification {
608
678
  /**
679
+ * @public
609
680
  * <p>The name of the lifecycle hook.</p>
610
681
  */
611
682
  LifecycleHookName: string | undefined;
612
683
  /**
684
+ * @public
613
685
  * <p>The lifecycle transition. For Auto Scaling groups, there are two major lifecycle
614
686
  * transitions.</p>
615
687
  * <ul>
@@ -625,17 +697,20 @@ export interface LifecycleHookSpecification {
625
697
  */
626
698
  LifecycleTransition: string | undefined;
627
699
  /**
700
+ * @public
628
701
  * <p>Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to
629
702
  * the notification target.</p>
630
703
  */
631
704
  NotificationMetadata?: string;
632
705
  /**
706
+ * @public
633
707
  * <p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. The
634
708
  * range is from <code>30</code> to <code>7200</code> seconds. The default value is
635
709
  * <code>3600</code> seconds (1 hour).</p>
636
710
  */
637
711
  HeartbeatTimeout?: number;
638
712
  /**
713
+ * @public
639
714
  * <p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an
640
715
  * unexpected failure occurs. The default value is <code>ABANDON</code>.</p>
641
716
  * <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code>
@@ -643,12 +718,14 @@ export interface LifecycleHookSpecification {
643
718
  */
644
719
  DefaultResult?: string;
645
720
  /**
721
+ * @public
646
722
  * <p>The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends
647
723
  * notifications to when an instance is in a wait state for the lifecycle hook. You can
648
724
  * specify an Amazon SNS topic or an Amazon SQS queue.</p>
649
725
  */
650
726
  NotificationTargetARN?: string;
651
727
  /**
728
+ * @public
652
729
  * <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
653
730
  * notification target. For information about creating this role, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target">Configure a notification target for a lifecycle hook</a> in the
654
731
  * <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
@@ -664,6 +741,7 @@ export interface LifecycleHookSpecification {
664
741
  */
665
742
  export interface InstancesDistribution {
666
743
  /**
744
+ * @public
667
745
  * <p>The allocation strategy to apply to your On-Demand Instances when they are launched.
668
746
  * Possible instance types are determined by the launch template overrides that you
669
747
  * specify.</p>
@@ -690,6 +768,7 @@ export interface InstancesDistribution {
690
768
  */
691
769
  OnDemandAllocationStrategy?: string;
692
770
  /**
771
+ * @public
693
772
  * <p>The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand
694
773
  * Instances. This base portion is launched first as your group scales.</p>
695
774
  * <p>This number has the same unit of measurement as the group's desired capacity. If you
@@ -701,6 +780,7 @@ export interface InstancesDistribution {
701
780
  */
702
781
  OnDemandBaseCapacity?: number;
703
782
  /**
783
+ * @public
704
784
  * <p>Controls the percentages of On-Demand Instances and Spot Instances for your additional
705
785
  * capacity beyond <code>OnDemandBaseCapacity</code>. Expressed as a number (for example,
706
786
  * 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand
@@ -709,6 +789,7 @@ export interface InstancesDistribution {
709
789
  */
710
790
  OnDemandPercentageAboveBaseCapacity?: number;
711
791
  /**
792
+ * @public
712
793
  * <p>The allocation strategy to apply to your Spot Instances when they are launched.
713
794
  * Possible instance types are determined by the launch template overrides that you
714
795
  * specify.</p>
@@ -751,6 +832,7 @@ export interface InstancesDistribution {
751
832
  */
752
833
  SpotAllocationStrategy?: string;
753
834
  /**
835
+ * @public
754
836
  * <p>The number of Spot Instance pools across which to allocate your Spot Instances. The
755
837
  * Spot pools are determined from the different instance types in the overrides. Valid only
756
838
  * when the <code>SpotAllocationStrategy</code> is <code>lowest-price</code>. Value must be
@@ -759,6 +841,7 @@ export interface InstancesDistribution {
759
841
  */
760
842
  SpotInstancePools?: number;
761
843
  /**
844
+ * @public
762
845
  * <p>The maximum price per unit hour that you are willing to pay for a Spot Instance. If
763
846
  * your maximum price is lower than the Spot price for the instance types that you
764
847
  * selected, your Spot Instances are not launched. We do not recommend specifying a maximum
@@ -793,10 +876,12 @@ export type BareMetal = (typeof BareMetal)[keyof typeof BareMetal];
793
876
  */
794
877
  export interface BaselineEbsBandwidthMbpsRequest {
795
878
  /**
879
+ * @public
796
880
  * <p>The minimum value in Mbps.</p>
797
881
  */
798
882
  Min?: number;
799
883
  /**
884
+ * @public
800
885
  * <p>The maximum value in Mbps.</p>
801
886
  */
802
887
  Max?: number;
@@ -871,10 +956,12 @@ export type LocalStorageType = (typeof LocalStorageType)[keyof typeof LocalStora
871
956
  */
872
957
  export interface MemoryGiBPerVCpuRequest {
873
958
  /**
959
+ * @public
874
960
  * <p>The memory minimum in GiB.</p>
875
961
  */
876
962
  Min?: number;
877
963
  /**
964
+ * @public
878
965
  * <p>The memory maximum in GiB.</p>
879
966
  */
880
967
  Max?: number;
@@ -886,10 +973,12 @@ export interface MemoryGiBPerVCpuRequest {
886
973
  */
887
974
  export interface MemoryMiBRequest {
888
975
  /**
976
+ * @public
889
977
  * <p>The memory minimum in MiB.</p>
890
978
  */
891
979
  Min: number | undefined;
892
980
  /**
981
+ * @public
893
982
  * <p>The memory maximum in MiB.</p>
894
983
  */
895
984
  Max?: number;
@@ -908,10 +997,12 @@ export interface MemoryMiBRequest {
908
997
  */
909
998
  export interface NetworkBandwidthGbpsRequest {
910
999
  /**
1000
+ * @public
911
1001
  * <p>The minimum amount of network bandwidth, in gigabits per second (Gbps).</p>
912
1002
  */
913
1003
  Min?: number;
914
1004
  /**
1005
+ * @public
915
1006
  * <p>The maximum amount of network bandwidth, in gigabits per second (Gbps).</p>
916
1007
  */
917
1008
  Max?: number;
@@ -923,10 +1014,12 @@ export interface NetworkBandwidthGbpsRequest {
923
1014
  */
924
1015
  export interface NetworkInterfaceCountRequest {
925
1016
  /**
1017
+ * @public
926
1018
  * <p>The minimum number of network interfaces.</p>
927
1019
  */
928
1020
  Min?: number;
929
1021
  /**
1022
+ * @public
930
1023
  * <p>The maximum number of network interfaces.</p>
931
1024
  */
932
1025
  Max?: number;
@@ -938,10 +1031,12 @@ export interface NetworkInterfaceCountRequest {
938
1031
  */
939
1032
  export interface TotalLocalStorageGBRequest {
940
1033
  /**
1034
+ * @public
941
1035
  * <p>The storage minimum in GB.</p>
942
1036
  */
943
1037
  Min?: number;
944
1038
  /**
1039
+ * @public
945
1040
  * <p>The storage maximum in GB.</p>
946
1041
  */
947
1042
  Max?: number;
@@ -953,10 +1048,12 @@ export interface TotalLocalStorageGBRequest {
953
1048
  */
954
1049
  export interface VCpuCountRequest {
955
1050
  /**
1051
+ * @public
956
1052
  * <p>The minimum number of vCPUs.</p>
957
1053
  */
958
1054
  Min: number | undefined;
959
1055
  /**
1056
+ * @public
960
1057
  * <p>The maximum number of vCPUs.</p>
961
1058
  */
962
1059
  Max?: number;
@@ -998,14 +1095,17 @@ export interface VCpuCountRequest {
998
1095
  */
999
1096
  export interface InstanceRequirements {
1000
1097
  /**
1098
+ * @public
1001
1099
  * <p>The minimum and maximum number of vCPUs for an instance type.</p>
1002
1100
  */
1003
1101
  VCpuCount: VCpuCountRequest | undefined;
1004
1102
  /**
1103
+ * @public
1005
1104
  * <p>The minimum and maximum instance memory size for an instance type, in MiB.</p>
1006
1105
  */
1007
1106
  MemoryMiB: MemoryMiBRequest | undefined;
1008
1107
  /**
1108
+ * @public
1009
1109
  * <p>Lists which specific CPU manufacturers to include.</p>
1010
1110
  * <ul>
1011
1111
  * <li>
@@ -1028,11 +1128,13 @@ export interface InstanceRequirements {
1028
1128
  */
1029
1129
  CpuManufacturers?: (CpuManufacturer | string)[];
1030
1130
  /**
1131
+ * @public
1031
1132
  * <p>The minimum and maximum amount of memory per vCPU for an instance type, in GiB.</p>
1032
1133
  * <p>Default: No minimum or maximum limits</p>
1033
1134
  */
1034
1135
  MemoryGiBPerVCpu?: MemoryGiBPerVCpuRequest;
1035
1136
  /**
1137
+ * @public
1036
1138
  * <p>The instance types to exclude. You can use strings with one or more wild cards,
1037
1139
  * represented by an asterisk (<code>*</code>), to exclude an instance family, type, size,
1038
1140
  * or generation. The following are examples: <code>m5.8xlarge</code>, <code>c5*.*</code>,
@@ -1049,6 +1151,7 @@ export interface InstanceRequirements {
1049
1151
  */
1050
1152
  ExcludedInstanceTypes?: string[];
1051
1153
  /**
1154
+ * @public
1052
1155
  * <p>Indicates whether current or previous generation instance types are included.</p>
1053
1156
  * <ul>
1054
1157
  * <li>
@@ -1066,6 +1169,7 @@ export interface InstanceRequirements {
1066
1169
  */
1067
1170
  InstanceGenerations?: (InstanceGeneration | string)[];
1068
1171
  /**
1172
+ * @public
1069
1173
  * <p>The price protection threshold for Spot Instances. This is the maximum you’ll pay for
1070
1174
  * a Spot Instance, expressed as a percentage higher than the least expensive current
1071
1175
  * generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling
@@ -1081,6 +1185,7 @@ export interface InstanceRequirements {
1081
1185
  */
1082
1186
  SpotMaxPricePercentageOverLowestPrice?: number;
1083
1187
  /**
1188
+ * @public
1084
1189
  * <p>The price protection threshold for On-Demand Instances. This is the maximum you’ll pay
1085
1190
  * for an On-Demand Instance, expressed as a percentage higher than the least expensive
1086
1191
  * current generation M, C, or R instance type with your specified attributes. When
@@ -1096,6 +1201,7 @@ export interface InstanceRequirements {
1096
1201
  */
1097
1202
  OnDemandMaxPricePercentageOverLowestPrice?: number;
1098
1203
  /**
1204
+ * @public
1099
1205
  * <p>Indicates whether bare metal instance types are included, excluded, or
1100
1206
  * required.</p>
1101
1207
  * <p>Default: <code>excluded</code>
@@ -1103,6 +1209,7 @@ export interface InstanceRequirements {
1103
1209
  */
1104
1210
  BareMetal?: BareMetal | string;
1105
1211
  /**
1212
+ * @public
1106
1213
  * <p>Indicates whether burstable performance instance types are included, excluded, or
1107
1214
  * required. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable
1108
1215
  * performance instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1111,6 +1218,7 @@ export interface InstanceRequirements {
1111
1218
  */
1112
1219
  BurstablePerformance?: BurstablePerformance | string;
1113
1220
  /**
1221
+ * @public
1114
1222
  * <p>Indicates whether instance types must provide On-Demand Instance hibernation
1115
1223
  * support.</p>
1116
1224
  * <p>Default: <code>false</code>
@@ -1118,11 +1226,13 @@ export interface InstanceRequirements {
1118
1226
  */
1119
1227
  RequireHibernateSupport?: boolean;
1120
1228
  /**
1229
+ * @public
1121
1230
  * <p>The minimum and maximum number of network interfaces for an instance type.</p>
1122
1231
  * <p>Default: No minimum or maximum limits</p>
1123
1232
  */
1124
1233
  NetworkInterfaceCount?: NetworkInterfaceCountRequest;
1125
1234
  /**
1235
+ * @public
1126
1236
  * <p>Indicates whether instance types with instance store volumes are included, excluded,
1127
1237
  * or required. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 instance store</a> in
1128
1238
  * the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1131,6 +1241,7 @@ export interface InstanceRequirements {
1131
1241
  */
1132
1242
  LocalStorage?: LocalStorage | string;
1133
1243
  /**
1244
+ * @public
1134
1245
  * <p>Indicates the type of local storage that is required.</p>
1135
1246
  * <ul>
1136
1247
  * <li>
@@ -1146,11 +1257,13 @@ export interface InstanceRequirements {
1146
1257
  */
1147
1258
  LocalStorageTypes?: (LocalStorageType | string)[];
1148
1259
  /**
1260
+ * @public
1149
1261
  * <p>The minimum and maximum total local storage size for an instance type, in GB.</p>
1150
1262
  * <p>Default: No minimum or maximum limits</p>
1151
1263
  */
1152
1264
  TotalLocalStorageGB?: TotalLocalStorageGBRequest;
1153
1265
  /**
1266
+ * @public
1154
1267
  * <p>The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.
1155
1268
  * For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html">Amazon EBS–optimized instances</a>
1156
1269
  * in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1158,6 +1271,7 @@ export interface InstanceRequirements {
1158
1271
  */
1159
1272
  BaselineEbsBandwidthMbps?: BaselineEbsBandwidthMbpsRequest;
1160
1273
  /**
1274
+ * @public
1161
1275
  * <p>Lists the accelerator types that must be on an instance type.</p>
1162
1276
  * <ul>
1163
1277
  * <li>
@@ -1175,6 +1289,7 @@ export interface InstanceRequirements {
1175
1289
  */
1176
1290
  AcceleratorTypes?: (AcceleratorType | string)[];
1177
1291
  /**
1292
+ * @public
1178
1293
  * <p>The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia
1179
1294
  * chips) for an instance type.</p>
1180
1295
  * <p>To exclude accelerator-enabled instance types, set <code>Max</code> to
@@ -1183,6 +1298,7 @@ export interface InstanceRequirements {
1183
1298
  */
1184
1299
  AcceleratorCount?: AcceleratorCountRequest;
1185
1300
  /**
1301
+ * @public
1186
1302
  * <p>Indicates whether instance types must have accelerators by specific
1187
1303
  * manufacturers.</p>
1188
1304
  * <ul>
@@ -1204,6 +1320,7 @@ export interface InstanceRequirements {
1204
1320
  */
1205
1321
  AcceleratorManufacturers?: (AcceleratorManufacturer | string)[];
1206
1322
  /**
1323
+ * @public
1207
1324
  * <p>Lists the accelerators that must be on an instance type.</p>
1208
1325
  * <ul>
1209
1326
  * <li>
@@ -1233,18 +1350,21 @@ export interface InstanceRequirements {
1233
1350
  */
1234
1351
  AcceleratorNames?: (AcceleratorName | string)[];
1235
1352
  /**
1353
+ * @public
1236
1354
  * <p>The minimum and maximum total memory size for the accelerators on an instance type, in
1237
1355
  * MiB.</p>
1238
1356
  * <p>Default: No minimum or maximum limits</p>
1239
1357
  */
1240
1358
  AcceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRequest;
1241
1359
  /**
1360
+ * @public
1242
1361
  * <p>The minimum and maximum amount of network bandwidth, in gigabits per second
1243
1362
  * (Gbps).</p>
1244
1363
  * <p>Default: No minimum or maximum limits</p>
1245
1364
  */
1246
1365
  NetworkBandwidthGbps?: NetworkBandwidthGbpsRequest;
1247
1366
  /**
1367
+ * @public
1248
1368
  * <p>The instance types to apply your specified attributes against. All other instance
1249
1369
  * types are ignored, even if they match your specified attributes.</p>
1250
1370
  * <p>You can use strings with one or more wild cards, represented by an asterisk
@@ -1287,6 +1407,7 @@ export interface InstanceRequirements {
1287
1407
  */
1288
1408
  export interface LaunchTemplateOverrides {
1289
1409
  /**
1410
+ * @public
1290
1411
  * <p>The instance type, such as <code>m3.xlarge</code>. You must specify an instance type
1291
1412
  * that is supported in your requested Region and Availability Zones. For more information,
1292
1413
  * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon Elastic Compute Cloud User
@@ -1295,6 +1416,7 @@ export interface LaunchTemplateOverrides {
1295
1416
  */
1296
1417
  InstanceType?: string;
1297
1418
  /**
1419
+ * @public
1298
1420
  * <p>If you provide a list of instance types to use, you can specify the number of capacity
1299
1421
  * units provided by each instance type in terms of virtual CPUs, memory, storage,
1300
1422
  * throughput, or other relative performance characteristic. When a Spot or On-Demand
@@ -1317,6 +1439,7 @@ export interface LaunchTemplateOverrides {
1317
1439
  */
1318
1440
  WeightedCapacity?: string;
1319
1441
  /**
1442
+ * @public
1320
1443
  * <p>Provides a launch template for the specified instance type or set of instance
1321
1444
  * requirements. For example, some instance types might require a launch template with a
1322
1445
  * different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in
@@ -1328,6 +1451,7 @@ export interface LaunchTemplateOverrides {
1328
1451
  */
1329
1452
  LaunchTemplateSpecification?: LaunchTemplateSpecification;
1330
1453
  /**
1454
+ * @public
1331
1455
  * <p>The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify
1332
1456
  * instance types. Then, it uses your On-Demand and Spot allocation strategies to launch
1333
1457
  * instances from these instance types.</p>
@@ -1350,10 +1474,12 @@ export interface LaunchTemplateOverrides {
1350
1474
  */
1351
1475
  export interface LaunchTemplate {
1352
1476
  /**
1477
+ * @public
1353
1478
  * <p>The launch template.</p>
1354
1479
  */
1355
1480
  LaunchTemplateSpecification?: LaunchTemplateSpecification;
1356
1481
  /**
1482
+ * @public
1357
1483
  * <p>Any properties that you specify override the same properties in the launch
1358
1484
  * template.</p>
1359
1485
  */
@@ -1370,11 +1496,13 @@ export interface LaunchTemplate {
1370
1496
  */
1371
1497
  export interface MixedInstancesPolicy {
1372
1498
  /**
1499
+ * @public
1373
1500
  * <p>One or more launch templates and the instance types (overrides) that are used to
1374
1501
  * launch EC2 instances to fulfill On-Demand and Spot capacities.</p>
1375
1502
  */
1376
1503
  LaunchTemplate?: LaunchTemplate;
1377
1504
  /**
1505
+ * @public
1378
1506
  * <p>The instances distribution.</p>
1379
1507
  */
1380
1508
  InstancesDistribution?: InstancesDistribution;
@@ -1385,23 +1513,28 @@ export interface MixedInstancesPolicy {
1385
1513
  */
1386
1514
  export interface Tag {
1387
1515
  /**
1516
+ * @public
1388
1517
  * <p>The name of the Auto Scaling group.</p>
1389
1518
  */
1390
1519
  ResourceId?: string;
1391
1520
  /**
1521
+ * @public
1392
1522
  * <p>The type of resource. The only supported value is
1393
1523
  * <code>auto-scaling-group</code>.</p>
1394
1524
  */
1395
1525
  ResourceType?: string;
1396
1526
  /**
1527
+ * @public
1397
1528
  * <p>The tag key.</p>
1398
1529
  */
1399
1530
  Key: string | undefined;
1400
1531
  /**
1532
+ * @public
1401
1533
  * <p>The tag value.</p>
1402
1534
  */
1403
1535
  Value?: string;
1404
1536
  /**
1537
+ * @public
1405
1538
  * <p>Determines whether the tag is added to new instances as they are launched in the
1406
1539
  * group.</p>
1407
1540
  */
@@ -1412,6 +1545,7 @@ export interface Tag {
1412
1545
  */
1413
1546
  export interface CreateAutoScalingGroupType {
1414
1547
  /**
1548
+ * @public
1415
1549
  * <p>The name of the Auto Scaling group. This name must be unique per Region per account.</p>
1416
1550
  * <p>The name can contain any ASCII character 33 to 126 including most punctuation
1417
1551
  * characters, digits, and upper and lowercased letters.</p>
@@ -1421,6 +1555,7 @@ export interface CreateAutoScalingGroupType {
1421
1555
  */
1422
1556
  AutoScalingGroupName: string | undefined;
1423
1557
  /**
1558
+ * @public
1424
1559
  * <p>The name of the launch configuration to use to launch instances. </p>
1425
1560
  * <p>Conditional: You must specify either a launch template (<code>LaunchTemplate</code> or
1426
1561
  * <code>MixedInstancesPolicy</code>) or a launch configuration
@@ -1428,6 +1563,7 @@ export interface CreateAutoScalingGroupType {
1428
1563
  */
1429
1564
  LaunchConfigurationName?: string;
1430
1565
  /**
1566
+ * @public
1431
1567
  * <p>Information used to specify the launch template and version to use to launch
1432
1568
  * instances. </p>
1433
1569
  * <p>Conditional: You must specify either a launch template (<code>LaunchTemplate</code> or
@@ -1442,12 +1578,14 @@ export interface CreateAutoScalingGroupType {
1442
1578
  */
1443
1579
  LaunchTemplate?: LaunchTemplateSpecification;
1444
1580
  /**
1581
+ * @public
1445
1582
  * <p>The mixed instances policy. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling
1446
1583
  * groups with multiple instance types and purchase options</a> in the
1447
1584
  * <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
1448
1585
  */
1449
1586
  MixedInstancesPolicy?: MixedInstancesPolicy;
1450
1587
  /**
1588
+ * @public
1451
1589
  * <p>The ID of the instance used to base the launch configuration on. If specified, Amazon
1452
1590
  * EC2 Auto Scaling uses the configuration values from the specified instance to create a
1453
1591
  * new launch configuration. To get the instance ID, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> API operation. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html">Creating an Auto Scaling group using an EC2 instance</a> in the
@@ -1455,10 +1593,12 @@ export interface CreateAutoScalingGroupType {
1455
1593
  */
1456
1594
  InstanceId?: string;
1457
1595
  /**
1596
+ * @public
1458
1597
  * <p>The minimum size of the group.</p>
1459
1598
  */
1460
1599
  MinSize: number | undefined;
1461
1600
  /**
1601
+ * @public
1462
1602
  * <p>The maximum size of the group.</p>
1463
1603
  * <note>
1464
1604
  * <p>With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to
@@ -1470,6 +1610,7 @@ export interface CreateAutoScalingGroupType {
1470
1610
  */
1471
1611
  MaxSize: number | undefined;
1472
1612
  /**
1613
+ * @public
1473
1614
  * <p>The desired capacity is the initial capacity of the Auto Scaling group at the time of its
1474
1615
  * creation and the capacity it attempts to maintain. It can scale beyond this capacity if
1475
1616
  * you configure auto scaling. This number must be greater than or equal to the minimum
@@ -1478,6 +1619,7 @@ export interface CreateAutoScalingGroupType {
1478
1619
  */
1479
1620
  DesiredCapacity?: number;
1480
1621
  /**
1622
+ * @public
1481
1623
  * <p>
1482
1624
  * <i>Only needed if you use simple scaling policies.</i>
1483
1625
  * </p>
@@ -1488,6 +1630,7 @@ export interface CreateAutoScalingGroupType {
1488
1630
  */
1489
1631
  DefaultCooldown?: number;
1490
1632
  /**
1633
+ * @public
1491
1634
  * <p>A list of Availability Zones where instances in the Auto Scaling group can be created. Used
1492
1635
  * for launching into the default VPC subnet in each Availability Zone when not using the
1493
1636
  * <code>VPCZoneIdentifier</code> property, or for attaching a network interface when
@@ -1495,11 +1638,13 @@ export interface CreateAutoScalingGroupType {
1495
1638
  */
1496
1639
  AvailabilityZones?: string[];
1497
1640
  /**
1641
+ * @public
1498
1642
  * <p>A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers,
1499
1643
  * specify the <code>TargetGroupARNs</code> property instead.</p>
1500
1644
  */
1501
1645
  LoadBalancerNames?: string[];
1502
1646
  /**
1647
+ * @public
1503
1648
  * <p>The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling
1504
1649
  * group. Instances are registered as targets with the target groups. The target groups
1505
1650
  * receive incoming traffic and route requests to one or more registered targets. For more
@@ -1509,6 +1654,7 @@ export interface CreateAutoScalingGroupType {
1509
1654
  */
1510
1655
  TargetGroupARNs?: string[];
1511
1656
  /**
1657
+ * @public
1512
1658
  * <p>A comma-separated value string of one or more health check types.</p>
1513
1659
  * <p>The valid values are <code>EC2</code>, <code>ELB</code>, and <code>VPC_LATTICE</code>.
1514
1660
  * <code>EC2</code> is the default health check and cannot be disabled. For more
@@ -1519,6 +1665,7 @@ export interface CreateAutoScalingGroupType {
1519
1665
  */
1520
1666
  HealthCheckType?: string;
1521
1667
  /**
1668
+ * @public
1522
1669
  * <p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
1523
1670
  * of an EC2 instance that has come into service and marking it unhealthy due to a failed
1524
1671
  * health check. This is useful if your instances do not immediately pass their health
@@ -1530,6 +1677,7 @@ export interface CreateAutoScalingGroupType {
1530
1677
  */
1531
1678
  HealthCheckGracePeriod?: number;
1532
1679
  /**
1680
+ * @public
1533
1681
  * <p>The name of the placement group into which to launch your instances. For more
1534
1682
  * information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the
1535
1683
  * <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1541,6 +1689,7 @@ export interface CreateAutoScalingGroupType {
1541
1689
  */
1542
1690
  PlacementGroup?: string;
1543
1691
  /**
1692
+ * @public
1544
1693
  * <p>A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances
1545
1694
  * in the Auto Scaling group can be created. If you specify <code>VPCZoneIdentifier</code> with
1546
1695
  * <code>AvailabilityZones</code>, the subnets that you specify must reside in those
@@ -1548,6 +1697,7 @@ export interface CreateAutoScalingGroupType {
1548
1697
  */
1549
1698
  VPCZoneIdentifier?: string;
1550
1699
  /**
1700
+ * @public
1551
1701
  * <p>A policy or a list of policies that are used to select the instance to terminate.
1552
1702
  * These policies are executed in the order that you list them. For more information, see
1553
1703
  * <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
@@ -1562,6 +1712,7 @@ export interface CreateAutoScalingGroupType {
1562
1712
  */
1563
1713
  TerminationPolicies?: string[];
1564
1714
  /**
1715
+ * @public
1565
1716
  * <p>Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling
1566
1717
  * when scaling in. For more information about preventing instances from terminating on
1567
1718
  * scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Using
@@ -1570,6 +1721,7 @@ export interface CreateAutoScalingGroupType {
1570
1721
  */
1571
1722
  NewInstancesProtectedFromScaleIn?: boolean;
1572
1723
  /**
1724
+ * @public
1573
1725
  * <p>Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is
1574
1726
  * disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot
1575
1727
  * Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of
@@ -1579,11 +1731,13 @@ export interface CreateAutoScalingGroupType {
1579
1731
  */
1580
1732
  CapacityRebalance?: boolean;
1581
1733
  /**
1734
+ * @public
1582
1735
  * <p>One or more lifecycle hooks to add to the Auto Scaling group before instances are
1583
1736
  * launched.</p>
1584
1737
  */
1585
1738
  LifecycleHookSpecificationList?: LifecycleHookSpecification[];
1586
1739
  /**
1740
+ * @public
1587
1741
  * <p>One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2
1588
1742
  * instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS
1589
1743
  * volumes, specify the tags in a launch template but use caution. If the launch template
@@ -1594,6 +1748,7 @@ export interface CreateAutoScalingGroupType {
1594
1748
  */
1595
1749
  Tags?: Tag[];
1596
1750
  /**
1751
+ * @public
1597
1752
  * <p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to
1598
1753
  * call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role
1599
1754
  * named <code>AWSServiceRoleForAutoScaling</code>, which it creates if it does not exist.
@@ -1602,6 +1757,7 @@ export interface CreateAutoScalingGroupType {
1602
1757
  */
1603
1758
  ServiceLinkedRoleARN?: string;
1604
1759
  /**
1760
+ * @public
1605
1761
  * <p>The maximum amount of time, in seconds, that an instance can be in service. The
1606
1762
  * default is null. If specified, the value must be either 0 or a number equal to or
1607
1763
  * greater than 86,400 seconds (1 day). For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html">Replacing Auto Scaling instances based on maximum instance lifetime</a> in the
@@ -1609,10 +1765,12 @@ export interface CreateAutoScalingGroupType {
1609
1765
  */
1610
1766
  MaxInstanceLifetime?: number;
1611
1767
  /**
1768
+ * @public
1612
1769
  * <p>Reserved.</p>
1613
1770
  */
1614
1771
  Context?: string;
1615
1772
  /**
1773
+ * @public
1616
1774
  * <p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling
1617
1775
  * supports <code>DesiredCapacityType</code> for attribute-based instance type selection
1618
1776
  * only. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html">Creating
@@ -1625,6 +1783,7 @@ export interface CreateAutoScalingGroupType {
1625
1783
  */
1626
1784
  DesiredCapacityType?: string;
1627
1785
  /**
1786
+ * @public
1628
1787
  * <p>The amount of time, in seconds, until a new instance is considered to have finished
1629
1788
  * initializing and resource consumption to become stable after it enters the
1630
1789
  * <code>InService</code> state. </p>
@@ -1647,6 +1806,7 @@ export interface CreateAutoScalingGroupType {
1647
1806
  */
1648
1807
  DefaultInstanceWarmup?: number;
1649
1808
  /**
1809
+ * @public
1650
1810
  * <p>The list of traffic sources to attach to this Auto Scaling group. You can use any of the
1651
1811
  * following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and
1652
1812
  * VPC Lattice.</p>
@@ -1660,11 +1820,13 @@ export interface CreateAutoScalingGroupType {
1660
1820
  */
1661
1821
  export interface Ebs {
1662
1822
  /**
1823
+ * @public
1663
1824
  * <p>The snapshot ID of the volume to use.</p>
1664
1825
  * <p>You must specify either a <code>VolumeSize</code> or a <code>SnapshotId</code>.</p>
1665
1826
  */
1666
1827
  SnapshotId?: string;
1667
1828
  /**
1829
+ * @public
1668
1830
  * <p>The volume size, in GiBs. The following are the supported volumes sizes for each
1669
1831
  * volume type: </p>
1670
1832
  * <ul>
@@ -1691,6 +1853,7 @@ export interface Ebs {
1691
1853
  */
1692
1854
  VolumeSize?: number;
1693
1855
  /**
1856
+ * @public
1694
1857
  * <p>The volume type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the
1695
1858
  * <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
1696
1859
  * <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> |
@@ -1699,11 +1862,13 @@ export interface Ebs {
1699
1862
  */
1700
1863
  VolumeType?: string;
1701
1864
  /**
1865
+ * @public
1702
1866
  * <p>Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the
1703
1867
  * default value is <code>true</code>.</p>
1704
1868
  */
1705
1869
  DeleteOnTermination?: boolean;
1706
1870
  /**
1871
+ * @public
1707
1872
  * <p>The number of input/output (I/O) operations per second (IOPS) to provision for the
1708
1873
  * volume. For <code>gp3</code> and <code>io1</code> volumes, this represents the number of
1709
1874
  * IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents
@@ -1731,6 +1896,7 @@ export interface Ebs {
1731
1896
  */
1732
1897
  Iops?: number;
1733
1898
  /**
1899
+ * @public
1734
1900
  * <p>Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be
1735
1901
  * attached to instances that support Amazon EBS encryption. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances">Supported instance types</a>. If your AMI uses encrypted volumes, you can also
1736
1902
  * only launch it on supported instance types.</p>
@@ -1747,6 +1913,7 @@ export interface Ebs {
1747
1913
  */
1748
1914
  Encrypted?: boolean;
1749
1915
  /**
1916
+ * @public
1750
1917
  * <p>The throughput (MiBps) to provision for a <code>gp3</code> volume.</p>
1751
1918
  */
1752
1919
  Throughput?: number;
@@ -1757,6 +1924,7 @@ export interface Ebs {
1757
1924
  */
1758
1925
  export interface BlockDeviceMapping {
1759
1926
  /**
1927
+ * @public
1760
1928
  * <p>The name of the instance store volume (virtual device) to attach to an instance at
1761
1929
  * launch. The name must be in the form ephemeral<i>X</i> where
1762
1930
  * <i>X</i> is a number starting from zero (0), for example,
@@ -1764,6 +1932,7 @@ export interface BlockDeviceMapping {
1764
1932
  */
1765
1933
  VirtualName?: string;
1766
1934
  /**
1935
+ * @public
1767
1936
  * <p>The device name assigned to the volume (for example, <code>/dev/sdh</code> or
1768
1937
  * <code>xvdh</code>). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html">Device naming on Linux
1769
1938
  * instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1775,10 +1944,12 @@ export interface BlockDeviceMapping {
1775
1944
  */
1776
1945
  DeviceName: string | undefined;
1777
1946
  /**
1947
+ * @public
1778
1948
  * <p>Information to attach an EBS volume to an instance at launch.</p>
1779
1949
  */
1780
1950
  Ebs?: Ebs;
1781
1951
  /**
1952
+ * @public
1782
1953
  * <p>Setting this value to <code>true</code> prevents a volume that is included in the
1783
1954
  * block device mapping of the AMI from being mapped to the specified device name at
1784
1955
  * launch.</p>
@@ -1793,6 +1964,7 @@ export interface BlockDeviceMapping {
1793
1964
  */
1794
1965
  export interface InstanceMonitoring {
1795
1966
  /**
1967
+ * @public
1796
1968
  * <p>If <code>true</code>, detailed monitoring is enabled. Otherwise, basic monitoring is
1797
1969
  * enabled.</p>
1798
1970
  */
@@ -1829,6 +2001,7 @@ export type InstanceMetadataHttpTokensState = (typeof InstanceMetadataHttpTokens
1829
2001
  */
1830
2002
  export interface InstanceMetadataOptions {
1831
2003
  /**
2004
+ * @public
1832
2005
  * <p>The state of token usage for your instance metadata requests. If the parameter is not
1833
2006
  * specified in the request, the default state is <code>optional</code>.</p>
1834
2007
  * <p>If the state is <code>optional</code>, you can choose to retrieve instance metadata
@@ -1843,12 +2016,14 @@ export interface InstanceMetadataOptions {
1843
2016
  */
1844
2017
  HttpTokens?: InstanceMetadataHttpTokensState | string;
1845
2018
  /**
2019
+ * @public
1846
2020
  * <p>The desired HTTP PUT response hop limit for instance metadata requests. The larger the
1847
2021
  * number, the further instance metadata requests can travel.</p>
1848
2022
  * <p>Default: 1</p>
1849
2023
  */
1850
2024
  HttpPutResponseHopLimit?: number;
1851
2025
  /**
2026
+ * @public
1852
2027
  * <p>This parameter enables or disables the HTTP metadata endpoint on your instances. If
1853
2028
  * the parameter is not specified, the default state is <code>enabled</code>.</p>
1854
2029
  * <note>
@@ -1863,11 +2038,13 @@ export interface InstanceMetadataOptions {
1863
2038
  */
1864
2039
  export interface CreateLaunchConfigurationType {
1865
2040
  /**
2041
+ * @public
1866
2042
  * <p>The name of the launch configuration. This name must be unique per Region per
1867
2043
  * account.</p>
1868
2044
  */
1869
2045
  LaunchConfigurationName: string | undefined;
1870
2046
  /**
2047
+ * @public
1871
2048
  * <p>The ID of the Amazon Machine Image (AMI) that was assigned during registration. For
1872
2049
  * more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding a Linux AMI</a> in the
1873
2050
  * <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1876,11 +2053,13 @@ export interface CreateLaunchConfigurationType {
1876
2053
  */
1877
2054
  ImageId?: string;
1878
2055
  /**
2056
+ * @public
1879
2057
  * <p>The name of the key pair. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Linux
1880
2058
  * instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
1881
2059
  */
1882
2060
  KeyName?: string;
1883
2061
  /**
2062
+ * @public
1884
2063
  * <p>A list that contains the security group IDs to assign to the instances in the Auto Scaling
1885
2064
  * group. For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Control traffic to
1886
2065
  * resources using security groups</a> in the <i>Amazon Virtual Private
@@ -1888,14 +2067,17 @@ export interface CreateLaunchConfigurationType {
1888
2067
  */
1889
2068
  SecurityGroups?: string[];
1890
2069
  /**
2070
+ * @public
1891
2071
  * <p>Available for backward compatibility.</p>
1892
2072
  */
1893
2073
  ClassicLinkVPCId?: string;
1894
2074
  /**
2075
+ * @public
1895
2076
  * <p>Available for backward compatibility.</p>
1896
2077
  */
1897
2078
  ClassicLinkVPCSecurityGroups?: string[];
1898
2079
  /**
2080
+ * @public
1899
2081
  * <p>The user data to make available to the launched EC2 instances. For more information,
1900
2082
  * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance metadata and user data</a> (Linux) and <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html">Instance metadata and
1901
2083
  * user data</a> (Windows). If you are using a command line tool, base64-encoding
@@ -1904,6 +2086,7 @@ export interface CreateLaunchConfigurationType {
1904
2086
  */
1905
2087
  UserData?: string;
1906
2088
  /**
2089
+ * @public
1907
2090
  * <p>The ID of the instance to use to create the launch configuration. The new launch
1908
2091
  * configuration derives attributes from the instance, except for the block device
1909
2092
  * mapping.</p>
@@ -1915,6 +2098,7 @@ export interface CreateLaunchConfigurationType {
1915
2098
  */
1916
2099
  InstanceId?: string;
1917
2100
  /**
2101
+ * @public
1918
2102
  * <p>Specifies the instance type of the EC2 instance. For information about available
1919
2103
  * instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes">Available
1920
2104
  * instance types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -1923,6 +2107,7 @@ export interface CreateLaunchConfigurationType {
1923
2107
  */
1924
2108
  InstanceType?: string;
1925
2109
  /**
2110
+ * @public
1926
2111
  * <p>The ID of the kernel associated with the AMI.</p>
1927
2112
  * <note>
1928
2113
  * <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
@@ -1933,6 +2118,7 @@ export interface CreateLaunchConfigurationType {
1933
2118
  */
1934
2119
  KernelId?: string;
1935
2120
  /**
2121
+ * @public
1936
2122
  * <p>The ID of the RAM disk to select.</p>
1937
2123
  * <note>
1938
2124
  * <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
@@ -1943,6 +2129,7 @@ export interface CreateLaunchConfigurationType {
1943
2129
  */
1944
2130
  RamdiskId?: string;
1945
2131
  /**
2132
+ * @public
1946
2133
  * <p>The block device mapping entries that define the block devices to attach to the
1947
2134
  * instances at launch. By default, the block devices specified in the block device mapping
1948
2135
  * for the AMI are used. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device
@@ -1950,6 +2137,7 @@ export interface CreateLaunchConfigurationType {
1950
2137
  */
1951
2138
  BlockDeviceMappings?: BlockDeviceMapping[];
1952
2139
  /**
2140
+ * @public
1953
2141
  * <p>Controls whether instances in this group are launched with detailed
1954
2142
  * (<code>true</code>) or basic (<code>false</code>) monitoring.</p>
1955
2143
  * <p>The default value is <code>true</code> (enabled).</p>
@@ -1963,6 +2151,7 @@ export interface CreateLaunchConfigurationType {
1963
2151
  */
1964
2152
  InstanceMonitoring?: InstanceMonitoring;
1965
2153
  /**
2154
+ * @public
1966
2155
  * <p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the
1967
2156
  * request. Spot Instances are launched when the price you specify exceeds the current Spot
1968
2157
  * price. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html">Request Spot
@@ -1977,6 +2166,7 @@ export interface CreateLaunchConfigurationType {
1977
2166
  */
1978
2167
  SpotPrice?: string;
1979
2168
  /**
2169
+ * @public
1980
2170
  * <p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the
1981
2171
  * IAM role for the instance. The instance profile contains the IAM role. For more
1982
2172
  * information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html">IAM role for applications that run
@@ -1984,6 +2174,7 @@ export interface CreateLaunchConfigurationType {
1984
2174
  */
1985
2175
  IamInstanceProfile?: string;
1986
2176
  /**
2177
+ * @public
1987
2178
  * <p>Specifies whether the launch configuration is optimized for EBS I/O
1988
2179
  * (<code>true</code>) or not (<code>false</code>). The optimization provides dedicated
1989
2180
  * throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O
@@ -1995,6 +2186,7 @@ export interface CreateLaunchConfigurationType {
1995
2186
  */
1996
2187
  EbsOptimized?: boolean;
1997
2188
  /**
2189
+ * @public
1998
2190
  * <p>Specifies whether to assign a public IPv4 address to the group's instances. If the
1999
2191
  * instance is launched into a default subnet, the default is to assign a public IPv4
2000
2192
  * address, unless you disabled the option to assign a public IPv4 address on the subnet.
@@ -2009,6 +2201,7 @@ export interface CreateLaunchConfigurationType {
2009
2201
  */
2010
2202
  AssociatePublicIpAddress?: boolean;
2011
2203
  /**
2204
+ * @public
2012
2205
  * <p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An
2013
2206
  * instance with <code>dedicated</code> tenancy runs on isolated, single-tenant hardware
2014
2207
  * and can only be launched into a VPC. To launch dedicated instances into a shared tenancy
@@ -2024,6 +2217,7 @@ export interface CreateLaunchConfigurationType {
2024
2217
  */
2025
2218
  PlacementTenancy?: string;
2026
2219
  /**
2220
+ * @public
2027
2221
  * <p>The metadata options for the instances. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds">Configuring the Instance Metadata Options</a> in the
2028
2222
  * <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
2029
2223
  */
@@ -2034,6 +2228,7 @@ export interface CreateLaunchConfigurationType {
2034
2228
  */
2035
2229
  export interface CreateOrUpdateTagsType {
2036
2230
  /**
2231
+ * @public
2037
2232
  * <p>One or more tags.</p>
2038
2233
  */
2039
2234
  Tags: Tag[] | undefined;
@@ -2055,10 +2250,12 @@ export declare class ResourceInUseFault extends __BaseException {
2055
2250
  */
2056
2251
  export interface DeleteAutoScalingGroupType {
2057
2252
  /**
2253
+ * @public
2058
2254
  * <p>The name of the Auto Scaling group.</p>
2059
2255
  */
2060
2256
  AutoScalingGroupName: string | undefined;
2061
2257
  /**
2258
+ * @public
2062
2259
  * <p>Specifies that the group is to be deleted along with all instances associated with the
2063
2260
  * group, without waiting for all instances to be terminated. This action also deletes any
2064
2261
  * outstanding lifecycle actions associated with the group.</p>
@@ -2083,6 +2280,7 @@ export declare class ScalingActivityInProgressFault extends __BaseException {
2083
2280
  */
2084
2281
  export interface LaunchConfigurationNameType {
2085
2282
  /**
2283
+ * @public
2086
2284
  * <p>The name of the launch configuration.</p>
2087
2285
  */
2088
2286
  LaunchConfigurationName: string | undefined;
@@ -2097,10 +2295,12 @@ export interface DeleteLifecycleHookAnswer {
2097
2295
  */
2098
2296
  export interface DeleteLifecycleHookType {
2099
2297
  /**
2298
+ * @public
2100
2299
  * <p>The name of the lifecycle hook.</p>
2101
2300
  */
2102
2301
  LifecycleHookName: string | undefined;
2103
2302
  /**
2303
+ * @public
2104
2304
  * <p>The name of the Auto Scaling group.</p>
2105
2305
  */
2106
2306
  AutoScalingGroupName: string | undefined;
@@ -2110,10 +2310,12 @@ export interface DeleteLifecycleHookType {
2110
2310
  */
2111
2311
  export interface DeleteNotificationConfigurationType {
2112
2312
  /**
2313
+ * @public
2113
2314
  * <p>The name of the Auto Scaling group.</p>
2114
2315
  */
2115
2316
  AutoScalingGroupName: string | undefined;
2116
2317
  /**
2318
+ * @public
2117
2319
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic.</p>
2118
2320
  */
2119
2321
  TopicARN: string | undefined;
@@ -2123,10 +2325,12 @@ export interface DeleteNotificationConfigurationType {
2123
2325
  */
2124
2326
  export interface DeletePolicyType {
2125
2327
  /**
2328
+ * @public
2126
2329
  * <p>The name of the Auto Scaling group.</p>
2127
2330
  */
2128
2331
  AutoScalingGroupName?: string;
2129
2332
  /**
2333
+ * @public
2130
2334
  * <p>The name or Amazon Resource Name (ARN) of the policy.</p>
2131
2335
  */
2132
2336
  PolicyName: string | undefined;
@@ -2136,10 +2340,12 @@ export interface DeletePolicyType {
2136
2340
  */
2137
2341
  export interface DeleteScheduledActionType {
2138
2342
  /**
2343
+ * @public
2139
2344
  * <p>The name of the Auto Scaling group.</p>
2140
2345
  */
2141
2346
  AutoScalingGroupName: string | undefined;
2142
2347
  /**
2348
+ * @public
2143
2349
  * <p>The name of the action to delete.</p>
2144
2350
  */
2145
2351
  ScheduledActionName: string | undefined;
@@ -2149,6 +2355,7 @@ export interface DeleteScheduledActionType {
2149
2355
  */
2150
2356
  export interface DeleteTagsType {
2151
2357
  /**
2358
+ * @public
2152
2359
  * <p>One or more tags.</p>
2153
2360
  */
2154
2361
  Tags: Tag[] | undefined;
@@ -2163,10 +2370,12 @@ export interface DeleteWarmPoolAnswer {
2163
2370
  */
2164
2371
  export interface DeleteWarmPoolType {
2165
2372
  /**
2373
+ * @public
2166
2374
  * <p>The name of the Auto Scaling group.</p>
2167
2375
  */
2168
2376
  AutoScalingGroupName: string | undefined;
2169
2377
  /**
2378
+ * @public
2170
2379
  * <p>Specifies that the warm pool is to be deleted along with all of its associated
2171
2380
  * instances, without waiting for all instances to be terminated. This parameter also
2172
2381
  * deletes any outstanding lifecycle actions associated with the warm pool
@@ -2179,20 +2388,24 @@ export interface DeleteWarmPoolType {
2179
2388
  */
2180
2389
  export interface DescribeAccountLimitsAnswer {
2181
2390
  /**
2391
+ * @public
2182
2392
  * <p>The maximum number of groups allowed for your account. The default is 200 groups per
2183
2393
  * Region.</p>
2184
2394
  */
2185
2395
  MaxNumberOfAutoScalingGroups?: number;
2186
2396
  /**
2397
+ * @public
2187
2398
  * <p>The maximum number of launch configurations allowed for your account. The default is
2188
2399
  * 200 launch configurations per Region.</p>
2189
2400
  */
2190
2401
  MaxNumberOfLaunchConfigurations?: number;
2191
2402
  /**
2403
+ * @public
2192
2404
  * <p>The current number of groups for your account.</p>
2193
2405
  */
2194
2406
  NumberOfAutoScalingGroups?: number;
2195
2407
  /**
2408
+ * @public
2196
2409
  * <p>The current number of launch configurations for your account.</p>
2197
2410
  */
2198
2411
  NumberOfLaunchConfigurations?: number;
@@ -2202,6 +2415,7 @@ export interface DescribeAccountLimitsAnswer {
2202
2415
  */
2203
2416
  export interface DescribeAdjustmentTypesAnswer {
2204
2417
  /**
2418
+ * @public
2205
2419
  * <p>The policy adjustment types.</p>
2206
2420
  */
2207
2421
  AdjustmentTypes?: AdjustmentType[];
@@ -2218,6 +2432,7 @@ export interface DescribeAdjustmentTypesAnswer {
2218
2432
  */
2219
2433
  export interface Filter {
2220
2434
  /**
2435
+ * @public
2221
2436
  * <p>The name of the filter.</p>
2222
2437
  * <p>The valid values for <code>Name</code> depend on which API operation you're using with
2223
2438
  * the filter (<a>DescribeAutoScalingGroups</a> or <a>DescribeTags</a>).</p>
@@ -2275,6 +2490,7 @@ export interface Filter {
2275
2490
  */
2276
2491
  Name?: string;
2277
2492
  /**
2493
+ * @public
2278
2494
  * <p>One or more filter values. Filter values are case-sensitive. </p>
2279
2495
  * <p>If you specify multiple values for a filter, the values are automatically logically
2280
2496
  * joined with an <code>OR</code>, and the request returns all results that match any of
@@ -2289,22 +2505,26 @@ export interface Filter {
2289
2505
  */
2290
2506
  export interface AutoScalingGroupNamesType {
2291
2507
  /**
2508
+ * @public
2292
2509
  * <p>The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can
2293
2510
  * optionally increase this limit using the <code>MaxRecords</code> property.</p>
2294
2511
  * <p>If you omit this property, all Auto Scaling groups are described.</p>
2295
2512
  */
2296
2513
  AutoScalingGroupNames?: string[];
2297
2514
  /**
2515
+ * @public
2298
2516
  * <p>The token for the next set of items to return. (You received this token from a
2299
2517
  * previous call.)</p>
2300
2518
  */
2301
2519
  NextToken?: string;
2302
2520
  /**
2521
+ * @public
2303
2522
  * <p>The maximum number of items to return with this call. The default value is
2304
2523
  * <code>50</code> and the maximum value is <code>100</code>.</p>
2305
2524
  */
2306
2525
  MaxRecords?: number;
2307
2526
  /**
2527
+ * @public
2308
2528
  * <p>One or more filters to limit the results based on specific tags.
2309
2529
  * </p>
2310
2530
  */
@@ -2316,6 +2536,7 @@ export interface AutoScalingGroupNamesType {
2316
2536
  */
2317
2537
  export interface EnabledMetric {
2318
2538
  /**
2539
+ * @public
2319
2540
  * <p>One of the following metrics:</p>
2320
2541
  * <ul>
2321
2542
  * <li>
@@ -2423,6 +2644,7 @@ export interface EnabledMetric {
2423
2644
  */
2424
2645
  Metric?: string;
2425
2646
  /**
2647
+ * @public
2426
2648
  * <p>The granularity of the metric. The only valid value is <code>1Minute</code>.</p>
2427
2649
  */
2428
2650
  Granularity?: string;
@@ -2466,43 +2688,52 @@ export type LifecycleState = (typeof LifecycleState)[keyof typeof LifecycleState
2466
2688
  */
2467
2689
  export interface Instance {
2468
2690
  /**
2691
+ * @public
2469
2692
  * <p>The ID of the instance.</p>
2470
2693
  */
2471
2694
  InstanceId: string | undefined;
2472
2695
  /**
2696
+ * @public
2473
2697
  * <p>The instance type of the EC2 instance.</p>
2474
2698
  */
2475
2699
  InstanceType?: string;
2476
2700
  /**
2701
+ * @public
2477
2702
  * <p>The Availability Zone in which the instance is running.</p>
2478
2703
  */
2479
2704
  AvailabilityZone: string | undefined;
2480
2705
  /**
2706
+ * @public
2481
2707
  * <p>A description of the current lifecycle state. The <code>Quarantined</code> state is
2482
2708
  * not used. For information about lifecycle states, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html">Instance
2483
2709
  * lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
2484
2710
  */
2485
2711
  LifecycleState: LifecycleState | string | undefined;
2486
2712
  /**
2713
+ * @public
2487
2714
  * <p>The last reported health status of the instance. <code>Healthy</code> means that the
2488
2715
  * instance is healthy and should remain in service. <code>Unhealthy</code> means that the
2489
2716
  * instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.</p>
2490
2717
  */
2491
2718
  HealthStatus: string | undefined;
2492
2719
  /**
2720
+ * @public
2493
2721
  * <p>The launch configuration associated with the instance.</p>
2494
2722
  */
2495
2723
  LaunchConfigurationName?: string;
2496
2724
  /**
2725
+ * @public
2497
2726
  * <p>The launch template for the instance.</p>
2498
2727
  */
2499
2728
  LaunchTemplate?: LaunchTemplateSpecification;
2500
2729
  /**
2730
+ * @public
2501
2731
  * <p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling
2502
2732
  * in.</p>
2503
2733
  */
2504
2734
  ProtectedFromScaleIn: boolean | undefined;
2505
2735
  /**
2736
+ * @public
2506
2737
  * <p>The number of capacity units contributed by the instance based on its instance
2507
2738
  * type.</p>
2508
2739
  * <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>
@@ -2516,10 +2747,12 @@ export interface Instance {
2516
2747
  */
2517
2748
  export interface SuspendedProcess {
2518
2749
  /**
2750
+ * @public
2519
2751
  * <p>The name of the suspended process.</p>
2520
2752
  */
2521
2753
  ProcessName?: string;
2522
2754
  /**
2755
+ * @public
2523
2756
  * <p>The reason that the process was suspended.</p>
2524
2757
  */
2525
2758
  SuspensionReason?: string;
@@ -2530,23 +2763,28 @@ export interface SuspendedProcess {
2530
2763
  */
2531
2764
  export interface TagDescription {
2532
2765
  /**
2766
+ * @public
2533
2767
  * <p>The name of the group.</p>
2534
2768
  */
2535
2769
  ResourceId?: string;
2536
2770
  /**
2771
+ * @public
2537
2772
  * <p>The type of resource. The only supported value is
2538
2773
  * <code>auto-scaling-group</code>.</p>
2539
2774
  */
2540
2775
  ResourceType?: string;
2541
2776
  /**
2777
+ * @public
2542
2778
  * <p>The tag key.</p>
2543
2779
  */
2544
2780
  Key?: string;
2545
2781
  /**
2782
+ * @public
2546
2783
  * <p>The tag value.</p>
2547
2784
  */
2548
2785
  Value?: string;
2549
2786
  /**
2787
+ * @public
2550
2788
  * <p>Determines whether the tag is added to new instances as they are launched in the
2551
2789
  * group.</p>
2552
2790
  */
@@ -2560,6 +2798,7 @@ export interface TagDescription {
2560
2798
  */
2561
2799
  export interface InstanceReusePolicy {
2562
2800
  /**
2801
+ * @public
2563
2802
  * <p>Specifies whether instances in the Auto Scaling group can be returned to the warm pool on
2564
2803
  * scale in. </p>
2565
2804
  */
@@ -2595,23 +2834,28 @@ export type WarmPoolStatus = (typeof WarmPoolStatus)[keyof typeof WarmPoolStatus
2595
2834
  */
2596
2835
  export interface WarmPoolConfiguration {
2597
2836
  /**
2837
+ * @public
2598
2838
  * <p>The maximum number of instances that are allowed to be in the warm pool or in any
2599
2839
  * state except <code>Terminated</code> for the Auto Scaling group.</p>
2600
2840
  */
2601
2841
  MaxGroupPreparedCapacity?: number;
2602
2842
  /**
2843
+ * @public
2603
2844
  * <p>The minimum number of instances to maintain in the warm pool.</p>
2604
2845
  */
2605
2846
  MinSize?: number;
2606
2847
  /**
2848
+ * @public
2607
2849
  * <p>The instance state to transition to after the lifecycle actions are complete.</p>
2608
2850
  */
2609
2851
  PoolState?: WarmPoolState | string;
2610
2852
  /**
2853
+ * @public
2611
2854
  * <p>The status of a warm pool that is marked for deletion.</p>
2612
2855
  */
2613
2856
  Status?: WarmPoolStatus | string;
2614
2857
  /**
2858
+ * @public
2615
2859
  * <p>The instance reuse policy.</p>
2616
2860
  */
2617
2861
  InstanceReusePolicy?: InstanceReusePolicy;
@@ -2622,144 +2866,178 @@ export interface WarmPoolConfiguration {
2622
2866
  */
2623
2867
  export interface AutoScalingGroup {
2624
2868
  /**
2869
+ * @public
2625
2870
  * <p>The name of the Auto Scaling group.</p>
2626
2871
  */
2627
2872
  AutoScalingGroupName: string | undefined;
2628
2873
  /**
2874
+ * @public
2629
2875
  * <p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>
2630
2876
  */
2631
2877
  AutoScalingGroupARN?: string;
2632
2878
  /**
2879
+ * @public
2633
2880
  * <p>The name of the associated launch configuration.</p>
2634
2881
  */
2635
2882
  LaunchConfigurationName?: string;
2636
2883
  /**
2884
+ * @public
2637
2885
  * <p>The launch template for the group.</p>
2638
2886
  */
2639
2887
  LaunchTemplate?: LaunchTemplateSpecification;
2640
2888
  /**
2889
+ * @public
2641
2890
  * <p>The mixed instances policy for the group.</p>
2642
2891
  */
2643
2892
  MixedInstancesPolicy?: MixedInstancesPolicy;
2644
2893
  /**
2894
+ * @public
2645
2895
  * <p>The minimum size of the group.</p>
2646
2896
  */
2647
2897
  MinSize: number | undefined;
2648
2898
  /**
2899
+ * @public
2649
2900
  * <p>The maximum size of the group.</p>
2650
2901
  */
2651
2902
  MaxSize: number | undefined;
2652
2903
  /**
2904
+ * @public
2653
2905
  * <p>The desired size of the group.</p>
2654
2906
  */
2655
2907
  DesiredCapacity: number | undefined;
2656
2908
  /**
2909
+ * @public
2657
2910
  * <p>The predicted capacity of the group when it has a predictive scaling policy.</p>
2658
2911
  */
2659
2912
  PredictedCapacity?: number;
2660
2913
  /**
2914
+ * @public
2661
2915
  * <p>The duration of the default cooldown period, in seconds.</p>
2662
2916
  */
2663
2917
  DefaultCooldown: number | undefined;
2664
2918
  /**
2919
+ * @public
2665
2920
  * <p>One or more Availability Zones for the group.</p>
2666
2921
  */
2667
2922
  AvailabilityZones: string[] | undefined;
2668
2923
  /**
2924
+ * @public
2669
2925
  * <p>One or more load balancers associated with the group.</p>
2670
2926
  */
2671
2927
  LoadBalancerNames?: string[];
2672
2928
  /**
2929
+ * @public
2673
2930
  * <p>The Amazon Resource Names (ARN) of the target groups for your load balancer.</p>
2674
2931
  */
2675
2932
  TargetGroupARNs?: string[];
2676
2933
  /**
2934
+ * @public
2677
2935
  * <p>A comma-separated value string of one or more health check types.</p>
2678
2936
  */
2679
2937
  HealthCheckType: string | undefined;
2680
2938
  /**
2939
+ * @public
2681
2940
  * <p>The duration of the health check grace period, in seconds.</p>
2682
2941
  */
2683
2942
  HealthCheckGracePeriod?: number;
2684
2943
  /**
2944
+ * @public
2685
2945
  * <p>The EC2 instances associated with the group.</p>
2686
2946
  */
2687
2947
  Instances?: Instance[];
2688
2948
  /**
2949
+ * @public
2689
2950
  * <p>The date and time the group was created.</p>
2690
2951
  */
2691
2952
  CreatedTime: Date | undefined;
2692
2953
  /**
2954
+ * @public
2693
2955
  * <p>The suspended processes associated with the group.</p>
2694
2956
  */
2695
2957
  SuspendedProcesses?: SuspendedProcess[];
2696
2958
  /**
2959
+ * @public
2697
2960
  * <p>The name of the placement group into which to launch your instances, if any.</p>
2698
2961
  */
2699
2962
  PlacementGroup?: string;
2700
2963
  /**
2964
+ * @public
2701
2965
  * <p>One or more subnet IDs, if applicable, separated by commas.</p>
2702
2966
  */
2703
2967
  VPCZoneIdentifier?: string;
2704
2968
  /**
2969
+ * @public
2705
2970
  * <p>The metrics enabled for the group.</p>
2706
2971
  */
2707
2972
  EnabledMetrics?: EnabledMetric[];
2708
2973
  /**
2974
+ * @public
2709
2975
  * <p>The current state of the group when the <a>DeleteAutoScalingGroup</a>
2710
2976
  * operation is in progress.</p>
2711
2977
  */
2712
2978
  Status?: string;
2713
2979
  /**
2980
+ * @public
2714
2981
  * <p>The tags for the group.</p>
2715
2982
  */
2716
2983
  Tags?: TagDescription[];
2717
2984
  /**
2985
+ * @public
2718
2986
  * <p>The termination policies for the group.</p>
2719
2987
  */
2720
2988
  TerminationPolicies?: string[];
2721
2989
  /**
2990
+ * @public
2722
2991
  * <p>Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling
2723
2992
  * when scaling in.</p>
2724
2993
  */
2725
2994
  NewInstancesProtectedFromScaleIn?: boolean;
2726
2995
  /**
2996
+ * @public
2727
2997
  * <p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to
2728
2998
  * call other Amazon Web Services on your behalf.</p>
2729
2999
  */
2730
3000
  ServiceLinkedRoleARN?: string;
2731
3001
  /**
3002
+ * @public
2732
3003
  * <p>The maximum amount of time, in seconds, that an instance can be in service.</p>
2733
3004
  * <p>Valid Range: Minimum value of 0.</p>
2734
3005
  */
2735
3006
  MaxInstanceLifetime?: number;
2736
3007
  /**
3008
+ * @public
2737
3009
  * <p>Indicates whether Capacity Rebalancing is enabled.</p>
2738
3010
  */
2739
3011
  CapacityRebalance?: boolean;
2740
3012
  /**
3013
+ * @public
2741
3014
  * <p>The warm pool for the group.</p>
2742
3015
  */
2743
3016
  WarmPoolConfiguration?: WarmPoolConfiguration;
2744
3017
  /**
3018
+ * @public
2745
3019
  * <p>The current size of the warm pool.</p>
2746
3020
  */
2747
3021
  WarmPoolSize?: number;
2748
3022
  /**
3023
+ * @public
2749
3024
  * <p>Reserved.</p>
2750
3025
  */
2751
3026
  Context?: string;
2752
3027
  /**
3028
+ * @public
2753
3029
  * <p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling
2754
3030
  * supports <code>DesiredCapacityType</code> for attribute-based instance type selection
2755
3031
  * only.</p>
2756
3032
  */
2757
3033
  DesiredCapacityType?: string;
2758
3034
  /**
3035
+ * @public
2759
3036
  * <p>The duration of the default instance warmup, in seconds.</p>
2760
3037
  */
2761
3038
  DefaultInstanceWarmup?: number;
2762
3039
  /**
3040
+ * @public
2763
3041
  * <p>The traffic sources associated with this Auto Scaling group.</p>
2764
3042
  */
2765
3043
  TrafficSources?: TrafficSourceIdentifier[];
@@ -2769,10 +3047,12 @@ export interface AutoScalingGroup {
2769
3047
  */
2770
3048
  export interface AutoScalingGroupsType {
2771
3049
  /**
3050
+ * @public
2772
3051
  * <p>The groups.</p>
2773
3052
  */
2774
3053
  AutoScalingGroups: AutoScalingGroup[] | undefined;
2775
3054
  /**
3055
+ * @public
2776
3056
  * <p>A string that indicates that the response contains more items than can be returned in
2777
3057
  * a single response. To receive additional items, specify this string for the
2778
3058
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -2798,22 +3078,27 @@ export declare class InvalidNextToken extends __BaseException {
2798
3078
  */
2799
3079
  export interface AutoScalingInstanceDetails {
2800
3080
  /**
3081
+ * @public
2801
3082
  * <p>The ID of the instance.</p>
2802
3083
  */
2803
3084
  InstanceId: string | undefined;
2804
3085
  /**
3086
+ * @public
2805
3087
  * <p>The instance type of the EC2 instance.</p>
2806
3088
  */
2807
3089
  InstanceType?: string;
2808
3090
  /**
3091
+ * @public
2809
3092
  * <p>The name of the Auto Scaling group for the instance.</p>
2810
3093
  */
2811
3094
  AutoScalingGroupName: string | undefined;
2812
3095
  /**
3096
+ * @public
2813
3097
  * <p>The Availability Zone for the instance.</p>
2814
3098
  */
2815
3099
  AvailabilityZone: string | undefined;
2816
3100
  /**
3101
+ * @public
2817
3102
  * <p>The lifecycle state for the instance. The <code>Quarantined</code> state is not used.
2818
3103
  * For information about lifecycle states, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html">Instance
2819
3104
  * lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
@@ -2831,26 +3116,31 @@ export interface AutoScalingInstanceDetails {
2831
3116
  */
2832
3117
  LifecycleState: string | undefined;
2833
3118
  /**
3119
+ * @public
2834
3120
  * <p>The last reported health status of this instance. <code>Healthy</code> means that the
2835
3121
  * instance is healthy and should remain in service. <code>Unhealthy</code> means that the
2836
3122
  * instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.</p>
2837
3123
  */
2838
3124
  HealthStatus: string | undefined;
2839
3125
  /**
3126
+ * @public
2840
3127
  * <p>The launch configuration used to launch the instance. This value is not available if
2841
3128
  * you attached the instance to the Auto Scaling group.</p>
2842
3129
  */
2843
3130
  LaunchConfigurationName?: string;
2844
3131
  /**
3132
+ * @public
2845
3133
  * <p>The launch template for the instance.</p>
2846
3134
  */
2847
3135
  LaunchTemplate?: LaunchTemplateSpecification;
2848
3136
  /**
3137
+ * @public
2849
3138
  * <p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling
2850
3139
  * in.</p>
2851
3140
  */
2852
3141
  ProtectedFromScaleIn: boolean | undefined;
2853
3142
  /**
3143
+ * @public
2854
3144
  * <p>The number of capacity units contributed by the instance based on its instance
2855
3145
  * type.</p>
2856
3146
  * <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>
@@ -2862,10 +3152,12 @@ export interface AutoScalingInstanceDetails {
2862
3152
  */
2863
3153
  export interface AutoScalingInstancesType {
2864
3154
  /**
3155
+ * @public
2865
3156
  * <p>The instances.</p>
2866
3157
  */
2867
3158
  AutoScalingInstances?: AutoScalingInstanceDetails[];
2868
3159
  /**
3160
+ * @public
2869
3161
  * <p>A string that indicates that the response contains more items than can be returned in
2870
3162
  * a single response. To receive additional items, specify this string for the
2871
3163
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -2878,17 +3170,20 @@ export interface AutoScalingInstancesType {
2878
3170
  */
2879
3171
  export interface DescribeAutoScalingInstancesType {
2880
3172
  /**
3173
+ * @public
2881
3174
  * <p>The IDs of the instances. If you omit this property, all Auto Scaling instances are described.
2882
3175
  * If you specify an ID that does not exist, it is ignored with no error.</p>
2883
3176
  * <p>Array Members: Maximum number of 50 items.</p>
2884
3177
  */
2885
3178
  InstanceIds?: string[];
2886
3179
  /**
3180
+ * @public
2887
3181
  * <p>The maximum number of items to return with this call. The default value is
2888
3182
  * <code>50</code> and the maximum value is <code>50</code>.</p>
2889
3183
  */
2890
3184
  MaxRecords?: number;
2891
3185
  /**
3186
+ * @public
2892
3187
  * <p>The token for the next set of items to return. (You received this token from a
2893
3188
  * previous call.)</p>
2894
3189
  */
@@ -2899,6 +3194,7 @@ export interface DescribeAutoScalingInstancesType {
2899
3194
  */
2900
3195
  export interface DescribeAutoScalingNotificationTypesAnswer {
2901
3196
  /**
3197
+ * @public
2902
3198
  * <p>The notification types.</p>
2903
3199
  */
2904
3200
  AutoScalingNotificationTypes?: string[];
@@ -2911,12 +3207,14 @@ export interface DescribeAutoScalingNotificationTypesAnswer {
2911
3207
  */
2912
3208
  export interface DesiredConfiguration {
2913
3209
  /**
3210
+ * @public
2914
3211
  * <p>Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling
2915
3212
  * uses to launch Amazon EC2 instances. For more information about launch templates, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html">Launch
2916
3213
  * templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
2917
3214
  */
2918
3215
  LaunchTemplate?: LaunchTemplateSpecification;
2919
3216
  /**
3217
+ * @public
2920
3218
  * <p>Use this structure to launch multiple instance types and On-Demand Instances and Spot
2921
3219
  * Instances within a single Auto Scaling group.</p>
2922
3220
  * <p>A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch
@@ -2958,6 +3256,7 @@ export type StandbyInstances = (typeof StandbyInstances)[keyof typeof StandbyIns
2958
3256
  */
2959
3257
  export interface RefreshPreferences {
2960
3258
  /**
3259
+ * @public
2961
3260
  * <p>The amount of capacity in the Auto Scaling group that must pass your group's health checks to
2962
3261
  * allow the operation to continue. The value is expressed as a percentage of the desired
2963
3262
  * capacity of the Auto Scaling group (rounded up to the nearest integer). The default is
@@ -2968,6 +3267,7 @@ export interface RefreshPreferences {
2968
3267
  */
2969
3268
  MinHealthyPercentage?: number;
2970
3269
  /**
3270
+ * @public
2971
3271
  * <p>A time period, in seconds, during which an instance refresh waits before moving on to
2972
3272
  * replacing the next instance after a new instance enters the <code>InService</code>
2973
3273
  * state.</p>
@@ -2982,6 +3282,7 @@ export interface RefreshPreferences {
2982
3282
  */
2983
3283
  InstanceWarmup?: number;
2984
3284
  /**
3285
+ * @public
2985
3286
  * <p>(Optional) Threshold values for each checkpoint in ascending order. Each number must
2986
3287
  * be unique. To replace all instances in the Auto Scaling group, the last number in the array must
2987
3288
  * be <code>100</code>.</p>
@@ -2991,6 +3292,7 @@ export interface RefreshPreferences {
2991
3292
  */
2992
3293
  CheckpointPercentages?: number[];
2993
3294
  /**
3295
+ * @public
2994
3296
  * <p>(Optional) The amount of time, in seconds, to wait after a checkpoint before
2995
3297
  * continuing. This property is optional, but if you specify a value for it, you must also
2996
3298
  * specify a value for <code>CheckpointPercentages</code>. If you specify a value for
@@ -2999,6 +3301,7 @@ export interface RefreshPreferences {
2999
3301
  */
3000
3302
  CheckpointDelay?: number;
3001
3303
  /**
3304
+ * @public
3002
3305
  * <p>(Optional) Indicates whether skip matching is enabled. If enabled (<code>true</code>),
3003
3306
  * then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no
3004
3307
  * desired configuration is specified, then it skips replacing instances that have the same
@@ -3010,8 +3313,10 @@ export interface RefreshPreferences {
3010
3313
  */
3011
3314
  SkipMatching?: boolean;
3012
3315
  /**
3316
+ * @public
3013
3317
  * <p>(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration
3014
- * if the instance refresh fails. The default is <code>false</code>.</p>
3318
+ * if the instance refresh fails or a CloudWatch alarm threshold is met. The default is
3319
+ * <code>false</code>.</p>
3015
3320
  * <p>A rollback is not supported in the following situations: </p>
3016
3321
  * <ul>
3017
3322
  * <li>
@@ -3026,9 +3331,12 @@ export interface RefreshPreferences {
3026
3331
  * <code>$Default</code> version.</p>
3027
3332
  * </li>
3028
3333
  * </ul>
3334
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-refresh-rollback.html">Undo changes with a
3335
+ * rollback</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3029
3336
  */
3030
3337
  AutoRollback?: boolean;
3031
3338
  /**
3339
+ * @public
3032
3340
  * <p>Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in
3033
3341
  * are found. </p>
3034
3342
  * <p>The following lists the valid values:</p>
@@ -3051,6 +3359,7 @@ export interface RefreshPreferences {
3051
3359
  */
3052
3360
  ScaleInProtectedInstances?: ScaleInProtectedInstances | string;
3053
3361
  /**
3362
+ * @public
3054
3363
  * <p>Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in <code>Standby</code>
3055
3364
  * state are found.</p>
3056
3365
  * <p>The following lists the valid values:</p>
@@ -3072,6 +3381,12 @@ export interface RefreshPreferences {
3072
3381
  * </dl>
3073
3382
  */
3074
3383
  StandbyInstances?: StandbyInstances | string;
3384
+ /**
3385
+ * @public
3386
+ * <p>(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any
3387
+ * issues and fail the operation if an alarm threshold is met.</p>
3388
+ */
3389
+ AlarmSpecification?: AlarmSpecification;
3075
3390
  }
3076
3391
  /**
3077
3392
  * @public
@@ -3079,6 +3394,7 @@ export interface RefreshPreferences {
3079
3394
  */
3080
3395
  export interface InstanceRefreshLivePoolProgress {
3081
3396
  /**
3397
+ * @public
3082
3398
  * <p>The percentage of instances in the Auto Scaling group that have been replaced. For each
3083
3399
  * instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.
3084
3400
  * When the instance's health status changes to healthy and the specified warm-up time
@@ -3087,6 +3403,7 @@ export interface InstanceRefreshLivePoolProgress {
3087
3403
  */
3088
3404
  PercentageComplete?: number;
3089
3405
  /**
3406
+ * @public
3090
3407
  * <p>The number of instances remaining to update.</p>
3091
3408
  */
3092
3409
  InstancesToUpdate?: number;
@@ -3097,6 +3414,7 @@ export interface InstanceRefreshLivePoolProgress {
3097
3414
  */
3098
3415
  export interface InstanceRefreshWarmPoolProgress {
3099
3416
  /**
3417
+ * @public
3100
3418
  * <p>The percentage of instances in the warm pool that have been replaced. For each
3101
3419
  * instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.
3102
3420
  * When the instance's health status changes to healthy and the specified warm-up time
@@ -3105,6 +3423,7 @@ export interface InstanceRefreshWarmPoolProgress {
3105
3423
  */
3106
3424
  PercentageComplete?: number;
3107
3425
  /**
3426
+ * @public
3108
3427
  * <p>The number of instances remaining to update.</p>
3109
3428
  */
3110
3429
  InstancesToUpdate?: number;
@@ -3117,10 +3436,12 @@ export interface InstanceRefreshWarmPoolProgress {
3117
3436
  */
3118
3437
  export interface InstanceRefreshProgressDetails {
3119
3438
  /**
3439
+ * @public
3120
3440
  * <p>Reports progress on replacing instances that are in the Auto Scaling group.</p>
3121
3441
  */
3122
3442
  LivePoolProgress?: InstanceRefreshLivePoolProgress;
3123
3443
  /**
3444
+ * @public
3124
3445
  * <p>Reports progress on replacing instances that are in the warm pool.</p>
3125
3446
  */
3126
3447
  WarmPoolProgress?: InstanceRefreshWarmPoolProgress;
@@ -3131,25 +3452,30 @@ export interface InstanceRefreshProgressDetails {
3131
3452
  */
3132
3453
  export interface RollbackDetails {
3133
3454
  /**
3455
+ * @public
3134
3456
  * <p>The reason for this instance refresh rollback (for example, whether a manual or
3135
3457
  * automatic rollback was initiated).</p>
3136
3458
  */
3137
3459
  RollbackReason?: string;
3138
3460
  /**
3461
+ * @public
3139
3462
  * <p>The date and time at which the rollback began.</p>
3140
3463
  */
3141
3464
  RollbackStartTime?: Date;
3142
3465
  /**
3466
+ * @public
3143
3467
  * <p>Indicates the value of <code>PercentageComplete</code> at the time the rollback
3144
3468
  * started.</p>
3145
3469
  */
3146
3470
  PercentageCompleteOnRollback?: number;
3147
3471
  /**
3472
+ * @public
3148
3473
  * <p>Indicates the value of <code>InstancesToUpdate</code> at the time the rollback
3149
3474
  * started.</p>
3150
3475
  */
3151
3476
  InstancesToUpdateOnRollback?: number;
3152
3477
  /**
3478
+ * @public
3153
3479
  * <p>Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This
3154
3480
  * includes separate details for instances in the warm pool and instances in the Auto Scaling group
3155
3481
  * (the live pool).</p>
@@ -3181,14 +3507,17 @@ export type InstanceRefreshStatus = (typeof InstanceRefreshStatus)[keyof typeof
3181
3507
  */
3182
3508
  export interface InstanceRefresh {
3183
3509
  /**
3510
+ * @public
3184
3511
  * <p>The instance refresh ID.</p>
3185
3512
  */
3186
3513
  InstanceRefreshId?: string;
3187
3514
  /**
3515
+ * @public
3188
3516
  * <p>The name of the Auto Scaling group.</p>
3189
3517
  */
3190
3518
  AutoScalingGroupName?: string;
3191
3519
  /**
3520
+ * @public
3192
3521
  * <p>The current status for the instance refresh operation:</p>
3193
3522
  * <ul>
3194
3523
  * <li>
@@ -3236,18 +3565,22 @@ export interface InstanceRefresh {
3236
3565
  */
3237
3566
  Status?: InstanceRefreshStatus | string;
3238
3567
  /**
3568
+ * @public
3239
3569
  * <p>The explanation for the specific status assigned to this operation.</p>
3240
3570
  */
3241
3571
  StatusReason?: string;
3242
3572
  /**
3573
+ * @public
3243
3574
  * <p>The date and time at which the instance refresh began.</p>
3244
3575
  */
3245
3576
  StartTime?: Date;
3246
3577
  /**
3578
+ * @public
3247
3579
  * <p>The date and time at which the instance refresh ended.</p>
3248
3580
  */
3249
3581
  EndTime?: Date;
3250
3582
  /**
3583
+ * @public
3251
3584
  * <p>The percentage of the instance refresh that is complete. For each instance
3252
3585
  * replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the
3253
3586
  * instance's health status changes to healthy and the specified warm-up time passes, the
@@ -3261,6 +3594,7 @@ export interface InstanceRefresh {
3261
3594
  */
3262
3595
  PercentageComplete?: number;
3263
3596
  /**
3597
+ * @public
3264
3598
  * <p>The number of instances remaining to update before the instance refresh is
3265
3599
  * complete.</p>
3266
3600
  * <note>
@@ -3271,18 +3605,22 @@ export interface InstanceRefresh {
3271
3605
  */
3272
3606
  InstancesToUpdate?: number;
3273
3607
  /**
3608
+ * @public
3274
3609
  * <p>Additional progress details for an Auto Scaling group that has a warm pool.</p>
3275
3610
  */
3276
3611
  ProgressDetails?: InstanceRefreshProgressDetails;
3277
3612
  /**
3613
+ * @public
3278
3614
  * <p>The preferences for an instance refresh.</p>
3279
3615
  */
3280
3616
  Preferences?: RefreshPreferences;
3281
3617
  /**
3618
+ * @public
3282
3619
  * <p>Describes the desired configuration for the instance refresh.</p>
3283
3620
  */
3284
3621
  DesiredConfiguration?: DesiredConfiguration;
3285
3622
  /**
3623
+ * @public
3286
3624
  * <p>The rollback details.</p>
3287
3625
  */
3288
3626
  RollbackDetails?: RollbackDetails;
@@ -3292,11 +3630,13 @@ export interface InstanceRefresh {
3292
3630
  */
3293
3631
  export interface DescribeInstanceRefreshesAnswer {
3294
3632
  /**
3633
+ * @public
3295
3634
  * <p>The instance refreshes for the specified group, sorted by creation timestamp in
3296
3635
  * descending order.</p>
3297
3636
  */
3298
3637
  InstanceRefreshes?: InstanceRefresh[];
3299
3638
  /**
3639
+ * @public
3300
3640
  * <p>A string that indicates that the response contains more items than can be returned in
3301
3641
  * a single response. To receive additional items, specify this string for the
3302
3642
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -3309,19 +3649,23 @@ export interface DescribeInstanceRefreshesAnswer {
3309
3649
  */
3310
3650
  export interface DescribeInstanceRefreshesType {
3311
3651
  /**
3652
+ * @public
3312
3653
  * <p>The name of the Auto Scaling group.</p>
3313
3654
  */
3314
3655
  AutoScalingGroupName: string | undefined;
3315
3656
  /**
3657
+ * @public
3316
3658
  * <p>One or more instance refresh IDs.</p>
3317
3659
  */
3318
3660
  InstanceRefreshIds?: string[];
3319
3661
  /**
3662
+ * @public
3320
3663
  * <p>The token for the next set of items to return. (You received this token from a
3321
3664
  * previous call.)</p>
3322
3665
  */
3323
3666
  NextToken?: string;
3324
3667
  /**
3668
+ * @public
3325
3669
  * <p>The maximum number of items to return with this call. The default value is
3326
3670
  * <code>50</code> and the maximum value is <code>100</code>.</p>
3327
3671
  */
@@ -3332,17 +3676,20 @@ export interface DescribeInstanceRefreshesType {
3332
3676
  */
3333
3677
  export interface LaunchConfigurationNamesType {
3334
3678
  /**
3679
+ * @public
3335
3680
  * <p>The launch configuration names. If you omit this property, all launch configurations
3336
3681
  * are described.</p>
3337
3682
  * <p>Array Members: Maximum number of 50 items.</p>
3338
3683
  */
3339
3684
  LaunchConfigurationNames?: string[];
3340
3685
  /**
3686
+ * @public
3341
3687
  * <p>The token for the next set of items to return. (You received this token from a
3342
3688
  * previous call.)</p>
3343
3689
  */
3344
3690
  NextToken?: string;
3345
3691
  /**
3692
+ * @public
3346
3693
  * <p>The maximum number of items to return with this call. The default value is
3347
3694
  * <code>50</code> and the maximum value is <code>100</code>.</p>
3348
3695
  */
@@ -3354,26 +3701,31 @@ export interface LaunchConfigurationNamesType {
3354
3701
  */
3355
3702
  export interface LaunchConfiguration {
3356
3703
  /**
3704
+ * @public
3357
3705
  * <p>The name of the launch configuration.</p>
3358
3706
  */
3359
3707
  LaunchConfigurationName: string | undefined;
3360
3708
  /**
3709
+ * @public
3361
3710
  * <p>The Amazon Resource Name (ARN) of the launch configuration.</p>
3362
3711
  */
3363
3712
  LaunchConfigurationARN?: string;
3364
3713
  /**
3714
+ * @public
3365
3715
  * <p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more
3366
3716
  * information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Find a Linux AMI</a> in the
3367
3717
  * <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
3368
3718
  */
3369
3719
  ImageId: string | undefined;
3370
3720
  /**
3721
+ * @public
3371
3722
  * <p>The name of the key pair.</p>
3372
3723
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 Key Pairs</a> in the
3373
3724
  * <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
3374
3725
  */
3375
3726
  KeyName?: string;
3376
3727
  /**
3728
+ * @public
3377
3729
  * <p>A list that contains the security groups to assign to the instances in the Auto Scaling group.
3378
3730
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your
3379
3731
  * VPC</a> in the <i>Amazon Virtual Private Cloud User
@@ -3381,14 +3733,17 @@ export interface LaunchConfiguration {
3381
3733
  */
3382
3734
  SecurityGroups?: string[];
3383
3735
  /**
3736
+ * @public
3384
3737
  * <p>Available for backward compatibility.</p>
3385
3738
  */
3386
3739
  ClassicLinkVPCId?: string;
3387
3740
  /**
3741
+ * @public
3388
3742
  * <p>Available for backward compatibility.</p>
3389
3743
  */
3390
3744
  ClassicLinkVPCSecurityGroups?: string[];
3391
3745
  /**
3746
+ * @public
3392
3747
  * <p>The user data to make available to the launched EC2 instances. For more information,
3393
3748
  * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance metadata and user data</a> (Linux) and <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html">Instance metadata and
3394
3749
  * user data</a> (Windows). If you are using a command line tool, base64-encoding
@@ -3397,20 +3752,24 @@ export interface LaunchConfiguration {
3397
3752
  */
3398
3753
  UserData?: string;
3399
3754
  /**
3755
+ * @public
3400
3756
  * <p>The instance type for the instances. For information about available instance types,
3401
3757
  * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes">Available
3402
3758
  * instance types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
3403
3759
  */
3404
3760
  InstanceType: string | undefined;
3405
3761
  /**
3762
+ * @public
3406
3763
  * <p>The ID of the kernel associated with the AMI.</p>
3407
3764
  */
3408
3765
  KernelId?: string;
3409
3766
  /**
3767
+ * @public
3410
3768
  * <p>The ID of the RAM disk associated with the AMI.</p>
3411
3769
  */
3412
3770
  RamdiskId?: string;
3413
3771
  /**
3772
+ * @public
3414
3773
  * <p>The block device mapping entries that define the block devices to attach to the
3415
3774
  * instances at launch. By default, the block devices specified in the block device mapping
3416
3775
  * for the AMI are used. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device
@@ -3418,6 +3777,7 @@ export interface LaunchConfiguration {
3418
3777
  */
3419
3778
  BlockDeviceMappings?: BlockDeviceMapping[];
3420
3779
  /**
3780
+ * @public
3421
3781
  * <p>Controls whether instances in this group are launched with detailed
3422
3782
  * (<code>true</code>) or basic (<code>false</code>) monitoring.</p>
3423
3783
  * <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html">Configure
@@ -3426,6 +3786,7 @@ export interface LaunchConfiguration {
3426
3786
  */
3427
3787
  InstanceMonitoring?: InstanceMonitoring;
3428
3788
  /**
3789
+ * @public
3429
3790
  * <p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the
3430
3791
  * request. Spot Instances are launched when the price you specify exceeds the current Spot
3431
3792
  * price. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html">Requesting Spot
@@ -3433,6 +3794,7 @@ export interface LaunchConfiguration {
3433
3794
  */
3434
3795
  SpotPrice?: string;
3435
3796
  /**
3797
+ * @public
3436
3798
  * <p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the
3437
3799
  * IAM role for the instance. The instance profile contains the IAM role. For more
3438
3800
  * information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html">IAM role for applications that run
@@ -3440,16 +3802,19 @@ export interface LaunchConfiguration {
3440
3802
  */
3441
3803
  IamInstanceProfile?: string;
3442
3804
  /**
3805
+ * @public
3443
3806
  * <p>The creation date and time for the launch configuration.</p>
3444
3807
  */
3445
3808
  CreatedTime: Date | undefined;
3446
3809
  /**
3810
+ * @public
3447
3811
  * <p>Specifies whether the launch configuration is optimized for EBS I/O
3448
3812
  * (<code>true</code>) or not (<code>false</code>). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html">Amazon
3449
3813
  * EBS-Optimized Instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
3450
3814
  */
3451
3815
  EbsOptimized?: boolean;
3452
3816
  /**
3817
+ * @public
3453
3818
  * <p>Specifies whether to assign a public IPv4 address to the group's instances. If the
3454
3819
  * instance is launched into a default subnet, the default is to assign a public IPv4
3455
3820
  * address, unless you disabled the option to assign a public IPv4 address on the subnet.
@@ -3460,6 +3825,7 @@ export interface LaunchConfiguration {
3460
3825
  */
3461
3826
  AssociatePublicIpAddress?: boolean;
3462
3827
  /**
3828
+ * @public
3463
3829
  * <p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An
3464
3830
  * instance with <code>dedicated</code> tenancy runs on isolated, single-tenant hardware
3465
3831
  * and can only be launched into a VPC.</p>
@@ -3469,6 +3835,7 @@ export interface LaunchConfiguration {
3469
3835
  */
3470
3836
  PlacementTenancy?: string;
3471
3837
  /**
3838
+ * @public
3472
3839
  * <p>The metadata options for the instances. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds">Configuring the Instance Metadata Options</a> in the
3473
3840
  * <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
3474
3841
  */
@@ -3479,10 +3846,12 @@ export interface LaunchConfiguration {
3479
3846
  */
3480
3847
  export interface LaunchConfigurationsType {
3481
3848
  /**
3849
+ * @public
3482
3850
  * <p>The launch configurations.</p>
3483
3851
  */
3484
3852
  LaunchConfigurations: LaunchConfiguration[] | undefined;
3485
3853
  /**
3854
+ * @public
3486
3855
  * <p>A string that indicates that the response contains more items than can be returned in
3487
3856
  * a single response. To receive additional items, specify this string for the
3488
3857
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -3499,14 +3868,17 @@ export interface LaunchConfigurationsType {
3499
3868
  */
3500
3869
  export interface LifecycleHook {
3501
3870
  /**
3871
+ * @public
3502
3872
  * <p>The name of the lifecycle hook.</p>
3503
3873
  */
3504
3874
  LifecycleHookName?: string;
3505
3875
  /**
3876
+ * @public
3506
3877
  * <p>The name of the Auto Scaling group for the lifecycle hook.</p>
3507
3878
  */
3508
3879
  AutoScalingGroupName?: string;
3509
3880
  /**
3881
+ * @public
3510
3882
  * <p>The lifecycle transition.</p>
3511
3883
  * <p>Valid values: <code>autoscaling:EC2_INSTANCE_LAUNCHING</code> |
3512
3884
  * <code>autoscaling:EC2_INSTANCE_TERMINATING</code>
@@ -3514,33 +3886,39 @@ export interface LifecycleHook {
3514
3886
  */
3515
3887
  LifecycleTransition?: string;
3516
3888
  /**
3889
+ * @public
3517
3890
  * <p>The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a
3518
3891
  * wait state for the lifecycle hook.</p>
3519
3892
  */
3520
3893
  NotificationTargetARN?: string;
3521
3894
  /**
3895
+ * @public
3522
3896
  * <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
3523
3897
  * notification target (an Amazon SNS topic or an Amazon SQS queue).</p>
3524
3898
  */
3525
3899
  RoleARN?: string;
3526
3900
  /**
3901
+ * @public
3527
3902
  * <p>Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the
3528
3903
  * notification target.</p>
3529
3904
  */
3530
3905
  NotificationMetadata?: string;
3531
3906
  /**
3907
+ * @public
3532
3908
  * <p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If
3533
3909
  * the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
3534
3910
  * <code>DefaultResult</code> property.</p>
3535
3911
  */
3536
3912
  HeartbeatTimeout?: number;
3537
3913
  /**
3914
+ * @public
3538
3915
  * <p>The maximum time, in seconds, that an instance can remain in a wait state. The maximum
3539
3916
  * is 172800 seconds (48 hours) or 100 times <code>HeartbeatTimeout</code>, whichever is
3540
3917
  * smaller.</p>
3541
3918
  */
3542
3919
  GlobalTimeout?: number;
3543
3920
  /**
3921
+ * @public
3544
3922
  * <p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an
3545
3923
  * unexpected failure occurs.</p>
3546
3924
  * <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code>
@@ -3553,6 +3931,7 @@ export interface LifecycleHook {
3553
3931
  */
3554
3932
  export interface DescribeLifecycleHooksAnswer {
3555
3933
  /**
3934
+ * @public
3556
3935
  * <p>The lifecycle hooks for the specified group.</p>
3557
3936
  */
3558
3937
  LifecycleHooks?: LifecycleHook[];
@@ -3562,10 +3941,12 @@ export interface DescribeLifecycleHooksAnswer {
3562
3941
  */
3563
3942
  export interface DescribeLifecycleHooksType {
3564
3943
  /**
3944
+ * @public
3565
3945
  * <p>The name of the Auto Scaling group.</p>
3566
3946
  */
3567
3947
  AutoScalingGroupName: string | undefined;
3568
3948
  /**
3949
+ * @public
3569
3950
  * <p>The names of one or more lifecycle hooks. If you omit this property, all lifecycle
3570
3951
  * hooks are described.</p>
3571
3952
  */
@@ -3576,6 +3957,7 @@ export interface DescribeLifecycleHooksType {
3576
3957
  */
3577
3958
  export interface DescribeLifecycleHookTypesAnswer {
3578
3959
  /**
3960
+ * @public
3579
3961
  * <p>The lifecycle hook types.</p>
3580
3962
  */
3581
3963
  LifecycleHookTypes?: string[];
@@ -3585,15 +3967,18 @@ export interface DescribeLifecycleHookTypesAnswer {
3585
3967
  */
3586
3968
  export interface DescribeLoadBalancersRequest {
3587
3969
  /**
3970
+ * @public
3588
3971
  * <p>The name of the Auto Scaling group.</p>
3589
3972
  */
3590
3973
  AutoScalingGroupName: string | undefined;
3591
3974
  /**
3975
+ * @public
3592
3976
  * <p>The token for the next set of items to return. (You received this token from a
3593
3977
  * previous call.)</p>
3594
3978
  */
3595
3979
  NextToken?: string;
3596
3980
  /**
3981
+ * @public
3597
3982
  * <p>The maximum number of items to return with this call. The default value is
3598
3983
  * <code>100</code> and the maximum value is <code>100</code>.</p>
3599
3984
  */
@@ -3605,10 +3990,12 @@ export interface DescribeLoadBalancersRequest {
3605
3990
  */
3606
3991
  export interface LoadBalancerState {
3607
3992
  /**
3993
+ * @public
3608
3994
  * <p>The name of the load balancer.</p>
3609
3995
  */
3610
3996
  LoadBalancerName?: string;
3611
3997
  /**
3998
+ * @public
3612
3999
  * <p>One of the following load balancer states:</p>
3613
4000
  * <ul>
3614
4001
  * <li>
@@ -3646,10 +4033,12 @@ export interface LoadBalancerState {
3646
4033
  */
3647
4034
  export interface DescribeLoadBalancersResponse {
3648
4035
  /**
4036
+ * @public
3649
4037
  * <p>The load balancers.</p>
3650
4038
  */
3651
4039
  LoadBalancers?: LoadBalancerState[];
3652
4040
  /**
4041
+ * @public
3653
4042
  * <p>A string that indicates that the response contains more items than can be returned in
3654
4043
  * a single response. To receive additional items, specify this string for the
3655
4044
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -3662,15 +4051,18 @@ export interface DescribeLoadBalancersResponse {
3662
4051
  */
3663
4052
  export interface DescribeLoadBalancerTargetGroupsRequest {
3664
4053
  /**
4054
+ * @public
3665
4055
  * <p>The name of the Auto Scaling group.</p>
3666
4056
  */
3667
4057
  AutoScalingGroupName: string | undefined;
3668
4058
  /**
4059
+ * @public
3669
4060
  * <p>The token for the next set of items to return. (You received this token from a
3670
4061
  * previous call.)</p>
3671
4062
  */
3672
4063
  NextToken?: string;
3673
4064
  /**
4065
+ * @public
3674
4066
  * <p>The maximum number of items to return with this call. The default value is
3675
4067
  * <code>100</code> and the maximum value is <code>100</code>.</p>
3676
4068
  */
@@ -3682,10 +4074,12 @@ export interface DescribeLoadBalancerTargetGroupsRequest {
3682
4074
  */
3683
4075
  export interface LoadBalancerTargetGroupState {
3684
4076
  /**
4077
+ * @public
3685
4078
  * <p>The Amazon Resource Name (ARN) of the target group.</p>
3686
4079
  */
3687
4080
  LoadBalancerTargetGroupARN?: string;
3688
4081
  /**
4082
+ * @public
3689
4083
  * <p>The state of the target group.</p>
3690
4084
  * <ul>
3691
4085
  * <li>
@@ -3723,10 +4117,12 @@ export interface LoadBalancerTargetGroupState {
3723
4117
  */
3724
4118
  export interface DescribeLoadBalancerTargetGroupsResponse {
3725
4119
  /**
4120
+ * @public
3726
4121
  * <p>Information about the target groups.</p>
3727
4122
  */
3728
4123
  LoadBalancerTargetGroups?: LoadBalancerTargetGroupState[];
3729
4124
  /**
4125
+ * @public
3730
4126
  * <p>A string that indicates that the response contains more items than can be returned in
3731
4127
  * a single response. To receive additional items, specify this string for the
3732
4128
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -3740,6 +4136,7 @@ export interface DescribeLoadBalancerTargetGroupsResponse {
3740
4136
  */
3741
4137
  export interface MetricGranularityType {
3742
4138
  /**
4139
+ * @public
3743
4140
  * <p>The granularity. The only valid value is <code>1Minute</code>.</p>
3744
4141
  */
3745
4142
  Granularity?: string;
@@ -3750,6 +4147,7 @@ export interface MetricGranularityType {
3750
4147
  */
3751
4148
  export interface MetricCollectionType {
3752
4149
  /**
4150
+ * @public
3753
4151
  * <p>One of the following metrics:</p>
3754
4152
  * <ul>
3755
4153
  * <li>
@@ -3861,10 +4259,12 @@ export interface MetricCollectionType {
3861
4259
  */
3862
4260
  export interface DescribeMetricCollectionTypesAnswer {
3863
4261
  /**
4262
+ * @public
3864
4263
  * <p>The metrics.</p>
3865
4264
  */
3866
4265
  Metrics?: MetricCollectionType[];
3867
4266
  /**
4267
+ * @public
3868
4268
  * <p>The granularities for the metrics.</p>
3869
4269
  */
3870
4270
  Granularities?: MetricGranularityType[];
@@ -3875,14 +4275,17 @@ export interface DescribeMetricCollectionTypesAnswer {
3875
4275
  */
3876
4276
  export interface NotificationConfiguration {
3877
4277
  /**
4278
+ * @public
3878
4279
  * <p>The name of the Auto Scaling group.</p>
3879
4280
  */
3880
4281
  AutoScalingGroupName?: string;
3881
4282
  /**
4283
+ * @public
3882
4284
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic.</p>
3883
4285
  */
3884
4286
  TopicARN?: string;
3885
4287
  /**
4288
+ * @public
3886
4289
  * <p>One of the following event notification types:</p>
3887
4290
  * <ul>
3888
4291
  * <li>
@@ -3919,10 +4322,12 @@ export interface NotificationConfiguration {
3919
4322
  */
3920
4323
  export interface DescribeNotificationConfigurationsAnswer {
3921
4324
  /**
4325
+ * @public
3922
4326
  * <p>The notification configurations.</p>
3923
4327
  */
3924
4328
  NotificationConfigurations: NotificationConfiguration[] | undefined;
3925
4329
  /**
4330
+ * @public
3926
4331
  * <p>A string that indicates that the response contains more items than can be returned in
3927
4332
  * a single response. To receive additional items, specify this string for the
3928
4333
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -3935,15 +4340,18 @@ export interface DescribeNotificationConfigurationsAnswer {
3935
4340
  */
3936
4341
  export interface DescribeNotificationConfigurationsType {
3937
4342
  /**
4343
+ * @public
3938
4344
  * <p>The name of the Auto Scaling group.</p>
3939
4345
  */
3940
4346
  AutoScalingGroupNames?: string[];
3941
4347
  /**
4348
+ * @public
3942
4349
  * <p>The token for the next set of items to return. (You received this token from a
3943
4350
  * previous call.)</p>
3944
4351
  */
3945
4352
  NextToken?: string;
3946
4353
  /**
4354
+ * @public
3947
4355
  * <p>The maximum number of items to return with this call. The default value is
3948
4356
  * <code>50</code> and the maximum value is <code>100</code>.</p>
3949
4357
  */
@@ -3954,10 +4362,12 @@ export interface DescribeNotificationConfigurationsType {
3954
4362
  */
3955
4363
  export interface DescribePoliciesType {
3956
4364
  /**
4365
+ * @public
3957
4366
  * <p>The name of the Auto Scaling group.</p>
3958
4367
  */
3959
4368
  AutoScalingGroupName?: string;
3960
4369
  /**
4370
+ * @public
3961
4371
  * <p>The names of one or more policies. If you omit this property, all policies are
3962
4372
  * described. If a group name is provided, the results are limited to that group. If you
3963
4373
  * specify an unknown policy name, it is ignored with no error.</p>
@@ -3965,17 +4375,20 @@ export interface DescribePoliciesType {
3965
4375
  */
3966
4376
  PolicyNames?: string[];
3967
4377
  /**
4378
+ * @public
3968
4379
  * <p>One or more policy types. The valid values are <code>SimpleScaling</code>,
3969
4380
  * <code>StepScaling</code>, <code>TargetTrackingScaling</code>, and
3970
4381
  * <code>PredictiveScaling</code>.</p>
3971
4382
  */
3972
4383
  PolicyTypes?: string[];
3973
4384
  /**
4385
+ * @public
3974
4386
  * <p>The token for the next set of items to return. (You received this token from a
3975
4387
  * previous call.)</p>
3976
4388
  */
3977
4389
  NextToken?: string;
3978
4390
  /**
4391
+ * @public
3979
4392
  * <p>The maximum number of items to be returned with each call. The default value is
3980
4393
  * <code>50</code> and the maximum value is <code>100</code>.</p>
3981
4394
  */
@@ -3999,10 +4412,12 @@ export type PredictiveScalingMaxCapacityBreachBehavior = (typeof PredictiveScali
3999
4412
  */
4000
4413
  export interface MetricDimension {
4001
4414
  /**
4415
+ * @public
4002
4416
  * <p>The name of the dimension.</p>
4003
4417
  */
4004
4418
  Name: string | undefined;
4005
4419
  /**
4420
+ * @public
4006
4421
  * <p>The value of the dimension.</p>
4007
4422
  */
4008
4423
  Value: string | undefined;
@@ -4013,16 +4428,19 @@ export interface MetricDimension {
4013
4428
  */
4014
4429
  export interface Metric {
4015
4430
  /**
4431
+ * @public
4016
4432
  * <p>The namespace of the metric. For more information, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services
4017
4433
  * services that publish CloudWatch metrics </a> in the <i>Amazon CloudWatch User
4018
4434
  * Guide</i>.</p>
4019
4435
  */
4020
4436
  Namespace: string | undefined;
4021
4437
  /**
4438
+ * @public
4022
4439
  * <p>The name of the metric.</p>
4023
4440
  */
4024
4441
  MetricName: string | undefined;
4025
4442
  /**
4443
+ * @public
4026
4444
  * <p>The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services
4027
4445
  * documentation available from the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services
4028
4446
  * services that publish CloudWatch metrics </a> in the <i>Amazon CloudWatch User
@@ -4041,11 +4459,13 @@ export interface Metric {
4041
4459
  */
4042
4460
  export interface MetricStat {
4043
4461
  /**
4462
+ * @public
4044
4463
  * <p>The CloudWatch metric to return, including the metric name, namespace, and dimensions. To
4045
4464
  * get the exact metric name, namespace, and dimensions, inspect the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object that is returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
4046
4465
  */
4047
4466
  Metric: Metric | undefined;
4048
4467
  /**
4468
+ * @public
4049
4469
  * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For
4050
4470
  * a list of valid values, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
4051
4471
  * <p>The most commonly used metrics for predictive scaling are <code>Average</code> and
@@ -4053,6 +4473,7 @@ export interface MetricStat {
4053
4473
  */
4054
4474
  Stat: string | undefined;
4055
4475
  /**
4476
+ * @public
4056
4477
  * <p>The unit to use for the returned data points. For a complete list of the units that
4057
4478
  * CloudWatch supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a>
4058
4479
  * data type in the <i>Amazon CloudWatch API Reference</i>.</p>
@@ -4070,6 +4491,7 @@ export interface MetricStat {
4070
4491
  */
4071
4492
  export interface MetricDataQuery {
4072
4493
  /**
4494
+ * @public
4073
4495
  * <p>A short name that identifies the object's results in the response. This name must be
4074
4496
  * unique among all <code>MetricDataQuery</code> objects specified for a single scaling
4075
4497
  * policy. If you are performing math expressions on this set of data, this name represents
@@ -4079,6 +4501,7 @@ export interface MetricDataQuery {
4079
4501
  */
4080
4502
  Id: string | undefined;
4081
4503
  /**
4504
+ * @public
4082
4505
  * <p>The math expression to perform on the returned data, if this object is performing a
4083
4506
  * math expression. This expression can use the <code>Id</code> of the other metrics to
4084
4507
  * refer to those metrics, and can also use the <code>Id</code> of other expressions to use
@@ -4088,17 +4511,20 @@ export interface MetricDataQuery {
4088
4511
  */
4089
4512
  Expression?: string;
4090
4513
  /**
4514
+ * @public
4091
4515
  * <p>Information about the metric data to return.</p>
4092
4516
  * <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either
4093
4517
  * <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
4094
4518
  */
4095
4519
  MetricStat?: MetricStat;
4096
4520
  /**
4521
+ * @public
4097
4522
  * <p>A human-readable label for this metric or expression. This is especially useful if
4098
4523
  * this is a math expression, so that you know what the value represents.</p>
4099
4524
  */
4100
4525
  Label?: string;
4101
4526
  /**
4527
+ * @public
4102
4528
  * <p>Indicates whether to return the timestamps and raw data values of this metric. </p>
4103
4529
  * <p>If you use any math expressions, specify <code>true</code> for this value for only the
4104
4530
  * final math expression that the metric specification is based on. You must specify
@@ -4116,6 +4542,7 @@ export interface MetricDataQuery {
4116
4542
  */
4117
4543
  export interface PredictiveScalingCustomizedCapacityMetric {
4118
4544
  /**
4545
+ * @public
4119
4546
  * <p>One or more metric data queries to provide the data points for a capacity metric. Use
4120
4547
  * multiple metric data queries only if you are performing a math expression on returned
4121
4548
  * data. </p>
@@ -4128,6 +4555,7 @@ export interface PredictiveScalingCustomizedCapacityMetric {
4128
4555
  */
4129
4556
  export interface PredictiveScalingCustomizedLoadMetric {
4130
4557
  /**
4558
+ * @public
4131
4559
  * <p>One or more metric data queries to provide the data points for a load metric. Use
4132
4560
  * multiple metric data queries only if you are performing a math expression on returned
4133
4561
  * data. </p>
@@ -4140,6 +4568,7 @@ export interface PredictiveScalingCustomizedLoadMetric {
4140
4568
  */
4141
4569
  export interface PredictiveScalingCustomizedScalingMetric {
4142
4570
  /**
4571
+ * @public
4143
4572
  * <p>One or more metric data queries to provide the data points for a scaling metric. Use
4144
4573
  * multiple metric data queries only if you are performing a math expression on returned
4145
4574
  * data. </p>
@@ -4169,10 +4598,12 @@ export type PredefinedLoadMetricType = (typeof PredefinedLoadMetricType)[keyof t
4169
4598
  */
4170
4599
  export interface PredictiveScalingPredefinedLoadMetric {
4171
4600
  /**
4601
+ * @public
4172
4602
  * <p>The metric type.</p>
4173
4603
  */
4174
4604
  PredefinedMetricType: PredefinedLoadMetricType | string | undefined;
4175
4605
  /**
4606
+ * @public
4176
4607
  * <p>A label that uniquely identifies a specific Application Load Balancer target group from which to determine
4177
4608
  * the request count served by your Auto Scaling group. You can't specify a resource label unless
4178
4609
  * the target group is attached to the Auto Scaling group.</p>
@@ -4217,6 +4648,7 @@ export type PredefinedMetricPairType = (typeof PredefinedMetricPairType)[keyof t
4217
4648
  */
4218
4649
  export interface PredictiveScalingPredefinedMetricPair {
4219
4650
  /**
4651
+ * @public
4220
4652
  * <p>Indicates which metrics to use. There are two different types of metrics for each
4221
4653
  * metric type: one is a load metric and one is a scaling metric. For example, if the
4222
4654
  * metric type is <code>ASGCPUUtilization</code>, the Auto Scaling group's total CPU metric is used
@@ -4224,6 +4656,7 @@ export interface PredictiveScalingPredefinedMetricPair {
4224
4656
  */
4225
4657
  PredefinedMetricType: PredefinedMetricPairType | string | undefined;
4226
4658
  /**
4659
+ * @public
4227
4660
  * <p>A label that uniquely identifies a specific Application Load Balancer target group from which to determine
4228
4661
  * the total and average request count served by your Auto Scaling group. You can't specify a
4229
4662
  * resource label unless the target group is attached to the Auto Scaling group.</p>
@@ -4271,10 +4704,12 @@ export type PredefinedScalingMetricType = (typeof PredefinedScalingMetricType)[k
4271
4704
  */
4272
4705
  export interface PredictiveScalingPredefinedScalingMetric {
4273
4706
  /**
4707
+ * @public
4274
4708
  * <p>The metric type.</p>
4275
4709
  */
4276
4710
  PredefinedMetricType: PredefinedScalingMetricType | string | undefined;
4277
4711
  /**
4712
+ * @public
4278
4713
  * <p>A label that uniquely identifies a specific Application Load Balancer target group from which to determine
4279
4714
  * the average request count served by your Auto Scaling group. You can't specify a resource label
4280
4715
  * unless the target group is attached to the Auto Scaling group.</p>
@@ -4348,6 +4783,7 @@ export interface PredictiveScalingPredefinedScalingMetric {
4348
4783
  */
4349
4784
  export interface PredictiveScalingMetricSpecification {
4350
4785
  /**
4786
+ * @public
4351
4787
  * <p>Specifies the target utilization.</p>
4352
4788
  * <note>
4353
4789
  * <p>Some metrics are based on a count instead of a percentage, such as the request
@@ -4359,27 +4795,33 @@ export interface PredictiveScalingMetricSpecification {
4359
4795
  */
4360
4796
  TargetValue: number | undefined;
4361
4797
  /**
4798
+ * @public
4362
4799
  * <p>The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the
4363
4800
  * appropriate scaling metric and load metric to use.</p>
4364
4801
  */
4365
4802
  PredefinedMetricPairSpecification?: PredictiveScalingPredefinedMetricPair;
4366
4803
  /**
4804
+ * @public
4367
4805
  * <p>The predefined scaling metric specification.</p>
4368
4806
  */
4369
4807
  PredefinedScalingMetricSpecification?: PredictiveScalingPredefinedScalingMetric;
4370
4808
  /**
4809
+ * @public
4371
4810
  * <p>The predefined load metric specification.</p>
4372
4811
  */
4373
4812
  PredefinedLoadMetricSpecification?: PredictiveScalingPredefinedLoadMetric;
4374
4813
  /**
4814
+ * @public
4375
4815
  * <p>The customized scaling metric specification.</p>
4376
4816
  */
4377
4817
  CustomizedScalingMetricSpecification?: PredictiveScalingCustomizedScalingMetric;
4378
4818
  /**
4819
+ * @public
4379
4820
  * <p>The customized load metric specification.</p>
4380
4821
  */
4381
4822
  CustomizedLoadMetricSpecification?: PredictiveScalingCustomizedLoadMetric;
4382
4823
  /**
4824
+ * @public
4383
4825
  * <p>The customized capacity metric specification.</p>
4384
4826
  */
4385
4827
  CustomizedCapacityMetricSpecification?: PredictiveScalingCustomizedCapacityMetric;
@@ -4402,6 +4844,7 @@ export type PredictiveScalingMode = (typeof PredictiveScalingMode)[keyof typeof
4402
4844
  */
4403
4845
  export interface PredictiveScalingConfiguration {
4404
4846
  /**
4847
+ * @public
4405
4848
  * <p>This structure includes the metrics and target utilization to use for predictive
4406
4849
  * scaling. </p>
4407
4850
  * <p>This is an array, but we currently only support a single metric specification. That
@@ -4410,11 +4853,13 @@ export interface PredictiveScalingConfiguration {
4410
4853
  */
4411
4854
  MetricSpecifications: PredictiveScalingMetricSpecification[] | undefined;
4412
4855
  /**
4856
+ * @public
4413
4857
  * <p>The predictive scaling mode. Defaults to <code>ForecastOnly</code> if not
4414
4858
  * specified.</p>
4415
4859
  */
4416
4860
  Mode?: PredictiveScalingMode | string;
4417
4861
  /**
4862
+ * @public
4418
4863
  * <p>The amount of time, in seconds, by which the instance launch time can be advanced. For
4419
4864
  * example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch
4420
4865
  * instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The
@@ -4426,6 +4871,7 @@ export interface PredictiveScalingConfiguration {
4426
4871
  */
4427
4872
  SchedulingBufferTime?: number;
4428
4873
  /**
4874
+ * @public
4429
4875
  * <p>Defines the behavior that should be applied if the forecast capacity approaches or
4430
4876
  * exceeds the maximum capacity of the Auto Scaling group. Defaults to
4431
4877
  * <code>HonorMaxCapacity</code> if not specified.</p>
@@ -4447,6 +4893,7 @@ export interface PredictiveScalingConfiguration {
4447
4893
  */
4448
4894
  MaxCapacityBreachBehavior?: PredictiveScalingMaxCapacityBreachBehavior | string;
4449
4895
  /**
4896
+ * @public
4450
4897
  * <p>The size of the capacity buffer to use when the forecast capacity is close to or
4451
4898
  * exceeds the maximum capacity. The value is specified as a percentage relative to the
4452
4899
  * forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,
@@ -4499,6 +4946,7 @@ export interface PredictiveScalingConfiguration {
4499
4946
  */
4500
4947
  export interface StepAdjustment {
4501
4948
  /**
4949
+ * @public
4502
4950
  * <p>The lower bound for the difference between the alarm threshold and the CloudWatch metric. If
4503
4951
  * the metric value is above the breach threshold, the lower bound is inclusive (the metric
4504
4952
  * must be greater than or equal to the threshold plus the lower bound). Otherwise, it is
@@ -4507,6 +4955,7 @@ export interface StepAdjustment {
4507
4955
  */
4508
4956
  MetricIntervalLowerBound?: number;
4509
4957
  /**
4958
+ * @public
4510
4959
  * <p>The upper bound for the difference between the alarm threshold and the CloudWatch metric. If
4511
4960
  * the metric value is above the breach threshold, the upper bound is exclusive (the metric
4512
4961
  * must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the
@@ -4516,9 +4965,10 @@ export interface StepAdjustment {
4516
4965
  */
4517
4966
  MetricIntervalUpperBound?: number;
4518
4967
  /**
4968
+ * @public
4519
4969
  * <p>The amount by which to scale, based on the specified adjustment type. A positive value
4520
- * adds to the current capacity while a negative number removes from the current
4521
- * capacity. For exact capacity, you must specify a non-negative value.</p>
4970
+ * adds to the current capacity while a negative number removes from the current capacity.
4971
+ * For exact capacity, you must specify a non-negative value.</p>
4522
4972
  */
4523
4973
  ScalingAdjustment: number | undefined;
4524
4974
  }
@@ -4531,16 +4981,19 @@ export interface StepAdjustment {
4531
4981
  */
4532
4982
  export interface TargetTrackingMetricStat {
4533
4983
  /**
4984
+ * @public
4534
4985
  * <p>The metric to use.</p>
4535
4986
  */
4536
4987
  Metric: Metric | undefined;
4537
4988
  /**
4989
+ * @public
4538
4990
  * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For
4539
4991
  * a list of valid values, see the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
4540
4992
  * <p>The most commonly used metric for scaling is <code>Average</code>.</p>
4541
4993
  */
4542
4994
  Stat: string | undefined;
4543
4995
  /**
4996
+ * @public
4544
4997
  * <p>The unit to use for the returned data points. For a complete list of the units that
4545
4998
  * CloudWatch supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a>
4546
4999
  * data type in the <i>Amazon CloudWatch API Reference</i>.</p>
@@ -4556,6 +5009,7 @@ export interface TargetTrackingMetricStat {
4556
5009
  */
4557
5010
  export interface TargetTrackingMetricDataQuery {
4558
5011
  /**
5012
+ * @public
4559
5013
  * <p>A short name that identifies the object's results in the response. This name must be
4560
5014
  * unique among all <code>TargetTrackingMetricDataQuery</code> objects specified for a
4561
5015
  * single scaling policy. If you are performing math expressions on this set of data, this
@@ -4565,6 +5019,7 @@ export interface TargetTrackingMetricDataQuery {
4565
5019
  */
4566
5020
  Id: string | undefined;
4567
5021
  /**
5022
+ * @public
4568
5023
  * <p>The math expression to perform on the returned data, if this object is performing a
4569
5024
  * math expression. This expression can use the <code>Id</code> of the other metrics to
4570
5025
  * refer to those metrics, and can also use the <code>Id</code> of other expressions to use
@@ -4574,17 +5029,20 @@ export interface TargetTrackingMetricDataQuery {
4574
5029
  */
4575
5030
  Expression?: string;
4576
5031
  /**
5032
+ * @public
4577
5033
  * <p>Information about the metric data to return.</p>
4578
5034
  * <p>Conditional: Within each <code>TargetTrackingMetricDataQuery</code> object, you must
4579
5035
  * specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
4580
5036
  */
4581
5037
  MetricStat?: TargetTrackingMetricStat;
4582
5038
  /**
5039
+ * @public
4583
5040
  * <p>A human-readable label for this metric or expression. This is especially useful if
4584
5041
  * this is a math expression, so that you know what the value represents.</p>
4585
5042
  */
4586
5043
  Label?: string;
4587
5044
  /**
5045
+ * @public
4588
5046
  * <p>Indicates whether to return the timestamps and raw data values of this metric. </p>
4589
5047
  * <p>If you use any math expressions, specify <code>true</code> for this value for only the
4590
5048
  * final math expression that the metric specification is based on. You must specify
@@ -4641,32 +5099,38 @@ export type MetricStatistic = (typeof MetricStatistic)[keyof typeof MetricStatis
4641
5099
  */
4642
5100
  export interface CustomizedMetricSpecification {
4643
5101
  /**
5102
+ * @public
4644
5103
  * <p>The name of the metric. To get the exact metric name, namespace, and dimensions,
4645
5104
  * inspect the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object
4646
5105
  * that is returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
4647
5106
  */
4648
5107
  MetricName?: string;
4649
5108
  /**
5109
+ * @public
4650
5110
  * <p>The namespace of the metric.</p>
4651
5111
  */
4652
5112
  Namespace?: string;
4653
5113
  /**
5114
+ * @public
4654
5115
  * <p>The dimensions of the metric.</p>
4655
5116
  * <p>Conditional: If you published your metric with dimensions, you must specify the same
4656
5117
  * dimensions in your scaling policy.</p>
4657
5118
  */
4658
5119
  Dimensions?: MetricDimension[];
4659
5120
  /**
5121
+ * @public
4660
5122
  * <p>The statistic of the metric.</p>
4661
5123
  */
4662
5124
  Statistic?: MetricStatistic | string;
4663
5125
  /**
5126
+ * @public
4664
5127
  * <p>The unit of the metric. For a complete list of the units that CloudWatch supports, see the
4665
5128
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a>
4666
5129
  * data type in the <i>Amazon CloudWatch API Reference</i>.</p>
4667
5130
  */
4668
5131
  Unit?: string;
4669
5132
  /**
5133
+ * @public
4670
5134
  * <p>The metrics to include in the target tracking scaling policy, as a metric data query.
4671
5135
  * This can include both raw metric and metric math expressions.</p>
4672
5136
  */
@@ -4693,6 +5157,7 @@ export type MetricType = (typeof MetricType)[keyof typeof MetricType];
4693
5157
  */
4694
5158
  export interface PredefinedMetricSpecification {
4695
5159
  /**
5160
+ * @public
4696
5161
  * <p>The metric type. The following predefined metrics are available:</p>
4697
5162
  * <ul>
4698
5163
  * <li>
@@ -4719,6 +5184,7 @@ export interface PredefinedMetricSpecification {
4719
5184
  */
4720
5185
  PredefinedMetricType: MetricType | string | undefined;
4721
5186
  /**
5187
+ * @public
4722
5188
  * <p>A label that uniquely identifies a specific Application Load Balancer target group
4723
5189
  * from which to determine the average request count served by your Auto Scaling group. You can't
4724
5190
  * specify a resource label unless the target group is attached to the Auto Scaling group.</p>
@@ -4749,16 +5215,19 @@ export interface PredefinedMetricSpecification {
4749
5215
  */
4750
5216
  export interface TargetTrackingConfiguration {
4751
5217
  /**
5218
+ * @public
4752
5219
  * <p>A predefined metric. You must specify either a predefined metric or a customized
4753
5220
  * metric.</p>
4754
5221
  */
4755
5222
  PredefinedMetricSpecification?: PredefinedMetricSpecification;
4756
5223
  /**
5224
+ * @public
4757
5225
  * <p>A customized metric. You must specify either a predefined metric or a customized
4758
5226
  * metric.</p>
4759
5227
  */
4760
5228
  CustomizedMetricSpecification?: CustomizedMetricSpecification;
4761
5229
  /**
5230
+ * @public
4762
5231
  * <p>The target value for the metric.</p>
4763
5232
  * <note>
4764
5233
  * <p>Some metrics are based on a count instead of a percentage, such as the request
@@ -4770,6 +5239,7 @@ export interface TargetTrackingConfiguration {
4770
5239
  */
4771
5240
  TargetValue: number | undefined;
4772
5241
  /**
5242
+ * @public
4773
5243
  * <p>Indicates whether scaling in by the target tracking scaling policy is disabled. If
4774
5244
  * scaling in is disabled, the target tracking scaling policy doesn't remove instances from
4775
5245
  * the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from
@@ -4783,18 +5253,22 @@ export interface TargetTrackingConfiguration {
4783
5253
  */
4784
5254
  export interface ScalingPolicy {
4785
5255
  /**
5256
+ * @public
4786
5257
  * <p>The name of the Auto Scaling group.</p>
4787
5258
  */
4788
5259
  AutoScalingGroupName?: string;
4789
5260
  /**
5261
+ * @public
4790
5262
  * <p>The name of the scaling policy.</p>
4791
5263
  */
4792
5264
  PolicyName?: string;
4793
5265
  /**
5266
+ * @public
4794
5267
  * <p>The Amazon Resource Name (ARN) of the policy.</p>
4795
5268
  */
4796
5269
  PolicyARN?: string;
4797
5270
  /**
5271
+ * @public
4798
5272
  * <p>One of the following policy types: </p>
4799
5273
  * <ul>
4800
5274
  * <li>
@@ -4823,12 +5297,14 @@ export interface ScalingPolicy {
4823
5297
  */
4824
5298
  PolicyType?: string;
4825
5299
  /**
5300
+ * @public
4826
5301
  * <p>Specifies how the scaling adjustment is interpreted (for example, an absolute number
4827
5302
  * or a percentage). The valid values are <code>ChangeInCapacity</code>,
4828
5303
  * <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
4829
5304
  */
4830
5305
  AdjustmentType?: string;
4831
5306
  /**
5307
+ * @public
4832
5308
  * @deprecated
4833
5309
  *
4834
5310
  * <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
@@ -4836,49 +5312,59 @@ export interface ScalingPolicy {
4836
5312
  */
4837
5313
  MinAdjustmentStep?: number;
4838
5314
  /**
5315
+ * @public
4839
5316
  * <p>The minimum value to scale by when the adjustment type is
4840
5317
  * <code>PercentChangeInCapacity</code>. </p>
4841
5318
  */
4842
5319
  MinAdjustmentMagnitude?: number;
4843
5320
  /**
5321
+ * @public
4844
5322
  * <p>The amount by which to scale, based on the specified adjustment type. A positive value
4845
5323
  * adds to the current capacity while a negative number removes from the current
4846
5324
  * capacity.</p>
4847
5325
  */
4848
5326
  ScalingAdjustment?: number;
4849
5327
  /**
5328
+ * @public
4850
5329
  * <p>The duration of the policy's cooldown period, in seconds.</p>
4851
5330
  */
4852
5331
  Cooldown?: number;
4853
5332
  /**
5333
+ * @public
4854
5334
  * <p>A set of adjustments that enable you to scale based on the size of the alarm
4855
5335
  * breach.</p>
4856
5336
  */
4857
5337
  StepAdjustments?: StepAdjustment[];
4858
5338
  /**
5339
+ * @public
4859
5340
  * <p>The aggregation type for the CloudWatch metrics. The valid values are <code>Minimum</code>,
4860
5341
  * <code>Maximum</code>, and <code>Average</code>.</p>
4861
5342
  */
4862
5343
  MetricAggregationType?: string;
4863
5344
  /**
5345
+ * @public
4864
5346
  * <p>The estimated time, in seconds, until a newly launched instance can contribute to the
4865
5347
  * CloudWatch metrics.</p>
4866
5348
  */
4867
5349
  EstimatedInstanceWarmup?: number;
4868
5350
  /**
5351
+ * @public
4869
5352
  * <p>The CloudWatch alarms related to the policy.</p>
4870
5353
  */
4871
5354
  Alarms?: Alarm[];
4872
5355
  /**
5356
+ * @public
4873
5357
  * <p>A target tracking scaling policy.</p>
4874
5358
  */
4875
5359
  TargetTrackingConfiguration?: TargetTrackingConfiguration;
4876
5360
  /**
5361
+ * @public
4877
5362
  * <p>Indicates whether the policy is enabled (<code>true</code>) or disabled
4878
5363
  * (<code>false</code>).</p>
4879
5364
  */
4880
5365
  Enabled?: boolean;
4881
5366
  /**
5367
+ * @public
4882
5368
  * <p>A predictive scaling policy.</p>
4883
5369
  */
4884
5370
  PredictiveScalingConfiguration?: PredictiveScalingConfiguration;
@@ -4888,10 +5374,12 @@ export interface ScalingPolicy {
4888
5374
  */
4889
5375
  export interface PoliciesType {
4890
5376
  /**
5377
+ * @public
4891
5378
  * <p>The scaling policies.</p>
4892
5379
  */
4893
5380
  ScalingPolicies?: ScalingPolicy[];
4894
5381
  /**
5382
+ * @public
4895
5383
  * <p>A string that indicates that the response contains more items than can be returned in
4896
5384
  * a single response. To receive additional items, specify this string for the
4897
5385
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -4904,6 +5392,7 @@ export interface PoliciesType {
4904
5392
  */
4905
5393
  export interface DescribeScalingActivitiesType {
4906
5394
  /**
5395
+ * @public
4907
5396
  * <p>The activity IDs of the desired scaling activities. If you omit this property, all
4908
5397
  * activities for the past six weeks are described. If unknown activities are requested,
4909
5398
  * they are ignored with no error. If you specify an Auto Scaling group, the results are limited to
@@ -4912,19 +5401,23 @@ export interface DescribeScalingActivitiesType {
4912
5401
  */
4913
5402
  ActivityIds?: string[];
4914
5403
  /**
5404
+ * @public
4915
5405
  * <p>The name of the Auto Scaling group.</p>
4916
5406
  */
4917
5407
  AutoScalingGroupName?: string;
4918
5408
  /**
5409
+ * @public
4919
5410
  * <p>Indicates whether to include scaling activity from deleted Auto Scaling groups.</p>
4920
5411
  */
4921
5412
  IncludeDeletedGroups?: boolean;
4922
5413
  /**
5414
+ * @public
4923
5415
  * <p>The maximum number of items to return with this call. The default value is
4924
5416
  * <code>100</code> and the maximum value is <code>100</code>.</p>
4925
5417
  */
4926
5418
  MaxRecords?: number;
4927
5419
  /**
5420
+ * @public
4928
5421
  * <p>The token for the next set of items to return. (You received this token from a
4929
5422
  * previous call.)</p>
4930
5423
  */
@@ -4937,6 +5430,7 @@ export interface DescribeScalingActivitiesType {
4937
5430
  */
4938
5431
  export interface ProcessType {
4939
5432
  /**
5433
+ * @public
4940
5434
  * <p>One of the following processes:</p>
4941
5435
  * <ul>
4942
5436
  * <li>
@@ -4993,6 +5487,7 @@ export interface ProcessType {
4993
5487
  */
4994
5488
  export interface ProcessesType {
4995
5489
  /**
5490
+ * @public
4996
5491
  * <p>The names of the process types.</p>
4997
5492
  */
4998
5493
  Processes?: ProcessType[];
@@ -5002,10 +5497,12 @@ export interface ProcessesType {
5002
5497
  */
5003
5498
  export interface DescribeScheduledActionsType {
5004
5499
  /**
5500
+ * @public
5005
5501
  * <p>The name of the Auto Scaling group.</p>
5006
5502
  */
5007
5503
  AutoScalingGroupName?: string;
5008
5504
  /**
5505
+ * @public
5009
5506
  * <p>The names of one or more scheduled actions. If you omit this property, all scheduled
5010
5507
  * actions are described. If you specify an unknown scheduled action, it is ignored with no
5011
5508
  * error.</p>
@@ -5013,21 +5510,25 @@ export interface DescribeScheduledActionsType {
5013
5510
  */
5014
5511
  ScheduledActionNames?: string[];
5015
5512
  /**
5513
+ * @public
5016
5514
  * <p>The earliest scheduled start time to return. If scheduled action names are provided,
5017
5515
  * this property is ignored.</p>
5018
5516
  */
5019
5517
  StartTime?: Date;
5020
5518
  /**
5519
+ * @public
5021
5520
  * <p>The latest scheduled start time to return. If scheduled action names are provided,
5022
5521
  * this property is ignored.</p>
5023
5522
  */
5024
5523
  EndTime?: Date;
5025
5524
  /**
5525
+ * @public
5026
5526
  * <p>The token for the next set of items to return. (You received this token from a
5027
5527
  * previous call.)</p>
5028
5528
  */
5029
5529
  NextToken?: string;
5030
5530
  /**
5531
+ * @public
5031
5532
  * <p>The maximum number of items to return with this call. The default value is
5032
5533
  * <code>50</code> and the maximum value is <code>100</code>.</p>
5033
5534
  */
@@ -5040,32 +5541,39 @@ export interface DescribeScheduledActionsType {
5040
5541
  */
5041
5542
  export interface ScheduledUpdateGroupAction {
5042
5543
  /**
5544
+ * @public
5043
5545
  * <p>The name of the Auto Scaling group.</p>
5044
5546
  */
5045
5547
  AutoScalingGroupName?: string;
5046
5548
  /**
5549
+ * @public
5047
5550
  * <p>The name of the scheduled action.</p>
5048
5551
  */
5049
5552
  ScheduledActionName?: string;
5050
5553
  /**
5554
+ * @public
5051
5555
  * <p>The Amazon Resource Name (ARN) of the scheduled action.</p>
5052
5556
  */
5053
5557
  ScheduledActionARN?: string;
5054
5558
  /**
5559
+ * @public
5055
5560
  * <p>This property is no longer used.</p>
5056
5561
  */
5057
5562
  Time?: Date;
5058
5563
  /**
5564
+ * @public
5059
5565
  * <p>The date and time in UTC for this action to start. For example,
5060
5566
  * <code>"2019-06-01T00:00:00Z"</code>. </p>
5061
5567
  */
5062
5568
  StartTime?: Date;
5063
5569
  /**
5570
+ * @public
5064
5571
  * <p>The date and time in UTC for the recurring schedule to end. For example,
5065
5572
  * <code>"2019-06-01T00:00:00Z"</code>. </p>
5066
5573
  */
5067
5574
  EndTime?: Date;
5068
5575
  /**
5576
+ * @public
5069
5577
  * <p>The recurring schedule for the action, in Unix cron syntax format.</p>
5070
5578
  * <p>When <code>StartTime</code> and <code>EndTime</code> are specified with
5071
5579
  * <code>Recurrence</code>, they form the boundaries of when the recurring action
@@ -5073,19 +5581,23 @@ export interface ScheduledUpdateGroupAction {
5073
5581
  */
5074
5582
  Recurrence?: string;
5075
5583
  /**
5584
+ * @public
5076
5585
  * <p>The minimum size of the Auto Scaling group.</p>
5077
5586
  */
5078
5587
  MinSize?: number;
5079
5588
  /**
5589
+ * @public
5080
5590
  * <p>The maximum size of the Auto Scaling group.</p>
5081
5591
  */
5082
5592
  MaxSize?: number;
5083
5593
  /**
5594
+ * @public
5084
5595
  * <p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled
5085
5596
  * action runs and the capacity it attempts to maintain.</p>
5086
5597
  */
5087
5598
  DesiredCapacity?: number;
5088
5599
  /**
5600
+ * @public
5089
5601
  * <p>The time zone for the cron expression.</p>
5090
5602
  */
5091
5603
  TimeZone?: string;
@@ -5095,10 +5607,12 @@ export interface ScheduledUpdateGroupAction {
5095
5607
  */
5096
5608
  export interface ScheduledActionsType {
5097
5609
  /**
5610
+ * @public
5098
5611
  * <p>The scheduled actions.</p>
5099
5612
  */
5100
5613
  ScheduledUpdateGroupActions?: ScheduledUpdateGroupAction[];
5101
5614
  /**
5615
+ * @public
5102
5616
  * <p>A string that indicates that the response contains more items than can be returned in
5103
5617
  * a single response. To receive additional items, specify this string for the
5104
5618
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -5111,16 +5625,19 @@ export interface ScheduledActionsType {
5111
5625
  */
5112
5626
  export interface DescribeTagsType {
5113
5627
  /**
5628
+ * @public
5114
5629
  * <p>One or more filters to scope the tags to return. The maximum number of filters per
5115
5630
  * filter type (for example, <code>auto-scaling-group</code>) is 1000.</p>
5116
5631
  */
5117
5632
  Filters?: Filter[];
5118
5633
  /**
5634
+ * @public
5119
5635
  * <p>The token for the next set of items to return. (You received this token from a
5120
5636
  * previous call.)</p>
5121
5637
  */
5122
5638
  NextToken?: string;
5123
5639
  /**
5640
+ * @public
5124
5641
  * <p>The maximum number of items to return with this call. The default value is
5125
5642
  * <code>50</code> and the maximum value is <code>100</code>.</p>
5126
5643
  */
@@ -5131,10 +5648,12 @@ export interface DescribeTagsType {
5131
5648
  */
5132
5649
  export interface TagsType {
5133
5650
  /**
5651
+ * @public
5134
5652
  * <p>One or more tags.</p>
5135
5653
  */
5136
5654
  Tags?: TagDescription[];
5137
5655
  /**
5656
+ * @public
5138
5657
  * <p>A string that indicates that the response contains more items than can be returned in
5139
5658
  * a single response. To receive additional items, specify this string for the
5140
5659
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -5147,6 +5666,7 @@ export interface TagsType {
5147
5666
  */
5148
5667
  export interface DescribeTerminationPolicyTypesAnswer {
5149
5668
  /**
5669
+ * @public
5150
5670
  * <p>The termination policies supported by Amazon EC2 Auto Scaling: <code>OldestInstance</code>,
5151
5671
  * <code>OldestLaunchConfiguration</code>, <code>NewestInstance</code>,
5152
5672
  * <code>ClosestToNextInstanceHour</code>, <code>Default</code>,
@@ -5159,10 +5679,12 @@ export interface DescribeTerminationPolicyTypesAnswer {
5159
5679
  */
5160
5680
  export interface DescribeTrafficSourcesRequest {
5161
5681
  /**
5682
+ * @public
5162
5683
  * <p>The name of the Auto Scaling group.</p>
5163
5684
  */
5164
5685
  AutoScalingGroupName: string | undefined;
5165
5686
  /**
5687
+ * @public
5166
5688
  * <p>The traffic source type that you want to describe.</p>
5167
5689
  * <p>The following lists the valid values:</p>
5168
5690
  * <ul>
@@ -5182,11 +5704,13 @@ export interface DescribeTrafficSourcesRequest {
5182
5704
  */
5183
5705
  TrafficSourceType?: string;
5184
5706
  /**
5707
+ * @public
5185
5708
  * <p>The token for the next set of items to return. (You received this token from a
5186
5709
  * previous call.)</p>
5187
5710
  */
5188
5711
  NextToken?: string;
5189
5712
  /**
5713
+ * @public
5190
5714
  * <p>The maximum number of items to return with this call. The maximum value is
5191
5715
  * <code>50</code>.</p>
5192
5716
  */
@@ -5198,12 +5722,14 @@ export interface DescribeTrafficSourcesRequest {
5198
5722
  */
5199
5723
  export interface TrafficSourceState {
5200
5724
  /**
5725
+ * @public
5201
5726
  * @deprecated
5202
5727
  *
5203
5728
  * <p>This is replaced by <code>Identifier</code>.</p>
5204
5729
  */
5205
5730
  TrafficSource?: string;
5206
5731
  /**
5732
+ * @public
5207
5733
  * <p>Describes the current state of a traffic source.</p>
5208
5734
  * <p>The state values are as follows:</p>
5209
5735
  * <ul>
@@ -5239,10 +5765,12 @@ export interface TrafficSourceState {
5239
5765
  */
5240
5766
  State?: string;
5241
5767
  /**
5768
+ * @public
5242
5769
  * <p>The unique identifier of the traffic source.</p>
5243
5770
  */
5244
5771
  Identifier?: string;
5245
5772
  /**
5773
+ * @public
5246
5774
  * <p>Provides additional context for the value of <code>Identifier</code>.</p>
5247
5775
  * <p>The following lists the valid values:</p>
5248
5776
  * <ul>
@@ -5270,10 +5798,12 @@ export interface TrafficSourceState {
5270
5798
  */
5271
5799
  export interface DescribeTrafficSourcesResponse {
5272
5800
  /**
5801
+ * @public
5273
5802
  * <p>Information about the traffic sources.</p>
5274
5803
  */
5275
5804
  TrafficSources?: TrafficSourceState[];
5276
5805
  /**
5806
+ * @public
5277
5807
  * <p>This string indicates that the response contains more items than can be returned in a
5278
5808
  * single response. To receive additional items, specify this string for the
5279
5809
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -5286,14 +5816,17 @@ export interface DescribeTrafficSourcesResponse {
5286
5816
  */
5287
5817
  export interface DescribeWarmPoolAnswer {
5288
5818
  /**
5819
+ * @public
5289
5820
  * <p>The warm pool configuration details. </p>
5290
5821
  */
5291
5822
  WarmPoolConfiguration?: WarmPoolConfiguration;
5292
5823
  /**
5824
+ * @public
5293
5825
  * <p>The instances that are currently in the warm pool.</p>
5294
5826
  */
5295
5827
  Instances?: Instance[];
5296
5828
  /**
5829
+ * @public
5297
5830
  * <p>This string indicates that the response contains more items than can be returned in a
5298
5831
  * single response. To receive additional items, specify this string for the
5299
5832
  * <code>NextToken</code> value when requesting the next set of items. This value is
@@ -5306,15 +5839,18 @@ export interface DescribeWarmPoolAnswer {
5306
5839
  */
5307
5840
  export interface DescribeWarmPoolType {
5308
5841
  /**
5842
+ * @public
5309
5843
  * <p>The name of the Auto Scaling group.</p>
5310
5844
  */
5311
5845
  AutoScalingGroupName: string | undefined;
5312
5846
  /**
5847
+ * @public
5313
5848
  * <p>The maximum number of instances to return with this call. The maximum value is
5314
5849
  * <code>50</code>.</p>
5315
5850
  */
5316
5851
  MaxRecords?: number;
5317
5852
  /**
5853
+ * @public
5318
5854
  * <p>The token for the next set of instances to return. (You received this token from a
5319
5855
  * previous call.)</p>
5320
5856
  */
@@ -5325,6 +5861,7 @@ export interface DescribeWarmPoolType {
5325
5861
  */
5326
5862
  export interface DetachInstancesAnswer {
5327
5863
  /**
5864
+ * @public
5328
5865
  * <p>The activities related to detaching the instances from the Auto Scaling group.</p>
5329
5866
  */
5330
5867
  Activities?: Activity[];
@@ -5334,14 +5871,17 @@ export interface DetachInstancesAnswer {
5334
5871
  */
5335
5872
  export interface DetachInstancesQuery {
5336
5873
  /**
5874
+ * @public
5337
5875
  * <p>The IDs of the instances. You can specify up to 20 instances.</p>
5338
5876
  */
5339
5877
  InstanceIds?: string[];
5340
5878
  /**
5879
+ * @public
5341
5880
  * <p>The name of the Auto Scaling group.</p>
5342
5881
  */
5343
5882
  AutoScalingGroupName: string | undefined;
5344
5883
  /**
5884
+ * @public
5345
5885
  * <p>Indicates whether the Auto Scaling group decrements the desired capacity value by the number
5346
5886
  * of instances detached.</p>
5347
5887
  */
@@ -5357,10 +5897,12 @@ export interface DetachLoadBalancersResultType {
5357
5897
  */
5358
5898
  export interface DetachLoadBalancersType {
5359
5899
  /**
5900
+ * @public
5360
5901
  * <p>The name of the Auto Scaling group.</p>
5361
5902
  */
5362
5903
  AutoScalingGroupName: string | undefined;
5363
5904
  /**
5905
+ * @public
5364
5906
  * <p>The names of the load balancers. You can specify up to 10 load balancers.</p>
5365
5907
  */
5366
5908
  LoadBalancerNames: string[] | undefined;
@@ -5375,10 +5917,12 @@ export interface DetachLoadBalancerTargetGroupsResultType {
5375
5917
  */
5376
5918
  export interface DetachLoadBalancerTargetGroupsType {
5377
5919
  /**
5920
+ * @public
5378
5921
  * <p>The name of the Auto Scaling group.</p>
5379
5922
  */
5380
5923
  AutoScalingGroupName: string | undefined;
5381
5924
  /**
5925
+ * @public
5382
5926
  * <p>The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target
5383
5927
  * groups.</p>
5384
5928
  */
@@ -5394,10 +5938,12 @@ export interface DetachTrafficSourcesResultType {
5394
5938
  */
5395
5939
  export interface DetachTrafficSourcesType {
5396
5940
  /**
5941
+ * @public
5397
5942
  * <p>The name of the Auto Scaling group.</p>
5398
5943
  */
5399
5944
  AutoScalingGroupName: string | undefined;
5400
5945
  /**
5946
+ * @public
5401
5947
  * <p>The unique identifiers of one or more traffic sources. You can specify up to 10
5402
5948
  * traffic sources.</p>
5403
5949
  */
@@ -5408,10 +5954,12 @@ export interface DetachTrafficSourcesType {
5408
5954
  */
5409
5955
  export interface DisableMetricsCollectionQuery {
5410
5956
  /**
5957
+ * @public
5411
5958
  * <p>The name of the Auto Scaling group.</p>
5412
5959
  */
5413
5960
  AutoScalingGroupName: string | undefined;
5414
5961
  /**
5962
+ * @public
5415
5963
  * <p>Identifies the metrics to disable.</p>
5416
5964
  * <p>You can specify one or more of the following metrics:</p>
5417
5965
  * <ul>
@@ -5526,10 +6074,12 @@ export interface DisableMetricsCollectionQuery {
5526
6074
  */
5527
6075
  export interface EnableMetricsCollectionQuery {
5528
6076
  /**
6077
+ * @public
5529
6078
  * <p>The name of the Auto Scaling group.</p>
5530
6079
  */
5531
6080
  AutoScalingGroupName: string | undefined;
5532
6081
  /**
6082
+ * @public
5533
6083
  * <p>Identifies the metrics to enable.</p>
5534
6084
  * <p>You can specify one or more of the following metrics:</p>
5535
6085
  * <ul>
@@ -5640,6 +6190,7 @@ export interface EnableMetricsCollectionQuery {
5640
6190
  */
5641
6191
  Metrics?: string[];
5642
6192
  /**
6193
+ * @public
5643
6194
  * <p>The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
5644
6195
  * <code>1Minute</code>.</p>
5645
6196
  */
@@ -5650,6 +6201,7 @@ export interface EnableMetricsCollectionQuery {
5650
6201
  */
5651
6202
  export interface EnterStandbyAnswer {
5652
6203
  /**
6204
+ * @public
5653
6205
  * <p>The activities related to moving instances into <code>Standby</code> mode.</p>
5654
6206
  */
5655
6207
  Activities?: Activity[];
@@ -5659,14 +6211,17 @@ export interface EnterStandbyAnswer {
5659
6211
  */
5660
6212
  export interface EnterStandbyQuery {
5661
6213
  /**
6214
+ * @public
5662
6215
  * <p>The IDs of the instances. You can specify up to 20 instances.</p>
5663
6216
  */
5664
6217
  InstanceIds?: string[];
5665
6218
  /**
6219
+ * @public
5666
6220
  * <p>The name of the Auto Scaling group.</p>
5667
6221
  */
5668
6222
  AutoScalingGroupName: string | undefined;
5669
6223
  /**
6224
+ * @public
5670
6225
  * <p>Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of
5671
6226
  * instances moved to <code>Standby</code> mode.</p>
5672
6227
  */
@@ -5677,14 +6232,17 @@ export interface EnterStandbyQuery {
5677
6232
  */
5678
6233
  export interface ExecutePolicyType {
5679
6234
  /**
6235
+ * @public
5680
6236
  * <p>The name of the Auto Scaling group.</p>
5681
6237
  */
5682
6238
  AutoScalingGroupName?: string;
5683
6239
  /**
6240
+ * @public
5684
6241
  * <p>The name or ARN of the policy.</p>
5685
6242
  */
5686
6243
  PolicyName: string | undefined;
5687
6244
  /**
6245
+ * @public
5688
6246
  * <p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing
5689
6247
  * the policy.</p>
5690
6248
  * <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see
@@ -5693,6 +6251,7 @@ export interface ExecutePolicyType {
5693
6251
  */
5694
6252
  HonorCooldown?: boolean;
5695
6253
  /**
6254
+ * @public
5696
6255
  * <p>The metric value to compare to <code>BreachThreshold</code>. This enables you to
5697
6256
  * execute a policy of type <code>StepScaling</code> and determine which step adjustment to
5698
6257
  * use. For example, if the breach threshold is 50 and you want to use a step adjustment
@@ -5705,6 +6264,7 @@ export interface ExecutePolicyType {
5705
6264
  */
5706
6265
  MetricValue?: number;
5707
6266
  /**
6267
+ * @public
5708
6268
  * <p>The breach threshold for the alarm.</p>
5709
6269
  * <p>Required if the policy type is <code>StepScaling</code> and not supported
5710
6270
  * otherwise.</p>
@@ -5716,6 +6276,7 @@ export interface ExecutePolicyType {
5716
6276
  */
5717
6277
  export interface ExitStandbyAnswer {
5718
6278
  /**
6279
+ * @public
5719
6280
  * <p>The activities related to moving instances out of <code>Standby</code> mode.</p>
5720
6281
  */
5721
6282
  Activities?: Activity[];
@@ -5725,10 +6286,12 @@ export interface ExitStandbyAnswer {
5725
6286
  */
5726
6287
  export interface ExitStandbyQuery {
5727
6288
  /**
6289
+ * @public
5728
6290
  * <p>The IDs of the instances. You can specify up to 20 instances.</p>
5729
6291
  */
5730
6292
  InstanceIds?: string[];
5731
6293
  /**
6294
+ * @public
5732
6295
  * <p>The name of the Auto Scaling group.</p>
5733
6296
  */
5734
6297
  AutoScalingGroupName: string | undefined;
@@ -5741,10 +6304,12 @@ export interface ExitStandbyQuery {
5741
6304
  */
5742
6305
  export interface CapacityForecast {
5743
6306
  /**
6307
+ * @public
5744
6308
  * <p>The timestamps for the data points, in UTC format.</p>
5745
6309
  */
5746
6310
  Timestamps: Date[] | undefined;
5747
6311
  /**
6312
+ * @public
5748
6313
  * <p>The values of the data points.</p>
5749
6314
  */
5750
6315
  Values: number[] | undefined;
@@ -5758,14 +6323,17 @@ export interface CapacityForecast {
5758
6323
  */
5759
6324
  export interface LoadForecast {
5760
6325
  /**
6326
+ * @public
5761
6327
  * <p>The timestamps for the data points, in UTC format.</p>
5762
6328
  */
5763
6329
  Timestamps: Date[] | undefined;
5764
6330
  /**
6331
+ * @public
5765
6332
  * <p>The values of the data points.</p>
5766
6333
  */
5767
6334
  Values: number[] | undefined;
5768
6335
  /**
6336
+ * @public
5769
6337
  * <p>The metric specification for the load forecast.</p>
5770
6338
  */
5771
6339
  MetricSpecification: PredictiveScalingMetricSpecification | undefined;
@@ -5775,14 +6343,17 @@ export interface LoadForecast {
5775
6343
  */
5776
6344
  export interface GetPredictiveScalingForecastAnswer {
5777
6345
  /**
6346
+ * @public
5778
6347
  * <p>The load forecast.</p>
5779
6348
  */
5780
6349
  LoadForecast: LoadForecast[] | undefined;
5781
6350
  /**
6351
+ * @public
5782
6352
  * <p>The capacity forecast.</p>
5783
6353
  */
5784
6354
  CapacityForecast: CapacityForecast | undefined;
5785
6355
  /**
6356
+ * @public
5786
6357
  * <p>The time the forecast was made.</p>
5787
6358
  */
5788
6359
  UpdateTime: Date | undefined;
@@ -5792,19 +6363,23 @@ export interface GetPredictiveScalingForecastAnswer {
5792
6363
  */
5793
6364
  export interface GetPredictiveScalingForecastType {
5794
6365
  /**
6366
+ * @public
5795
6367
  * <p>The name of the Auto Scaling group.</p>
5796
6368
  */
5797
6369
  AutoScalingGroupName: string | undefined;
5798
6370
  /**
6371
+ * @public
5799
6372
  * <p>The name of the policy.</p>
5800
6373
  */
5801
6374
  PolicyName: string | undefined;
5802
6375
  /**
6376
+ * @public
5803
6377
  * <p>The inclusive start time of the time range for the forecast data to get. At most, the
5804
6378
  * date and time can be one year before the current date and time.</p>
5805
6379
  */
5806
6380
  StartTime: Date | undefined;
5807
6381
  /**
6382
+ * @public
5808
6383
  * <p>The exclusive end time of the time range for the forecast data to get. The maximum
5809
6384
  * time duration between the start and end time is 30 days. </p>
5810
6385
  * <p>Although this parameter can accept a date and time that is more than two days in the
@@ -5823,14 +6398,17 @@ export interface PutLifecycleHookAnswer {
5823
6398
  */
5824
6399
  export interface PutLifecycleHookType {
5825
6400
  /**
6401
+ * @public
5826
6402
  * <p>The name of the lifecycle hook.</p>
5827
6403
  */
5828
6404
  LifecycleHookName: string | undefined;
5829
6405
  /**
6406
+ * @public
5830
6407
  * <p>The name of the Auto Scaling group.</p>
5831
6408
  */
5832
6409
  AutoScalingGroupName: string | undefined;
5833
6410
  /**
6411
+ * @public
5834
6412
  * <p>The lifecycle transition. For Auto Scaling groups, there are two major lifecycle
5835
6413
  * transitions.</p>
5836
6414
  * <ul>
@@ -5847,6 +6425,7 @@ export interface PutLifecycleHookType {
5847
6425
  */
5848
6426
  LifecycleTransition?: string;
5849
6427
  /**
6428
+ * @public
5850
6429
  * <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
5851
6430
  * notification target.</p>
5852
6431
  * <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required
@@ -5854,6 +6433,7 @@ export interface PutLifecycleHookType {
5854
6433
  */
5855
6434
  RoleARN?: string;
5856
6435
  /**
6436
+ * @public
5857
6437
  * <p>The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify
5858
6438
  * you when an instance is in a wait state for the lifecycle hook. You can specify either
5859
6439
  * an Amazon SNS topic or an Amazon SQS queue.</p>
@@ -5866,17 +6446,20 @@ export interface PutLifecycleHookType {
5866
6446
  */
5867
6447
  NotificationTargetARN?: string;
5868
6448
  /**
6449
+ * @public
5869
6450
  * <p>Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to
5870
6451
  * the notification target.</p>
5871
6452
  */
5872
6453
  NotificationMetadata?: string;
5873
6454
  /**
6455
+ * @public
5874
6456
  * <p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. The
5875
6457
  * range is from <code>30</code> to <code>7200</code> seconds. The default value is
5876
6458
  * <code>3600</code> seconds (1 hour).</p>
5877
6459
  */
5878
6460
  HeartbeatTimeout?: number;
5879
6461
  /**
6462
+ * @public
5880
6463
  * <p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an
5881
6464
  * unexpected failure occurs. The default value is <code>ABANDON</code>.</p>
5882
6465
  * <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code>
@@ -5889,14 +6472,17 @@ export interface PutLifecycleHookType {
5889
6472
  */
5890
6473
  export interface PutNotificationConfigurationType {
5891
6474
  /**
6475
+ * @public
5892
6476
  * <p>The name of the Auto Scaling group.</p>
5893
6477
  */
5894
6478
  AutoScalingGroupName: string | undefined;
5895
6479
  /**
6480
+ * @public
5896
6481
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic.</p>
5897
6482
  */
5898
6483
  TopicARN: string | undefined;
5899
6484
  /**
6485
+ * @public
5900
6486
  * <p>The type of event that causes the notification to be sent. To query the notification
5901
6487
  * types supported by Amazon EC2 Auto Scaling, call the <a>DescribeAutoScalingNotificationTypes</a> API.</p>
5902
6488
  */
@@ -5908,10 +6494,12 @@ export interface PutNotificationConfigurationType {
5908
6494
  */
5909
6495
  export interface PolicyARNType {
5910
6496
  /**
6497
+ * @public
5911
6498
  * <p>The Amazon Resource Name (ARN) of the policy.</p>
5912
6499
  */
5913
6500
  PolicyARN?: string;
5914
6501
  /**
6502
+ * @public
5915
6503
  * <p>The CloudWatch alarms created for the target tracking scaling policy.</p>
5916
6504
  */
5917
6505
  Alarms?: Alarm[];
@@ -5921,14 +6509,17 @@ export interface PolicyARNType {
5921
6509
  */
5922
6510
  export interface PutScalingPolicyType {
5923
6511
  /**
6512
+ * @public
5924
6513
  * <p>The name of the Auto Scaling group.</p>
5925
6514
  */
5926
6515
  AutoScalingGroupName: string | undefined;
5927
6516
  /**
6517
+ * @public
5928
6518
  * <p>The name of the policy.</p>
5929
6519
  */
5930
6520
  PolicyName: string | undefined;
5931
6521
  /**
6522
+ * @public
5932
6523
  * <p>One of the following policy types: </p>
5933
6524
  * <ul>
5934
6525
  * <li>
@@ -5954,6 +6545,7 @@ export interface PutScalingPolicyType {
5954
6545
  */
5955
6546
  PolicyType?: string;
5956
6547
  /**
6548
+ * @public
5957
6549
  * <p>Specifies how the scaling adjustment is interpreted (for example, an absolute number
5958
6550
  * or a percentage). The valid values are <code>ChangeInCapacity</code>,
5959
6551
  * <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
@@ -5962,6 +6554,7 @@ export interface PutScalingPolicyType {
5962
6554
  */
5963
6555
  AdjustmentType?: string;
5964
6556
  /**
6557
+ * @public
5965
6558
  * @deprecated
5966
6559
  *
5967
6560
  * <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
@@ -5969,6 +6562,7 @@ export interface PutScalingPolicyType {
5969
6562
  */
5970
6563
  MinAdjustmentStep?: number;
5971
6564
  /**
6565
+ * @public
5972
6566
  * <p>The minimum value to scale by when the adjustment type is
5973
6567
  * <code>PercentChangeInCapacity</code>. For example, suppose that you create a step
5974
6568
  * scaling policy to scale out an Auto Scaling group by 25 percent and you specify a
@@ -5987,6 +6581,7 @@ export interface PutScalingPolicyType {
5987
6581
  */
5988
6582
  MinAdjustmentMagnitude?: number;
5989
6583
  /**
6584
+ * @public
5990
6585
  * <p>The amount by which to scale, based on the specified adjustment type. A positive value
5991
6586
  * adds to the current capacity while a negative number removes from the current capacity.
5992
6587
  * For exact capacity, you must specify a non-negative value.</p>
@@ -5995,6 +6590,7 @@ export interface PutScalingPolicyType {
5995
6590
  */
5996
6591
  ScalingAdjustment?: number;
5997
6592
  /**
6593
+ * @public
5998
6594
  * <p>A cooldown period, in seconds, that applies to a specific simple scaling policy. When
5999
6595
  * a cooldown period is specified here, it overrides the default cooldown.</p>
6000
6596
  * <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see
@@ -6004,6 +6600,7 @@ export interface PutScalingPolicyType {
6004
6600
  */
6005
6601
  Cooldown?: number;
6006
6602
  /**
6603
+ * @public
6007
6604
  * <p>The aggregation type for the CloudWatch metrics. The valid values are <code>Minimum</code>,
6008
6605
  * <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the
6009
6606
  * value is treated as <code>Average</code>.</p>
@@ -6011,6 +6608,7 @@ export interface PutScalingPolicyType {
6011
6608
  */
6012
6609
  MetricAggregationType?: string;
6013
6610
  /**
6611
+ * @public
6014
6612
  * <p>A set of adjustments that enable you to scale based on the size of the alarm
6015
6613
  * breach.</p>
6016
6614
  * <p>Required if the policy type is <code>StepScaling</code>. (Not used with any other
@@ -6018,6 +6616,7 @@ export interface PutScalingPolicyType {
6018
6616
  */
6019
6617
  StepAdjustments?: StepAdjustment[];
6020
6618
  /**
6619
+ * @public
6021
6620
  * <p>
6022
6621
  * <i>Not needed if the default instance warmup is defined for the
6023
6622
  * group.</i>
@@ -6036,6 +6635,7 @@ export interface PutScalingPolicyType {
6036
6635
  */
6037
6636
  EstimatedInstanceWarmup?: number;
6038
6637
  /**
6638
+ * @public
6039
6639
  * <p>A target tracking scaling policy. Provides support for predefined or custom
6040
6640
  * metrics.</p>
6041
6641
  * <p>The following predefined metrics are available:</p>
@@ -6070,6 +6670,7 @@ export interface PutScalingPolicyType {
6070
6670
  */
6071
6671
  TargetTrackingConfiguration?: TargetTrackingConfiguration;
6072
6672
  /**
6673
+ * @public
6073
6674
  * <p>Indicates whether the scaling policy is enabled or disabled. The default is enabled.
6074
6675
  * For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html">Disabling a
6075
6676
  * scaling policy for an Auto Scaling group</a> in the
@@ -6077,6 +6678,7 @@ export interface PutScalingPolicyType {
6077
6678
  */
6078
6679
  Enabled?: boolean;
6079
6680
  /**
6681
+ * @public
6080
6682
  * <p>A predictive scaling policy. Provides support for predefined and custom
6081
6683
  * metrics.</p>
6082
6684
  * <p>Predefined metrics include CPU utilization, network in/out, and the Application Load
@@ -6092,18 +6694,22 @@ export interface PutScalingPolicyType {
6092
6694
  */
6093
6695
  export interface PutScheduledUpdateGroupActionType {
6094
6696
  /**
6697
+ * @public
6095
6698
  * <p>The name of the Auto Scaling group.</p>
6096
6699
  */
6097
6700
  AutoScalingGroupName: string | undefined;
6098
6701
  /**
6702
+ * @public
6099
6703
  * <p>The name of this scaling action.</p>
6100
6704
  */
6101
6705
  ScheduledActionName: string | undefined;
6102
6706
  /**
6707
+ * @public
6103
6708
  * <p>This property is no longer used.</p>
6104
6709
  */
6105
6710
  Time?: Date;
6106
6711
  /**
6712
+ * @public
6107
6713
  * <p>The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT
6108
6714
  * only and in quotes (for example, <code>"2021-06-01T00:00:00Z"</code>).</p>
6109
6715
  * <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs
@@ -6112,11 +6718,13 @@ export interface PutScheduledUpdateGroupActionType {
6112
6718
  */
6113
6719
  StartTime?: Date;
6114
6720
  /**
6721
+ * @public
6115
6722
  * <p>The date and time for the recurring schedule to end, in UTC. For example,
6116
6723
  * <code>"2021-06-01T00:00:00Z"</code>.</p>
6117
6724
  */
6118
6725
  EndTime?: Date;
6119
6726
  /**
6727
+ * @public
6120
6728
  * <p>The recurring schedule for this action. This format consists of five fields separated
6121
6729
  * by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value
6122
6730
  * must be in quotes (for example, <code>"30 0 1 1,6,12 *"</code>). For more information
@@ -6128,14 +6736,17 @@ export interface PutScheduledUpdateGroupActionType {
6128
6736
  */
6129
6737
  Recurrence?: string;
6130
6738
  /**
6739
+ * @public
6131
6740
  * <p>The minimum size of the Auto Scaling group.</p>
6132
6741
  */
6133
6742
  MinSize?: number;
6134
6743
  /**
6744
+ * @public
6135
6745
  * <p>The maximum size of the Auto Scaling group.</p>
6136
6746
  */
6137
6747
  MaxSize?: number;
6138
6748
  /**
6749
+ * @public
6139
6750
  * <p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled
6140
6751
  * action runs and the capacity it attempts to maintain. It can scale beyond this capacity
6141
6752
  * if you add more scaling conditions. </p>
@@ -6146,6 +6757,7 @@ export interface PutScheduledUpdateGroupActionType {
6146
6757
  */
6147
6758
  DesiredCapacity?: number;
6148
6759
  /**
6760
+ * @public
6149
6761
  * <p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is
6150
6762
  * used by default. </p>
6151
6763
  * <p>Valid values are the canonical names of the IANA time zones, derived from the IANA
@@ -6164,10 +6776,12 @@ export interface PutWarmPoolAnswer {
6164
6776
  */
6165
6777
  export interface PutWarmPoolType {
6166
6778
  /**
6779
+ * @public
6167
6780
  * <p>The name of the Auto Scaling group.</p>
6168
6781
  */
6169
6782
  AutoScalingGroupName: string | undefined;
6170
6783
  /**
6784
+ * @public
6171
6785
  * <p>Specifies the maximum number of instances that are allowed to be in the warm pool or
6172
6786
  * in any state except <code>Terminated</code> for the Auto Scaling group. This is an optional
6173
6787
  * property. Specify it only if you do not want the warm pool size to be determined by the
@@ -6189,17 +6803,20 @@ export interface PutWarmPoolType {
6189
6803
  */
6190
6804
  MaxGroupPreparedCapacity?: number;
6191
6805
  /**
6806
+ * @public
6192
6807
  * <p>Specifies the minimum number of instances to maintain in the warm pool. This helps you
6193
6808
  * to ensure that there is always a certain number of warmed instances available to handle
6194
6809
  * traffic spikes. Defaults to 0 if not specified.</p>
6195
6810
  */
6196
6811
  MinSize?: number;
6197
6812
  /**
6813
+ * @public
6198
6814
  * <p>Sets the instance state to transition to after the lifecycle actions are complete.
6199
6815
  * Default is <code>Stopped</code>.</p>
6200
6816
  */
6201
6817
  PoolState?: WarmPoolState | string;
6202
6818
  /**
6819
+ * @public
6203
6820
  * <p>Indicates whether instances in the Auto Scaling group can be returned to the warm pool on
6204
6821
  * scale in. The default is to terminate instances in the Auto Scaling group when the group scales
6205
6822
  * in.</p>
@@ -6216,20 +6833,24 @@ export interface RecordLifecycleActionHeartbeatAnswer {
6216
6833
  */
6217
6834
  export interface RecordLifecycleActionHeartbeatType {
6218
6835
  /**
6836
+ * @public
6219
6837
  * <p>The name of the lifecycle hook.</p>
6220
6838
  */
6221
6839
  LifecycleHookName: string | undefined;
6222
6840
  /**
6841
+ * @public
6223
6842
  * <p>The name of the Auto Scaling group.</p>
6224
6843
  */
6225
6844
  AutoScalingGroupName: string | undefined;
6226
6845
  /**
6846
+ * @public
6227
6847
  * <p>A token that uniquely identifies a specific lifecycle action associated with an
6228
6848
  * instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when
6229
6849
  * you created the lifecycle hook.</p>
6230
6850
  */
6231
6851
  LifecycleActionToken?: string;
6232
6852
  /**
6853
+ * @public
6233
6854
  * <p>The ID of the instance.</p>
6234
6855
  */
6235
6856
  InstanceId?: string;
@@ -6239,10 +6860,12 @@ export interface RecordLifecycleActionHeartbeatType {
6239
6860
  */
6240
6861
  export interface ScalingProcessQuery {
6241
6862
  /**
6863
+ * @public
6242
6864
  * <p>The name of the Auto Scaling group.</p>
6243
6865
  */
6244
6866
  AutoScalingGroupName: string | undefined;
6245
6867
  /**
6868
+ * @public
6246
6869
  * <p>One or more of the following processes:</p>
6247
6870
  * <ul>
6248
6871
  * <li>
@@ -6315,6 +6938,7 @@ export declare class IrreversibleInstanceRefreshFault extends __BaseException {
6315
6938
  */
6316
6939
  export interface RollbackInstanceRefreshAnswer {
6317
6940
  /**
6941
+ * @public
6318
6942
  * <p>The instance refresh ID associated with the request. This is the unique ID assigned to
6319
6943
  * the instance refresh when it was started.</p>
6320
6944
  */
@@ -6325,6 +6949,7 @@ export interface RollbackInstanceRefreshAnswer {
6325
6949
  */
6326
6950
  export interface RollbackInstanceRefreshType {
6327
6951
  /**
6952
+ * @public
6328
6953
  * <p>The name of the Auto Scaling group.</p>
6329
6954
  */
6330
6955
  AutoScalingGroupName: string | undefined;
@@ -6334,15 +6959,18 @@ export interface RollbackInstanceRefreshType {
6334
6959
  */
6335
6960
  export interface SetDesiredCapacityType {
6336
6961
  /**
6962
+ * @public
6337
6963
  * <p>The name of the Auto Scaling group.</p>
6338
6964
  */
6339
6965
  AutoScalingGroupName: string | undefined;
6340
6966
  /**
6967
+ * @public
6341
6968
  * <p>The desired capacity is the initial capacity of the Auto Scaling group after this operation
6342
6969
  * completes and the capacity it attempts to maintain.</p>
6343
6970
  */
6344
6971
  DesiredCapacity: number | undefined;
6345
6972
  /**
6973
+ * @public
6346
6974
  * <p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating
6347
6975
  * a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does
6348
6976
  * not honor the cooldown period during manual scaling activities.</p>
@@ -6354,16 +6982,19 @@ export interface SetDesiredCapacityType {
6354
6982
  */
6355
6983
  export interface SetInstanceHealthQuery {
6356
6984
  /**
6985
+ * @public
6357
6986
  * <p>The ID of the instance.</p>
6358
6987
  */
6359
6988
  InstanceId: string | undefined;
6360
6989
  /**
6990
+ * @public
6361
6991
  * <p>The health status of the instance. Set to <code>Healthy</code> to have the instance
6362
6992
  * remain in service. Set to <code>Unhealthy</code> to have the instance be out of service.
6363
6993
  * Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.</p>
6364
6994
  */
6365
6995
  HealthStatus: string | undefined;
6366
6996
  /**
6997
+ * @public
6367
6998
  * <p>If the Auto Scaling group of the specified instance has a <code>HealthCheckGracePeriod</code>
6368
6999
  * specified for the group, by default, this call respects the grace period. Set this to
6369
7000
  * <code>False</code>, to have the call not respect the grace period associated with
@@ -6384,14 +7015,17 @@ export interface SetInstanceProtectionAnswer {
6384
7015
  */
6385
7016
  export interface SetInstanceProtectionQuery {
6386
7017
  /**
7018
+ * @public
6387
7019
  * <p>One or more instance IDs. You can specify up to 50 instances.</p>
6388
7020
  */
6389
7021
  InstanceIds: string[] | undefined;
6390
7022
  /**
7023
+ * @public
6391
7024
  * <p>The name of the Auto Scaling group.</p>
6392
7025
  */
6393
7026
  AutoScalingGroupName: string | undefined;
6394
7027
  /**
7028
+ * @public
6395
7029
  * <p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling
6396
7030
  * in.</p>
6397
7031
  */
@@ -6415,6 +7049,7 @@ export declare class InstanceRefreshInProgressFault extends __BaseException {
6415
7049
  */
6416
7050
  export interface StartInstanceRefreshAnswer {
6417
7051
  /**
7052
+ * @public
6418
7053
  * <p>A unique ID for tracking the progress of the instance refresh.</p>
6419
7054
  */
6420
7055
  InstanceRefreshId?: string;
@@ -6435,15 +7070,18 @@ export type RefreshStrategy = (typeof RefreshStrategy)[keyof typeof RefreshStrat
6435
7070
  */
6436
7071
  export interface StartInstanceRefreshType {
6437
7072
  /**
7073
+ * @public
6438
7074
  * <p>The name of the Auto Scaling group.</p>
6439
7075
  */
6440
7076
  AutoScalingGroupName: string | undefined;
6441
7077
  /**
7078
+ * @public
6442
7079
  * <p>The strategy to use for the instance refresh. The only valid value is
6443
7080
  * <code>Rolling</code>.</p>
6444
7081
  */
6445
7082
  Strategy?: RefreshStrategy | string;
6446
7083
  /**
7084
+ * @public
6447
7085
  * <p>The desired configuration. For example, the desired configuration can specify a new
6448
7086
  * launch template or a new version of the current launch template.</p>
6449
7087
  * <p>Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to
@@ -6459,6 +7097,7 @@ export interface StartInstanceRefreshType {
6459
7097
  */
6460
7098
  DesiredConfiguration?: DesiredConfiguration;
6461
7099
  /**
7100
+ * @public
6462
7101
  * <p>Sets your preferences for the instance refresh so that it performs as expected when
6463
7102
  * you start it. Includes the instance warmup time, the minimum healthy percentage, and the
6464
7103
  * behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in <code>Standby</code>
@@ -6472,6 +7111,9 @@ export interface StartInstanceRefreshType {
6472
7111
  * <p>Checkpoints</p>
6473
7112
  * </li>
6474
7113
  * <li>
7114
+ * <p>CloudWatch alarms</p>
7115
+ * </li>
7116
+ * <li>
6475
7117
  * <p>Skip matching</p>
6476
7118
  * </li>
6477
7119
  * </ul>
@@ -6483,10 +7125,12 @@ export interface StartInstanceRefreshType {
6483
7125
  */
6484
7126
  export interface TerminateInstanceInAutoScalingGroupType {
6485
7127
  /**
7128
+ * @public
6486
7129
  * <p>The ID of the instance.</p>
6487
7130
  */
6488
7131
  InstanceId: string | undefined;
6489
7132
  /**
7133
+ * @public
6490
7134
  * <p>Indicates whether terminating the instance also decrements the size of the Auto Scaling
6491
7135
  * group.</p>
6492
7136
  */
@@ -6497,32 +7141,38 @@ export interface TerminateInstanceInAutoScalingGroupType {
6497
7141
  */
6498
7142
  export interface UpdateAutoScalingGroupType {
6499
7143
  /**
7144
+ * @public
6500
7145
  * <p>The name of the Auto Scaling group.</p>
6501
7146
  */
6502
7147
  AutoScalingGroupName: string | undefined;
6503
7148
  /**
7149
+ * @public
6504
7150
  * <p>The name of the launch configuration. If you specify
6505
7151
  * <code>LaunchConfigurationName</code> in your update request, you can't specify
6506
7152
  * <code>LaunchTemplate</code> or <code>MixedInstancesPolicy</code>.</p>
6507
7153
  */
6508
7154
  LaunchConfigurationName?: string;
6509
7155
  /**
7156
+ * @public
6510
7157
  * <p>The launch template and version to use to specify the updates. If you specify
6511
7158
  * <code>LaunchTemplate</code> in your update request, you can't specify
6512
7159
  * <code>LaunchConfigurationName</code> or <code>MixedInstancesPolicy</code>.</p>
6513
7160
  */
6514
7161
  LaunchTemplate?: LaunchTemplateSpecification;
6515
7162
  /**
7163
+ * @public
6516
7164
  * <p>The mixed instances policy. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling
6517
7165
  * groups with multiple instance types and purchase options</a> in the
6518
7166
  * <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
6519
7167
  */
6520
7168
  MixedInstancesPolicy?: MixedInstancesPolicy;
6521
7169
  /**
7170
+ * @public
6522
7171
  * <p>The minimum size of the Auto Scaling group.</p>
6523
7172
  */
6524
7173
  MinSize?: number;
6525
7174
  /**
7175
+ * @public
6526
7176
  * <p>The maximum size of the Auto Scaling group.</p>
6527
7177
  * <note>
6528
7178
  * <p>With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to
@@ -6534,6 +7184,7 @@ export interface UpdateAutoScalingGroupType {
6534
7184
  */
6535
7185
  MaxSize?: number;
6536
7186
  /**
7187
+ * @public
6537
7188
  * <p>The desired capacity is the initial capacity of the Auto Scaling group after this operation
6538
7189
  * completes and the capacity it attempts to maintain. This number must be greater than or
6539
7190
  * equal to the minimum size of the group and less than or equal to the maximum size of the
@@ -6541,6 +7192,7 @@ export interface UpdateAutoScalingGroupType {
6541
7192
  */
6542
7193
  DesiredCapacity?: number;
6543
7194
  /**
7195
+ * @public
6544
7196
  * <p>
6545
7197
  * <i>Only needed if you use simple scaling policies.</i>
6546
7198
  * </p>
@@ -6550,10 +7202,12 @@ export interface UpdateAutoScalingGroupType {
6550
7202
  */
6551
7203
  DefaultCooldown?: number;
6552
7204
  /**
7205
+ * @public
6553
7206
  * <p>One or more Availability Zones for the group.</p>
6554
7207
  */
6555
7208
  AvailabilityZones?: string[];
6556
7209
  /**
7210
+ * @public
6557
7211
  * <p>A comma-separated value string of one or more health check types.</p>
6558
7212
  * <p>The valid values are <code>EC2</code>, <code>ELB</code>, and <code>VPC_LATTICE</code>.
6559
7213
  * <code>EC2</code> is the default health check and cannot be disabled. For more
@@ -6564,6 +7218,7 @@ export interface UpdateAutoScalingGroupType {
6564
7218
  */
6565
7219
  HealthCheckType?: string;
6566
7220
  /**
7221
+ * @public
6567
7222
  * <p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
6568
7223
  * of an EC2 instance that has come into service and marking it unhealthy due to a failed
6569
7224
  * health check. This is useful if your instances do not immediately pass their health
@@ -6574,6 +7229,7 @@ export interface UpdateAutoScalingGroupType {
6574
7229
  */
6575
7230
  HealthCheckGracePeriod?: number;
6576
7231
  /**
7232
+ * @public
6577
7233
  * <p>The name of an existing placement group into which to launch your instances. For more
6578
7234
  * information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the
6579
7235
  * <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
@@ -6585,12 +7241,14 @@ export interface UpdateAutoScalingGroupType {
6585
7241
  */
6586
7242
  PlacementGroup?: string;
6587
7243
  /**
7244
+ * @public
6588
7245
  * <p>A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify
6589
7246
  * <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, the subnets that
6590
7247
  * you specify must reside in those Availability Zones.</p>
6591
7248
  */
6592
7249
  VPCZoneIdentifier?: string;
6593
7250
  /**
7251
+ * @public
6594
7252
  * <p>A policy or a list of policies that are used to select the instances to terminate. The
6595
7253
  * policies are executed in the order that you list them. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
6596
7254
  * Amazon EC2 Auto Scaling termination policies</a> in the
@@ -6604,6 +7262,7 @@ export interface UpdateAutoScalingGroupType {
6604
7262
  */
6605
7263
  TerminationPolicies?: string[];
6606
7264
  /**
7265
+ * @public
6607
7266
  * <p>Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling
6608
7267
  * when scaling in. For more information about preventing instances from terminating on
6609
7268
  * scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Using
@@ -6612,12 +7271,14 @@ export interface UpdateAutoScalingGroupType {
6612
7271
  */
6613
7272
  NewInstancesProtectedFromScaleIn?: boolean;
6614
7273
  /**
7274
+ * @public
6615
7275
  * <p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to
6616
7276
  * call other Amazon Web Services on your behalf. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html">Service-linked
6617
7277
  * roles</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
6618
7278
  */
6619
7279
  ServiceLinkedRoleARN?: string;
6620
7280
  /**
7281
+ * @public
6621
7282
  * <p>The maximum amount of time, in seconds, that an instance can be in service. The
6622
7283
  * default is null. If specified, the value must be either 0 or a number equal to or
6623
7284
  * greater than 86,400 seconds (1 day). To clear a previously set value, specify a new
@@ -6627,15 +7288,18 @@ export interface UpdateAutoScalingGroupType {
6627
7288
  */
6628
7289
  MaxInstanceLifetime?: number;
6629
7290
  /**
7291
+ * @public
6630
7292
  * <p>Enables or disables Capacity Rebalancing. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html">Use Capacity
6631
7293
  * Rebalancing to handle Amazon EC2 Spot Interruptions</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
6632
7294
  */
6633
7295
  CapacityRebalance?: boolean;
6634
7296
  /**
7297
+ * @public
6635
7298
  * <p>Reserved.</p>
6636
7299
  */
6637
7300
  Context?: string;
6638
7301
  /**
7302
+ * @public
6639
7303
  * <p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling
6640
7304
  * supports <code>DesiredCapacityType</code> for attribute-based instance type selection
6641
7305
  * only. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html">Creating
@@ -6648,6 +7312,7 @@ export interface UpdateAutoScalingGroupType {
6648
7312
  */
6649
7313
  DesiredCapacityType?: string;
6650
7314
  /**
7315
+ * @public
6651
7316
  * <p>The amount of time, in seconds, until a new instance is considered to have finished
6652
7317
  * initializing and resource consumption to become stable after it enters the
6653
7318
  * <code>InService</code> state. </p>