@aws-sdk/client-auto-scaling 3.224.0 → 3.227.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.
- package/dist-cjs/AutoScaling.js +45 -0
- package/dist-cjs/commands/AttachTrafficSourcesCommand.js +46 -0
- package/dist-cjs/commands/DescribeTrafficSourcesCommand.js +46 -0
- package/dist-cjs/commands/DetachTrafficSourcesCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +1 -10
- package/dist-cjs/models/models_0.js +45 -4
- package/dist-cjs/protocols/Aws_query.js +420 -3
- package/dist-es/AutoScaling.js +45 -0
- package/dist-es/commands/AttachTrafficSourcesCommand.js +42 -0
- package/dist-es/commands/DescribeTrafficSourcesCommand.js +42 -0
- package/dist-es/commands/DetachTrafficSourcesCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +1 -10
- package/dist-es/models/models_0.js +30 -0
- package/dist-es/protocols/Aws_query.js +411 -0
- package/dist-types/AutoScaling.d.ts +217 -183
- package/dist-types/AutoScalingClient.d.ts +7 -17
- package/dist-types/commands/AttachInstancesCommand.d.ts +3 -3
- package/dist-types/commands/AttachLoadBalancerTargetGroupsCommand.d.ts +8 -8
- package/dist-types/commands/AttachLoadBalancersCommand.d.ts +5 -5
- package/dist-types/commands/AttachTrafficSourcesCommand.d.ts +45 -0
- package/dist-types/commands/CancelInstanceRefreshCommand.d.ts +1 -1
- package/dist-types/commands/CompleteLifecycleActionCommand.d.ts +11 -11
- package/dist-types/commands/CreateAutoScalingGroupCommand.d.ts +4 -4
- package/dist-types/commands/CreateLaunchConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/CreateOrUpdateTagsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteAutoScalingGroupCommand.d.ts +5 -5
- package/dist-types/commands/DeleteLaunchConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteLifecycleHookCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteWarmPoolCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAdjustmentTypesCommand.d.ts +11 -11
- package/dist-types/commands/DescribeAutoScalingGroupsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstanceRefreshesCommand.d.ts +10 -10
- package/dist-types/commands/DescribeLifecycleHookTypesCommand.d.ts +8 -8
- package/dist-types/commands/DescribeLoadBalancerTargetGroupsCommand.d.ts +8 -3
- package/dist-types/commands/DescribeLoadBalancersCommand.d.ts +4 -4
- package/dist-types/commands/DescribeScalingActivitiesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeScheduledActionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTagsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeTerminationPolicyTypesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTrafficSourcesCommand.d.ts +41 -0
- package/dist-types/commands/DescribeWarmPoolCommand.d.ts +1 -1
- package/dist-types/commands/DetachInstancesCommand.d.ts +4 -4
- package/dist-types/commands/DetachLoadBalancerTargetGroupsCommand.d.ts +6 -1
- package/dist-types/commands/DetachLoadBalancersCommand.d.ts +2 -2
- package/dist-types/commands/DetachTrafficSourcesCommand.d.ts +41 -0
- package/dist-types/commands/EnableMetricsCollectionCommand.d.ts +1 -1
- package/dist-types/commands/EnterStandbyCommand.d.ts +3 -3
- package/dist-types/commands/ExitStandbyCommand.d.ts +2 -2
- package/dist-types/commands/GetPredictiveScalingForecastCommand.d.ts +3 -3
- package/dist-types/commands/PutLifecycleHookCommand.d.ts +14 -14
- package/dist-types/commands/PutNotificationConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +3 -3
- package/dist-types/commands/PutScheduledUpdateGroupActionCommand.d.ts +3 -3
- package/dist-types/commands/PutWarmPoolCommand.d.ts +2 -2
- package/dist-types/commands/RecordLifecycleActionHeartbeatCommand.d.ts +11 -11
- package/dist-types/commands/ResumeProcessesCommand.d.ts +1 -1
- package/dist-types/commands/SetDesiredCapacityCommand.d.ts +2 -2
- package/dist-types/commands/SetInstanceHealthCommand.d.ts +1 -1
- package/dist-types/commands/SetInstanceProtectionCommand.d.ts +2 -2
- package/dist-types/commands/StartInstanceRefreshCommand.d.ts +2 -2
- package/dist-types/commands/SuspendProcessesCommand.d.ts +2 -2
- package/dist-types/commands/TerminateInstanceInAutoScalingGroupCommand.d.ts +3 -3
- package/dist-types/commands/UpdateAutoScalingGroupCommand.d.ts +9 -9
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1040 -790
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/AutoScaling.d.ts +51 -0
- package/dist-types/ts3.4/AutoScalingClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/AttachTrafficSourcesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DescribeTrafficSourcesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DetachTrafficSourcesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +75 -3
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +36 -0
- package/package.json +29 -29
|
@@ -236,11 +236,39 @@ export interface AttachLoadBalancerTargetGroupsType {
|
|
|
236
236
|
*/
|
|
237
237
|
AutoScalingGroupName: string | undefined;
|
|
238
238
|
/**
|
|
239
|
-
* <p>The Amazon Resource Names (
|
|
239
|
+
* <p>The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target
|
|
240
240
|
* 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>
|
|
241
241
|
*/
|
|
242
242
|
TargetGroupARNs: string[] | undefined;
|
|
243
243
|
}
|
|
244
|
+
export interface AttachTrafficSourcesResultType {
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* <p>Describes the identifier of a traffic source.</p>
|
|
248
|
+
* <p>Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice
|
|
249
|
+
* target group.</p>
|
|
250
|
+
*/
|
|
251
|
+
export interface TrafficSourceIdentifier {
|
|
252
|
+
/**
|
|
253
|
+
* <p>The unique identifier of the traffic source.</p>
|
|
254
|
+
*/
|
|
255
|
+
Identifier?: string;
|
|
256
|
+
}
|
|
257
|
+
export interface AttachTrafficSourcesType {
|
|
258
|
+
/**
|
|
259
|
+
* <p>The name of the Auto Scaling group.</p>
|
|
260
|
+
*/
|
|
261
|
+
AutoScalingGroupName: string | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* <p>The unique identifiers of one or more traffic sources. You can specify up to 10
|
|
264
|
+
* traffic sources.</p>
|
|
265
|
+
* <p>Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice
|
|
266
|
+
* target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups.
|
|
267
|
+
* The target groups receive incoming traffic and route requests to one or more registered
|
|
268
|
+
* targets.</p>
|
|
269
|
+
*/
|
|
270
|
+
TrafficSources: TrafficSourceIdentifier[] | undefined;
|
|
271
|
+
}
|
|
244
272
|
/**
|
|
245
273
|
* <p>Describes a scheduled action that could not be created, updated, or deleted.</p>
|
|
246
274
|
*/
|
|
@@ -294,10 +322,10 @@ export interface ScheduledUpdateGroupActionRequest {
|
|
|
294
322
|
/**
|
|
295
323
|
* <p>The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT
|
|
296
324
|
* only and in quotes (for example, <code>"2019-06-01T00:00:00Z"</code>).</p>
|
|
297
|
-
*
|
|
325
|
+
* <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs
|
|
298
326
|
* the action at this time, and then performs the action based on the specified
|
|
299
327
|
* recurrence.</p>
|
|
300
|
-
*
|
|
328
|
+
* <p>If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error
|
|
301
329
|
* message.</p>
|
|
302
330
|
*/
|
|
303
331
|
StartTime?: Date;
|
|
@@ -310,10 +338,10 @@ export interface ScheduledUpdateGroupActionRequest {
|
|
|
310
338
|
* consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]
|
|
311
339
|
* [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>"30 0 1
|
|
312
340
|
* 1,6,12 *"</code>). For more information about this format, see <a href="http://crontab.org">Crontab</a>.</p>
|
|
313
|
-
*
|
|
341
|
+
* <p>When <code>StartTime</code> and <code>EndTime</code> are specified with
|
|
314
342
|
* <code>Recurrence</code>, they form the boundaries of when the recurring action
|
|
315
343
|
* starts and stops.</p>
|
|
316
|
-
*
|
|
344
|
+
* <p>Cron expressions use Universal Coordinated Time (UTC) by default.</p>
|
|
317
345
|
*/
|
|
318
346
|
Recurrence?: string;
|
|
319
347
|
/**
|
|
@@ -332,7 +360,7 @@ export interface ScheduledUpdateGroupActionRequest {
|
|
|
332
360
|
/**
|
|
333
361
|
* <p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is
|
|
334
362
|
* used by default. </p>
|
|
335
|
-
*
|
|
363
|
+
* <p>Valid values are the canonical names of the IANA time zones, derived from the IANA
|
|
336
364
|
* Time Zone Database (such as <code>Etc/GMT+9</code> or <code>Pacific/Tahiti</code>). For
|
|
337
365
|
* more information, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>.</p>
|
|
338
366
|
*/
|
|
@@ -410,14 +438,14 @@ export interface LaunchTemplateSpecification {
|
|
|
410
438
|
/**
|
|
411
439
|
* <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
|
|
412
440
|
* using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p>
|
|
413
|
-
*
|
|
441
|
+
* <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a
|
|
414
442
|
* <code>LaunchTemplateName</code>.</p>
|
|
415
443
|
*/
|
|
416
444
|
LaunchTemplateId?: string;
|
|
417
445
|
/**
|
|
418
446
|
* <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
|
|
419
447
|
* using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p>
|
|
420
|
-
*
|
|
448
|
+
* <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a
|
|
421
449
|
* <code>LaunchTemplateName</code>.</p>
|
|
422
450
|
*/
|
|
423
451
|
LaunchTemplateName?: string;
|
|
@@ -434,10 +462,7 @@ export interface LaunchTemplateSpecification {
|
|
|
434
462
|
/**
|
|
435
463
|
* <p>Describes information used to specify a lifecycle hook for an Auto Scaling
|
|
436
464
|
* group.</p>
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
465
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
441
466
|
* hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
442
467
|
*/
|
|
443
468
|
export interface LifecycleHookSpecification {
|
|
@@ -448,13 +473,13 @@ export interface LifecycleHookSpecification {
|
|
|
448
473
|
/**
|
|
449
474
|
* <p>The lifecycle transition. For Auto Scaling groups, there are two major lifecycle
|
|
450
475
|
* transitions.</p>
|
|
451
|
-
*
|
|
476
|
+
* <ul>
|
|
452
477
|
* <li>
|
|
453
|
-
*
|
|
478
|
+
* <p>To create a lifecycle hook for scale-out events, specify
|
|
454
479
|
* <code>autoscaling:EC2_INSTANCE_LAUNCHING</code>.</p>
|
|
455
480
|
* </li>
|
|
456
481
|
* <li>
|
|
457
|
-
*
|
|
482
|
+
* <p>To create a lifecycle hook for scale-in events, specify
|
|
458
483
|
* <code>autoscaling:EC2_INSTANCE_TERMINATING</code>.</p>
|
|
459
484
|
* </li>
|
|
460
485
|
* </ul>
|
|
@@ -474,7 +499,7 @@ export interface LifecycleHookSpecification {
|
|
|
474
499
|
/**
|
|
475
500
|
* <p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an
|
|
476
501
|
* unexpected failure occurs. The default value is <code>ABANDON</code>.</p>
|
|
477
|
-
*
|
|
502
|
+
* <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code>
|
|
478
503
|
* </p>
|
|
479
504
|
*/
|
|
480
505
|
DefaultResult?: string;
|
|
@@ -488,7 +513,7 @@ export interface LifecycleHookSpecification {
|
|
|
488
513
|
* <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
|
|
489
514
|
* 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
|
|
490
515
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
491
|
-
*
|
|
516
|
+
* <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.</p>
|
|
492
517
|
*/
|
|
493
518
|
RoleARN?: string;
|
|
494
519
|
}
|
|
@@ -502,17 +527,17 @@ export interface InstancesDistribution {
|
|
|
502
527
|
* <p>The allocation strategy to apply to your On-Demand Instances when they are launched.
|
|
503
528
|
* Possible instance types are determined by the launch template overrides that you
|
|
504
529
|
* specify.</p>
|
|
505
|
-
*
|
|
506
|
-
*
|
|
530
|
+
* <p>The following lists the valid values:</p>
|
|
531
|
+
* <dl>
|
|
507
532
|
* <dt>lowest-price</dt>
|
|
508
533
|
* <dd>
|
|
509
|
-
*
|
|
534
|
+
* <p>Uses price to determine which instance types are the highest priority,
|
|
510
535
|
* launching the lowest priced instance types within an Availability Zone
|
|
511
536
|
* first. This is the default value for Auto Scaling groups that specify <a>InstanceRequirements</a>. </p>
|
|
512
|
-
*
|
|
537
|
+
* </dd>
|
|
513
538
|
* <dt>prioritized</dt>
|
|
514
539
|
* <dd>
|
|
515
|
-
*
|
|
540
|
+
* <p>You set the order of instance types for the launch template overrides from
|
|
516
541
|
* highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling
|
|
517
542
|
* launches your highest priority instance types first. If all your On-Demand
|
|
518
543
|
* capacity cannot be fulfilled using your highest priority instance type, then
|
|
@@ -520,19 +545,19 @@ export interface InstancesDistribution {
|
|
|
520
545
|
* type, and so on. This is the default value for Auto Scaling groups that don't
|
|
521
546
|
* specify <a>InstanceRequirements</a> and cannot be used for groups
|
|
522
547
|
* that do.</p>
|
|
523
|
-
*
|
|
548
|
+
* </dd>
|
|
524
549
|
* </dl>
|
|
525
550
|
*/
|
|
526
551
|
OnDemandAllocationStrategy?: string;
|
|
527
552
|
/**
|
|
528
553
|
* <p>The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand
|
|
529
554
|
* Instances. This base portion is launched first as your group scales.</p>
|
|
530
|
-
*
|
|
555
|
+
* <p>This number has the same unit of measurement as the group's desired capacity. If you
|
|
531
556
|
* change the default unit of measurement (number of instances) by specifying weighted
|
|
532
557
|
* capacity values in your launch template overrides list, or by changing the default
|
|
533
558
|
* desired capacity type setting of the group, you must specify this number using the same
|
|
534
559
|
* unit of measurement.</p>
|
|
535
|
-
*
|
|
560
|
+
* <p>Default: 0</p>
|
|
536
561
|
*/
|
|
537
562
|
OnDemandBaseCapacity?: number;
|
|
538
563
|
/**
|
|
@@ -540,50 +565,48 @@ export interface InstancesDistribution {
|
|
|
540
565
|
* capacity beyond <code>OnDemandBaseCapacity</code>. Expressed as a number (for example,
|
|
541
566
|
* 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand
|
|
542
567
|
* Instances are used.</p>
|
|
543
|
-
*
|
|
568
|
+
* <p>Default: 100</p>
|
|
544
569
|
*/
|
|
545
570
|
OnDemandPercentageAboveBaseCapacity?: number;
|
|
546
571
|
/**
|
|
547
572
|
* <p>The allocation strategy to apply to your Spot Instances when they are launched.
|
|
548
573
|
* Possible instance types are determined by the launch template overrides that you
|
|
549
574
|
* specify.</p>
|
|
550
|
-
*
|
|
551
|
-
*
|
|
575
|
+
* <p>The following lists the valid values:</p>
|
|
576
|
+
* <dl>
|
|
552
577
|
* <dt>capacity-optimized</dt>
|
|
553
578
|
* <dd>
|
|
554
|
-
*
|
|
579
|
+
* <p>Requests Spot Instances using pools that are optimally chosen based on the
|
|
555
580
|
* available Spot capacity. This strategy has the lowest risk of interruption.
|
|
556
581
|
* To give certain instance types a higher chance of launching first, use
|
|
557
582
|
* <code>capacity-optimized-prioritized</code>.</p>
|
|
558
|
-
*
|
|
583
|
+
* </dd>
|
|
559
584
|
* <dt>capacity-optimized-prioritized</dt>
|
|
560
585
|
* <dd>
|
|
561
|
-
*
|
|
586
|
+
* <p>You set the order of instance types for the launch template overrides from
|
|
562
587
|
* highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors
|
|
563
588
|
* the instance type priorities on a best effort basis but optimizes for
|
|
564
589
|
* capacity first. Note that if the On-Demand allocation strategy is set to
|
|
565
590
|
* <code>prioritized</code>, the same priority is applied when fulfilling
|
|
566
591
|
* On-Demand capacity. This is not a valid value for Auto Scaling groups that specify
|
|
567
592
|
* <a>InstanceRequirements</a>.</p>
|
|
568
|
-
*
|
|
593
|
+
* </dd>
|
|
569
594
|
* <dt>lowest-price</dt>
|
|
570
595
|
* <dd>
|
|
571
|
-
*
|
|
596
|
+
* <p>Requests Spot Instances using the lowest priced pools within an
|
|
572
597
|
* Availability Zone, across the number of Spot pools that you specify for the
|
|
573
598
|
* <code>SpotInstancePools</code> property. To ensure that your desired
|
|
574
599
|
* capacity is met, you might receive Spot Instances from several pools. This
|
|
575
600
|
* is the default value, but it might lead to high interruption rates because
|
|
576
601
|
* this strategy only considers instance price and not available
|
|
577
602
|
* capacity.</p>
|
|
578
|
-
*
|
|
603
|
+
* </dd>
|
|
579
604
|
* <dt>price-capacity-optimized (recommended)</dt>
|
|
580
605
|
* <dd>
|
|
581
|
-
*
|
|
582
|
-
* the
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
* the lowest priced of these pools.</p>
|
|
586
|
-
* </dd>
|
|
606
|
+
* <p>The price and capacity optimized allocation strategy looks at both price
|
|
607
|
+
* and capacity to select the Spot Instance pools that are the least likely to
|
|
608
|
+
* be interrupted and have the lowest possible price.</p>
|
|
609
|
+
* </dd>
|
|
587
610
|
* </dl>
|
|
588
611
|
*/
|
|
589
612
|
SpotAllocationStrategy?: string;
|
|
@@ -592,7 +615,7 @@ export interface InstancesDistribution {
|
|
|
592
615
|
* Spot pools are determined from the different instance types in the overrides. Valid only
|
|
593
616
|
* when the <code>SpotAllocationStrategy</code> is <code>lowest-price</code>. Value must be
|
|
594
617
|
* in the range of 1–20.</p>
|
|
595
|
-
*
|
|
618
|
+
* <p>Default: 2</p>
|
|
596
619
|
*/
|
|
597
620
|
SpotInstancePools?: number;
|
|
598
621
|
/**
|
|
@@ -602,11 +625,11 @@ export interface InstancesDistribution {
|
|
|
602
625
|
* price because it can lead to increased interruptions. When Spot Instances launch, you
|
|
603
626
|
* pay the current Spot price. To remove a maximum price that you previously set, include
|
|
604
627
|
* the property but specify an empty string ("") for the value.</p>
|
|
605
|
-
*
|
|
628
|
+
* <important>
|
|
606
629
|
* <p>If you specify a maximum price, your instances will be interrupted more frequently
|
|
607
630
|
* than if you do not specify one.</p>
|
|
608
|
-
*
|
|
609
|
-
*
|
|
631
|
+
* </important>
|
|
632
|
+
* <p>Valid Range: Minimum value of 0.001</p>
|
|
610
633
|
*/
|
|
611
634
|
SpotMaxPrice?: string;
|
|
612
635
|
}
|
|
@@ -683,13 +706,13 @@ export interface MemoryMiBRequest {
|
|
|
683
706
|
/**
|
|
684
707
|
* <p>Specifies the minimum and maximum for the <code>NetworkBandwidthGbps</code> object
|
|
685
708
|
* when you specify <a>InstanceRequirements</a> for an Auto Scaling group.</p>
|
|
686
|
-
*
|
|
709
|
+
* <note>
|
|
687
710
|
* <p>Setting the minimum bandwidth does not guarantee that your instance will achieve
|
|
688
711
|
* the minimum bandwidth. Amazon EC2 will identify instance types that support the specified
|
|
689
712
|
* minimum bandwidth, but the actual bandwidth of your instance might go below the
|
|
690
713
|
* specified minimum at times. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth">Available instance bandwidth</a> in the
|
|
691
714
|
* <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
692
|
-
*
|
|
715
|
+
* </note>
|
|
693
716
|
*/
|
|
694
717
|
export interface NetworkBandwidthGbpsRequest {
|
|
695
718
|
/**
|
|
@@ -747,31 +770,31 @@ export interface VCpuCountRequest {
|
|
|
747
770
|
* <p>The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your
|
|
748
771
|
* specified requirements to identify instance types. Then, it uses your On-Demand and Spot
|
|
749
772
|
* allocation strategies to launch instances from these instance types.</p>
|
|
750
|
-
*
|
|
773
|
+
* <p>When you specify multiple attributes, you get instance types that satisfy all of the
|
|
751
774
|
* specified attributes. If you specify multiple values for an attribute, you get instance
|
|
752
775
|
* types that satisfy any of the specified values.</p>
|
|
753
|
-
*
|
|
776
|
+
* <p>To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance
|
|
754
777
|
* types, you can use one of the following parameters, but not both in the same
|
|
755
778
|
* request:</p>
|
|
756
|
-
*
|
|
779
|
+
* <ul>
|
|
757
780
|
* <li>
|
|
758
|
-
*
|
|
781
|
+
* <p>
|
|
759
782
|
* <code>AllowedInstanceTypes</code> - The instance types to include in the list.
|
|
760
783
|
* All other instance types are ignored, even if they match your specified
|
|
761
784
|
* attributes.</p>
|
|
762
785
|
* </li>
|
|
763
786
|
* <li>
|
|
764
|
-
*
|
|
787
|
+
* <p>
|
|
765
788
|
* <code>ExcludedInstanceTypes</code> - The instance types to exclude from the
|
|
766
789
|
* list, even if they match your specified attributes.</p>
|
|
767
790
|
* </li>
|
|
768
791
|
* </ul>
|
|
769
|
-
*
|
|
792
|
+
* <note>
|
|
770
793
|
* <p>You must specify <code>VCpuCount</code> and <code>MemoryMiB</code>. All other
|
|
771
794
|
* attributes are optional. Any unspecified optional attribute is set to its
|
|
772
795
|
* default.</p>
|
|
773
|
-
*
|
|
774
|
-
*
|
|
796
|
+
* </note>
|
|
797
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html">Creating
|
|
775
798
|
* an Auto Scaling group using attribute-based instance type selection</a> in the
|
|
776
799
|
* <i>Amazon EC2 Auto Scaling User Guide</i>. For help determining which instance types match
|
|
777
800
|
* your attributes before you apply them to your Auto Scaling group, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements">Preview instance types with specified attributes</a> in the
|
|
@@ -788,29 +811,29 @@ export interface InstanceRequirements {
|
|
|
788
811
|
MemoryMiB: MemoryMiBRequest | undefined;
|
|
789
812
|
/**
|
|
790
813
|
* <p>Lists which specific CPU manufacturers to include.</p>
|
|
791
|
-
*
|
|
814
|
+
* <ul>
|
|
792
815
|
* <li>
|
|
793
|
-
*
|
|
816
|
+
* <p>For instance types with Intel CPUs, specify <code>intel</code>.</p>
|
|
794
817
|
* </li>
|
|
795
818
|
* <li>
|
|
796
|
-
*
|
|
819
|
+
* <p>For instance types with AMD CPUs, specify <code>amd</code>.</p>
|
|
797
820
|
* </li>
|
|
798
821
|
* <li>
|
|
799
|
-
*
|
|
822
|
+
* <p>For instance types with Amazon Web Services CPUs, specify
|
|
800
823
|
* <code>amazon-web-services</code>.</p>
|
|
801
824
|
* </li>
|
|
802
825
|
* </ul>
|
|
803
|
-
*
|
|
826
|
+
* <note>
|
|
804
827
|
* <p>Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.
|
|
805
828
|
* Instances will be launched with a compatible CPU architecture based on the Amazon
|
|
806
829
|
* Machine Image (AMI) that you specify in your launch template. </p>
|
|
807
|
-
*
|
|
808
|
-
*
|
|
830
|
+
* </note>
|
|
831
|
+
* <p>Default: Any manufacturer</p>
|
|
809
832
|
*/
|
|
810
833
|
CpuManufacturers?: (CpuManufacturer | string)[];
|
|
811
834
|
/**
|
|
812
835
|
* <p>The minimum and maximum amount of memory per vCPU for an instance type, in GiB.</p>
|
|
813
|
-
*
|
|
836
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
814
837
|
*/
|
|
815
838
|
MemoryGiBPerVCpu?: MemoryGiBPerVCpuRequest;
|
|
816
839
|
/**
|
|
@@ -818,32 +841,32 @@ export interface InstanceRequirements {
|
|
|
818
841
|
* represented by an asterisk (<code>*</code>), to exclude an instance family, type, size,
|
|
819
842
|
* or generation. The following are examples: <code>m5.8xlarge</code>, <code>c5*.*</code>,
|
|
820
843
|
* <code>m5a.*</code>, <code>r*</code>, <code>*3*</code>. </p>
|
|
821
|
-
*
|
|
844
|
+
* <p>For example, if you specify <code>c5*</code>, you are excluding the entire C5 instance
|
|
822
845
|
* family, which includes all C5a and C5n instance types. If you specify
|
|
823
846
|
* <code>m5a.*</code>, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n
|
|
824
847
|
* instance types.</p>
|
|
825
|
-
*
|
|
848
|
+
* <note>
|
|
826
849
|
* <p>If you specify <code>ExcludedInstanceTypes</code>, you can't specify
|
|
827
850
|
* <code>AllowedInstanceTypes</code>.</p>
|
|
828
|
-
*
|
|
829
|
-
*
|
|
851
|
+
* </note>
|
|
852
|
+
* <p>Default: No excluded instance types</p>
|
|
830
853
|
*/
|
|
831
854
|
ExcludedInstanceTypes?: string[];
|
|
832
855
|
/**
|
|
833
856
|
* <p>Indicates whether current or previous generation instance types are included.</p>
|
|
834
|
-
*
|
|
857
|
+
* <ul>
|
|
835
858
|
* <li>
|
|
836
|
-
*
|
|
859
|
+
* <p>For current generation instance types, specify <code>current</code>. The
|
|
837
860
|
* current generation includes EC2 instance types currently recommended for use.
|
|
838
861
|
* This typically includes the latest two to three generations in each instance
|
|
839
862
|
* family. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in
|
|
840
863
|
* the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
841
864
|
* </li>
|
|
842
865
|
* <li>
|
|
843
|
-
*
|
|
866
|
+
* <p>For previous generation instance types, specify <code>previous</code>.</p>
|
|
844
867
|
* </li>
|
|
845
868
|
* </ul>
|
|
846
|
-
*
|
|
869
|
+
* <p>Default: Any current or previous generation</p>
|
|
847
870
|
*/
|
|
848
871
|
InstanceGenerations?: (InstanceGeneration | string)[];
|
|
849
872
|
/**
|
|
@@ -854,10 +877,10 @@ export interface InstanceRequirements {
|
|
|
854
877
|
* is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling
|
|
855
878
|
* interprets as a percentage. To turn off price protection, specify a high value, such as
|
|
856
879
|
* <code>999999</code>. </p>
|
|
857
|
-
*
|
|
880
|
+
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
|
|
858
881
|
* <code>memory-mib</code>, the price protection threshold is applied based on the per
|
|
859
882
|
* vCPU or per memory price instead of the per instance price. </p>
|
|
860
|
-
*
|
|
883
|
+
* <p>Default: <code>100</code>
|
|
861
884
|
* </p>
|
|
862
885
|
*/
|
|
863
886
|
SpotMaxPricePercentageOverLowestPrice?: number;
|
|
@@ -869,17 +892,17 @@ export interface InstanceRequirements {
|
|
|
869
892
|
* whose price is higher than your threshold. The parameter accepts an integer, which
|
|
870
893
|
* Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value,
|
|
871
894
|
* such as <code>999999</code>. </p>
|
|
872
|
-
*
|
|
895
|
+
* <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or
|
|
873
896
|
* <code>memory-mib</code>, the price protection threshold is applied based on the per
|
|
874
897
|
* vCPU or per memory price instead of the per instance price. </p>
|
|
875
|
-
*
|
|
898
|
+
* <p>Default: <code>20</code>
|
|
876
899
|
* </p>
|
|
877
900
|
*/
|
|
878
901
|
OnDemandMaxPricePercentageOverLowestPrice?: number;
|
|
879
902
|
/**
|
|
880
903
|
* <p>Indicates whether bare metal instance types are included, excluded, or
|
|
881
904
|
* required.</p>
|
|
882
|
-
*
|
|
905
|
+
* <p>Default: <code>excluded</code>
|
|
883
906
|
* </p>
|
|
884
907
|
*/
|
|
885
908
|
BareMetal?: BareMetal | string;
|
|
@@ -887,180 +910,180 @@ export interface InstanceRequirements {
|
|
|
887
910
|
* <p>Indicates whether burstable performance instance types are included, excluded, or
|
|
888
911
|
* required. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable
|
|
889
912
|
* performance instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
890
|
-
*
|
|
913
|
+
* <p>Default: <code>excluded</code>
|
|
891
914
|
* </p>
|
|
892
915
|
*/
|
|
893
916
|
BurstablePerformance?: BurstablePerformance | string;
|
|
894
917
|
/**
|
|
895
918
|
* <p>Indicates whether instance types must provide On-Demand Instance hibernation
|
|
896
919
|
* support.</p>
|
|
897
|
-
*
|
|
920
|
+
* <p>Default: <code>false</code>
|
|
898
921
|
* </p>
|
|
899
922
|
*/
|
|
900
923
|
RequireHibernateSupport?: boolean;
|
|
901
924
|
/**
|
|
902
925
|
* <p>The minimum and maximum number of network interfaces for an instance type.</p>
|
|
903
|
-
*
|
|
926
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
904
927
|
*/
|
|
905
928
|
NetworkInterfaceCount?: NetworkInterfaceCountRequest;
|
|
906
929
|
/**
|
|
907
930
|
* <p>Indicates whether instance types with instance store volumes are included, excluded,
|
|
908
931
|
* or required. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 instance store</a> in
|
|
909
932
|
* the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
910
|
-
*
|
|
933
|
+
* <p>Default: <code>included</code>
|
|
911
934
|
* </p>
|
|
912
935
|
*/
|
|
913
936
|
LocalStorage?: LocalStorage | string;
|
|
914
937
|
/**
|
|
915
938
|
* <p>Indicates the type of local storage that is required.</p>
|
|
916
|
-
*
|
|
939
|
+
* <ul>
|
|
917
940
|
* <li>
|
|
918
|
-
*
|
|
941
|
+
* <p>For instance types with hard disk drive (HDD) storage, specify
|
|
919
942
|
* <code>hdd</code>.</p>
|
|
920
943
|
* </li>
|
|
921
944
|
* <li>
|
|
922
|
-
*
|
|
945
|
+
* <p>For instance types with solid state drive (SSD) storage, specify
|
|
923
946
|
* <code>ssd</code>.</p>
|
|
924
947
|
* </li>
|
|
925
948
|
* </ul>
|
|
926
|
-
*
|
|
949
|
+
* <p>Default: Any local storage type</p>
|
|
927
950
|
*/
|
|
928
951
|
LocalStorageTypes?: (LocalStorageType | string)[];
|
|
929
952
|
/**
|
|
930
953
|
* <p>The minimum and maximum total local storage size for an instance type, in GB.</p>
|
|
931
|
-
*
|
|
954
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
932
955
|
*/
|
|
933
956
|
TotalLocalStorageGB?: TotalLocalStorageGBRequest;
|
|
934
957
|
/**
|
|
935
958
|
* <p>The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.
|
|
936
959
|
* For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html">Amazon EBS–optimized instances</a>
|
|
937
960
|
* in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
938
|
-
*
|
|
961
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
939
962
|
*/
|
|
940
963
|
BaselineEbsBandwidthMbps?: BaselineEbsBandwidthMbpsRequest;
|
|
941
964
|
/**
|
|
942
965
|
* <p>Lists the accelerator types that must be on an instance type.</p>
|
|
943
|
-
*
|
|
966
|
+
* <ul>
|
|
944
967
|
* <li>
|
|
945
|
-
*
|
|
968
|
+
* <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p>
|
|
946
969
|
* </li>
|
|
947
970
|
* <li>
|
|
948
|
-
*
|
|
971
|
+
* <p>For instance types with FPGA accelerators, specify <code>fpga</code>.</p>
|
|
949
972
|
* </li>
|
|
950
973
|
* <li>
|
|
951
|
-
*
|
|
974
|
+
* <p>For instance types with inference accelerators, specify
|
|
952
975
|
* <code>inference</code>.</p>
|
|
953
976
|
* </li>
|
|
954
977
|
* </ul>
|
|
955
|
-
*
|
|
978
|
+
* <p>Default: Any accelerator type</p>
|
|
956
979
|
*/
|
|
957
980
|
AcceleratorTypes?: (AcceleratorType | string)[];
|
|
958
981
|
/**
|
|
959
982
|
* <p>The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia
|
|
960
983
|
* chips) for an instance type.</p>
|
|
961
|
-
*
|
|
984
|
+
* <p>To exclude accelerator-enabled instance types, set <code>Max</code> to
|
|
962
985
|
* <code>0</code>.</p>
|
|
963
|
-
*
|
|
986
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
964
987
|
*/
|
|
965
988
|
AcceleratorCount?: AcceleratorCountRequest;
|
|
966
989
|
/**
|
|
967
990
|
* <p>Indicates whether instance types must have accelerators by specific
|
|
968
991
|
* manufacturers.</p>
|
|
969
|
-
*
|
|
992
|
+
* <ul>
|
|
970
993
|
* <li>
|
|
971
|
-
*
|
|
994
|
+
* <p>For instance types with NVIDIA devices, specify <code>nvidia</code>.</p>
|
|
972
995
|
* </li>
|
|
973
996
|
* <li>
|
|
974
|
-
*
|
|
997
|
+
* <p>For instance types with AMD devices, specify <code>amd</code>.</p>
|
|
975
998
|
* </li>
|
|
976
999
|
* <li>
|
|
977
|
-
*
|
|
1000
|
+
* <p>For instance types with Amazon Web Services devices, specify
|
|
978
1001
|
* <code>amazon-web-services</code>.</p>
|
|
979
1002
|
* </li>
|
|
980
1003
|
* <li>
|
|
981
|
-
*
|
|
1004
|
+
* <p>For instance types with Xilinx devices, specify <code>xilinx</code>.</p>
|
|
982
1005
|
* </li>
|
|
983
1006
|
* </ul>
|
|
984
|
-
*
|
|
1007
|
+
* <p>Default: Any manufacturer</p>
|
|
985
1008
|
*/
|
|
986
1009
|
AcceleratorManufacturers?: (AcceleratorManufacturer | string)[];
|
|
987
1010
|
/**
|
|
988
1011
|
* <p>Lists the accelerators that must be on an instance type.</p>
|
|
989
|
-
*
|
|
1012
|
+
* <ul>
|
|
990
1013
|
* <li>
|
|
991
|
-
*
|
|
1014
|
+
* <p>For instance types with NVIDIA A100 GPUs, specify <code>a100</code>.</p>
|
|
992
1015
|
* </li>
|
|
993
1016
|
* <li>
|
|
994
|
-
*
|
|
1017
|
+
* <p>For instance types with NVIDIA V100 GPUs, specify <code>v100</code>.</p>
|
|
995
1018
|
* </li>
|
|
996
1019
|
* <li>
|
|
997
|
-
*
|
|
1020
|
+
* <p>For instance types with NVIDIA K80 GPUs, specify <code>k80</code>.</p>
|
|
998
1021
|
* </li>
|
|
999
1022
|
* <li>
|
|
1000
|
-
*
|
|
1023
|
+
* <p>For instance types with NVIDIA T4 GPUs, specify <code>t4</code>.</p>
|
|
1001
1024
|
* </li>
|
|
1002
1025
|
* <li>
|
|
1003
|
-
*
|
|
1026
|
+
* <p>For instance types with NVIDIA M60 GPUs, specify <code>m60</code>.</p>
|
|
1004
1027
|
* </li>
|
|
1005
1028
|
* <li>
|
|
1006
|
-
*
|
|
1029
|
+
* <p>For instance types with AMD Radeon Pro V520 GPUs, specify
|
|
1007
1030
|
* <code>radeon-pro-v520</code>.</p>
|
|
1008
1031
|
* </li>
|
|
1009
1032
|
* <li>
|
|
1010
|
-
*
|
|
1033
|
+
* <p>For instance types with Xilinx VU9P FPGAs, specify <code>vu9p</code>.</p>
|
|
1011
1034
|
* </li>
|
|
1012
1035
|
* </ul>
|
|
1013
|
-
*
|
|
1036
|
+
* <p>Default: Any accelerator</p>
|
|
1014
1037
|
*/
|
|
1015
1038
|
AcceleratorNames?: (AcceleratorName | string)[];
|
|
1016
1039
|
/**
|
|
1017
1040
|
* <p>The minimum and maximum total memory size for the accelerators on an instance type, in
|
|
1018
1041
|
* MiB.</p>
|
|
1019
|
-
*
|
|
1042
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
1020
1043
|
*/
|
|
1021
1044
|
AcceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRequest;
|
|
1022
1045
|
/**
|
|
1023
1046
|
* <p>The minimum and maximum amount of network bandwidth, in gigabits per second
|
|
1024
1047
|
* (Gbps).</p>
|
|
1025
|
-
*
|
|
1048
|
+
* <p>Default: No minimum or maximum limits</p>
|
|
1026
1049
|
*/
|
|
1027
1050
|
NetworkBandwidthGbps?: NetworkBandwidthGbpsRequest;
|
|
1028
1051
|
/**
|
|
1029
1052
|
* <p>The instance types to apply your specified attributes against. All other instance
|
|
1030
1053
|
* types are ignored, even if they match your specified attributes.</p>
|
|
1031
|
-
*
|
|
1054
|
+
* <p>You can use strings with one or more wild cards, represented by an asterisk
|
|
1032
1055
|
* (<code>*</code>), to allow an instance type, size, or generation. The following are
|
|
1033
1056
|
* examples: <code>m5.8xlarge</code>, <code>c5*.*</code>, <code>m5a.*</code>,
|
|
1034
1057
|
* <code>r*</code>, <code>*3*</code>.</p>
|
|
1035
|
-
*
|
|
1058
|
+
* <p>For example, if you specify <code>c5*</code>, Amazon EC2 Auto Scaling will allow the entire C5
|
|
1036
1059
|
* instance family, which includes all C5a and C5n instance types. If you specify
|
|
1037
1060
|
* <code>m5a.*</code>, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n
|
|
1038
1061
|
* instance types.</p>
|
|
1039
|
-
*
|
|
1062
|
+
* <note>
|
|
1040
1063
|
* <p>If you specify <code>AllowedInstanceTypes</code>, you can't specify
|
|
1041
1064
|
* <code>ExcludedInstanceTypes</code>.</p>
|
|
1042
|
-
*
|
|
1043
|
-
*
|
|
1065
|
+
* </note>
|
|
1066
|
+
* <p>Default: All instance types</p>
|
|
1044
1067
|
*/
|
|
1045
1068
|
AllowedInstanceTypes?: string[];
|
|
1046
1069
|
}
|
|
1047
1070
|
/**
|
|
1048
1071
|
* <p>Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed
|
|
1049
1072
|
* instances policy:</p>
|
|
1050
|
-
*
|
|
1073
|
+
* <ul>
|
|
1051
1074
|
* <li>
|
|
1052
|
-
*
|
|
1075
|
+
* <p>Override the instance type that is specified in the launch template.</p>
|
|
1053
1076
|
* </li>
|
|
1054
1077
|
* <li>
|
|
1055
|
-
*
|
|
1078
|
+
* <p>Use multiple instance types.</p>
|
|
1056
1079
|
* </li>
|
|
1057
1080
|
* </ul>
|
|
1058
|
-
*
|
|
1081
|
+
* <p>Specify the instance types that you want, or define your instance requirements instead
|
|
1059
1082
|
* and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements.
|
|
1060
1083
|
* This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when
|
|
1061
1084
|
* fulfilling Spot and On-Demand capacities. You can view which instance types are matched
|
|
1062
1085
|
* before you apply the instance requirements to your Auto Scaling group.</p>
|
|
1063
|
-
*
|
|
1086
|
+
* <p>After you define your instance requirements, you don't have to keep updating these
|
|
1064
1087
|
* settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance
|
|
1065
1088
|
* requirements of the Auto Scaling group to determine whether a new EC2 instance type can be
|
|
1066
1089
|
* used.</p>
|
|
@@ -1071,7 +1094,7 @@ export interface LaunchTemplateOverrides {
|
|
|
1071
1094
|
* that is supported in your requested Region and Availability Zones. For more information,
|
|
1072
1095
|
* 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
|
|
1073
1096
|
* Guide</i>.</p>
|
|
1074
|
-
*
|
|
1097
|
+
* <p>You can specify up to 40 instance types per Auto Scaling group.</p>
|
|
1075
1098
|
*/
|
|
1076
1099
|
InstanceType?: string;
|
|
1077
1100
|
/**
|
|
@@ -1085,15 +1108,15 @@ export interface LaunchTemplateOverrides {
|
|
|
1085
1108
|
* the instance is launched, and the desired capacity is exceeded by three units. For more
|
|
1086
1109
|
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html">Configuring instance weighting for Amazon EC2 Auto Scaling</a> in the
|
|
1087
1110
|
* <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the range of 1–999.</p>
|
|
1088
|
-
*
|
|
1111
|
+
* <p>If you specify a value for <code>WeightedCapacity</code> for one instance type, you
|
|
1089
1112
|
* must specify a value for <code>WeightedCapacity</code> for all of them.</p>
|
|
1090
|
-
*
|
|
1113
|
+
* <important>
|
|
1091
1114
|
* <p>Every Auto Scaling group has three size parameters (<code>DesiredCapacity</code>,
|
|
1092
1115
|
* <code>MaxSize</code>, and <code>MinSize</code>). Usually, you set these sizes
|
|
1093
1116
|
* based on a specific number of instances. However, if you configure a mixed instances
|
|
1094
1117
|
* policy that defines weights for the instance types, you must specify these sizes
|
|
1095
1118
|
* with the same units that you use for weighting instances. </p>
|
|
1096
|
-
*
|
|
1119
|
+
* </important>
|
|
1097
1120
|
*/
|
|
1098
1121
|
WeightedCapacity?: string;
|
|
1099
1122
|
/**
|
|
@@ -1102,7 +1125,7 @@ export interface LaunchTemplateOverrides {
|
|
|
1102
1125
|
* different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in
|
|
1103
1126
|
* the <code>LaunchTemplate</code> definition. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html">Specifying a different launch template for an instance type</a> in the
|
|
1104
1127
|
* <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
|
|
1105
|
-
*
|
|
1128
|
+
* <p>You can specify up to 20 launch templates per Auto Scaling group. The launch templates
|
|
1106
1129
|
* specified in the overrides and in the <code>LaunchTemplate</code> definition count
|
|
1107
1130
|
* towards this limit.</p>
|
|
1108
1131
|
*/
|
|
@@ -1111,15 +1134,15 @@ export interface LaunchTemplateOverrides {
|
|
|
1111
1134
|
* <p>The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify
|
|
1112
1135
|
* instance types. Then, it uses your On-Demand and Spot allocation strategies to launch
|
|
1113
1136
|
* instances from these instance types.</p>
|
|
1114
|
-
*
|
|
1137
|
+
* <p>You can specify up to four separate sets of instance requirements per Auto Scaling group. This
|
|
1115
1138
|
* is useful for provisioning instances from different Amazon Machine Images (AMIs) in the
|
|
1116
1139
|
* same Auto Scaling group. To do this, create the AMIs and create a new launch template for each
|
|
1117
1140
|
* AMI. Then, create a compatible set of instance requirements for each launch template.
|
|
1118
1141
|
* </p>
|
|
1119
|
-
*
|
|
1142
|
+
* <note>
|
|
1120
1143
|
* <p>If you specify <code>InstanceRequirements</code>, you can't specify
|
|
1121
1144
|
* <code>InstanceType</code>.</p>
|
|
1122
|
-
*
|
|
1145
|
+
* </note>
|
|
1123
1146
|
*/
|
|
1124
1147
|
InstanceRequirements?: InstanceRequirements;
|
|
1125
1148
|
}
|
|
@@ -1141,7 +1164,7 @@ export interface LaunchTemplate {
|
|
|
1141
1164
|
/**
|
|
1142
1165
|
* <p>Use this structure to launch multiple instance types and On-Demand Instances and Spot
|
|
1143
1166
|
* Instances within a single Auto Scaling group.</p>
|
|
1144
|
-
*
|
|
1167
|
+
* <p>A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch
|
|
1145
1168
|
* instances and help optimize your costs. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling
|
|
1146
1169
|
* groups with multiple instance types and purchase options</a> in the
|
|
1147
1170
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
@@ -1187,16 +1210,16 @@ export interface Tag {
|
|
|
1187
1210
|
export interface CreateAutoScalingGroupType {
|
|
1188
1211
|
/**
|
|
1189
1212
|
* <p>The name of the Auto Scaling group. This name must be unique per Region per account.</p>
|
|
1190
|
-
*
|
|
1213
|
+
* <p>The name can contain any ASCII character 33 to 126 including most punctuation
|
|
1191
1214
|
* characters, digits, and upper and lowercased letters.</p>
|
|
1192
|
-
*
|
|
1215
|
+
* <note>
|
|
1193
1216
|
* <p>You cannot use a colon (:) in the name.</p>
|
|
1194
|
-
*
|
|
1217
|
+
* </note>
|
|
1195
1218
|
*/
|
|
1196
1219
|
AutoScalingGroupName: string | undefined;
|
|
1197
1220
|
/**
|
|
1198
1221
|
* <p>The name of the launch configuration to use to launch instances. </p>
|
|
1199
|
-
*
|
|
1222
|
+
* <p>Conditional: You must specify either a launch template (<code>LaunchTemplate</code> or
|
|
1200
1223
|
* <code>MixedInstancesPolicy</code>) or a launch configuration
|
|
1201
1224
|
* (<code>LaunchConfigurationName</code> or <code>InstanceId</code>).</p>
|
|
1202
1225
|
*/
|
|
@@ -1204,15 +1227,15 @@ export interface CreateAutoScalingGroupType {
|
|
|
1204
1227
|
/**
|
|
1205
1228
|
* <p>Information used to specify the launch template and version to use to launch
|
|
1206
1229
|
* instances. </p>
|
|
1207
|
-
*
|
|
1230
|
+
* <p>Conditional: You must specify either a launch template (<code>LaunchTemplate</code> or
|
|
1208
1231
|
* <code>MixedInstancesPolicy</code>) or a launch configuration
|
|
1209
1232
|
* (<code>LaunchConfigurationName</code> or <code>InstanceId</code>).</p>
|
|
1210
|
-
*
|
|
1233
|
+
* <note>
|
|
1211
1234
|
* <p>The launch template that is specified must be configured for use with an Auto Scaling
|
|
1212
1235
|
* group. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html">Creating a launch
|
|
1213
1236
|
* template for an Auto Scaling group</a> in the
|
|
1214
1237
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1215
|
-
*
|
|
1238
|
+
* </note>
|
|
1216
1239
|
*/
|
|
1217
1240
|
LaunchTemplate?: LaunchTemplateSpecification;
|
|
1218
1241
|
/**
|
|
@@ -1234,13 +1257,13 @@ export interface CreateAutoScalingGroupType {
|
|
|
1234
1257
|
MinSize: number | undefined;
|
|
1235
1258
|
/**
|
|
1236
1259
|
* <p>The maximum size of the group.</p>
|
|
1237
|
-
*
|
|
1260
|
+
* <note>
|
|
1238
1261
|
* <p>With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to
|
|
1239
1262
|
* go above <code>MaxSize</code> to meet your capacity requirements. In this event,
|
|
1240
1263
|
* Amazon EC2 Auto Scaling will never go above <code>MaxSize</code> by more than your largest instance
|
|
1241
1264
|
* weight (weights that define how many units each instance contributes to the desired
|
|
1242
1265
|
* capacity of the group).</p>
|
|
1243
|
-
*
|
|
1266
|
+
* </note>
|
|
1244
1267
|
*/
|
|
1245
1268
|
MaxSize: number | undefined;
|
|
1246
1269
|
/**
|
|
@@ -1255,10 +1278,10 @@ export interface CreateAutoScalingGroupType {
|
|
|
1255
1278
|
* <p>
|
|
1256
1279
|
* <i>Only needed if you use simple scaling policies.</i>
|
|
1257
1280
|
* </p>
|
|
1258
|
-
*
|
|
1281
|
+
* <p>The amount of time, in seconds, between one scaling activity ending and another one
|
|
1259
1282
|
* starting due to simple scaling policies. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling cooldowns
|
|
1260
1283
|
* for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1261
|
-
*
|
|
1284
|
+
* <p>Default: <code>300</code> seconds</p>
|
|
1262
1285
|
*/
|
|
1263
1286
|
DefaultCooldown?: number;
|
|
1264
1287
|
/**
|
|
@@ -1274,42 +1297,43 @@ export interface CreateAutoScalingGroupType {
|
|
|
1274
1297
|
*/
|
|
1275
1298
|
LoadBalancerNames?: string[];
|
|
1276
1299
|
/**
|
|
1277
|
-
* <p>The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling
|
|
1278
|
-
* Instances are registered as targets with the target groups. The target groups
|
|
1279
|
-
* incoming traffic and route requests to one or more registered targets. For more
|
|
1300
|
+
* <p>The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling
|
|
1301
|
+
* group. Instances are registered as targets with the target groups. The target groups
|
|
1302
|
+
* receive incoming traffic and route requests to one or more registered targets. For more
|
|
1280
1303
|
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
|
|
1281
1304
|
* distribute traffic across the instances in your Auto Scaling group</a> in the
|
|
1282
1305
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1283
1306
|
*/
|
|
1284
1307
|
TargetGroupARNs?: string[];
|
|
1285
1308
|
/**
|
|
1286
|
-
* <p>
|
|
1287
|
-
*
|
|
1288
|
-
* (ELB) health checks, it considers the instance unhealthy if it fails either the EC2
|
|
1289
|
-
* status checks or the load balancer health checks. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html">Health checks
|
|
1309
|
+
* <p>Determines whether any additional health checks are performed on the instances in this
|
|
1310
|
+
* group. Amazon EC2 health checks are always on. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html">Health checks
|
|
1290
1311
|
* for Auto Scaling instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1312
|
+
* <p>The valid values are <code>EC2</code> (default), <code>ELB</code>, and
|
|
1313
|
+
* <code>VPC_LATTICE</code>. The <code>VPC_LATTICE</code> health check type is reserved
|
|
1314
|
+
* for use with VPC Lattice, which is in preview release and is subject to change.</p>
|
|
1291
1315
|
*/
|
|
1292
1316
|
HealthCheckType?: string;
|
|
1293
1317
|
/**
|
|
1294
1318
|
* <p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
|
|
1295
1319
|
* of an EC2 instance that has come into service and marking it unhealthy due to a failed
|
|
1296
|
-
*
|
|
1297
|
-
*
|
|
1298
|
-
*
|
|
1320
|
+
* health check. This is useful if your instances do not immediately pass their health
|
|
1321
|
+
* checks after they enter the <code>InService</code> state. For more information, see
|
|
1322
|
+
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html">Set the health check
|
|
1299
1323
|
* grace period for an Auto Scaling group</a> in the
|
|
1300
1324
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1301
|
-
*
|
|
1325
|
+
* <p>Default: <code>0</code> seconds</p>
|
|
1302
1326
|
*/
|
|
1303
1327
|
HealthCheckGracePeriod?: number;
|
|
1304
1328
|
/**
|
|
1305
1329
|
* <p>The name of the placement group into which to launch your instances. For more
|
|
1306
1330
|
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the
|
|
1307
1331
|
* <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
1308
|
-
*
|
|
1332
|
+
* <note>
|
|
1309
1333
|
* <p>A <i>cluster</i> placement group is a logical grouping of instances
|
|
1310
1334
|
* within a single Availability Zone. You cannot specify multiple Availability Zones
|
|
1311
1335
|
* and a cluster placement group. </p>
|
|
1312
|
-
*
|
|
1336
|
+
* </note>
|
|
1313
1337
|
*/
|
|
1314
1338
|
PlacementGroup?: string;
|
|
1315
1339
|
/**
|
|
@@ -1325,7 +1349,7 @@ export interface CreateAutoScalingGroupType {
|
|
|
1325
1349
|
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
|
|
1326
1350
|
* Amazon EC2 Auto Scaling termination policies</a> in the
|
|
1327
1351
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1328
|
-
*
|
|
1352
|
+
* <p>Valid values: <code>Default</code> | <code>AllocationStrategy</code> |
|
|
1329
1353
|
* <code>ClosestToNextInstanceHour</code> | <code>NewestInstance</code> |
|
|
1330
1354
|
* <code>OldestInstance</code> | <code>OldestLaunchConfiguration</code> |
|
|
1331
1355
|
* <code>OldestLaunchTemplate</code> |
|
|
@@ -1390,10 +1414,9 @@ export interface CreateAutoScalingGroupType {
|
|
|
1390
1414
|
* only. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html">Creating
|
|
1391
1415
|
* an Auto Scaling group using attribute-based instance type selection</a> in the
|
|
1392
1416
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1393
|
-
*
|
|
1417
|
+
* <p>By default, Amazon EC2 Auto Scaling specifies <code>units</code>, which translates into number of
|
|
1394
1418
|
* instances.</p>
|
|
1395
|
-
*
|
|
1396
|
-
* <p>Valid values: <code>units</code> | <code>vcpu</code> | <code>memory-mib</code>
|
|
1419
|
+
* <p>Valid values: <code>units</code> | <code>vcpu</code> | <code>memory-mib</code>
|
|
1397
1420
|
* </p>
|
|
1398
1421
|
*/
|
|
1399
1422
|
DesiredCapacityType?: string;
|
|
@@ -1405,7 +1428,7 @@ export interface CreateAutoScalingGroupType {
|
|
|
1405
1428
|
* instance reaches the <code>InService</code> state. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html">Set
|
|
1406
1429
|
* the default instance warmup for an Auto Scaling group</a> in the
|
|
1407
1430
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1408
|
-
*
|
|
1431
|
+
* <important>
|
|
1409
1432
|
* <p>To manage your warm-up settings at the group level, we recommend that you set the
|
|
1410
1433
|
* default instance warmup, <i>even if its value is set to 0 seconds</i>.
|
|
1411
1434
|
* This also optimizes the performance of scaling policies that scale continuously,
|
|
@@ -1414,10 +1437,22 @@ export interface CreateAutoScalingGroupType {
|
|
|
1414
1437
|
* specify <code>-1</code> for the value. However, we strongly recommend keeping the
|
|
1415
1438
|
* default instance warmup enabled by specifying a minimum value of
|
|
1416
1439
|
* <code>0</code>.</p>
|
|
1417
|
-
*
|
|
1418
|
-
*
|
|
1440
|
+
* </important>
|
|
1441
|
+
* <p>Default: None </p>
|
|
1419
1442
|
*/
|
|
1420
1443
|
DefaultInstanceWarmup?: number;
|
|
1444
|
+
/**
|
|
1445
|
+
* <p>
|
|
1446
|
+
* <b>Reserved for use with Amazon VPC Lattice, which is in preview release and is subject to
|
|
1447
|
+
* change. Do not use this parameter for production workloads. It is also subject to change.</b>
|
|
1448
|
+
* </p>
|
|
1449
|
+
* <p>The unique identifiers of one or more traffic sources.</p>
|
|
1450
|
+
* <p>Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice
|
|
1451
|
+
* target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups.
|
|
1452
|
+
* The target groups receive incoming traffic and route requests to one or more registered
|
|
1453
|
+
* targets.</p>
|
|
1454
|
+
*/
|
|
1455
|
+
TrafficSources?: TrafficSourceIdentifier[];
|
|
1421
1456
|
}
|
|
1422
1457
|
/**
|
|
1423
1458
|
* <p>Describes information used to set up an Amazon EBS volume specified in a block device
|
|
@@ -1426,31 +1461,31 @@ export interface CreateAutoScalingGroupType {
|
|
|
1426
1461
|
export interface Ebs {
|
|
1427
1462
|
/**
|
|
1428
1463
|
* <p>The snapshot ID of the volume to use.</p>
|
|
1429
|
-
*
|
|
1464
|
+
* <p>You must specify either a <code>VolumeSize</code> or a <code>SnapshotId</code>.</p>
|
|
1430
1465
|
*/
|
|
1431
1466
|
SnapshotId?: string;
|
|
1432
1467
|
/**
|
|
1433
1468
|
* <p>The volume size, in GiBs. The following are the supported volumes sizes for each
|
|
1434
1469
|
* volume type: </p>
|
|
1435
|
-
*
|
|
1470
|
+
* <ul>
|
|
1436
1471
|
* <li>
|
|
1437
|
-
*
|
|
1472
|
+
* <p>
|
|
1438
1473
|
* <code>gp2</code> and <code>gp3</code>: 1-16,384</p>
|
|
1439
1474
|
* </li>
|
|
1440
1475
|
* <li>
|
|
1441
|
-
*
|
|
1476
|
+
* <p>
|
|
1442
1477
|
* <code>io1</code>: 4-16,384</p>
|
|
1443
1478
|
* </li>
|
|
1444
1479
|
* <li>
|
|
1445
|
-
*
|
|
1480
|
+
* <p>
|
|
1446
1481
|
* <code>st1</code> and <code>sc1</code>: 125-16,384</p>
|
|
1447
1482
|
* </li>
|
|
1448
1483
|
* <li>
|
|
1449
|
-
*
|
|
1484
|
+
* <p>
|
|
1450
1485
|
* <code>standard</code>: 1-1,024</p>
|
|
1451
1486
|
* </li>
|
|
1452
1487
|
* </ul>
|
|
1453
|
-
*
|
|
1488
|
+
* <p>You must specify either a <code>SnapshotId</code> or a <code>VolumeSize</code>. If you
|
|
1454
1489
|
* specify both <code>SnapshotId</code> and <code>VolumeSize</code>, the volume size must
|
|
1455
1490
|
* be equal or greater than the size of the snapshot.</p>
|
|
1456
1491
|
*/
|
|
@@ -1458,7 +1493,7 @@ export interface Ebs {
|
|
|
1458
1493
|
/**
|
|
1459
1494
|
* <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
|
|
1460
1495
|
* <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
1461
|
-
*
|
|
1496
|
+
* <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> |
|
|
1462
1497
|
* <code>st1</code> | <code>sc1</code> | <code>gp3</code>
|
|
1463
1498
|
* </p>
|
|
1464
1499
|
*/
|
|
@@ -1474,21 +1509,21 @@ export interface Ebs {
|
|
|
1474
1509
|
* IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents
|
|
1475
1510
|
* the baseline performance of the volume and the rate at which the volume accumulates I/O
|
|
1476
1511
|
* credits for bursting. </p>
|
|
1477
|
-
*
|
|
1478
|
-
*
|
|
1512
|
+
* <p>The following are the supported values for each volume type: </p>
|
|
1513
|
+
* <ul>
|
|
1479
1514
|
* <li>
|
|
1480
|
-
*
|
|
1515
|
+
* <p>
|
|
1481
1516
|
* <code>gp3</code>: 3,000-16,000 IOPS</p>
|
|
1482
1517
|
* </li>
|
|
1483
1518
|
* <li>
|
|
1484
|
-
*
|
|
1519
|
+
* <p>
|
|
1485
1520
|
* <code>io1</code>: 100-64,000 IOPS</p>
|
|
1486
1521
|
* </li>
|
|
1487
1522
|
* </ul>
|
|
1488
|
-
*
|
|
1523
|
+
* <p>For <code>io1</code> volumes, we guarantee 64,000 IOPS only for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Instances
|
|
1489
1524
|
* built on the Nitro System</a>. Other instance families guarantee performance up
|
|
1490
1525
|
* to 32,000 IOPS. </p>
|
|
1491
|
-
*
|
|
1526
|
+
* <p>
|
|
1492
1527
|
* <code>Iops</code> is supported when the volume type is <code>gp3</code> or
|
|
1493
1528
|
* <code>io1</code> and required only when the volume type is <code>io1</code>. (Not
|
|
1494
1529
|
* used with <code>standard</code>, <code>gp2</code>, <code>st1</code>, or <code>sc1</code>
|
|
@@ -1499,7 +1534,7 @@ export interface Ebs {
|
|
|
1499
1534
|
* <p>Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be
|
|
1500
1535
|
* 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
|
|
1501
1536
|
* only launch it on supported instance types.</p>
|
|
1502
|
-
*
|
|
1537
|
+
* <note>
|
|
1503
1538
|
* <p>If you are creating a volume from a snapshot, you cannot create an unencrypted
|
|
1504
1539
|
* volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using
|
|
1505
1540
|
* a launch configuration.</p>
|
|
@@ -1508,7 +1543,7 @@ export interface Ebs {
|
|
|
1508
1543
|
* regardless of whether the snapshot was encrypted. </p>
|
|
1509
1544
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption">Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes</a> in the
|
|
1510
1545
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1511
|
-
*
|
|
1546
|
+
* </note>
|
|
1512
1547
|
*/
|
|
1513
1548
|
Encrypted?: boolean;
|
|
1514
1549
|
/**
|
|
@@ -1531,11 +1566,11 @@ export interface BlockDeviceMapping {
|
|
|
1531
1566
|
* <p>The device name assigned to the volume (for example, <code>/dev/sdh</code> or
|
|
1532
1567
|
* <code>xvdh</code>). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html">Device naming on Linux
|
|
1533
1568
|
* instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
1534
|
-
*
|
|
1569
|
+
* <note>
|
|
1535
1570
|
* <p>To define a block device mapping, set the device name and exactly one of the
|
|
1536
1571
|
* following properties: <code>Ebs</code>, <code>NoDevice</code>, or
|
|
1537
1572
|
* <code>VirtualName</code>.</p>
|
|
1538
|
-
*
|
|
1573
|
+
* </note>
|
|
1539
1574
|
*/
|
|
1540
1575
|
DeviceName: string | undefined;
|
|
1541
1576
|
/**
|
|
@@ -1546,7 +1581,7 @@ export interface BlockDeviceMapping {
|
|
|
1546
1581
|
* <p>Setting this value to <code>true</code> prevents a volume that is included in the
|
|
1547
1582
|
* block device mapping of the AMI from being mapped to the specified device name at
|
|
1548
1583
|
* launch.</p>
|
|
1549
|
-
*
|
|
1584
|
+
* <p>If <code>NoDevice</code> is <code>true</code> for the root device, instances might
|
|
1550
1585
|
* fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.</p>
|
|
1551
1586
|
*/
|
|
1552
1587
|
NoDevice?: boolean;
|
|
@@ -1577,12 +1612,12 @@ export interface InstanceMetadataOptions {
|
|
|
1577
1612
|
/**
|
|
1578
1613
|
* <p>The state of token usage for your instance metadata requests. If the parameter is not
|
|
1579
1614
|
* specified in the request, the default state is <code>optional</code>.</p>
|
|
1580
|
-
*
|
|
1615
|
+
* <p>If the state is <code>optional</code>, you can choose to retrieve instance metadata
|
|
1581
1616
|
* with or without a signed token header on your request. If you retrieve the IAM role
|
|
1582
1617
|
* credentials without a token, the version 1.0 role credentials are returned. If you
|
|
1583
1618
|
* retrieve the IAM role credentials using a valid signed token, the version 2.0 role
|
|
1584
1619
|
* credentials are returned.</p>
|
|
1585
|
-
*
|
|
1620
|
+
* <p>If the state is <code>required</code>, you must send a signed token header with any
|
|
1586
1621
|
* instance metadata retrieval requests. In this state, retrieving the IAM role credentials
|
|
1587
1622
|
* always returns the version 2.0 credentials; the version 1.0 credentials are not
|
|
1588
1623
|
* available.</p>
|
|
@@ -1591,16 +1626,16 @@ export interface InstanceMetadataOptions {
|
|
|
1591
1626
|
/**
|
|
1592
1627
|
* <p>The desired HTTP PUT response hop limit for instance metadata requests. The larger the
|
|
1593
1628
|
* number, the further instance metadata requests can travel.</p>
|
|
1594
|
-
*
|
|
1629
|
+
* <p>Default: 1</p>
|
|
1595
1630
|
*/
|
|
1596
1631
|
HttpPutResponseHopLimit?: number;
|
|
1597
1632
|
/**
|
|
1598
1633
|
* <p>This parameter enables or disables the HTTP metadata endpoint on your instances. If
|
|
1599
1634
|
* the parameter is not specified, the default state is <code>enabled</code>.</p>
|
|
1600
|
-
*
|
|
1635
|
+
* <note>
|
|
1601
1636
|
* <p>If you specify a value of <code>disabled</code>, you will not be able to access
|
|
1602
1637
|
* your instance metadata. </p>
|
|
1603
|
-
*
|
|
1638
|
+
* </note>
|
|
1604
1639
|
*/
|
|
1605
1640
|
HttpEndpoint?: InstanceMetadataEndpointState | string;
|
|
1606
1641
|
}
|
|
@@ -1614,7 +1649,7 @@ export interface CreateLaunchConfigurationType {
|
|
|
1614
1649
|
* <p>The ID of the Amazon Machine Image (AMI) that was assigned during registration. For
|
|
1615
1650
|
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding a Linux AMI</a> in the
|
|
1616
1651
|
* <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
1617
|
-
*
|
|
1652
|
+
* <p>If you specify <code>InstanceId</code>, an <code>ImageId</code> is not
|
|
1618
1653
|
* required.</p>
|
|
1619
1654
|
*/
|
|
1620
1655
|
ImageId?: string;
|
|
@@ -1650,9 +1685,9 @@ export interface CreateLaunchConfigurationType {
|
|
|
1650
1685
|
* <p>The ID of the instance to use to create the launch configuration. The new launch
|
|
1651
1686
|
* configuration derives attributes from the instance, except for the block device
|
|
1652
1687
|
* mapping.</p>
|
|
1653
|
-
*
|
|
1688
|
+
* <p>To create a launch configuration with a block device mapping or override any other
|
|
1654
1689
|
* instance attributes, specify them as part of the same request.</p>
|
|
1655
|
-
*
|
|
1690
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html">Creating a launch
|
|
1656
1691
|
* configuration using an EC2 instance</a> in the
|
|
1657
1692
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1658
1693
|
*/
|
|
@@ -1661,28 +1696,28 @@ export interface CreateLaunchConfigurationType {
|
|
|
1661
1696
|
* <p>Specifies the instance type of the EC2 instance. For information about available
|
|
1662
1697
|
* instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes">Available
|
|
1663
1698
|
* instance types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
1664
|
-
*
|
|
1699
|
+
* <p>If you specify <code>InstanceId</code>, an <code>InstanceType</code> is not
|
|
1665
1700
|
* required.</p>
|
|
1666
1701
|
*/
|
|
1667
1702
|
InstanceType?: string;
|
|
1668
1703
|
/**
|
|
1669
1704
|
* <p>The ID of the kernel associated with the AMI.</p>
|
|
1670
|
-
*
|
|
1705
|
+
* <note>
|
|
1671
1706
|
* <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
|
|
1672
1707
|
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided
|
|
1673
1708
|
* kernels</a> in the <i>Amazon EC2 User Guide for Linux
|
|
1674
1709
|
* Instances</i>.</p>
|
|
1675
|
-
*
|
|
1710
|
+
* </note>
|
|
1676
1711
|
*/
|
|
1677
1712
|
KernelId?: string;
|
|
1678
1713
|
/**
|
|
1679
1714
|
* <p>The ID of the RAM disk to select.</p>
|
|
1680
|
-
*
|
|
1715
|
+
* <note>
|
|
1681
1716
|
* <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
|
|
1682
1717
|
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided
|
|
1683
1718
|
* kernels</a> in the <i>Amazon EC2 User Guide for Linux
|
|
1684
1719
|
* Instances</i>.</p>
|
|
1685
|
-
*
|
|
1720
|
+
* </note>
|
|
1686
1721
|
*/
|
|
1687
1722
|
RamdiskId?: string;
|
|
1688
1723
|
/**
|
|
@@ -1695,14 +1730,14 @@ export interface CreateLaunchConfigurationType {
|
|
|
1695
1730
|
/**
|
|
1696
1731
|
* <p>Controls whether instances in this group are launched with detailed
|
|
1697
1732
|
* (<code>true</code>) or basic (<code>false</code>) monitoring.</p>
|
|
1698
|
-
*
|
|
1699
|
-
*
|
|
1733
|
+
* <p>The default value is <code>true</code> (enabled).</p>
|
|
1734
|
+
* <important>
|
|
1700
1735
|
* <p>When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and
|
|
1701
1736
|
* your account is charged a fee. When you disable detailed monitoring, CloudWatch generates
|
|
1702
1737
|
* metrics every 5 minutes. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html">Configure
|
|
1703
1738
|
* Monitoring for Auto Scaling Instances</a> in the
|
|
1704
1739
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1705
|
-
*
|
|
1740
|
+
* </important>
|
|
1706
1741
|
*/
|
|
1707
1742
|
InstanceMonitoring?: InstanceMonitoring;
|
|
1708
1743
|
/**
|
|
@@ -1711,12 +1746,12 @@ export interface CreateLaunchConfigurationType {
|
|
|
1711
1746
|
* price. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html">Request Spot
|
|
1712
1747
|
* Instances for fault-tolerant and flexible applications</a> in the
|
|
1713
1748
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1714
|
-
*
|
|
1715
|
-
*
|
|
1749
|
+
* <p>Valid Range: Minimum value of 0.001</p>
|
|
1750
|
+
* <note>
|
|
1716
1751
|
* <p>When you change your maximum price by creating a new launch configuration, running
|
|
1717
1752
|
* instances will continue to run as long as the maximum price for those running
|
|
1718
1753
|
* instances is higher than the current Spot price.</p>
|
|
1719
|
-
*
|
|
1754
|
+
* </note>
|
|
1720
1755
|
*/
|
|
1721
1756
|
SpotPrice?: string;
|
|
1722
1757
|
/**
|
|
@@ -1734,7 +1769,7 @@ export interface CreateLaunchConfigurationType {
|
|
|
1734
1769
|
* are incurred when you enable EBS optimization for an instance type that is not
|
|
1735
1770
|
* EBS-optimized by default. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html">Amazon EBS-optimized instances</a> in
|
|
1736
1771
|
* the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
1737
|
-
*
|
|
1772
|
+
* <p>The default value is <code>false</code>.</p>
|
|
1738
1773
|
*/
|
|
1739
1774
|
EbsOptimized?: boolean;
|
|
1740
1775
|
/**
|
|
@@ -1744,10 +1779,10 @@ export interface CreateLaunchConfigurationType {
|
|
|
1744
1779
|
* If the instance is launched into a nondefault subnet, the default is not to assign a
|
|
1745
1780
|
* public IPv4 address, unless you enabled the option to assign a public IPv4 address on
|
|
1746
1781
|
* the subnet.</p>
|
|
1747
|
-
*
|
|
1782
|
+
* <p>If you specify <code>true</code>, each instance in the Auto Scaling group receives a unique
|
|
1748
1783
|
* public IPv4 address. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html">Launching Auto Scaling instances in a
|
|
1749
1784
|
* VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1750
|
-
*
|
|
1785
|
+
* <p>If you specify this property, you must specify at least one subnet for
|
|
1751
1786
|
* <code>VPCZoneIdentifier</code> when you create your group.</p>
|
|
1752
1787
|
*/
|
|
1753
1788
|
AssociatePublicIpAddress?: boolean;
|
|
@@ -1760,10 +1795,10 @@ export interface CreateLaunchConfigurationType {
|
|
|
1760
1795
|
* see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html">Configuring
|
|
1761
1796
|
* instance tenancy with Amazon EC2 Auto Scaling</a> in the
|
|
1762
1797
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1763
|
-
*
|
|
1798
|
+
* <p>If you specify <code>PlacementTenancy</code>, you must specify at least one subnet for
|
|
1764
1799
|
* <code>VPCZoneIdentifier</code> when you create your group.</p>
|
|
1765
|
-
*
|
|
1766
|
-
*
|
|
1800
|
+
* <p>Valid values: <code>default</code> | <code>dedicated</code>
|
|
1801
|
+
* </p>
|
|
1767
1802
|
*/
|
|
1768
1803
|
PlacementTenancy?: string;
|
|
1769
1804
|
/**
|
|
@@ -1911,63 +1946,63 @@ export interface DescribeAdjustmentTypesAnswer {
|
|
|
1911
1946
|
/**
|
|
1912
1947
|
* <p>Describes a filter that is used to return a more specific list of results from a
|
|
1913
1948
|
* describe operation.</p>
|
|
1914
|
-
*
|
|
1949
|
+
* <p>If you specify multiple filters, the filters are automatically logically joined with
|
|
1915
1950
|
* an <code>AND</code>, and the request returns only the results that match all of the
|
|
1916
1951
|
* specified filters. </p>
|
|
1917
|
-
*
|
|
1952
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html">Tag Auto Scaling groups and
|
|
1918
1953
|
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
1919
1954
|
*/
|
|
1920
1955
|
export interface Filter {
|
|
1921
1956
|
/**
|
|
1922
1957
|
* <p>The name of the filter.</p>
|
|
1923
|
-
*
|
|
1958
|
+
* <p>The valid values for <code>Name</code> depend on which API operation you're using with
|
|
1924
1959
|
* the filter (<a>DescribeAutoScalingGroups</a> or <a>DescribeTags</a>).</p>
|
|
1925
|
-
*
|
|
1960
|
+
* <p>
|
|
1926
1961
|
* <b>DescribeAutoScalingGroups</b>
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1929
|
-
*
|
|
1962
|
+
* </p>
|
|
1963
|
+
* <p>Valid values for <code>Name</code> include the following: </p>
|
|
1964
|
+
* <ul>
|
|
1930
1965
|
* <li>
|
|
1931
|
-
*
|
|
1966
|
+
* <p>
|
|
1932
1967
|
* <code>tag-key</code> - Accepts tag keys. The results only include information
|
|
1933
1968
|
* about the Auto Scaling groups associated with these tag keys. </p>
|
|
1934
1969
|
* </li>
|
|
1935
1970
|
* <li>
|
|
1936
|
-
*
|
|
1971
|
+
* <p>
|
|
1937
1972
|
* <code>tag-value</code> - Accepts tag values. The results only include
|
|
1938
1973
|
* information about the Auto Scaling groups associated with these tag values. </p>
|
|
1939
1974
|
* </li>
|
|
1940
1975
|
* <li>
|
|
1941
|
-
*
|
|
1976
|
+
* <p>
|
|
1942
1977
|
* <code>tag:<key></code> - Accepts the key/value combination of the tag.
|
|
1943
1978
|
* Use the tag key in the filter name and the tag value as the filter value. The
|
|
1944
1979
|
* results only include information about the Auto Scaling groups associated with the
|
|
1945
1980
|
* specified key/value combination. </p>
|
|
1946
1981
|
* </li>
|
|
1947
1982
|
* </ul>
|
|
1948
|
-
*
|
|
1983
|
+
* <p>
|
|
1949
1984
|
* <b>DescribeTags</b>
|
|
1950
|
-
*
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1985
|
+
* </p>
|
|
1986
|
+
* <p>Valid values for <code>Name</code> include the following: </p>
|
|
1987
|
+
* <ul>
|
|
1953
1988
|
* <li>
|
|
1954
|
-
*
|
|
1989
|
+
* <p>
|
|
1955
1990
|
* <code>auto-scaling-group</code> - Accepts the names of Auto Scaling groups. The
|
|
1956
1991
|
* results only include information about the tags associated with these Auto Scaling
|
|
1957
1992
|
* groups. </p>
|
|
1958
1993
|
* </li>
|
|
1959
1994
|
* <li>
|
|
1960
|
-
*
|
|
1995
|
+
* <p>
|
|
1961
1996
|
* <code>key</code> - Accepts tag keys. The results only include information
|
|
1962
1997
|
* about the tags associated with these tag keys. </p>
|
|
1963
1998
|
* </li>
|
|
1964
1999
|
* <li>
|
|
1965
|
-
*
|
|
1966
|
-
*
|
|
2000
|
+
* <p>
|
|
2001
|
+
* <code>value</code> - Accepts tag values. The results only include information
|
|
1967
2002
|
* about the tags associated with these tag values. </p>
|
|
1968
2003
|
* </li>
|
|
1969
2004
|
* <li>
|
|
1970
|
-
*
|
|
2005
|
+
* <p>
|
|
1971
2006
|
* <code>propagate-at-launch</code> - Accepts a Boolean value, which specifies
|
|
1972
2007
|
* whether tags propagate to instances at launch. The results only include
|
|
1973
2008
|
* information about the tags associated with the specified Boolean value. </p>
|
|
@@ -1977,7 +2012,7 @@ export interface Filter {
|
|
|
1977
2012
|
Name?: string;
|
|
1978
2013
|
/**
|
|
1979
2014
|
* <p>One or more filter values. Filter values are case-sensitive. </p>
|
|
1980
|
-
*
|
|
2015
|
+
* <p>If you specify multiple values for a filter, the values are automatically logically
|
|
1981
2016
|
* joined with an <code>OR</code>, and the request returns all results that match any of
|
|
1982
2017
|
* the specified values. For example, specify "tag:environment" for the filter name and
|
|
1983
2018
|
* "production,development" for the filter values to find Auto Scaling groups with the tag
|
|
@@ -1989,7 +2024,7 @@ export interface AutoScalingGroupNamesType {
|
|
|
1989
2024
|
/**
|
|
1990
2025
|
* <p>The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can
|
|
1991
2026
|
* optionally increase this limit using the <code>MaxRecords</code> property.</p>
|
|
1992
|
-
*
|
|
2027
|
+
* <p>If you omit this property, all Auto Scaling groups are described.</p>
|
|
1993
2028
|
*/
|
|
1994
2029
|
AutoScalingGroupNames?: string[];
|
|
1995
2030
|
/**
|
|
@@ -2014,109 +2049,109 @@ export interface AutoScalingGroupNamesType {
|
|
|
2014
2049
|
export interface EnabledMetric {
|
|
2015
2050
|
/**
|
|
2016
2051
|
* <p>One of the following metrics:</p>
|
|
2017
|
-
*
|
|
2052
|
+
* <ul>
|
|
2018
2053
|
* <li>
|
|
2019
|
-
*
|
|
2020
|
-
*
|
|
2021
|
-
*
|
|
2054
|
+
* <p>
|
|
2055
|
+
* <code>GroupMinSize</code>
|
|
2056
|
+
* </p>
|
|
2022
2057
|
* </li>
|
|
2023
2058
|
* <li>
|
|
2024
|
-
*
|
|
2025
|
-
*
|
|
2026
|
-
*
|
|
2059
|
+
* <p>
|
|
2060
|
+
* <code>GroupMaxSize</code>
|
|
2061
|
+
* </p>
|
|
2027
2062
|
* </li>
|
|
2028
2063
|
* <li>
|
|
2029
|
-
*
|
|
2030
|
-
*
|
|
2031
|
-
*
|
|
2064
|
+
* <p>
|
|
2065
|
+
* <code>GroupDesiredCapacity</code>
|
|
2066
|
+
* </p>
|
|
2032
2067
|
* </li>
|
|
2033
2068
|
* <li>
|
|
2034
|
-
*
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2069
|
+
* <p>
|
|
2070
|
+
* <code>GroupInServiceInstances</code>
|
|
2071
|
+
* </p>
|
|
2037
2072
|
* </li>
|
|
2038
2073
|
* <li>
|
|
2039
|
-
*
|
|
2040
|
-
*
|
|
2041
|
-
*
|
|
2074
|
+
* <p>
|
|
2075
|
+
* <code>GroupPendingInstances</code>
|
|
2076
|
+
* </p>
|
|
2042
2077
|
* </li>
|
|
2043
2078
|
* <li>
|
|
2044
|
-
*
|
|
2045
|
-
*
|
|
2046
|
-
*
|
|
2079
|
+
* <p>
|
|
2080
|
+
* <code>GroupStandbyInstances</code>
|
|
2081
|
+
* </p>
|
|
2047
2082
|
* </li>
|
|
2048
2083
|
* <li>
|
|
2049
|
-
*
|
|
2050
|
-
*
|
|
2051
|
-
*
|
|
2084
|
+
* <p>
|
|
2085
|
+
* <code>GroupTerminatingInstances</code>
|
|
2086
|
+
* </p>
|
|
2052
2087
|
* </li>
|
|
2053
2088
|
* <li>
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2089
|
+
* <p>
|
|
2090
|
+
* <code>GroupTotalInstances</code>
|
|
2091
|
+
* </p>
|
|
2057
2092
|
* </li>
|
|
2058
2093
|
* <li>
|
|
2059
|
-
*
|
|
2060
|
-
*
|
|
2061
|
-
*
|
|
2094
|
+
* <p>
|
|
2095
|
+
* <code>GroupInServiceCapacity</code>
|
|
2096
|
+
* </p>
|
|
2062
2097
|
* </li>
|
|
2063
2098
|
* <li>
|
|
2064
|
-
*
|
|
2065
|
-
*
|
|
2066
|
-
*
|
|
2099
|
+
* <p>
|
|
2100
|
+
* <code>GroupPendingCapacity</code>
|
|
2101
|
+
* </p>
|
|
2067
2102
|
* </li>
|
|
2068
2103
|
* <li>
|
|
2069
|
-
*
|
|
2070
|
-
*
|
|
2071
|
-
*
|
|
2104
|
+
* <p>
|
|
2105
|
+
* <code>GroupStandbyCapacity</code>
|
|
2106
|
+
* </p>
|
|
2072
2107
|
* </li>
|
|
2073
2108
|
* <li>
|
|
2074
|
-
*
|
|
2075
|
-
*
|
|
2076
|
-
*
|
|
2109
|
+
* <p>
|
|
2110
|
+
* <code>GroupTerminatingCapacity</code>
|
|
2111
|
+
* </p>
|
|
2077
2112
|
* </li>
|
|
2078
2113
|
* <li>
|
|
2079
|
-
*
|
|
2080
|
-
*
|
|
2081
|
-
*
|
|
2114
|
+
* <p>
|
|
2115
|
+
* <code>GroupTotalCapacity</code>
|
|
2116
|
+
* </p>
|
|
2082
2117
|
* </li>
|
|
2083
2118
|
* <li>
|
|
2084
|
-
*
|
|
2085
|
-
*
|
|
2086
|
-
*
|
|
2119
|
+
* <p>
|
|
2120
|
+
* <code>WarmPoolDesiredCapacity</code>
|
|
2121
|
+
* </p>
|
|
2087
2122
|
* </li>
|
|
2088
2123
|
* <li>
|
|
2089
|
-
*
|
|
2090
|
-
*
|
|
2091
|
-
*
|
|
2124
|
+
* <p>
|
|
2125
|
+
* <code>WarmPoolWarmedCapacity</code>
|
|
2126
|
+
* </p>
|
|
2092
2127
|
* </li>
|
|
2093
2128
|
* <li>
|
|
2094
|
-
*
|
|
2095
|
-
*
|
|
2096
|
-
*
|
|
2129
|
+
* <p>
|
|
2130
|
+
* <code>WarmPoolPendingCapacity</code>
|
|
2131
|
+
* </p>
|
|
2097
2132
|
* </li>
|
|
2098
2133
|
* <li>
|
|
2099
|
-
*
|
|
2100
|
-
*
|
|
2101
|
-
*
|
|
2134
|
+
* <p>
|
|
2135
|
+
* <code>WarmPoolTerminatingCapacity</code>
|
|
2136
|
+
* </p>
|
|
2102
2137
|
* </li>
|
|
2103
2138
|
* <li>
|
|
2104
|
-
*
|
|
2105
|
-
*
|
|
2106
|
-
*
|
|
2139
|
+
* <p>
|
|
2140
|
+
* <code>WarmPoolTotalCapacity</code>
|
|
2141
|
+
* </p>
|
|
2107
2142
|
* </li>
|
|
2108
2143
|
* <li>
|
|
2109
|
-
*
|
|
2110
|
-
*
|
|
2111
|
-
*
|
|
2144
|
+
* <p>
|
|
2145
|
+
* <code>GroupAndWarmPoolDesiredCapacity</code>
|
|
2146
|
+
* </p>
|
|
2112
2147
|
* </li>
|
|
2113
2148
|
* <li>
|
|
2114
|
-
*
|
|
2115
|
-
*
|
|
2116
|
-
*
|
|
2149
|
+
* <p>
|
|
2150
|
+
* <code>GroupAndWarmPoolTotalCapacity</code>
|
|
2151
|
+
* </p>
|
|
2117
2152
|
* </li>
|
|
2118
2153
|
* </ul>
|
|
2119
|
-
*
|
|
2154
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics">Auto Scaling group metrics</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
2120
2155
|
*/
|
|
2121
2156
|
Metric?: string;
|
|
2122
2157
|
/**
|
|
@@ -2193,13 +2228,13 @@ export interface Instance {
|
|
|
2193
2228
|
/**
|
|
2194
2229
|
* <p>The number of capacity units contributed by the instance based on its instance
|
|
2195
2230
|
* type.</p>
|
|
2196
|
-
*
|
|
2231
|
+
* <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>
|
|
2197
2232
|
*/
|
|
2198
2233
|
WeightedCapacity?: string;
|
|
2199
2234
|
}
|
|
2200
2235
|
/**
|
|
2201
2236
|
* <p>Describes an auto scaling process that has been suspended.</p>
|
|
2202
|
-
*
|
|
2237
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types">Scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
2203
2238
|
*/
|
|
2204
2239
|
export interface SuspendedProcess {
|
|
2205
2240
|
/**
|
|
@@ -2240,7 +2275,7 @@ export interface TagDescription {
|
|
|
2240
2275
|
}
|
|
2241
2276
|
/**
|
|
2242
2277
|
* <p>Describes an instance reuse policy for a warm pool. </p>
|
|
2243
|
-
*
|
|
2278
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
|
|
2244
2279
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
2245
2280
|
*/
|
|
2246
2281
|
export interface InstanceReusePolicy {
|
|
@@ -2341,10 +2376,11 @@ export interface AutoScalingGroup {
|
|
|
2341
2376
|
*/
|
|
2342
2377
|
TargetGroupARNs?: string[];
|
|
2343
2378
|
/**
|
|
2344
|
-
* <p>
|
|
2345
|
-
*
|
|
2346
|
-
*
|
|
2347
|
-
*
|
|
2379
|
+
* <p>Determines whether any additional health checks are performed on the instances in this
|
|
2380
|
+
* group. Amazon EC2 health checks are always on.</p>
|
|
2381
|
+
* <p>The valid values are <code>EC2</code> (default), <code>ELB</code>, and
|
|
2382
|
+
* <code>VPC_LATTICE</code>. The <code>VPC_LATTICE</code> health check type is reserved
|
|
2383
|
+
* for use with VPC Lattice, which is in preview release and is subject to change.</p>
|
|
2348
2384
|
*/
|
|
2349
2385
|
HealthCheckType: string | undefined;
|
|
2350
2386
|
/**
|
|
@@ -2400,7 +2436,7 @@ export interface AutoScalingGroup {
|
|
|
2400
2436
|
ServiceLinkedRoleARN?: string;
|
|
2401
2437
|
/**
|
|
2402
2438
|
* <p>The maximum amount of time, in seconds, that an instance can be in service.</p>
|
|
2403
|
-
*
|
|
2439
|
+
* <p>Valid Range: Minimum value of 0.</p>
|
|
2404
2440
|
*/
|
|
2405
2441
|
MaxInstanceLifetime?: number;
|
|
2406
2442
|
/**
|
|
@@ -2429,6 +2465,10 @@ export interface AutoScalingGroup {
|
|
|
2429
2465
|
* <p>The duration of the default instance warmup, in seconds.</p>
|
|
2430
2466
|
*/
|
|
2431
2467
|
DefaultInstanceWarmup?: number;
|
|
2468
|
+
/**
|
|
2469
|
+
* <p>The unique identifiers of the traffic sources.</p>
|
|
2470
|
+
*/
|
|
2471
|
+
TrafficSources?: TrafficSourceIdentifier[];
|
|
2432
2472
|
}
|
|
2433
2473
|
export interface AutoScalingGroupsType {
|
|
2434
2474
|
/**
|
|
@@ -2478,7 +2518,7 @@ export interface AutoScalingInstanceDetails {
|
|
|
2478
2518
|
* <p>The lifecycle state for the instance. The <code>Quarantined</code> state is not used.
|
|
2479
2519
|
* For information about lifecycle states, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html">Instance
|
|
2480
2520
|
* lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
|
|
2481
|
-
*
|
|
2521
|
+
* <p>Valid values: <code>Pending</code> | <code>Pending:Wait</code> |
|
|
2482
2522
|
* <code>Pending:Proceed</code> | <code>Quarantined</code> | <code>InService</code> |
|
|
2483
2523
|
* <code>Terminating</code> | <code>Terminating:Wait</code> |
|
|
2484
2524
|
* <code>Terminating:Proceed</code> | <code>Terminated</code> | <code>Detaching</code>
|
|
@@ -2514,7 +2554,7 @@ export interface AutoScalingInstanceDetails {
|
|
|
2514
2554
|
/**
|
|
2515
2555
|
* <p>The number of capacity units contributed by the instance based on its instance
|
|
2516
2556
|
* type.</p>
|
|
2517
|
-
*
|
|
2557
|
+
* <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>
|
|
2518
2558
|
*/
|
|
2519
2559
|
WeightedCapacity?: string;
|
|
2520
2560
|
}
|
|
@@ -2535,7 +2575,7 @@ export interface DescribeAutoScalingInstancesType {
|
|
|
2535
2575
|
/**
|
|
2536
2576
|
* <p>The IDs of the instances. If you omit this property, all Auto Scaling instances are described.
|
|
2537
2577
|
* If you specify an ID that does not exist, it is ignored with no error.</p>
|
|
2538
|
-
*
|
|
2578
|
+
* <p>Array Members: Maximum number of 50 items.</p>
|
|
2539
2579
|
*/
|
|
2540
2580
|
InstanceIds?: string[];
|
|
2541
2581
|
/**
|
|
@@ -2557,7 +2597,7 @@ export interface DescribeAutoScalingNotificationTypesAnswer {
|
|
|
2557
2597
|
}
|
|
2558
2598
|
/**
|
|
2559
2599
|
* <p>Describes the desired configuration for an instance refresh. </p>
|
|
2560
|
-
*
|
|
2600
|
+
* <p>If you specify a desired configuration, you must specify either a
|
|
2561
2601
|
* <code>LaunchTemplate</code> or a <code>MixedInstancesPolicy</code>. </p>
|
|
2562
2602
|
*/
|
|
2563
2603
|
export interface DesiredConfiguration {
|
|
@@ -2570,7 +2610,7 @@ export interface DesiredConfiguration {
|
|
|
2570
2610
|
/**
|
|
2571
2611
|
* <p>Use this structure to launch multiple instance types and On-Demand Instances and Spot
|
|
2572
2612
|
* Instances within a single Auto Scaling group.</p>
|
|
2573
|
-
*
|
|
2613
|
+
* <p>A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch
|
|
2574
2614
|
* instances and help optimize your costs. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling
|
|
2575
2615
|
* groups with multiple instance types and purchase options</a> in the
|
|
2576
2616
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
@@ -2586,7 +2626,7 @@ export interface RefreshPreferences {
|
|
|
2586
2626
|
* allow the operation to continue. The value is expressed as a percentage of the desired
|
|
2587
2627
|
* capacity of the Auto Scaling group (rounded up to the nearest integer). The default is
|
|
2588
2628
|
* <code>90</code>.</p>
|
|
2589
|
-
*
|
|
2629
|
+
* <p>Setting the minimum healthy percentage to 100 percent limits the rate of replacement
|
|
2590
2630
|
* to one instance at a time. In contrast, setting it to 0 percent has the effect of
|
|
2591
2631
|
* replacing all instances at the same time. </p>
|
|
2592
2632
|
*/
|
|
@@ -2596,19 +2636,19 @@ export interface RefreshPreferences {
|
|
|
2596
2636
|
* <i>Not needed if the default instance warmup is defined for the
|
|
2597
2637
|
* group.</i>
|
|
2598
2638
|
* </p>
|
|
2599
|
-
*
|
|
2600
|
-
*
|
|
2639
|
+
* <p>The duration of the instance warmup, in seconds.</p>
|
|
2640
|
+
* <note>
|
|
2601
2641
|
* <p>The default is to use the value for the default instance warmup defined for the
|
|
2602
2642
|
* group. If default instance warmup is null, then <code>InstanceWarmup</code> falls
|
|
2603
2643
|
* back to the value of the health check grace period.</p>
|
|
2604
|
-
*
|
|
2644
|
+
* </note>
|
|
2605
2645
|
*/
|
|
2606
2646
|
InstanceWarmup?: number;
|
|
2607
2647
|
/**
|
|
2608
2648
|
* <p>Threshold values for each checkpoint in ascending order. Each number must be unique.
|
|
2609
2649
|
* To replace all instances in the Auto Scaling group, the last number in the array must be
|
|
2610
2650
|
* <code>100</code>.</p>
|
|
2611
|
-
*
|
|
2651
|
+
* <p>For usage examples, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html">Adding
|
|
2612
2652
|
* checkpoints to an instance refresh</a> in the
|
|
2613
2653
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
2614
2654
|
*/
|
|
@@ -2705,33 +2745,33 @@ export interface InstanceRefresh {
|
|
|
2705
2745
|
AutoScalingGroupName?: string;
|
|
2706
2746
|
/**
|
|
2707
2747
|
* <p>The current status for the instance refresh operation:</p>
|
|
2708
|
-
*
|
|
2748
|
+
* <ul>
|
|
2709
2749
|
* <li>
|
|
2710
|
-
*
|
|
2750
|
+
* <p>
|
|
2711
2751
|
* <code>Pending</code> - The request was created, but the operation has not
|
|
2712
2752
|
* started.</p>
|
|
2713
2753
|
* </li>
|
|
2714
2754
|
* <li>
|
|
2715
|
-
*
|
|
2755
|
+
* <p>
|
|
2716
2756
|
* <code>InProgress</code> - The operation is in progress.</p>
|
|
2717
2757
|
* </li>
|
|
2718
2758
|
* <li>
|
|
2719
|
-
*
|
|
2759
|
+
* <p>
|
|
2720
2760
|
* <code>Successful</code> - The operation completed successfully.</p>
|
|
2721
2761
|
* </li>
|
|
2722
2762
|
* <li>
|
|
2723
|
-
*
|
|
2763
|
+
* <p>
|
|
2724
2764
|
* <code>Failed</code> - The operation failed to complete. You can troubleshoot
|
|
2725
2765
|
* using the status reason and the scaling activities. </p>
|
|
2726
2766
|
* </li>
|
|
2727
2767
|
* <li>
|
|
2728
|
-
*
|
|
2768
|
+
* <p>
|
|
2729
2769
|
* <code>Cancelling</code> - An ongoing operation is being cancelled.
|
|
2730
2770
|
* Cancellation does not roll back any replacements that have already been
|
|
2731
2771
|
* completed, but it prevents new replacements from being started. </p>
|
|
2732
2772
|
* </li>
|
|
2733
2773
|
* <li>
|
|
2734
|
-
*
|
|
2774
|
+
* <p>
|
|
2735
2775
|
* <code>Cancelled</code> - The operation is cancelled. </p>
|
|
2736
2776
|
* </li>
|
|
2737
2777
|
* </ul>
|
|
@@ -2811,7 +2851,7 @@ export interface LaunchConfigurationNamesType {
|
|
|
2811
2851
|
/**
|
|
2812
2852
|
* <p>The launch configuration names. If you omit this property, all launch configurations
|
|
2813
2853
|
* are described.</p>
|
|
2814
|
-
*
|
|
2854
|
+
* <p>Array Members: Maximum number of 50 items.</p>
|
|
2815
2855
|
*/
|
|
2816
2856
|
LaunchConfigurationNames?: string[];
|
|
2817
2857
|
/**
|
|
@@ -2845,7 +2885,7 @@ export interface LaunchConfiguration {
|
|
|
2845
2885
|
ImageId: string | undefined;
|
|
2846
2886
|
/**
|
|
2847
2887
|
* <p>The name of the key pair.</p>
|
|
2848
|
-
*
|
|
2888
|
+
* <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
|
|
2849
2889
|
* <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
2850
2890
|
*/
|
|
2851
2891
|
KeyName?: string;
|
|
@@ -2896,7 +2936,7 @@ export interface LaunchConfiguration {
|
|
|
2896
2936
|
/**
|
|
2897
2937
|
* <p>Controls whether instances in this group are launched with detailed
|
|
2898
2938
|
* (<code>true</code>) or basic (<code>false</code>) monitoring.</p>
|
|
2899
|
-
*
|
|
2939
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html">Configure
|
|
2900
2940
|
* Monitoring for Auto Scaling Instances</a> in the
|
|
2901
2941
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
2902
2942
|
*/
|
|
@@ -2939,7 +2979,7 @@ export interface LaunchConfiguration {
|
|
|
2939
2979
|
* <p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An
|
|
2940
2980
|
* instance with <code>dedicated</code> tenancy runs on isolated, single-tenant hardware
|
|
2941
2981
|
* and can only be launched into a VPC.</p>
|
|
2942
|
-
*
|
|
2982
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html">Configuring
|
|
2943
2983
|
* instance tenancy with Amazon EC2 Auto Scaling</a> in the
|
|
2944
2984
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
2945
2985
|
*/
|
|
@@ -2980,7 +3020,7 @@ export interface LifecycleHook {
|
|
|
2980
3020
|
AutoScalingGroupName?: string;
|
|
2981
3021
|
/**
|
|
2982
3022
|
* <p>The lifecycle transition.</p>
|
|
2983
|
-
*
|
|
3023
|
+
* <p>Valid values: <code>autoscaling:EC2_INSTANCE_LAUNCHING</code> |
|
|
2984
3024
|
* <code>autoscaling:EC2_INSTANCE_TERMINATING</code>
|
|
2985
3025
|
* </p>
|
|
2986
3026
|
*/
|
|
@@ -3015,7 +3055,7 @@ export interface LifecycleHook {
|
|
|
3015
3055
|
/**
|
|
3016
3056
|
* <p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an
|
|
3017
3057
|
* unexpected failure occurs.</p>
|
|
3018
|
-
*
|
|
3058
|
+
* <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code>
|
|
3019
3059
|
* </p>
|
|
3020
3060
|
*/
|
|
3021
3061
|
DefaultResult?: string;
|
|
@@ -3069,30 +3109,30 @@ export interface LoadBalancerState {
|
|
|
3069
3109
|
LoadBalancerName?: string;
|
|
3070
3110
|
/**
|
|
3071
3111
|
* <p>One of the following load balancer states:</p>
|
|
3072
|
-
*
|
|
3112
|
+
* <ul>
|
|
3073
3113
|
* <li>
|
|
3074
|
-
*
|
|
3114
|
+
* <p>
|
|
3075
3115
|
* <code>Adding</code> - The Auto Scaling instances are being registered with the load
|
|
3076
3116
|
* balancer.</p>
|
|
3077
3117
|
* </li>
|
|
3078
3118
|
* <li>
|
|
3079
|
-
*
|
|
3080
|
-
*
|
|
3119
|
+
* <p>
|
|
3120
|
+
* <code>Added</code> - All Auto Scaling instances are registered with the load
|
|
3081
3121
|
* balancer.</p>
|
|
3082
3122
|
* </li>
|
|
3083
3123
|
* <li>
|
|
3084
|
-
*
|
|
3124
|
+
* <p>
|
|
3085
3125
|
* <code>InService</code> - At least one Auto Scaling instance passed an <code>ELB</code>
|
|
3086
3126
|
* health check.</p>
|
|
3087
3127
|
* </li>
|
|
3088
3128
|
* <li>
|
|
3089
|
-
*
|
|
3129
|
+
* <p>
|
|
3090
3130
|
* <code>Removing</code> - The Auto Scaling instances are being deregistered from the
|
|
3091
3131
|
* load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight
|
|
3092
3132
|
* requests to complete before deregistering the instances.</p>
|
|
3093
3133
|
* </li>
|
|
3094
3134
|
* <li>
|
|
3095
|
-
*
|
|
3135
|
+
* <p>
|
|
3096
3136
|
* <code>Removed</code> - All Auto Scaling instances are deregistered from the load
|
|
3097
3137
|
* balancer.</p>
|
|
3098
3138
|
* </li>
|
|
@@ -3139,30 +3179,30 @@ export interface LoadBalancerTargetGroupState {
|
|
|
3139
3179
|
LoadBalancerTargetGroupARN?: string;
|
|
3140
3180
|
/**
|
|
3141
3181
|
* <p>The state of the target group.</p>
|
|
3142
|
-
*
|
|
3182
|
+
* <ul>
|
|
3143
3183
|
* <li>
|
|
3144
|
-
*
|
|
3184
|
+
* <p>
|
|
3145
3185
|
* <code>Adding</code> - The Auto Scaling instances are being registered with the target
|
|
3146
3186
|
* group.</p>
|
|
3147
3187
|
* </li>
|
|
3148
3188
|
* <li>
|
|
3149
|
-
*
|
|
3189
|
+
* <p>
|
|
3150
3190
|
* <code>Added</code> - All Auto Scaling instances are registered with the target
|
|
3151
3191
|
* group.</p>
|
|
3152
3192
|
* </li>
|
|
3153
3193
|
* <li>
|
|
3154
|
-
*
|
|
3194
|
+
* <p>
|
|
3155
3195
|
* <code>InService</code> - At least one Auto Scaling instance passed an <code>ELB</code>
|
|
3156
3196
|
* health check.</p>
|
|
3157
3197
|
* </li>
|
|
3158
3198
|
* <li>
|
|
3159
|
-
*
|
|
3199
|
+
* <p>
|
|
3160
3200
|
* <code>Removing</code> - The Auto Scaling instances are being deregistered from the
|
|
3161
3201
|
* target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight
|
|
3162
3202
|
* requests to complete before deregistering the instances.</p>
|
|
3163
3203
|
* </li>
|
|
3164
3204
|
* <li>
|
|
3165
|
-
*
|
|
3205
|
+
* <p>
|
|
3166
3206
|
* <code>Removed</code> - All Auto Scaling instances are deregistered from the target
|
|
3167
3207
|
* group.</p>
|
|
3168
3208
|
* </li>
|
|
@@ -3198,106 +3238,106 @@ export interface MetricGranularityType {
|
|
|
3198
3238
|
export interface MetricCollectionType {
|
|
3199
3239
|
/**
|
|
3200
3240
|
* <p>One of the following metrics:</p>
|
|
3201
|
-
*
|
|
3241
|
+
* <ul>
|
|
3202
3242
|
* <li>
|
|
3203
|
-
*
|
|
3204
|
-
*
|
|
3205
|
-
*
|
|
3243
|
+
* <p>
|
|
3244
|
+
* <code>GroupMinSize</code>
|
|
3245
|
+
* </p>
|
|
3206
3246
|
* </li>
|
|
3207
3247
|
* <li>
|
|
3208
|
-
*
|
|
3209
|
-
*
|
|
3210
|
-
*
|
|
3248
|
+
* <p>
|
|
3249
|
+
* <code>GroupMaxSize</code>
|
|
3250
|
+
* </p>
|
|
3211
3251
|
* </li>
|
|
3212
3252
|
* <li>
|
|
3213
|
-
*
|
|
3214
|
-
*
|
|
3215
|
-
*
|
|
3253
|
+
* <p>
|
|
3254
|
+
* <code>GroupDesiredCapacity</code>
|
|
3255
|
+
* </p>
|
|
3216
3256
|
* </li>
|
|
3217
3257
|
* <li>
|
|
3218
|
-
*
|
|
3219
|
-
*
|
|
3220
|
-
*
|
|
3258
|
+
* <p>
|
|
3259
|
+
* <code>GroupInServiceInstances</code>
|
|
3260
|
+
* </p>
|
|
3221
3261
|
* </li>
|
|
3222
3262
|
* <li>
|
|
3223
|
-
*
|
|
3224
|
-
*
|
|
3225
|
-
*
|
|
3263
|
+
* <p>
|
|
3264
|
+
* <code>GroupPendingInstances</code>
|
|
3265
|
+
* </p>
|
|
3226
3266
|
* </li>
|
|
3227
3267
|
* <li>
|
|
3228
|
-
*
|
|
3229
|
-
*
|
|
3230
|
-
*
|
|
3268
|
+
* <p>
|
|
3269
|
+
* <code>GroupStandbyInstances</code>
|
|
3270
|
+
* </p>
|
|
3231
3271
|
* </li>
|
|
3232
3272
|
* <li>
|
|
3233
|
-
*
|
|
3234
|
-
*
|
|
3235
|
-
*
|
|
3273
|
+
* <p>
|
|
3274
|
+
* <code>GroupTerminatingInstances</code>
|
|
3275
|
+
* </p>
|
|
3236
3276
|
* </li>
|
|
3237
3277
|
* <li>
|
|
3238
|
-
*
|
|
3239
|
-
*
|
|
3240
|
-
*
|
|
3278
|
+
* <p>
|
|
3279
|
+
* <code>GroupTotalInstances</code>
|
|
3280
|
+
* </p>
|
|
3241
3281
|
* </li>
|
|
3242
3282
|
* <li>
|
|
3243
|
-
*
|
|
3244
|
-
*
|
|
3245
|
-
*
|
|
3283
|
+
* <p>
|
|
3284
|
+
* <code>GroupInServiceCapacity</code>
|
|
3285
|
+
* </p>
|
|
3246
3286
|
* </li>
|
|
3247
3287
|
* <li>
|
|
3248
|
-
*
|
|
3249
|
-
*
|
|
3250
|
-
*
|
|
3288
|
+
* <p>
|
|
3289
|
+
* <code>GroupPendingCapacity</code>
|
|
3290
|
+
* </p>
|
|
3251
3291
|
* </li>
|
|
3252
3292
|
* <li>
|
|
3253
|
-
*
|
|
3254
|
-
*
|
|
3255
|
-
*
|
|
3293
|
+
* <p>
|
|
3294
|
+
* <code>GroupStandbyCapacity</code>
|
|
3295
|
+
* </p>
|
|
3256
3296
|
* </li>
|
|
3257
3297
|
* <li>
|
|
3258
|
-
*
|
|
3259
|
-
*
|
|
3260
|
-
*
|
|
3298
|
+
* <p>
|
|
3299
|
+
* <code>GroupTerminatingCapacity</code>
|
|
3300
|
+
* </p>
|
|
3261
3301
|
* </li>
|
|
3262
3302
|
* <li>
|
|
3263
|
-
*
|
|
3264
|
-
*
|
|
3265
|
-
*
|
|
3303
|
+
* <p>
|
|
3304
|
+
* <code>GroupTotalCapacity</code>
|
|
3305
|
+
* </p>
|
|
3266
3306
|
* </li>
|
|
3267
3307
|
* <li>
|
|
3268
|
-
*
|
|
3269
|
-
*
|
|
3270
|
-
*
|
|
3308
|
+
* <p>
|
|
3309
|
+
* <code>WarmPoolDesiredCapacity</code>
|
|
3310
|
+
* </p>
|
|
3271
3311
|
* </li>
|
|
3272
3312
|
* <li>
|
|
3273
|
-
*
|
|
3274
|
-
*
|
|
3275
|
-
*
|
|
3313
|
+
* <p>
|
|
3314
|
+
* <code>WarmPoolWarmedCapacity</code>
|
|
3315
|
+
* </p>
|
|
3276
3316
|
* </li>
|
|
3277
3317
|
* <li>
|
|
3278
|
-
*
|
|
3279
|
-
*
|
|
3280
|
-
*
|
|
3318
|
+
* <p>
|
|
3319
|
+
* <code>WarmPoolPendingCapacity</code>
|
|
3320
|
+
* </p>
|
|
3281
3321
|
* </li>
|
|
3282
3322
|
* <li>
|
|
3283
|
-
*
|
|
3284
|
-
*
|
|
3285
|
-
*
|
|
3323
|
+
* <p>
|
|
3324
|
+
* <code>WarmPoolTerminatingCapacity</code>
|
|
3325
|
+
* </p>
|
|
3286
3326
|
* </li>
|
|
3287
3327
|
* <li>
|
|
3288
|
-
*
|
|
3289
|
-
*
|
|
3290
|
-
*
|
|
3328
|
+
* <p>
|
|
3329
|
+
* <code>WarmPoolTotalCapacity</code>
|
|
3330
|
+
* </p>
|
|
3291
3331
|
* </li>
|
|
3292
3332
|
* <li>
|
|
3293
|
-
*
|
|
3294
|
-
*
|
|
3295
|
-
*
|
|
3333
|
+
* <p>
|
|
3334
|
+
* <code>GroupAndWarmPoolDesiredCapacity</code>
|
|
3335
|
+
* </p>
|
|
3296
3336
|
* </li>
|
|
3297
3337
|
* <li>
|
|
3298
|
-
*
|
|
3299
|
-
*
|
|
3300
|
-
*
|
|
3338
|
+
* <p>
|
|
3339
|
+
* <code>GroupAndWarmPoolTotalCapacity</code>
|
|
3340
|
+
* </p>
|
|
3301
3341
|
* </li>
|
|
3302
3342
|
* </ul>
|
|
3303
3343
|
*/
|
|
@@ -3327,31 +3367,31 @@ export interface NotificationConfiguration {
|
|
|
3327
3367
|
TopicARN?: string;
|
|
3328
3368
|
/**
|
|
3329
3369
|
* <p>One of the following event notification types:</p>
|
|
3330
|
-
*
|
|
3370
|
+
* <ul>
|
|
3331
3371
|
* <li>
|
|
3332
|
-
*
|
|
3333
|
-
*
|
|
3334
|
-
*
|
|
3372
|
+
* <p>
|
|
3373
|
+
* <code>autoscaling:EC2_INSTANCE_LAUNCH</code>
|
|
3374
|
+
* </p>
|
|
3335
3375
|
* </li>
|
|
3336
3376
|
* <li>
|
|
3337
|
-
*
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3377
|
+
* <p>
|
|
3378
|
+
* <code>autoscaling:EC2_INSTANCE_LAUNCH_ERROR</code>
|
|
3379
|
+
* </p>
|
|
3340
3380
|
* </li>
|
|
3341
3381
|
* <li>
|
|
3342
|
-
*
|
|
3343
|
-
*
|
|
3344
|
-
*
|
|
3382
|
+
* <p>
|
|
3383
|
+
* <code>autoscaling:EC2_INSTANCE_TERMINATE</code>
|
|
3384
|
+
* </p>
|
|
3345
3385
|
* </li>
|
|
3346
3386
|
* <li>
|
|
3347
|
-
*
|
|
3348
|
-
*
|
|
3349
|
-
*
|
|
3387
|
+
* <p>
|
|
3388
|
+
* <code>autoscaling:EC2_INSTANCE_TERMINATE_ERROR</code>
|
|
3389
|
+
* </p>
|
|
3350
3390
|
* </li>
|
|
3351
3391
|
* <li>
|
|
3352
|
-
*
|
|
3353
|
-
*
|
|
3354
|
-
*
|
|
3392
|
+
* <p>
|
|
3393
|
+
* <code>autoscaling:TEST_NOTIFICATION</code>
|
|
3394
|
+
* </p>
|
|
3355
3395
|
* </li>
|
|
3356
3396
|
* </ul>
|
|
3357
3397
|
*/
|
|
@@ -3395,7 +3435,7 @@ export interface DescribePoliciesType {
|
|
|
3395
3435
|
* <p>The names of one or more policies. If you omit this property, all policies are
|
|
3396
3436
|
* described. If a group name is provided, the results are limited to that group. If you
|
|
3397
3437
|
* specify an unknown policy name, it is ignored with no error.</p>
|
|
3398
|
-
*
|
|
3438
|
+
* <p>Array Members: Maximum number of 50 items.</p>
|
|
3399
3439
|
*/
|
|
3400
3440
|
PolicyNames?: string[];
|
|
3401
3441
|
/**
|
|
@@ -3451,7 +3491,7 @@ export interface Metric {
|
|
|
3451
3491
|
* documentation available from the table in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services
|
|
3452
3492
|
* services that publish CloudWatch metrics </a> in the <i>Amazon CloudWatch User
|
|
3453
3493
|
* Guide</i>. </p>
|
|
3454
|
-
*
|
|
3494
|
+
* <p>Conditional: If you published your metric with dimensions, you must specify the same
|
|
3455
3495
|
* dimensions in your scaling policy.</p>
|
|
3456
3496
|
*/
|
|
3457
3497
|
Dimensions?: MetricDimension[];
|
|
@@ -3459,8 +3499,7 @@ export interface Metric {
|
|
|
3459
3499
|
/**
|
|
3460
3500
|
* <p>This structure defines the CloudWatch metric to return, along with the statistic, period,
|
|
3461
3501
|
* and unit.</p>
|
|
3462
|
-
*
|
|
3463
|
-
* <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch
|
|
3502
|
+
* <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch
|
|
3464
3503
|
* concepts</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
3465
3504
|
*/
|
|
3466
3505
|
export interface MetricStat {
|
|
@@ -3472,7 +3511,7 @@ export interface MetricStat {
|
|
|
3472
3511
|
/**
|
|
3473
3512
|
* <p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For
|
|
3474
3513
|
* 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>
|
|
3475
|
-
*
|
|
3514
|
+
* <p>The most commonly used metrics for predictive scaling are <code>Average</code> and
|
|
3476
3515
|
* <code>Sum</code>.</p>
|
|
3477
3516
|
*/
|
|
3478
3517
|
Stat: string | undefined;
|
|
@@ -3488,9 +3527,7 @@ export interface MetricStat {
|
|
|
3488
3527
|
* metric only, or whether it is performing a math expression on the values of returned
|
|
3489
3528
|
* metric statistics to create a new time series. A time series is a series of data points,
|
|
3490
3529
|
* each of which is associated with a timestamp.</p>
|
|
3491
|
-
*
|
|
3492
|
-
*
|
|
3493
|
-
* <p>For more information and examples, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html">Advanced predictive scaling policy configurations using custom metrics</a> in
|
|
3530
|
+
* <p>For more information and examples, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html">Advanced predictive scaling policy configurations using custom metrics</a> in
|
|
3494
3531
|
* the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
3495
3532
|
*/
|
|
3496
3533
|
export interface MetricDataQuery {
|
|
@@ -3508,13 +3545,13 @@ export interface MetricDataQuery {
|
|
|
3508
3545
|
* math expression. This expression can use the <code>Id</code> of the other metrics to
|
|
3509
3546
|
* refer to those metrics, and can also use the <code>Id</code> of other expressions to use
|
|
3510
3547
|
* the result of those expressions. </p>
|
|
3511
|
-
*
|
|
3548
|
+
* <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either
|
|
3512
3549
|
* <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
|
|
3513
3550
|
*/
|
|
3514
3551
|
Expression?: string;
|
|
3515
3552
|
/**
|
|
3516
3553
|
* <p>Information about the metric data to return.</p>
|
|
3517
|
-
*
|
|
3554
|
+
* <p>Conditional: Within each <code>MetricDataQuery</code> object, you must specify either
|
|
3518
3555
|
* <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
|
|
3519
3556
|
*/
|
|
3520
3557
|
MetricStat?: MetricStat;
|
|
@@ -3525,11 +3562,11 @@ export interface MetricDataQuery {
|
|
|
3525
3562
|
Label?: string;
|
|
3526
3563
|
/**
|
|
3527
3564
|
* <p>Indicates whether to return the timestamps and raw data values of this metric. </p>
|
|
3528
|
-
*
|
|
3565
|
+
* <p>If you use any math expressions, specify <code>true</code> for this value for only the
|
|
3529
3566
|
* final math expression that the metric specification is based on. You must specify
|
|
3530
3567
|
* <code>false</code> for <code>ReturnData</code> for all the other metrics and
|
|
3531
3568
|
* expressions used in the metric specification.</p>
|
|
3532
|
-
*
|
|
3569
|
+
* <p>If you are only retrieving metrics and not performing any math expressions, do not
|
|
3533
3570
|
* specify anything for <code>ReturnData</code>. This sets it to its default
|
|
3534
3571
|
* (<code>true</code>).</p>
|
|
3535
3572
|
*/
|
|
@@ -3576,7 +3613,7 @@ export declare enum PredefinedLoadMetricType {
|
|
|
3576
3613
|
}
|
|
3577
3614
|
/**
|
|
3578
3615
|
* <p>Describes a load metric for a predictive scaling policy.</p>
|
|
3579
|
-
*
|
|
3616
|
+
* <p>When returned in the output of <code>DescribePolicies</code>, it indicates that a
|
|
3580
3617
|
* predictive scaling policy uses individually specified load and scaling metrics instead
|
|
3581
3618
|
* of a metric pair.</p>
|
|
3582
3619
|
*/
|
|
@@ -3592,20 +3629,20 @@ export interface PredictiveScalingPredefinedLoadMetric {
|
|
|
3592
3629
|
* <p>You create the resource label by appending the final portion of the load balancer ARN
|
|
3593
3630
|
* and the final portion of the target group ARN into a single value, separated by a forward
|
|
3594
3631
|
* slash (/). The format of the resource label is:</p>
|
|
3595
|
-
*
|
|
3632
|
+
* <p>
|
|
3596
3633
|
* <code>app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff</code>.</p>
|
|
3597
|
-
*
|
|
3598
|
-
*
|
|
3634
|
+
* <p>Where:</p>
|
|
3635
|
+
* <ul>
|
|
3599
3636
|
* <li>
|
|
3600
|
-
*
|
|
3637
|
+
* <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of
|
|
3601
3638
|
* the load balancer ARN</p>
|
|
3602
3639
|
* </li>
|
|
3603
3640
|
* <li>
|
|
3604
|
-
*
|
|
3641
|
+
* <p>targetgroup/<target-group-name>/<target-group-id> is the final portion
|
|
3605
3642
|
* of the target group ARN.</p>
|
|
3606
3643
|
* </li>
|
|
3607
3644
|
* </ul>
|
|
3608
|
-
*
|
|
3645
|
+
* <p>To find the ARN for an Application Load Balancer, use the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> API operation. To find the ARN for the target group, use
|
|
3609
3646
|
* the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a> API operation.</p>
|
|
3610
3647
|
*/
|
|
3611
3648
|
ResourceLabel?: string;
|
|
@@ -3631,23 +3668,23 @@ export interface PredictiveScalingPredefinedMetricPair {
|
|
|
3631
3668
|
* <p>A label that uniquely identifies a specific Application Load Balancer target group from which to determine
|
|
3632
3669
|
* the total and average request count served by your Auto Scaling group. You can't specify a
|
|
3633
3670
|
* resource label unless the target group is attached to the Auto Scaling group.</p>
|
|
3634
|
-
*
|
|
3671
|
+
* <p>You create the resource label by appending the final portion of the load balancer ARN
|
|
3635
3672
|
* and the final portion of the target group ARN into a single value, separated by a forward
|
|
3636
3673
|
* slash (/). The format of the resource label is:</p>
|
|
3637
|
-
*
|
|
3674
|
+
* <p>
|
|
3638
3675
|
* <code>app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff</code>.</p>
|
|
3639
|
-
*
|
|
3640
|
-
*
|
|
3676
|
+
* <p>Where:</p>
|
|
3677
|
+
* <ul>
|
|
3641
3678
|
* <li>
|
|
3642
|
-
*
|
|
3679
|
+
* <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of
|
|
3643
3680
|
* the load balancer ARN</p>
|
|
3644
3681
|
* </li>
|
|
3645
3682
|
* <li>
|
|
3646
|
-
*
|
|
3683
|
+
* <p>targetgroup/<target-group-name>/<target-group-id> is the final portion
|
|
3647
3684
|
* of the target group ARN.</p>
|
|
3648
3685
|
* </li>
|
|
3649
3686
|
* </ul>
|
|
3650
|
-
*
|
|
3687
|
+
* <p>To find the ARN for an Application Load Balancer, use the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> API operation. To find the ARN for the target group, use
|
|
3651
3688
|
* the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a> API operation.</p>
|
|
3652
3689
|
*/
|
|
3653
3690
|
ResourceLabel?: string;
|
|
@@ -3660,7 +3697,7 @@ export declare enum PredefinedScalingMetricType {
|
|
|
3660
3697
|
}
|
|
3661
3698
|
/**
|
|
3662
3699
|
* <p>Describes a scaling metric for a predictive scaling policy.</p>
|
|
3663
|
-
*
|
|
3700
|
+
* <p>When returned in the output of <code>DescribePolicies</code>, it indicates that a
|
|
3664
3701
|
* predictive scaling policy uses individually specified load and scaling metrics instead
|
|
3665
3702
|
* of a metric pair.</p>
|
|
3666
3703
|
*/
|
|
@@ -3676,20 +3713,20 @@ export interface PredictiveScalingPredefinedScalingMetric {
|
|
|
3676
3713
|
* <p>You create the resource label by appending the final portion of the load balancer ARN
|
|
3677
3714
|
* and the final portion of the target group ARN into a single value, separated by a forward
|
|
3678
3715
|
* slash (/). The format of the resource label is:</p>
|
|
3679
|
-
*
|
|
3716
|
+
* <p>
|
|
3680
3717
|
* <code>app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff</code>.</p>
|
|
3681
|
-
*
|
|
3682
|
-
*
|
|
3718
|
+
* <p>Where:</p>
|
|
3719
|
+
* <ul>
|
|
3683
3720
|
* <li>
|
|
3684
|
-
*
|
|
3721
|
+
* <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of
|
|
3685
3722
|
* the load balancer ARN</p>
|
|
3686
3723
|
* </li>
|
|
3687
3724
|
* <li>
|
|
3688
|
-
*
|
|
3725
|
+
* <p>targetgroup/<target-group-name>/<target-group-id> is the final portion
|
|
3689
3726
|
* of the target group ARN.</p>
|
|
3690
3727
|
* </li>
|
|
3691
3728
|
* </ul>
|
|
3692
|
-
*
|
|
3729
|
+
* <p>To find the ARN for an Application Load Balancer, use the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> API operation. To find the ARN for the target group, use
|
|
3693
3730
|
* the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a> API operation.</p>
|
|
3694
3731
|
*/
|
|
3695
3732
|
ResourceLabel?: string;
|
|
@@ -3697,15 +3734,15 @@ export interface PredictiveScalingPredefinedScalingMetric {
|
|
|
3697
3734
|
/**
|
|
3698
3735
|
* <p>This structure specifies the metrics and target utilization settings for a predictive
|
|
3699
3736
|
* scaling policy. </p>
|
|
3700
|
-
*
|
|
3737
|
+
* <p>You must specify either a metric pair, or a load metric and a scaling metric
|
|
3701
3738
|
* individually. Specifying a metric pair instead of individual metrics provides a simpler
|
|
3702
3739
|
* way to configure metrics for a scaling policy. You choose the metric pair, and the
|
|
3703
3740
|
* policy automatically knows the correct sum and average statistics to use for the load
|
|
3704
3741
|
* metric and the scaling metric.</p>
|
|
3705
|
-
*
|
|
3706
|
-
*
|
|
3742
|
+
* <p>Example</p>
|
|
3743
|
+
* <ul>
|
|
3707
3744
|
* <li>
|
|
3708
|
-
*
|
|
3745
|
+
* <p>You create a predictive scaling policy and specify
|
|
3709
3746
|
* <code>ALBRequestCount</code> as the value for the metric pair and
|
|
3710
3747
|
* <code>1000.0</code> as the target value. For this type of metric, you must
|
|
3711
3748
|
* provide the metric dimension for the corresponding target group, so you also
|
|
@@ -3713,43 +3750,43 @@ export interface PredictiveScalingPredefinedScalingMetric {
|
|
|
3713
3750
|
* attached to your Auto Scaling group.</p>
|
|
3714
3751
|
* </li>
|
|
3715
3752
|
* <li>
|
|
3716
|
-
*
|
|
3753
|
+
* <p>The number of requests the target group receives per minute provides the load
|
|
3717
3754
|
* metric, and the request count averaged between the members of the target group
|
|
3718
3755
|
* provides the scaling metric. In CloudWatch, this refers to the
|
|
3719
3756
|
* <code>RequestCount</code> and <code>RequestCountPerTarget</code> metrics,
|
|
3720
3757
|
* respectively.</p>
|
|
3721
3758
|
* </li>
|
|
3722
3759
|
* <li>
|
|
3723
|
-
*
|
|
3760
|
+
* <p>For optimal use of predictive scaling, you adhere to the best practice of
|
|
3724
3761
|
* using a dynamic scaling policy to automatically scale between the minimum
|
|
3725
3762
|
* capacity and maximum capacity in response to real-time changes in resource
|
|
3726
3763
|
* utilization.</p>
|
|
3727
3764
|
* </li>
|
|
3728
3765
|
* <li>
|
|
3729
|
-
*
|
|
3766
|
+
* <p>Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and
|
|
3730
3767
|
* creates an hourly load forecast for predictive scaling. (A minimum of 24 hours
|
|
3731
3768
|
* of data is required.)</p>
|
|
3732
3769
|
* </li>
|
|
3733
3770
|
* <li>
|
|
3734
|
-
*
|
|
3771
|
+
* <p>After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or
|
|
3735
3772
|
* increase the capacity of your Auto Scaling group in each hour of the forecast period so
|
|
3736
3773
|
* that the average number of requests received by each instance is as close to
|
|
3737
3774
|
* 1000 requests per minute as possible at all times.</p>
|
|
3738
3775
|
* </li>
|
|
3739
3776
|
* </ul>
|
|
3740
|
-
*
|
|
3777
|
+
* <p>For information about using custom metrics with predictive scaling, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/predictive-scaling-customized-metric-specification.html">Advanced predictive scaling policy configurations using custom metrics</a> in
|
|
3741
3778
|
* the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
3742
3779
|
*/
|
|
3743
3780
|
export interface PredictiveScalingMetricSpecification {
|
|
3744
3781
|
/**
|
|
3745
3782
|
* <p>Specifies the target utilization.</p>
|
|
3746
|
-
*
|
|
3783
|
+
* <note>
|
|
3747
3784
|
* <p>Some metrics are based on a count instead of a percentage, such as the request
|
|
3748
3785
|
* count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy
|
|
3749
3786
|
* specifies one of these metrics, specify the target utilization as the optimal
|
|
3750
3787
|
* average request or message count per instance during any one-minute interval.
|
|
3751
3788
|
* </p>
|
|
3752
|
-
*
|
|
3789
|
+
* </note>
|
|
3753
3790
|
*/
|
|
3754
3791
|
TargetValue: number | undefined;
|
|
3755
3792
|
/**
|
|
@@ -3789,7 +3826,7 @@ export interface PredictiveScalingConfiguration {
|
|
|
3789
3826
|
/**
|
|
3790
3827
|
* <p>This structure includes the metrics and target utilization to use for predictive
|
|
3791
3828
|
* scaling. </p>
|
|
3792
|
-
*
|
|
3829
|
+
* <p>This is an array, but we currently only support a single metric specification. That
|
|
3793
3830
|
* is, you can specify a target value and a single metric pair, or a target value and one
|
|
3794
3831
|
* scaling metric and one load metric.</p>
|
|
3795
3832
|
*/
|
|
@@ -3806,7 +3843,7 @@ export interface PredictiveScalingConfiguration {
|
|
|
3806
3843
|
* intention is to give resources time to be provisioned. It can take a few minutes to
|
|
3807
3844
|
* launch an EC2 instance. The actual amount of time required depends on several factors,
|
|
3808
3845
|
* such as the size of the instance and whether there are startup scripts to complete. </p>
|
|
3809
|
-
*
|
|
3846
|
+
* <p>The value must be less than the forecast interval duration of 3600 seconds (60
|
|
3810
3847
|
* minutes). Defaults to 300 seconds if not specified. </p>
|
|
3811
3848
|
*/
|
|
3812
3849
|
SchedulingBufferTime?: number;
|
|
@@ -3814,15 +3851,15 @@ export interface PredictiveScalingConfiguration {
|
|
|
3814
3851
|
* <p>Defines the behavior that should be applied if the forecast capacity approaches or
|
|
3815
3852
|
* exceeds the maximum capacity of the Auto Scaling group. Defaults to
|
|
3816
3853
|
* <code>HonorMaxCapacity</code> if not specified.</p>
|
|
3817
|
-
*
|
|
3818
|
-
*
|
|
3854
|
+
* <p>The following are possible values:</p>
|
|
3855
|
+
* <ul>
|
|
3819
3856
|
* <li>
|
|
3820
|
-
*
|
|
3857
|
+
* <p>
|
|
3821
3858
|
* <code>HonorMaxCapacity</code> - Amazon EC2 Auto Scaling cannot scale out capacity higher than
|
|
3822
3859
|
* the maximum capacity. The maximum capacity is enforced as a hard limit. </p>
|
|
3823
3860
|
* </li>
|
|
3824
3861
|
* <li>
|
|
3825
|
-
*
|
|
3862
|
+
* <p>
|
|
3826
3863
|
* <code>IncreaseMaxCapacity</code> - Amazon EC2 Auto Scaling can scale out capacity higher than
|
|
3827
3864
|
* the maximum capacity when the forecast capacity is close to or exceeds the
|
|
3828
3865
|
* maximum capacity. The upper limit is determined by the forecasted capacity and
|
|
@@ -3837,9 +3874,9 @@ export interface PredictiveScalingConfiguration {
|
|
|
3837
3874
|
* forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,
|
|
3838
3875
|
* such that if the forecast capacity is 50, and the maximum capacity is 40, then the
|
|
3839
3876
|
* effective maximum capacity is 55.</p>
|
|
3840
|
-
*
|
|
3877
|
+
* <p>If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but
|
|
3841
3878
|
* not exceed forecast capacity. </p>
|
|
3842
|
-
*
|
|
3879
|
+
* <p>Required if the <code>MaxCapacityBreachBehavior</code> property is set to
|
|
3843
3880
|
* <code>IncreaseMaxCapacity</code>, and cannot be used otherwise.</p>
|
|
3844
3881
|
*/
|
|
3845
3882
|
MaxCapacityBuffer?: number;
|
|
@@ -3847,38 +3884,38 @@ export interface PredictiveScalingConfiguration {
|
|
|
3847
3884
|
/**
|
|
3848
3885
|
* <p>Describes information used to create a step adjustment for a step scaling
|
|
3849
3886
|
* policy.</p>
|
|
3850
|
-
*
|
|
3887
|
+
* <p>For the following examples, suppose that you have an alarm with a breach threshold of
|
|
3851
3888
|
* 50:</p>
|
|
3852
|
-
*
|
|
3889
|
+
* <ul>
|
|
3853
3890
|
* <li>
|
|
3854
|
-
*
|
|
3891
|
+
* <p>To trigger the adjustment when the metric is greater than or equal to 50 and
|
|
3855
3892
|
* less than 60, specify a lower bound of 0 and an upper bound of 10.</p>
|
|
3856
3893
|
* </li>
|
|
3857
3894
|
* <li>
|
|
3858
|
-
*
|
|
3895
|
+
* <p>To trigger the adjustment when the metric is greater than 40 and less than or
|
|
3859
3896
|
* equal to 50, specify a lower bound of -10 and an upper bound of 0.</p>
|
|
3860
3897
|
* </li>
|
|
3861
3898
|
* </ul>
|
|
3862
|
-
*
|
|
3863
|
-
*
|
|
3899
|
+
* <p>There are a few rules for the step adjustments for your step policy:</p>
|
|
3900
|
+
* <ul>
|
|
3864
3901
|
* <li>
|
|
3865
|
-
*
|
|
3902
|
+
* <p>The ranges of your step adjustments can't overlap or have a gap.</p>
|
|
3866
3903
|
* </li>
|
|
3867
3904
|
* <li>
|
|
3868
|
-
*
|
|
3905
|
+
* <p>At most, one step adjustment can have a null lower bound. If one step
|
|
3869
3906
|
* adjustment has a negative lower bound, then there must be a step adjustment with
|
|
3870
3907
|
* a null lower bound.</p>
|
|
3871
3908
|
* </li>
|
|
3872
3909
|
* <li>
|
|
3873
|
-
*
|
|
3910
|
+
* <p>At most, one step adjustment can have a null upper bound. If one step
|
|
3874
3911
|
* adjustment has a positive upper bound, then there must be a step adjustment with
|
|
3875
3912
|
* a null upper bound.</p>
|
|
3876
3913
|
* </li>
|
|
3877
3914
|
* <li>
|
|
3878
|
-
*
|
|
3915
|
+
* <p>The upper and lower bound can't be null in the same step adjustment.</p>
|
|
3879
3916
|
* </li>
|
|
3880
3917
|
* </ul>
|
|
3881
|
-
*
|
|
3918
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps">Step
|
|
3882
3919
|
* adjustments</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
3883
3920
|
*/
|
|
3884
3921
|
export interface StepAdjustment {
|
|
@@ -3896,20 +3933,93 @@ export interface StepAdjustment {
|
|
|
3896
3933
|
* must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the
|
|
3897
3934
|
* metric must be less than or equal to the threshold plus the upper bound). A null value
|
|
3898
3935
|
* indicates positive infinity.</p>
|
|
3899
|
-
*
|
|
3936
|
+
* <p>The upper bound must be greater than the lower bound.</p>
|
|
3900
3937
|
*/
|
|
3901
3938
|
MetricIntervalUpperBound?: number;
|
|
3902
3939
|
/**
|
|
3903
3940
|
* <p>The amount by which to scale, based on the specified adjustment type. A positive value
|
|
3904
3941
|
* adds to the current capacity while a negative number removes from the current
|
|
3905
3942
|
* capacity.</p>
|
|
3906
|
-
*
|
|
3943
|
+
* <p>The amount by which to scale. The adjustment is based on the value that you specified
|
|
3907
3944
|
* in the <code>AdjustmentType</code> property (either an absolute number or a percentage).
|
|
3908
3945
|
* A positive value adds to the current capacity and a negative number subtracts from the
|
|
3909
3946
|
* current capacity. </p>
|
|
3910
3947
|
*/
|
|
3911
3948
|
ScalingAdjustment: number | undefined;
|
|
3912
3949
|
}
|
|
3950
|
+
/**
|
|
3951
|
+
* <p>This structure defines the CloudWatch metric to return, along with the statistic, period,
|
|
3952
|
+
* and unit.</p>
|
|
3953
|
+
* <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch
|
|
3954
|
+
* concepts</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
|
|
3955
|
+
*/
|
|
3956
|
+
export interface TargetTrackingMetricStat {
|
|
3957
|
+
/**
|
|
3958
|
+
* <p>Represents a specific metric. </p>
|
|
3959
|
+
*/
|
|
3960
|
+
Metric: Metric | undefined;
|
|
3961
|
+
/**
|
|
3962
|
+
* <p>The statistic to return. It can include any CloudWatch statistic or extended statistic. For
|
|
3963
|
+
* 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>
|
|
3964
|
+
* <p>The most commonly used metrics for scaling is <code>Average</code>
|
|
3965
|
+
* </p>
|
|
3966
|
+
*/
|
|
3967
|
+
Stat: string | undefined;
|
|
3968
|
+
/**
|
|
3969
|
+
* <p>The unit to use for the returned data points. For a complete list of the units that
|
|
3970
|
+
* CloudWatch supports, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a>
|
|
3971
|
+
* data type in the <i>Amazon CloudWatch API Reference</i>.</p>
|
|
3972
|
+
*/
|
|
3973
|
+
Unit?: string;
|
|
3974
|
+
}
|
|
3975
|
+
/**
|
|
3976
|
+
* <p>The metric data to return. Also defines whether this call is returning data for one
|
|
3977
|
+
* metric only, or whether it is performing a math expression on the values of returned
|
|
3978
|
+
* metric statistics to create a new time series. A time series is a series of data points,
|
|
3979
|
+
* each of which is associated with a timestamp.</p>
|
|
3980
|
+
*/
|
|
3981
|
+
export interface TargetTrackingMetricDataQuery {
|
|
3982
|
+
/**
|
|
3983
|
+
* <p>A short name that identifies the object's results in the response. This name must be
|
|
3984
|
+
* unique among all <code>TargetTrackingMetricDataQuery</code> objects specified for a
|
|
3985
|
+
* single scaling policy. If you are performing math expressions on this set of data, this
|
|
3986
|
+
* name represents that data and can serve as a variable in the mathematical expression.
|
|
3987
|
+
* The valid characters are letters, numbers, and underscores. The first character must be
|
|
3988
|
+
* a lowercase letter. </p>
|
|
3989
|
+
*/
|
|
3990
|
+
Id: string | undefined;
|
|
3991
|
+
/**
|
|
3992
|
+
* <p>The math expression to perform on the returned data, if this object is performing a
|
|
3993
|
+
* math expression. This expression can use the <code>Id</code> of the other metrics to
|
|
3994
|
+
* refer to those metrics, and can also use the <code>Id</code> of other expressions to use
|
|
3995
|
+
* the result of those expressions. </p>
|
|
3996
|
+
* <p>Conditional: Within each <code>TargetTrackingMetricDataQuery</code> object, you must
|
|
3997
|
+
* specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
|
|
3998
|
+
*/
|
|
3999
|
+
Expression?: string;
|
|
4000
|
+
/**
|
|
4001
|
+
* <p>Information about the metric data to return.</p>
|
|
4002
|
+
* <p>Conditional: Within each <code>TargetTrackingMetricDataQuery</code> object, you must
|
|
4003
|
+
* specify either <code>Expression</code> or <code>MetricStat</code>, but not both.</p>
|
|
4004
|
+
*/
|
|
4005
|
+
MetricStat?: TargetTrackingMetricStat;
|
|
4006
|
+
/**
|
|
4007
|
+
* <p>A human-readable label for this metric or expression. This is especially useful if
|
|
4008
|
+
* this is a math expression, so that you know what the value represents.</p>
|
|
4009
|
+
*/
|
|
4010
|
+
Label?: string;
|
|
4011
|
+
/**
|
|
4012
|
+
* <p>Indicates whether to return the timestamps and raw data values of this metric. </p>
|
|
4013
|
+
* <p>If you use any math expressions, specify <code>true</code> for this value for only the
|
|
4014
|
+
* final math expression that the metric specification is based on. You must specify
|
|
4015
|
+
* <code>false</code> for <code>ReturnData</code> for all the other metrics and
|
|
4016
|
+
* expressions used in the metric specification.</p>
|
|
4017
|
+
* <p>If you are only retrieving metrics and not performing any math expressions, do not
|
|
4018
|
+
* specify anything for <code>ReturnData</code>. This sets it to its default
|
|
4019
|
+
* (<code>true</code>).</p>
|
|
4020
|
+
*/
|
|
4021
|
+
ReturnData?: boolean;
|
|
4022
|
+
}
|
|
3913
4023
|
export declare enum MetricStatistic {
|
|
3914
4024
|
Average = "Average",
|
|
3915
4025
|
Maximum = "Maximum",
|
|
@@ -3920,29 +4030,29 @@ export declare enum MetricStatistic {
|
|
|
3920
4030
|
/**
|
|
3921
4031
|
* <p>Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use
|
|
3922
4032
|
* with Amazon EC2 Auto Scaling.</p>
|
|
3923
|
-
*
|
|
3924
|
-
*
|
|
4033
|
+
* <p>To create your customized metric specification:</p>
|
|
4034
|
+
* <ul>
|
|
3925
4035
|
* <li>
|
|
3926
|
-
*
|
|
4036
|
+
* <p>Add values for each required property from CloudWatch. You can use an existing
|
|
3927
4037
|
* metric, or a new metric that you create. To use your own metric, you must first
|
|
3928
4038
|
* publish the metric to CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publish
|
|
3929
4039
|
* custom metrics</a> in the <i>Amazon CloudWatch User
|
|
3930
4040
|
* Guide</i>.</p>
|
|
3931
4041
|
* </li>
|
|
3932
4042
|
* <li>
|
|
3933
|
-
*
|
|
4043
|
+
* <p>Choose a metric that changes proportionally with capacity. The value of the
|
|
3934
4044
|
* metric should increase or decrease in inverse proportion to the number of
|
|
3935
4045
|
* capacity units. That is, the value of the metric should decrease when capacity
|
|
3936
4046
|
* increases.</p>
|
|
3937
4047
|
* </li>
|
|
3938
4048
|
* </ul>
|
|
3939
|
-
*
|
|
4049
|
+
* <p>For more information about the CloudWatch terminology below, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html">Amazon CloudWatch
|
|
3940
4050
|
* concepts</a>.</p>
|
|
3941
|
-
*
|
|
4051
|
+
* <note>
|
|
3942
4052
|
* <p>Each individual service provides information about the metrics, namespace, and
|
|
3943
4053
|
* dimensions they use. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon Web Services services that publish CloudWatch metrics</a> in the <i>Amazon CloudWatch User
|
|
3944
4054
|
* Guide</i>.</p>
|
|
3945
|
-
*
|
|
4055
|
+
* </note>
|
|
3946
4056
|
*/
|
|
3947
4057
|
export interface CustomizedMetricSpecification {
|
|
3948
4058
|
/**
|
|
@@ -3950,27 +4060,32 @@ export interface CustomizedMetricSpecification {
|
|
|
3950
4060
|
* inspect the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html">Metric</a> object
|
|
3951
4061
|
* that is returned by a call to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
|
|
3952
4062
|
*/
|
|
3953
|
-
MetricName
|
|
4063
|
+
MetricName?: string;
|
|
3954
4064
|
/**
|
|
3955
4065
|
* <p>The namespace of the metric.</p>
|
|
3956
4066
|
*/
|
|
3957
|
-
Namespace
|
|
4067
|
+
Namespace?: string;
|
|
3958
4068
|
/**
|
|
3959
4069
|
* <p>The dimensions of the metric.</p>
|
|
3960
|
-
*
|
|
4070
|
+
* <p>Conditional: If you published your metric with dimensions, you must specify the same
|
|
3961
4071
|
* dimensions in your scaling policy.</p>
|
|
3962
4072
|
*/
|
|
3963
4073
|
Dimensions?: MetricDimension[];
|
|
3964
4074
|
/**
|
|
3965
4075
|
* <p>The statistic of the metric.</p>
|
|
3966
4076
|
*/
|
|
3967
|
-
Statistic
|
|
4077
|
+
Statistic?: MetricStatistic | string;
|
|
3968
4078
|
/**
|
|
3969
4079
|
* <p>The unit of the metric. For a complete list of the units that CloudWatch supports, see the
|
|
3970
4080
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">MetricDatum</a>
|
|
3971
4081
|
* data type in the <i>Amazon CloudWatch API Reference</i>.</p>
|
|
3972
4082
|
*/
|
|
3973
4083
|
Unit?: string;
|
|
4084
|
+
/**
|
|
4085
|
+
* <p>The metrics to include in the target tracking scaling policy, as a metric data query.
|
|
4086
|
+
* This can include both raw metric and metric math expressions.</p>
|
|
4087
|
+
*/
|
|
4088
|
+
Metrics?: TargetTrackingMetricDataQuery[];
|
|
3974
4089
|
}
|
|
3975
4090
|
export declare enum MetricType {
|
|
3976
4091
|
ALBRequestCountPerTarget = "ALBRequestCountPerTarget",
|
|
@@ -3985,24 +4100,24 @@ export declare enum MetricType {
|
|
|
3985
4100
|
export interface PredefinedMetricSpecification {
|
|
3986
4101
|
/**
|
|
3987
4102
|
* <p>The metric type. The following predefined metrics are available:</p>
|
|
3988
|
-
*
|
|
4103
|
+
* <ul>
|
|
3989
4104
|
* <li>
|
|
3990
|
-
*
|
|
4105
|
+
* <p>
|
|
3991
4106
|
* <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling
|
|
3992
4107
|
* group.</p>
|
|
3993
4108
|
* </li>
|
|
3994
4109
|
* <li>
|
|
3995
|
-
*
|
|
4110
|
+
* <p>
|
|
3996
4111
|
* <code>ASGAverageNetworkIn</code> - Average number of bytes received on all
|
|
3997
4112
|
* network interfaces by the Auto Scaling group.</p>
|
|
3998
4113
|
* </li>
|
|
3999
4114
|
* <li>
|
|
4000
|
-
*
|
|
4115
|
+
* <p>
|
|
4001
4116
|
* <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all
|
|
4002
4117
|
* network interfaces by the Auto Scaling group.</p>
|
|
4003
4118
|
* </li>
|
|
4004
4119
|
* <li>
|
|
4005
|
-
*
|
|
4120
|
+
* <p>
|
|
4006
4121
|
* <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count per target
|
|
4007
4122
|
* for your Auto Scaling group.</p>
|
|
4008
4123
|
* </li>
|
|
@@ -4013,23 +4128,23 @@ export interface PredefinedMetricSpecification {
|
|
|
4013
4128
|
* <p>A label that uniquely identifies a specific Application Load Balancer target group
|
|
4014
4129
|
* from which to determine the average request count served by your Auto Scaling group. You can't
|
|
4015
4130
|
* specify a resource label unless the target group is attached to the Auto Scaling group.</p>
|
|
4016
|
-
*
|
|
4131
|
+
* <p>You create the resource label by appending the final portion of the load balancer ARN
|
|
4017
4132
|
* and the final portion of the target group ARN into a single value, separated by a forward
|
|
4018
4133
|
* slash (/). The format of the resource label is:</p>
|
|
4019
|
-
*
|
|
4134
|
+
* <p>
|
|
4020
4135
|
* <code>app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff</code>.</p>
|
|
4021
|
-
*
|
|
4022
|
-
*
|
|
4136
|
+
* <p>Where:</p>
|
|
4137
|
+
* <ul>
|
|
4023
4138
|
* <li>
|
|
4024
|
-
*
|
|
4139
|
+
* <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of
|
|
4025
4140
|
* the load balancer ARN</p>
|
|
4026
4141
|
* </li>
|
|
4027
4142
|
* <li>
|
|
4028
|
-
*
|
|
4143
|
+
* <p>targetgroup/<target-group-name>/<target-group-id> is the final portion
|
|
4029
4144
|
* of the target group ARN.</p>
|
|
4030
4145
|
* </li>
|
|
4031
4146
|
* </ul>
|
|
4032
|
-
*
|
|
4147
|
+
* <p>To find the ARN for an Application Load Balancer, use the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html">DescribeLoadBalancers</a> API operation. To find the ARN for the target group, use
|
|
4033
4148
|
* the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html">DescribeTargetGroups</a> API operation.</p>
|
|
4034
4149
|
*/
|
|
4035
4150
|
ResourceLabel?: string;
|
|
@@ -4050,13 +4165,13 @@ export interface TargetTrackingConfiguration {
|
|
|
4050
4165
|
CustomizedMetricSpecification?: CustomizedMetricSpecification;
|
|
4051
4166
|
/**
|
|
4052
4167
|
* <p>The target value for the metric.</p>
|
|
4053
|
-
*
|
|
4168
|
+
* <note>
|
|
4054
4169
|
* <p>Some metrics are based on a count instead of a percentage, such as the request
|
|
4055
4170
|
* count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy
|
|
4056
4171
|
* specifies one of these metrics, specify the target utilization as the optimal
|
|
4057
4172
|
* average request or message count per instance during any one-minute interval.
|
|
4058
4173
|
* </p>
|
|
4059
|
-
*
|
|
4174
|
+
* </note>
|
|
4060
4175
|
*/
|
|
4061
4176
|
TargetValue: number | undefined;
|
|
4062
4177
|
/**
|
|
@@ -4085,28 +4200,28 @@ export interface ScalingPolicy {
|
|
|
4085
4200
|
PolicyARN?: string;
|
|
4086
4201
|
/**
|
|
4087
4202
|
* <p>One of the following policy types: </p>
|
|
4088
|
-
*
|
|
4203
|
+
* <ul>
|
|
4089
4204
|
* <li>
|
|
4090
|
-
*
|
|
4091
|
-
*
|
|
4092
|
-
*
|
|
4205
|
+
* <p>
|
|
4206
|
+
* <code>TargetTrackingScaling</code>
|
|
4207
|
+
* </p>
|
|
4093
4208
|
* </li>
|
|
4094
4209
|
* <li>
|
|
4095
|
-
*
|
|
4096
|
-
*
|
|
4097
|
-
*
|
|
4210
|
+
* <p>
|
|
4211
|
+
* <code>StepScaling</code>
|
|
4212
|
+
* </p>
|
|
4098
4213
|
* </li>
|
|
4099
4214
|
* <li>
|
|
4100
|
-
*
|
|
4215
|
+
* <p>
|
|
4101
4216
|
* <code>SimpleScaling</code> (default)</p>
|
|
4102
4217
|
* </li>
|
|
4103
4218
|
* <li>
|
|
4104
|
-
*
|
|
4105
|
-
*
|
|
4106
|
-
*
|
|
4219
|
+
* <p>
|
|
4220
|
+
* <code>PredictiveScaling</code>
|
|
4221
|
+
* </p>
|
|
4107
4222
|
* </li>
|
|
4108
4223
|
* </ul>
|
|
4109
|
-
*
|
|
4224
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html">Target tracking
|
|
4110
4225
|
* scaling policies</a> and <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html">Step and simple scaling
|
|
4111
4226
|
* policies</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
4112
4227
|
*/
|
|
@@ -4191,7 +4306,7 @@ export interface DescribeScalingActivitiesType {
|
|
|
4191
4306
|
* activities for the past six weeks are described. If unknown activities are requested,
|
|
4192
4307
|
* they are ignored with no error. If you specify an Auto Scaling group, the results are limited to
|
|
4193
4308
|
* that group.</p>
|
|
4194
|
-
*
|
|
4309
|
+
* <p>Array Members: Maximum number of 50 IDs.</p>
|
|
4195
4310
|
*/
|
|
4196
4311
|
ActivityIds?: string[];
|
|
4197
4312
|
/**
|
|
@@ -4215,56 +4330,56 @@ export interface DescribeScalingActivitiesType {
|
|
|
4215
4330
|
}
|
|
4216
4331
|
/**
|
|
4217
4332
|
* <p>Describes a process type.</p>
|
|
4218
|
-
*
|
|
4333
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types">Scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
4219
4334
|
*/
|
|
4220
4335
|
export interface ProcessType {
|
|
4221
4336
|
/**
|
|
4222
4337
|
* <p>One of the following processes:</p>
|
|
4223
|
-
*
|
|
4338
|
+
* <ul>
|
|
4224
4339
|
* <li>
|
|
4225
|
-
*
|
|
4226
|
-
*
|
|
4227
|
-
*
|
|
4340
|
+
* <p>
|
|
4341
|
+
* <code>Launch</code>
|
|
4342
|
+
* </p>
|
|
4228
4343
|
* </li>
|
|
4229
4344
|
* <li>
|
|
4230
|
-
*
|
|
4231
|
-
*
|
|
4232
|
-
*
|
|
4345
|
+
* <p>
|
|
4346
|
+
* <code>Terminate</code>
|
|
4347
|
+
* </p>
|
|
4233
4348
|
* </li>
|
|
4234
4349
|
* <li>
|
|
4235
|
-
*
|
|
4236
|
-
*
|
|
4237
|
-
*
|
|
4350
|
+
* <p>
|
|
4351
|
+
* <code>AddToLoadBalancer</code>
|
|
4352
|
+
* </p>
|
|
4238
4353
|
* </li>
|
|
4239
4354
|
* <li>
|
|
4240
|
-
*
|
|
4241
|
-
*
|
|
4242
|
-
*
|
|
4355
|
+
* <p>
|
|
4356
|
+
* <code>AlarmNotification</code>
|
|
4357
|
+
* </p>
|
|
4243
4358
|
* </li>
|
|
4244
4359
|
* <li>
|
|
4245
|
-
*
|
|
4246
|
-
*
|
|
4247
|
-
*
|
|
4360
|
+
* <p>
|
|
4361
|
+
* <code>AZRebalance</code>
|
|
4362
|
+
* </p>
|
|
4248
4363
|
* </li>
|
|
4249
4364
|
* <li>
|
|
4250
|
-
*
|
|
4251
|
-
*
|
|
4252
|
-
*
|
|
4365
|
+
* <p>
|
|
4366
|
+
* <code>HealthCheck</code>
|
|
4367
|
+
* </p>
|
|
4253
4368
|
* </li>
|
|
4254
4369
|
* <li>
|
|
4255
|
-
*
|
|
4256
|
-
*
|
|
4257
|
-
*
|
|
4370
|
+
* <p>
|
|
4371
|
+
* <code>InstanceRefresh</code>
|
|
4372
|
+
* </p>
|
|
4258
4373
|
* </li>
|
|
4259
4374
|
* <li>
|
|
4260
|
-
*
|
|
4261
|
-
*
|
|
4262
|
-
*
|
|
4375
|
+
* <p>
|
|
4376
|
+
* <code>ReplaceUnhealthy</code>
|
|
4377
|
+
* </p>
|
|
4263
4378
|
* </li>
|
|
4264
4379
|
* <li>
|
|
4265
|
-
*
|
|
4266
|
-
*
|
|
4267
|
-
*
|
|
4380
|
+
* <p>
|
|
4381
|
+
* <code>ScheduledActions</code>
|
|
4382
|
+
* </p>
|
|
4268
4383
|
* </li>
|
|
4269
4384
|
* </ul>
|
|
4270
4385
|
*/
|
|
@@ -4285,7 +4400,7 @@ export interface DescribeScheduledActionsType {
|
|
|
4285
4400
|
* <p>The names of one or more scheduled actions. If you omit this property, all scheduled
|
|
4286
4401
|
* actions are described. If you specify an unknown scheduled action, it is ignored with no
|
|
4287
4402
|
* error.</p>
|
|
4288
|
-
*
|
|
4403
|
+
* <p>Array Members: Maximum number of 50 actions.</p>
|
|
4289
4404
|
*/
|
|
4290
4405
|
ScheduledActionNames?: string[];
|
|
4291
4406
|
/**
|
|
@@ -4342,7 +4457,7 @@ export interface ScheduledUpdateGroupAction {
|
|
|
4342
4457
|
EndTime?: Date;
|
|
4343
4458
|
/**
|
|
4344
4459
|
* <p>The recurring schedule for the action, in Unix cron syntax format.</p>
|
|
4345
|
-
*
|
|
4460
|
+
* <p>When <code>StartTime</code> and <code>EndTime</code> are specified with
|
|
4346
4461
|
* <code>Recurrence</code>, they form the boundaries of when the recurring action
|
|
4347
4462
|
* starts and stops.</p>
|
|
4348
4463
|
*/
|
|
@@ -4417,6 +4532,82 @@ export interface DescribeTerminationPolicyTypesAnswer {
|
|
|
4417
4532
|
*/
|
|
4418
4533
|
TerminationPolicyTypes?: string[];
|
|
4419
4534
|
}
|
|
4535
|
+
export interface DescribeTrafficSourcesRequest {
|
|
4536
|
+
/**
|
|
4537
|
+
* <p>The name of the Auto Scaling group.</p>
|
|
4538
|
+
*/
|
|
4539
|
+
AutoScalingGroupName: string | undefined;
|
|
4540
|
+
/**
|
|
4541
|
+
* <p>The type of traffic source you are describing. Currently, the only valid value is
|
|
4542
|
+
* <code>vpc-lattice</code>.</p>
|
|
4543
|
+
*/
|
|
4544
|
+
TrafficSourceType: string | undefined;
|
|
4545
|
+
/**
|
|
4546
|
+
* <p>The token for the next set of items to return. (You received this token from a
|
|
4547
|
+
* previous call.)</p>
|
|
4548
|
+
*/
|
|
4549
|
+
NextToken?: string;
|
|
4550
|
+
/**
|
|
4551
|
+
* <p>The maximum number of items to return with this call. The maximum value is
|
|
4552
|
+
* <code>50</code>.</p>
|
|
4553
|
+
*/
|
|
4554
|
+
MaxRecords?: number;
|
|
4555
|
+
}
|
|
4556
|
+
/**
|
|
4557
|
+
* <p>Describes the state of a traffic source.</p>
|
|
4558
|
+
*/
|
|
4559
|
+
export interface TrafficSourceState {
|
|
4560
|
+
/**
|
|
4561
|
+
* <p>The unique identifier of the traffic source. Currently, this is the Amazon Resource
|
|
4562
|
+
* Name (ARN) for a VPC Lattice target group.</p>
|
|
4563
|
+
*/
|
|
4564
|
+
TrafficSource?: string;
|
|
4565
|
+
/**
|
|
4566
|
+
* <p>The following are the possible states for a VPC Lattice target group:</p>
|
|
4567
|
+
* <ul>
|
|
4568
|
+
* <li>
|
|
4569
|
+
* <p>
|
|
4570
|
+
* <code>Adding</code> - The Auto Scaling instances are being registered with the target
|
|
4571
|
+
* group.</p>
|
|
4572
|
+
* </li>
|
|
4573
|
+
* <li>
|
|
4574
|
+
* <p>
|
|
4575
|
+
* <code>Added</code> - All Auto Scaling instances are registered with the target
|
|
4576
|
+
* group.</p>
|
|
4577
|
+
* </li>
|
|
4578
|
+
* <li>
|
|
4579
|
+
* <p>
|
|
4580
|
+
* <code>InService</code> - At least one Auto Scaling instance passed the
|
|
4581
|
+
* <code>VPC_LATTICE</code> health check.</p>
|
|
4582
|
+
* </li>
|
|
4583
|
+
* <li>
|
|
4584
|
+
* <p>
|
|
4585
|
+
* <code>Removing</code> - The Auto Scaling instances are being deregistered from the
|
|
4586
|
+
* target group. If connection draining is enabled, VPC Lattice waits for in-flight
|
|
4587
|
+
* requests to complete before deregistering the instances.</p>
|
|
4588
|
+
* </li>
|
|
4589
|
+
* <li>
|
|
4590
|
+
* <p>
|
|
4591
|
+
* <code>Removed</code> - All Auto Scaling instances are deregistered from the target
|
|
4592
|
+
* group.</p>
|
|
4593
|
+
* </li>
|
|
4594
|
+
* </ul>
|
|
4595
|
+
*/
|
|
4596
|
+
State?: string;
|
|
4597
|
+
}
|
|
4598
|
+
export interface DescribeTrafficSourcesResponse {
|
|
4599
|
+
/**
|
|
4600
|
+
* <p>Information about the traffic sources.</p>
|
|
4601
|
+
*/
|
|
4602
|
+
TrafficSources?: TrafficSourceState[];
|
|
4603
|
+
/**
|
|
4604
|
+
* <p>This string indicates that the response contains more items than can be returned in a
|
|
4605
|
+
* single response. To receive additional items, specify this string for the
|
|
4606
|
+
* <code>NextToken</code> value when requesting the next set of items. This value is
|
|
4607
|
+
* null when there are no more items to return.</p>
|
|
4608
|
+
*/
|
|
4609
|
+
NextToken?: string;
|
|
4610
|
+
}
|
|
4420
4611
|
export interface DescribeWarmPoolAnswer {
|
|
4421
4612
|
/**
|
|
4422
4613
|
* <p>The warm pool configuration details. </p>
|
|
@@ -4427,8 +4618,10 @@ export interface DescribeWarmPoolAnswer {
|
|
|
4427
4618
|
*/
|
|
4428
4619
|
Instances?: Instance[];
|
|
4429
4620
|
/**
|
|
4430
|
-
* <p>
|
|
4431
|
-
*
|
|
4621
|
+
* <p>This string indicates that the response contains more items than can be returned in a
|
|
4622
|
+
* single response. To receive additional items, specify this string for the
|
|
4623
|
+
* <code>NextToken</code> value when requesting the next set of items. This value is
|
|
4624
|
+
* null when there are no more items to return.</p>
|
|
4432
4625
|
*/
|
|
4433
4626
|
NextToken?: string;
|
|
4434
4627
|
}
|
|
@@ -4494,6 +4687,23 @@ export interface DetachLoadBalancerTargetGroupsType {
|
|
|
4494
4687
|
*/
|
|
4495
4688
|
TargetGroupARNs: string[] | undefined;
|
|
4496
4689
|
}
|
|
4690
|
+
export interface DetachTrafficSourcesResultType {
|
|
4691
|
+
}
|
|
4692
|
+
export interface DetachTrafficSourcesType {
|
|
4693
|
+
/**
|
|
4694
|
+
* <p>The name of the Auto Scaling group.</p>
|
|
4695
|
+
*/
|
|
4696
|
+
AutoScalingGroupName: string | undefined;
|
|
4697
|
+
/**
|
|
4698
|
+
* <p>The unique identifiers of one or more traffic sources you are detaching. You can
|
|
4699
|
+
* specify up to 10 traffic sources.</p>
|
|
4700
|
+
* <p>Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice
|
|
4701
|
+
* target group. When you detach a target group, it enters the <code>Removing</code> state
|
|
4702
|
+
* while deregistering the instances in the group. When all instances are deregistered,
|
|
4703
|
+
* then you can no longer describe the target group using the <a>DescribeTrafficSources</a> API call. The instances continue to run.</p>
|
|
4704
|
+
*/
|
|
4705
|
+
TrafficSources: TrafficSourceIdentifier[] | undefined;
|
|
4706
|
+
}
|
|
4497
4707
|
export interface DisableMetricsCollectionQuery {
|
|
4498
4708
|
/**
|
|
4499
4709
|
* <p>The name of the Auto Scaling group.</p>
|
|
@@ -4501,111 +4711,111 @@ export interface DisableMetricsCollectionQuery {
|
|
|
4501
4711
|
AutoScalingGroupName: string | undefined;
|
|
4502
4712
|
/**
|
|
4503
4713
|
* <p>Identifies the metrics to disable.</p>
|
|
4504
|
-
*
|
|
4505
|
-
*
|
|
4714
|
+
* <p>You can specify one or more of the following metrics:</p>
|
|
4715
|
+
* <ul>
|
|
4506
4716
|
* <li>
|
|
4507
|
-
*
|
|
4508
|
-
*
|
|
4509
|
-
*
|
|
4717
|
+
* <p>
|
|
4718
|
+
* <code>GroupMinSize</code>
|
|
4719
|
+
* </p>
|
|
4510
4720
|
* </li>
|
|
4511
4721
|
* <li>
|
|
4512
|
-
*
|
|
4513
|
-
*
|
|
4514
|
-
*
|
|
4722
|
+
* <p>
|
|
4723
|
+
* <code>GroupMaxSize</code>
|
|
4724
|
+
* </p>
|
|
4515
4725
|
* </li>
|
|
4516
4726
|
* <li>
|
|
4517
|
-
*
|
|
4518
|
-
*
|
|
4519
|
-
*
|
|
4727
|
+
* <p>
|
|
4728
|
+
* <code>GroupDesiredCapacity</code>
|
|
4729
|
+
* </p>
|
|
4520
4730
|
* </li>
|
|
4521
4731
|
* <li>
|
|
4522
|
-
*
|
|
4523
|
-
*
|
|
4524
|
-
*
|
|
4732
|
+
* <p>
|
|
4733
|
+
* <code>GroupInServiceInstances</code>
|
|
4734
|
+
* </p>
|
|
4525
4735
|
* </li>
|
|
4526
4736
|
* <li>
|
|
4527
|
-
*
|
|
4528
|
-
*
|
|
4529
|
-
*
|
|
4737
|
+
* <p>
|
|
4738
|
+
* <code>GroupPendingInstances</code>
|
|
4739
|
+
* </p>
|
|
4530
4740
|
* </li>
|
|
4531
4741
|
* <li>
|
|
4532
|
-
*
|
|
4533
|
-
*
|
|
4534
|
-
*
|
|
4742
|
+
* <p>
|
|
4743
|
+
* <code>GroupStandbyInstances</code>
|
|
4744
|
+
* </p>
|
|
4535
4745
|
* </li>
|
|
4536
4746
|
* <li>
|
|
4537
|
-
*
|
|
4538
|
-
*
|
|
4539
|
-
*
|
|
4747
|
+
* <p>
|
|
4748
|
+
* <code>GroupTerminatingInstances</code>
|
|
4749
|
+
* </p>
|
|
4540
4750
|
* </li>
|
|
4541
4751
|
* <li>
|
|
4542
|
-
*
|
|
4543
|
-
*
|
|
4544
|
-
*
|
|
4752
|
+
* <p>
|
|
4753
|
+
* <code>GroupTotalInstances</code>
|
|
4754
|
+
* </p>
|
|
4545
4755
|
* </li>
|
|
4546
4756
|
* <li>
|
|
4547
|
-
*
|
|
4548
|
-
*
|
|
4549
|
-
*
|
|
4757
|
+
* <p>
|
|
4758
|
+
* <code>GroupInServiceCapacity</code>
|
|
4759
|
+
* </p>
|
|
4550
4760
|
* </li>
|
|
4551
4761
|
* <li>
|
|
4552
|
-
*
|
|
4553
|
-
*
|
|
4554
|
-
*
|
|
4762
|
+
* <p>
|
|
4763
|
+
* <code>GroupPendingCapacity</code>
|
|
4764
|
+
* </p>
|
|
4555
4765
|
* </li>
|
|
4556
4766
|
* <li>
|
|
4557
|
-
*
|
|
4558
|
-
*
|
|
4559
|
-
*
|
|
4767
|
+
* <p>
|
|
4768
|
+
* <code>GroupStandbyCapacity</code>
|
|
4769
|
+
* </p>
|
|
4560
4770
|
* </li>
|
|
4561
4771
|
* <li>
|
|
4562
|
-
*
|
|
4563
|
-
*
|
|
4564
|
-
*
|
|
4772
|
+
* <p>
|
|
4773
|
+
* <code>GroupTerminatingCapacity</code>
|
|
4774
|
+
* </p>
|
|
4565
4775
|
* </li>
|
|
4566
4776
|
* <li>
|
|
4567
|
-
*
|
|
4568
|
-
*
|
|
4569
|
-
*
|
|
4777
|
+
* <p>
|
|
4778
|
+
* <code>GroupTotalCapacity</code>
|
|
4779
|
+
* </p>
|
|
4570
4780
|
* </li>
|
|
4571
4781
|
* <li>
|
|
4572
|
-
*
|
|
4573
|
-
*
|
|
4574
|
-
*
|
|
4782
|
+
* <p>
|
|
4783
|
+
* <code>WarmPoolDesiredCapacity</code>
|
|
4784
|
+
* </p>
|
|
4575
4785
|
* </li>
|
|
4576
4786
|
* <li>
|
|
4577
|
-
*
|
|
4578
|
-
*
|
|
4579
|
-
*
|
|
4787
|
+
* <p>
|
|
4788
|
+
* <code>WarmPoolWarmedCapacity</code>
|
|
4789
|
+
* </p>
|
|
4580
4790
|
* </li>
|
|
4581
4791
|
* <li>
|
|
4582
|
-
*
|
|
4583
|
-
*
|
|
4584
|
-
*
|
|
4792
|
+
* <p>
|
|
4793
|
+
* <code>WarmPoolPendingCapacity</code>
|
|
4794
|
+
* </p>
|
|
4585
4795
|
* </li>
|
|
4586
4796
|
* <li>
|
|
4587
|
-
*
|
|
4588
|
-
*
|
|
4589
|
-
*
|
|
4797
|
+
* <p>
|
|
4798
|
+
* <code>WarmPoolTerminatingCapacity</code>
|
|
4799
|
+
* </p>
|
|
4590
4800
|
* </li>
|
|
4591
4801
|
* <li>
|
|
4592
|
-
*
|
|
4593
|
-
*
|
|
4594
|
-
*
|
|
4802
|
+
* <p>
|
|
4803
|
+
* <code>WarmPoolTotalCapacity</code>
|
|
4804
|
+
* </p>
|
|
4595
4805
|
* </li>
|
|
4596
4806
|
* <li>
|
|
4597
|
-
*
|
|
4598
|
-
*
|
|
4599
|
-
*
|
|
4807
|
+
* <p>
|
|
4808
|
+
* <code>GroupAndWarmPoolDesiredCapacity</code>
|
|
4809
|
+
* </p>
|
|
4600
4810
|
* </li>
|
|
4601
4811
|
* <li>
|
|
4602
|
-
*
|
|
4603
|
-
*
|
|
4604
|
-
*
|
|
4812
|
+
* <p>
|
|
4813
|
+
* <code>GroupAndWarmPoolTotalCapacity</code>
|
|
4814
|
+
* </p>
|
|
4605
4815
|
* </li>
|
|
4606
4816
|
* </ul>
|
|
4607
|
-
*
|
|
4608
|
-
*
|
|
4817
|
+
* <p>If you omit this property, all metrics are disabled.</p>
|
|
4818
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics">Auto Scaling group metrics</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
4609
4819
|
*/
|
|
4610
4820
|
Metrics?: string[];
|
|
4611
4821
|
}
|
|
@@ -4616,112 +4826,112 @@ export interface EnableMetricsCollectionQuery {
|
|
|
4616
4826
|
AutoScalingGroupName: string | undefined;
|
|
4617
4827
|
/**
|
|
4618
4828
|
* <p>Identifies the metrics to enable.</p>
|
|
4619
|
-
*
|
|
4620
|
-
*
|
|
4829
|
+
* <p>You can specify one or more of the following metrics:</p>
|
|
4830
|
+
* <ul>
|
|
4621
4831
|
* <li>
|
|
4622
|
-
*
|
|
4623
|
-
*
|
|
4624
|
-
*
|
|
4832
|
+
* <p>
|
|
4833
|
+
* <code>GroupMinSize</code>
|
|
4834
|
+
* </p>
|
|
4625
4835
|
* </li>
|
|
4626
4836
|
* <li>
|
|
4627
|
-
*
|
|
4628
|
-
*
|
|
4629
|
-
*
|
|
4837
|
+
* <p>
|
|
4838
|
+
* <code>GroupMaxSize</code>
|
|
4839
|
+
* </p>
|
|
4630
4840
|
* </li>
|
|
4631
4841
|
* <li>
|
|
4632
|
-
*
|
|
4633
|
-
*
|
|
4634
|
-
*
|
|
4842
|
+
* <p>
|
|
4843
|
+
* <code>GroupDesiredCapacity</code>
|
|
4844
|
+
* </p>
|
|
4635
4845
|
* </li>
|
|
4636
4846
|
* <li>
|
|
4637
|
-
*
|
|
4638
|
-
*
|
|
4639
|
-
*
|
|
4847
|
+
* <p>
|
|
4848
|
+
* <code>GroupInServiceInstances</code>
|
|
4849
|
+
* </p>
|
|
4640
4850
|
* </li>
|
|
4641
4851
|
* <li>
|
|
4642
|
-
*
|
|
4643
|
-
*
|
|
4644
|
-
*
|
|
4852
|
+
* <p>
|
|
4853
|
+
* <code>GroupPendingInstances</code>
|
|
4854
|
+
* </p>
|
|
4645
4855
|
* </li>
|
|
4646
4856
|
* <li>
|
|
4647
|
-
*
|
|
4648
|
-
*
|
|
4649
|
-
*
|
|
4857
|
+
* <p>
|
|
4858
|
+
* <code>GroupStandbyInstances</code>
|
|
4859
|
+
* </p>
|
|
4650
4860
|
* </li>
|
|
4651
4861
|
* <li>
|
|
4652
|
-
*
|
|
4653
|
-
*
|
|
4654
|
-
*
|
|
4862
|
+
* <p>
|
|
4863
|
+
* <code>GroupTerminatingInstances</code>
|
|
4864
|
+
* </p>
|
|
4655
4865
|
* </li>
|
|
4656
4866
|
* <li>
|
|
4657
|
-
*
|
|
4658
|
-
*
|
|
4659
|
-
*
|
|
4867
|
+
* <p>
|
|
4868
|
+
* <code>GroupTotalInstances</code>
|
|
4869
|
+
* </p>
|
|
4660
4870
|
* </li>
|
|
4661
4871
|
* <li>
|
|
4662
|
-
*
|
|
4663
|
-
*
|
|
4664
|
-
*
|
|
4872
|
+
* <p>
|
|
4873
|
+
* <code>GroupInServiceCapacity</code>
|
|
4874
|
+
* </p>
|
|
4665
4875
|
* </li>
|
|
4666
4876
|
* <li>
|
|
4667
|
-
*
|
|
4668
|
-
*
|
|
4669
|
-
*
|
|
4877
|
+
* <p>
|
|
4878
|
+
* <code>GroupPendingCapacity</code>
|
|
4879
|
+
* </p>
|
|
4670
4880
|
* </li>
|
|
4671
4881
|
* <li>
|
|
4672
|
-
*
|
|
4673
|
-
*
|
|
4674
|
-
*
|
|
4882
|
+
* <p>
|
|
4883
|
+
* <code>GroupStandbyCapacity</code>
|
|
4884
|
+
* </p>
|
|
4675
4885
|
* </li>
|
|
4676
4886
|
* <li>
|
|
4677
|
-
*
|
|
4678
|
-
*
|
|
4679
|
-
*
|
|
4887
|
+
* <p>
|
|
4888
|
+
* <code>GroupTerminatingCapacity</code>
|
|
4889
|
+
* </p>
|
|
4680
4890
|
* </li>
|
|
4681
4891
|
* <li>
|
|
4682
|
-
*
|
|
4683
|
-
*
|
|
4684
|
-
*
|
|
4892
|
+
* <p>
|
|
4893
|
+
* <code>GroupTotalCapacity</code>
|
|
4894
|
+
* </p>
|
|
4685
4895
|
* </li>
|
|
4686
4896
|
* <li>
|
|
4687
|
-
*
|
|
4688
|
-
*
|
|
4689
|
-
*
|
|
4897
|
+
* <p>
|
|
4898
|
+
* <code>WarmPoolDesiredCapacity</code>
|
|
4899
|
+
* </p>
|
|
4690
4900
|
* </li>
|
|
4691
4901
|
* <li>
|
|
4692
|
-
*
|
|
4693
|
-
*
|
|
4694
|
-
*
|
|
4902
|
+
* <p>
|
|
4903
|
+
* <code>WarmPoolWarmedCapacity</code>
|
|
4904
|
+
* </p>
|
|
4695
4905
|
* </li>
|
|
4696
4906
|
* <li>
|
|
4697
|
-
*
|
|
4698
|
-
*
|
|
4699
|
-
*
|
|
4907
|
+
* <p>
|
|
4908
|
+
* <code>WarmPoolPendingCapacity</code>
|
|
4909
|
+
* </p>
|
|
4700
4910
|
* </li>
|
|
4701
4911
|
* <li>
|
|
4702
|
-
*
|
|
4703
|
-
*
|
|
4704
|
-
*
|
|
4912
|
+
* <p>
|
|
4913
|
+
* <code>WarmPoolTerminatingCapacity</code>
|
|
4914
|
+
* </p>
|
|
4705
4915
|
* </li>
|
|
4706
4916
|
* <li>
|
|
4707
|
-
*
|
|
4708
|
-
*
|
|
4709
|
-
*
|
|
4917
|
+
* <p>
|
|
4918
|
+
* <code>WarmPoolTotalCapacity</code>
|
|
4919
|
+
* </p>
|
|
4710
4920
|
* </li>
|
|
4711
4921
|
* <li>
|
|
4712
|
-
*
|
|
4713
|
-
*
|
|
4714
|
-
*
|
|
4922
|
+
* <p>
|
|
4923
|
+
* <code>GroupAndWarmPoolDesiredCapacity</code>
|
|
4924
|
+
* </p>
|
|
4715
4925
|
* </li>
|
|
4716
4926
|
* <li>
|
|
4717
|
-
*
|
|
4718
|
-
*
|
|
4719
|
-
*
|
|
4927
|
+
* <p>
|
|
4928
|
+
* <code>GroupAndWarmPoolTotalCapacity</code>
|
|
4929
|
+
* </p>
|
|
4720
4930
|
* </li>
|
|
4721
4931
|
* </ul>
|
|
4722
|
-
*
|
|
4932
|
+
* <p>If you specify <code>Granularity</code> and don't specify any metrics, all metrics are
|
|
4723
4933
|
* enabled.</p>
|
|
4724
|
-
*
|
|
4934
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics">Auto Scaling group metrics</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
4725
4935
|
*/
|
|
4726
4936
|
Metrics?: string[];
|
|
4727
4937
|
/**
|
|
@@ -4763,7 +4973,7 @@ export interface ExecutePolicyType {
|
|
|
4763
4973
|
/**
|
|
4764
4974
|
* <p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing
|
|
4765
4975
|
* the policy.</p>
|
|
4766
|
-
*
|
|
4976
|
+
* <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see
|
|
4767
4977
|
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling
|
|
4768
4978
|
* cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
4769
4979
|
*/
|
|
@@ -4774,15 +4984,15 @@ export interface ExecutePolicyType {
|
|
|
4774
4984
|
* use. For example, if the breach threshold is 50 and you want to use a step adjustment
|
|
4775
4985
|
* with a lower bound of 0 and an upper bound of 10, you can set the metric value to
|
|
4776
4986
|
* 59.</p>
|
|
4777
|
-
*
|
|
4987
|
+
* <p>If you specify a metric value that doesn't correspond to a step adjustment for the
|
|
4778
4988
|
* policy, the call returns an error.</p>
|
|
4779
|
-
*
|
|
4989
|
+
* <p>Required if the policy type is <code>StepScaling</code> and not supported
|
|
4780
4990
|
* otherwise.</p>
|
|
4781
4991
|
*/
|
|
4782
4992
|
MetricValue?: number;
|
|
4783
4993
|
/**
|
|
4784
4994
|
* <p>The breach threshold for the alarm.</p>
|
|
4785
|
-
*
|
|
4995
|
+
* <p>Required if the policy type is <code>StepScaling</code> and not supported
|
|
4786
4996
|
* otherwise.</p>
|
|
4787
4997
|
*/
|
|
4788
4998
|
BreachThreshold?: number;
|
|
@@ -4869,7 +5079,7 @@ export interface GetPredictiveScalingForecastType {
|
|
|
4869
5079
|
/**
|
|
4870
5080
|
* <p>The exclusive end time of the time range for the forecast data to get. The maximum
|
|
4871
5081
|
* time duration between the start and end time is 30 days. </p>
|
|
4872
|
-
*
|
|
5082
|
+
* <p>Although this parameter can accept a date and time that is more than two days in the
|
|
4873
5083
|
* future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for
|
|
4874
5084
|
* periods of two days in advance.</p>
|
|
4875
5085
|
*/
|
|
@@ -4889,23 +5099,23 @@ export interface PutLifecycleHookType {
|
|
|
4889
5099
|
/**
|
|
4890
5100
|
* <p>The lifecycle transition. For Auto Scaling groups, there are two major lifecycle
|
|
4891
5101
|
* transitions.</p>
|
|
4892
|
-
*
|
|
5102
|
+
* <ul>
|
|
4893
5103
|
* <li>
|
|
4894
|
-
*
|
|
5104
|
+
* <p>To create a lifecycle hook for scale-out events, specify
|
|
4895
5105
|
* <code>autoscaling:EC2_INSTANCE_LAUNCHING</code>.</p>
|
|
4896
5106
|
* </li>
|
|
4897
5107
|
* <li>
|
|
4898
|
-
*
|
|
5108
|
+
* <p>To create a lifecycle hook for scale-in events, specify
|
|
4899
5109
|
* <code>autoscaling:EC2_INSTANCE_TERMINATING</code>.</p>
|
|
4900
5110
|
* </li>
|
|
4901
5111
|
* </ul>
|
|
4902
|
-
*
|
|
5112
|
+
* <p>Required for new lifecycle hooks, but optional when updating existing hooks.</p>
|
|
4903
5113
|
*/
|
|
4904
5114
|
LifecycleTransition?: string;
|
|
4905
5115
|
/**
|
|
4906
5116
|
* <p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
|
|
4907
5117
|
* notification target.</p>
|
|
4908
|
-
*
|
|
5118
|
+
* <p>Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required
|
|
4909
5119
|
* for new lifecycle hooks, but optional when updating existing hooks.</p>
|
|
4910
5120
|
*/
|
|
4911
5121
|
RoleARN?: string;
|
|
@@ -4913,10 +5123,10 @@ export interface PutLifecycleHookType {
|
|
|
4913
5123
|
* <p>The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify
|
|
4914
5124
|
* you when an instance is in a wait state for the lifecycle hook. You can specify either
|
|
4915
5125
|
* an Amazon SNS topic or an Amazon SQS queue.</p>
|
|
4916
|
-
*
|
|
4917
|
-
*
|
|
5126
|
+
* <p>If you specify an empty string, this overrides the current ARN.</p>
|
|
5127
|
+
* <p>This operation uses the JSON format when sending notifications to an Amazon SQS queue, and
|
|
4918
5128
|
* an email key-value pair format when sending notifications to an Amazon SNS topic.</p>
|
|
4919
|
-
*
|
|
5129
|
+
* <p>When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test
|
|
4920
5130
|
* messages contain the following additional key-value pair: <code>"Event":
|
|
4921
5131
|
* "autoscaling:TEST_NOTIFICATION"</code>.</p>
|
|
4922
5132
|
*/
|
|
@@ -4935,7 +5145,7 @@ export interface PutLifecycleHookType {
|
|
|
4935
5145
|
/**
|
|
4936
5146
|
* <p>The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an
|
|
4937
5147
|
* unexpected failure occurs. The default value is <code>ABANDON</code>.</p>
|
|
4938
|
-
*
|
|
5148
|
+
* <p>Valid values: <code>CONTINUE</code> | <code>ABANDON</code>
|
|
4939
5149
|
* </p>
|
|
4940
5150
|
*/
|
|
4941
5151
|
DefaultResult?: string;
|
|
@@ -4979,25 +5189,25 @@ export interface PutScalingPolicyType {
|
|
|
4979
5189
|
PolicyName: string | undefined;
|
|
4980
5190
|
/**
|
|
4981
5191
|
* <p>One of the following policy types: </p>
|
|
4982
|
-
*
|
|
5192
|
+
* <ul>
|
|
4983
5193
|
* <li>
|
|
4984
|
-
*
|
|
4985
|
-
*
|
|
4986
|
-
*
|
|
5194
|
+
* <p>
|
|
5195
|
+
* <code>TargetTrackingScaling</code>
|
|
5196
|
+
* </p>
|
|
4987
5197
|
* </li>
|
|
4988
5198
|
* <li>
|
|
4989
|
-
*
|
|
4990
|
-
*
|
|
4991
|
-
*
|
|
5199
|
+
* <p>
|
|
5200
|
+
* <code>StepScaling</code>
|
|
5201
|
+
* </p>
|
|
4992
5202
|
* </li>
|
|
4993
5203
|
* <li>
|
|
4994
|
-
*
|
|
5204
|
+
* <p>
|
|
4995
5205
|
* <code>SimpleScaling</code> (default)</p>
|
|
4996
5206
|
* </li>
|
|
4997
5207
|
* <li>
|
|
4998
|
-
*
|
|
4999
|
-
*
|
|
5000
|
-
*
|
|
5208
|
+
* <p>
|
|
5209
|
+
* <code>PredictiveScaling</code>
|
|
5210
|
+
* </p>
|
|
5001
5211
|
* </li>
|
|
5002
5212
|
* </ul>
|
|
5003
5213
|
*/
|
|
@@ -5006,7 +5216,7 @@ export interface PutScalingPolicyType {
|
|
|
5006
5216
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute number
|
|
5007
5217
|
* or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
5008
5218
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
5009
|
-
*
|
|
5219
|
+
* <p>Required if the policy type is <code>StepScaling</code> or <code>SimpleScaling</code>.
|
|
5010
5220
|
* For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling adjustment types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5011
5221
|
*/
|
|
5012
5222
|
AdjustmentType?: string;
|
|
@@ -5025,44 +5235,44 @@ export interface PutScalingPolicyType {
|
|
|
5025
5235
|
* scaling policy is performed, 25 percent of 4 is 1. However, because you specified a
|
|
5026
5236
|
* <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling scales out the group by 2
|
|
5027
5237
|
* instances.</p>
|
|
5028
|
-
*
|
|
5238
|
+
* <p>Valid only if the policy type is <code>StepScaling</code> or
|
|
5029
5239
|
* <code>SimpleScaling</code>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling adjustment types</a> in the <i>Amazon EC2 Auto Scaling User
|
|
5030
5240
|
* Guide</i>.</p>
|
|
5031
|
-
*
|
|
5241
|
+
* <note>
|
|
5032
5242
|
* <p>Some Auto Scaling groups use instance weights. In this case, set the
|
|
5033
5243
|
* <code>MinAdjustmentMagnitude</code> to a value that is at least as large as your
|
|
5034
5244
|
* largest instance weight.</p>
|
|
5035
|
-
*
|
|
5245
|
+
* </note>
|
|
5036
5246
|
*/
|
|
5037
5247
|
MinAdjustmentMagnitude?: number;
|
|
5038
5248
|
/**
|
|
5039
5249
|
* <p>The amount by which to scale, based on the specified adjustment type. A positive value
|
|
5040
5250
|
* adds to the current capacity while a negative number removes from the current capacity.
|
|
5041
5251
|
* For exact capacity, you must specify a positive value.</p>
|
|
5042
|
-
*
|
|
5252
|
+
* <p>Required if the policy type is <code>SimpleScaling</code>. (Not used with any other
|
|
5043
5253
|
* policy type.) </p>
|
|
5044
5254
|
*/
|
|
5045
5255
|
ScalingAdjustment?: number;
|
|
5046
5256
|
/**
|
|
5047
5257
|
* <p>A cooldown period, in seconds, that applies to a specific simple scaling policy. When
|
|
5048
5258
|
* a cooldown period is specified here, it overrides the default cooldown.</p>
|
|
5049
|
-
*
|
|
5259
|
+
* <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see
|
|
5050
5260
|
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling
|
|
5051
5261
|
* cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5052
|
-
*
|
|
5262
|
+
* <p>Default: None</p>
|
|
5053
5263
|
*/
|
|
5054
5264
|
Cooldown?: number;
|
|
5055
5265
|
/**
|
|
5056
5266
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are <code>Minimum</code>,
|
|
5057
5267
|
* <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the
|
|
5058
5268
|
* value is treated as <code>Average</code>.</p>
|
|
5059
|
-
*
|
|
5269
|
+
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
5060
5270
|
*/
|
|
5061
5271
|
MetricAggregationType?: string;
|
|
5062
5272
|
/**
|
|
5063
5273
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
5064
5274
|
* breach.</p>
|
|
5065
|
-
*
|
|
5275
|
+
* <p>Required if the policy type is <code>StepScaling</code>. (Not used with any other
|
|
5066
5276
|
* policy type.) </p>
|
|
5067
5277
|
*/
|
|
5068
5278
|
StepAdjustments?: StepAdjustment[];
|
|
@@ -5071,51 +5281,51 @@ export interface PutScalingPolicyType {
|
|
|
5071
5281
|
* <i>Not needed if the default instance warmup is defined for the
|
|
5072
5282
|
* group.</i>
|
|
5073
5283
|
* </p>
|
|
5074
|
-
*
|
|
5284
|
+
* <p>The estimated time, in seconds, until a newly launched instance can contribute to the
|
|
5075
5285
|
* CloudWatch metrics. This warm-up period applies to instances launched due to a specific target
|
|
5076
5286
|
* tracking or step scaling policy. When a warm-up period is specified here, it overrides
|
|
5077
5287
|
* the default instance warmup.</p>
|
|
5078
|
-
*
|
|
5288
|
+
* <p>Valid only if the policy type is <code>TargetTrackingScaling</code> or
|
|
5079
5289
|
* <code>StepScaling</code>.</p>
|
|
5080
|
-
*
|
|
5290
|
+
* <note>
|
|
5081
5291
|
* <p>The default is to use the value for the default instance warmup defined for the
|
|
5082
5292
|
* group. If default instance warmup is null, then <code>EstimatedInstanceWarmup</code>
|
|
5083
5293
|
* falls back to the value of default cooldown.</p>
|
|
5084
|
-
*
|
|
5294
|
+
* </note>
|
|
5085
5295
|
*/
|
|
5086
5296
|
EstimatedInstanceWarmup?: number;
|
|
5087
5297
|
/**
|
|
5088
5298
|
* <p>A target tracking scaling policy. Provides support for predefined or custom
|
|
5089
5299
|
* metrics.</p>
|
|
5090
|
-
*
|
|
5091
|
-
*
|
|
5300
|
+
* <p>The following predefined metrics are available:</p>
|
|
5301
|
+
* <ul>
|
|
5092
5302
|
* <li>
|
|
5093
|
-
*
|
|
5094
|
-
*
|
|
5095
|
-
*
|
|
5303
|
+
* <p>
|
|
5304
|
+
* <code>ASGAverageCPUUtilization</code>
|
|
5305
|
+
* </p>
|
|
5096
5306
|
* </li>
|
|
5097
5307
|
* <li>
|
|
5098
|
-
*
|
|
5099
|
-
*
|
|
5100
|
-
*
|
|
5308
|
+
* <p>
|
|
5309
|
+
* <code>ASGAverageNetworkIn</code>
|
|
5310
|
+
* </p>
|
|
5101
5311
|
* </li>
|
|
5102
5312
|
* <li>
|
|
5103
|
-
*
|
|
5104
|
-
*
|
|
5105
|
-
*
|
|
5313
|
+
* <p>
|
|
5314
|
+
* <code>ASGAverageNetworkOut</code>
|
|
5315
|
+
* </p>
|
|
5106
5316
|
* </li>
|
|
5107
5317
|
* <li>
|
|
5108
|
-
*
|
|
5109
|
-
*
|
|
5110
|
-
*
|
|
5318
|
+
* <p>
|
|
5319
|
+
* <code>ALBRequestCountPerTarget</code>
|
|
5320
|
+
* </p>
|
|
5111
5321
|
* </li>
|
|
5112
5322
|
* </ul>
|
|
5113
|
-
*
|
|
5323
|
+
* <p>If you specify <code>ALBRequestCountPerTarget</code> for the metric, you must specify
|
|
5114
5324
|
* the <code>ResourceLabel</code> property with the
|
|
5115
5325
|
* <code>PredefinedMetricSpecification</code>.</p>
|
|
5116
|
-
*
|
|
5326
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a> in the <i>Amazon EC2 Auto Scaling API
|
|
5117
5327
|
* Reference</i>.</p>
|
|
5118
|
-
*
|
|
5328
|
+
* <p>Required if the policy type is <code>TargetTrackingScaling</code>.</p>
|
|
5119
5329
|
*/
|
|
5120
5330
|
TargetTrackingConfiguration?: TargetTrackingConfiguration;
|
|
5121
5331
|
/**
|
|
@@ -5128,11 +5338,11 @@ export interface PutScalingPolicyType {
|
|
|
5128
5338
|
/**
|
|
5129
5339
|
* <p>A predictive scaling policy. Provides support for predefined and custom
|
|
5130
5340
|
* metrics.</p>
|
|
5131
|
-
*
|
|
5341
|
+
* <p>Predefined metrics include CPU utilization, network in/out, and the Application Load
|
|
5132
5342
|
* Balancer request count.</p>
|
|
5133
|
-
*
|
|
5343
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PredictiveScalingConfiguration.html">PredictiveScalingConfiguration</a> in the <i>Amazon EC2 Auto Scaling API
|
|
5134
5344
|
* Reference</i>.</p>
|
|
5135
|
-
*
|
|
5345
|
+
* <p>Required if the policy type is <code>PredictiveScaling</code>.</p>
|
|
5136
5346
|
*/
|
|
5137
5347
|
PredictiveScalingConfiguration?: PredictiveScalingConfiguration;
|
|
5138
5348
|
}
|
|
@@ -5152,7 +5362,7 @@ export interface PutScheduledUpdateGroupActionType {
|
|
|
5152
5362
|
/**
|
|
5153
5363
|
* <p>The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT
|
|
5154
5364
|
* only and in quotes (for example, <code>"2021-06-01T00:00:00Z"</code>).</p>
|
|
5155
|
-
*
|
|
5365
|
+
* <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs
|
|
5156
5366
|
* the action at this time, and then performs the action based on the specified
|
|
5157
5367
|
* recurrence.</p>
|
|
5158
5368
|
*/
|
|
@@ -5167,10 +5377,10 @@ export interface PutScheduledUpdateGroupActionType {
|
|
|
5167
5377
|
* by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value
|
|
5168
5378
|
* must be in quotes (for example, <code>"30 0 1 1,6,12 *"</code>). For more information
|
|
5169
5379
|
* about this format, see <a href="http://crontab.org">Crontab</a>.</p>
|
|
5170
|
-
*
|
|
5380
|
+
* <p>When <code>StartTime</code> and <code>EndTime</code> are specified with
|
|
5171
5381
|
* <code>Recurrence</code>, they form the boundaries of when the recurring action
|
|
5172
5382
|
* starts and stops.</p>
|
|
5173
|
-
*
|
|
5383
|
+
* <p>Cron expressions use Universal Coordinated Time (UTC) by default.</p>
|
|
5174
5384
|
*/
|
|
5175
5385
|
Recurrence?: string;
|
|
5176
5386
|
/**
|
|
@@ -5185,16 +5395,16 @@ export interface PutScheduledUpdateGroupActionType {
|
|
|
5185
5395
|
* <p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled
|
|
5186
5396
|
* action runs and the capacity it attempts to maintain. It can scale beyond this capacity
|
|
5187
5397
|
* if you add more scaling conditions. </p>
|
|
5188
|
-
*
|
|
5398
|
+
* <note>
|
|
5189
5399
|
* <p>You must specify at least one of the following properties: <code>MaxSize</code>,
|
|
5190
5400
|
* <code>MinSize</code>, or <code>DesiredCapacity</code>. </p>
|
|
5191
|
-
*
|
|
5401
|
+
* </note>
|
|
5192
5402
|
*/
|
|
5193
5403
|
DesiredCapacity?: number;
|
|
5194
5404
|
/**
|
|
5195
5405
|
* <p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is
|
|
5196
5406
|
* used by default. </p>
|
|
5197
|
-
*
|
|
5407
|
+
* <p>Valid values are the canonical names of the IANA time zones, derived from the IANA
|
|
5198
5408
|
* Time Zone Database (such as <code>Etc/GMT+9</code> or <code>Pacific/Tahiti</code>). For
|
|
5199
5409
|
* more information, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>.</p>
|
|
5200
5410
|
*/
|
|
@@ -5212,7 +5422,7 @@ export interface PutWarmPoolType {
|
|
|
5212
5422
|
* in any state except <code>Terminated</code> for the Auto Scaling group. This is an optional
|
|
5213
5423
|
* property. Specify it only if you do not want the warm pool size to be determined by the
|
|
5214
5424
|
* difference between the group's maximum capacity and its desired capacity. </p>
|
|
5215
|
-
*
|
|
5425
|
+
* <important>
|
|
5216
5426
|
* <p>If a value for <code>MaxGroupPreparedCapacity</code> is not specified, Amazon EC2 Auto Scaling
|
|
5217
5427
|
* launches and maintains the difference between the group's maximum capacity and its
|
|
5218
5428
|
* desired capacity. If you specify a value for <code>MaxGroupPreparedCapacity</code>,
|
|
@@ -5221,8 +5431,8 @@ export interface PutWarmPoolType {
|
|
|
5221
5431
|
* <p>The size of the warm pool is dynamic. Only when
|
|
5222
5432
|
* <code>MaxGroupPreparedCapacity</code> and <code>MinSize</code> are set to the
|
|
5223
5433
|
* same value does the warm pool have an absolute size.</p>
|
|
5224
|
-
*
|
|
5225
|
-
*
|
|
5434
|
+
* </important>
|
|
5435
|
+
* <p>If the desired capacity of the Auto Scaling group is higher than the
|
|
5226
5436
|
* <code>MaxGroupPreparedCapacity</code>, the capacity of the warm pool is 0, unless
|
|
5227
5437
|
* you specify a value for <code>MinSize</code>. To remove a value that you previously set,
|
|
5228
5438
|
* include the property but specify -1 for the value. </p>
|
|
@@ -5275,54 +5485,54 @@ export interface ScalingProcessQuery {
|
|
|
5275
5485
|
AutoScalingGroupName: string | undefined;
|
|
5276
5486
|
/**
|
|
5277
5487
|
* <p>One or more of the following processes:</p>
|
|
5278
|
-
*
|
|
5488
|
+
* <ul>
|
|
5279
5489
|
* <li>
|
|
5280
|
-
*
|
|
5281
|
-
*
|
|
5282
|
-
*
|
|
5490
|
+
* <p>
|
|
5491
|
+
* <code>Launch</code>
|
|
5492
|
+
* </p>
|
|
5283
5493
|
* </li>
|
|
5284
5494
|
* <li>
|
|
5285
|
-
*
|
|
5286
|
-
*
|
|
5287
|
-
*
|
|
5495
|
+
* <p>
|
|
5496
|
+
* <code>Terminate</code>
|
|
5497
|
+
* </p>
|
|
5288
5498
|
* </li>
|
|
5289
5499
|
* <li>
|
|
5290
|
-
*
|
|
5291
|
-
*
|
|
5292
|
-
*
|
|
5500
|
+
* <p>
|
|
5501
|
+
* <code>AddToLoadBalancer</code>
|
|
5502
|
+
* </p>
|
|
5293
5503
|
* </li>
|
|
5294
5504
|
* <li>
|
|
5295
|
-
*
|
|
5296
|
-
*
|
|
5297
|
-
*
|
|
5505
|
+
* <p>
|
|
5506
|
+
* <code>AlarmNotification</code>
|
|
5507
|
+
* </p>
|
|
5298
5508
|
* </li>
|
|
5299
5509
|
* <li>
|
|
5300
|
-
*
|
|
5301
|
-
*
|
|
5302
|
-
*
|
|
5510
|
+
* <p>
|
|
5511
|
+
* <code>AZRebalance</code>
|
|
5512
|
+
* </p>
|
|
5303
5513
|
* </li>
|
|
5304
5514
|
* <li>
|
|
5305
|
-
*
|
|
5306
|
-
*
|
|
5307
|
-
*
|
|
5515
|
+
* <p>
|
|
5516
|
+
* <code>HealthCheck</code>
|
|
5517
|
+
* </p>
|
|
5308
5518
|
* </li>
|
|
5309
5519
|
* <li>
|
|
5310
|
-
*
|
|
5311
|
-
*
|
|
5312
|
-
*
|
|
5520
|
+
* <p>
|
|
5521
|
+
* <code>InstanceRefresh</code>
|
|
5522
|
+
* </p>
|
|
5313
5523
|
* </li>
|
|
5314
5524
|
* <li>
|
|
5315
|
-
*
|
|
5316
|
-
*
|
|
5317
|
-
*
|
|
5525
|
+
* <p>
|
|
5526
|
+
* <code>ReplaceUnhealthy</code>
|
|
5527
|
+
* </p>
|
|
5318
5528
|
* </li>
|
|
5319
5529
|
* <li>
|
|
5320
|
-
*
|
|
5321
|
-
*
|
|
5322
|
-
*
|
|
5530
|
+
* <p>
|
|
5531
|
+
* <code>ScheduledActions</code>
|
|
5532
|
+
* </p>
|
|
5323
5533
|
* </li>
|
|
5324
5534
|
* </ul>
|
|
5325
|
-
*
|
|
5535
|
+
* <p>If you omit this property, all processes are specified.</p>
|
|
5326
5536
|
*/
|
|
5327
5537
|
ScalingProcesses?: string[];
|
|
5328
5538
|
}
|
|
@@ -5359,8 +5569,7 @@ export interface SetInstanceHealthQuery {
|
|
|
5359
5569
|
* specified for the group, by default, this call respects the grace period. Set this to
|
|
5360
5570
|
* <code>False</code>, to have the call not respect the grace period associated with
|
|
5361
5571
|
* the group.</p>
|
|
5362
|
-
*
|
|
5363
|
-
* <p>For more information about the health check grace
|
|
5572
|
+
* <p>For more information about the health check grace
|
|
5364
5573
|
* period, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html">CreateAutoScalingGroup</a> in the <i>Amazon EC2 Auto Scaling API
|
|
5365
5574
|
* Reference</i>.</p>
|
|
5366
5575
|
*/
|
|
@@ -5412,7 +5621,7 @@ export interface StartInstanceRefreshType {
|
|
|
5412
5621
|
/**
|
|
5413
5622
|
* <p>The strategy to use for the instance refresh. The only valid value is
|
|
5414
5623
|
* <code>Rolling</code>.</p>
|
|
5415
|
-
*
|
|
5624
|
+
* <p>A rolling update helps you update your instances gradually. A rolling update can fail
|
|
5416
5625
|
* due to failed health checks or if instances are on standby or are protected from scale
|
|
5417
5626
|
* in. If the rolling update process fails, any instances that are replaced are not rolled
|
|
5418
5627
|
* back to their previous configuration. </p>
|
|
@@ -5421,16 +5630,16 @@ export interface StartInstanceRefreshType {
|
|
|
5421
5630
|
/**
|
|
5422
5631
|
* <p>The desired configuration. For example, the desired configuration can specify a new
|
|
5423
5632
|
* launch template or a new version of the current launch template.</p>
|
|
5424
|
-
*
|
|
5633
|
+
* <p>Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to
|
|
5425
5634
|
* reflect the new desired configuration. </p>
|
|
5426
|
-
*
|
|
5635
|
+
* <note>
|
|
5427
5636
|
* <p>When you specify a new launch template or a new version of the current launch
|
|
5428
5637
|
* template for your desired configuration, consider enabling the
|
|
5429
5638
|
* <code>SkipMatching</code> property in preferences. If it's enabled, Amazon EC2 Auto Scaling
|
|
5430
5639
|
* skips replacing instances that already use the specified launch template and
|
|
5431
5640
|
* version. This can help you reduce the number of replacements that are required to
|
|
5432
5641
|
* apply updates. </p>
|
|
5433
|
-
*
|
|
5642
|
+
* </note>
|
|
5434
5643
|
*/
|
|
5435
5644
|
DesiredConfiguration?: DesiredConfiguration;
|
|
5436
5645
|
/**
|
|
@@ -5479,13 +5688,13 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5479
5688
|
MinSize?: number;
|
|
5480
5689
|
/**
|
|
5481
5690
|
* <p>The maximum size of the Auto Scaling group.</p>
|
|
5482
|
-
*
|
|
5691
|
+
* <note>
|
|
5483
5692
|
* <p>With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to
|
|
5484
5693
|
* go above <code>MaxSize</code> to meet your capacity requirements. In this event,
|
|
5485
5694
|
* Amazon EC2 Auto Scaling will never go above <code>MaxSize</code> by more than your largest instance
|
|
5486
5695
|
* weight (weights that define how many units each instance contributes to the desired
|
|
5487
5696
|
* capacity of the group).</p>
|
|
5488
|
-
*
|
|
5697
|
+
* </note>
|
|
5489
5698
|
*/
|
|
5490
5699
|
MaxSize?: number;
|
|
5491
5700
|
/**
|
|
@@ -5499,7 +5708,7 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5499
5708
|
* <p>
|
|
5500
5709
|
* <i>Only needed if you use simple scaling policies.</i>
|
|
5501
5710
|
* </p>
|
|
5502
|
-
*
|
|
5711
|
+
* <p>The amount of time, in seconds, between one scaling activity ending and another one
|
|
5503
5712
|
* starting due to simple scaling policies. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling cooldowns
|
|
5504
5713
|
* for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5505
5714
|
*/
|
|
@@ -5509,18 +5718,19 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5509
5718
|
*/
|
|
5510
5719
|
AvailabilityZones?: string[];
|
|
5511
5720
|
/**
|
|
5512
|
-
* <p>
|
|
5513
|
-
*
|
|
5514
|
-
*
|
|
5515
|
-
*
|
|
5721
|
+
* <p>Determines whether any additional health checks are performed on the instances in this
|
|
5722
|
+
* group. Amazon EC2 health checks are always on.</p>
|
|
5723
|
+
* <p>The valid values are <code>EC2</code> (default), <code>ELB</code>, and
|
|
5724
|
+
* <code>VPC_LATTICE</code>. The <code>VPC_LATTICE</code> health check type is reserved
|
|
5725
|
+
* for use with VPC Lattice, which is in preview release and is subject to change.</p>
|
|
5516
5726
|
*/
|
|
5517
5727
|
HealthCheckType?: string;
|
|
5518
5728
|
/**
|
|
5519
5729
|
* <p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
|
|
5520
5730
|
* of an EC2 instance that has come into service and marking it unhealthy due to a failed
|
|
5521
|
-
*
|
|
5522
|
-
*
|
|
5523
|
-
*
|
|
5731
|
+
* health check. This is useful if your instances do not immediately pass their health
|
|
5732
|
+
* checks after they enter the <code>InService</code> state. For more information, see
|
|
5733
|
+
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html">Set the health check
|
|
5524
5734
|
* grace period for an Auto Scaling group</a> in the
|
|
5525
5735
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5526
5736
|
*/
|
|
@@ -5529,11 +5739,11 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5529
5739
|
* <p>The name of an existing placement group into which to launch your instances. For more
|
|
5530
5740
|
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement groups</a> in the
|
|
5531
5741
|
* <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
|
|
5532
|
-
*
|
|
5742
|
+
* <note>
|
|
5533
5743
|
* <p>A <i>cluster</i> placement group is a logical grouping of instances
|
|
5534
5744
|
* within a single Availability Zone. You cannot specify multiple Availability Zones
|
|
5535
5745
|
* and a cluster placement group. </p>
|
|
5536
|
-
*
|
|
5746
|
+
* </note>
|
|
5537
5747
|
*/
|
|
5538
5748
|
PlacementGroup?: string;
|
|
5539
5749
|
/**
|
|
@@ -5547,7 +5757,7 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5547
5757
|
* 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
|
|
5548
5758
|
* Amazon EC2 Auto Scaling termination policies</a> in the
|
|
5549
5759
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5550
|
-
*
|
|
5760
|
+
* <p>Valid values: <code>Default</code> | <code>AllocationStrategy</code> |
|
|
5551
5761
|
* <code>ClosestToNextInstanceHour</code> | <code>NewestInstance</code> |
|
|
5552
5762
|
* <code>OldestInstance</code> | <code>OldestLaunchConfiguration</code> |
|
|
5553
5763
|
* <code>OldestLaunchTemplate</code> |
|
|
@@ -5593,9 +5803,9 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5593
5803
|
* only. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html">Creating
|
|
5594
5804
|
* an Auto Scaling group using attribute-based instance type selection</a> in the
|
|
5595
5805
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5596
|
-
*
|
|
5806
|
+
* <p>By default, Amazon EC2 Auto Scaling specifies <code>units</code>, which translates into number of
|
|
5597
5807
|
* instances.</p>
|
|
5598
|
-
*
|
|
5808
|
+
* <p>Valid values: <code>units</code> | <code>vcpu</code> | <code>memory-mib</code>
|
|
5599
5809
|
* </p>
|
|
5600
5810
|
*/
|
|
5601
5811
|
DesiredCapacityType?: string;
|
|
@@ -5607,7 +5817,7 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5607
5817
|
* instance reaches the <code>InService</code> state. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html">Set
|
|
5608
5818
|
* the default instance warmup for an Auto Scaling group</a> in the
|
|
5609
5819
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
5610
|
-
*
|
|
5820
|
+
* <important>
|
|
5611
5821
|
* <p>To manage your warm-up settings at the group level, we recommend that you set the
|
|
5612
5822
|
* default instance warmup, <i>even if its value is set to 0 seconds</i>.
|
|
5613
5823
|
* This also optimizes the performance of scaling policies that scale continuously,
|
|
@@ -5616,7 +5826,7 @@ export interface UpdateAutoScalingGroupType {
|
|
|
5616
5826
|
* specify <code>-1</code> for the value. However, we strongly recommend keeping the
|
|
5617
5827
|
* default instance warmup enabled by specifying a minimum value of
|
|
5618
5828
|
* <code>0</code>.</p>
|
|
5619
|
-
*
|
|
5829
|
+
* </important>
|
|
5620
5830
|
*/
|
|
5621
5831
|
DefaultInstanceWarmup?: number;
|
|
5622
5832
|
}
|
|
@@ -5668,6 +5878,18 @@ export declare const AttachLoadBalancerTargetGroupsResultTypeFilterSensitiveLog:
|
|
|
5668
5878
|
* @internal
|
|
5669
5879
|
*/
|
|
5670
5880
|
export declare const AttachLoadBalancerTargetGroupsTypeFilterSensitiveLog: (obj: AttachLoadBalancerTargetGroupsType) => any;
|
|
5881
|
+
/**
|
|
5882
|
+
* @internal
|
|
5883
|
+
*/
|
|
5884
|
+
export declare const AttachTrafficSourcesResultTypeFilterSensitiveLog: (obj: AttachTrafficSourcesResultType) => any;
|
|
5885
|
+
/**
|
|
5886
|
+
* @internal
|
|
5887
|
+
*/
|
|
5888
|
+
export declare const TrafficSourceIdentifierFilterSensitiveLog: (obj: TrafficSourceIdentifier) => any;
|
|
5889
|
+
/**
|
|
5890
|
+
* @internal
|
|
5891
|
+
*/
|
|
5892
|
+
export declare const AttachTrafficSourcesTypeFilterSensitiveLog: (obj: AttachTrafficSourcesType) => any;
|
|
5671
5893
|
/**
|
|
5672
5894
|
* @internal
|
|
5673
5895
|
*/
|
|
@@ -6064,6 +6286,14 @@ export declare const PredictiveScalingConfigurationFilterSensitiveLog: (obj: Pre
|
|
|
6064
6286
|
* @internal
|
|
6065
6287
|
*/
|
|
6066
6288
|
export declare const StepAdjustmentFilterSensitiveLog: (obj: StepAdjustment) => any;
|
|
6289
|
+
/**
|
|
6290
|
+
* @internal
|
|
6291
|
+
*/
|
|
6292
|
+
export declare const TargetTrackingMetricStatFilterSensitiveLog: (obj: TargetTrackingMetricStat) => any;
|
|
6293
|
+
/**
|
|
6294
|
+
* @internal
|
|
6295
|
+
*/
|
|
6296
|
+
export declare const TargetTrackingMetricDataQueryFilterSensitiveLog: (obj: TargetTrackingMetricDataQuery) => any;
|
|
6067
6297
|
/**
|
|
6068
6298
|
* @internal
|
|
6069
6299
|
*/
|
|
@@ -6120,6 +6350,18 @@ export declare const TagsTypeFilterSensitiveLog: (obj: TagsType) => any;
|
|
|
6120
6350
|
* @internal
|
|
6121
6351
|
*/
|
|
6122
6352
|
export declare const DescribeTerminationPolicyTypesAnswerFilterSensitiveLog: (obj: DescribeTerminationPolicyTypesAnswer) => any;
|
|
6353
|
+
/**
|
|
6354
|
+
* @internal
|
|
6355
|
+
*/
|
|
6356
|
+
export declare const DescribeTrafficSourcesRequestFilterSensitiveLog: (obj: DescribeTrafficSourcesRequest) => any;
|
|
6357
|
+
/**
|
|
6358
|
+
* @internal
|
|
6359
|
+
*/
|
|
6360
|
+
export declare const TrafficSourceStateFilterSensitiveLog: (obj: TrafficSourceState) => any;
|
|
6361
|
+
/**
|
|
6362
|
+
* @internal
|
|
6363
|
+
*/
|
|
6364
|
+
export declare const DescribeTrafficSourcesResponseFilterSensitiveLog: (obj: DescribeTrafficSourcesResponse) => any;
|
|
6123
6365
|
/**
|
|
6124
6366
|
* @internal
|
|
6125
6367
|
*/
|
|
@@ -6152,6 +6394,14 @@ export declare const DetachLoadBalancerTargetGroupsResultTypeFilterSensitiveLog:
|
|
|
6152
6394
|
* @internal
|
|
6153
6395
|
*/
|
|
6154
6396
|
export declare const DetachLoadBalancerTargetGroupsTypeFilterSensitiveLog: (obj: DetachLoadBalancerTargetGroupsType) => any;
|
|
6397
|
+
/**
|
|
6398
|
+
* @internal
|
|
6399
|
+
*/
|
|
6400
|
+
export declare const DetachTrafficSourcesResultTypeFilterSensitiveLog: (obj: DetachTrafficSourcesResultType) => any;
|
|
6401
|
+
/**
|
|
6402
|
+
* @internal
|
|
6403
|
+
*/
|
|
6404
|
+
export declare const DetachTrafficSourcesTypeFilterSensitiveLog: (obj: DetachTrafficSourcesType) => any;
|
|
6155
6405
|
/**
|
|
6156
6406
|
* @internal
|
|
6157
6407
|
*/
|