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