@aws-sdk/client-auto-scaling 3.226.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 +1 -1
|
@@ -3,6 +3,7 @@ import { AutoScalingClient } from "./AutoScalingClient";
|
|
|
3
3
|
import { AttachInstancesCommandInput, AttachInstancesCommandOutput } from "./commands/AttachInstancesCommand";
|
|
4
4
|
import { AttachLoadBalancersCommandInput, AttachLoadBalancersCommandOutput } from "./commands/AttachLoadBalancersCommand";
|
|
5
5
|
import { AttachLoadBalancerTargetGroupsCommandInput, AttachLoadBalancerTargetGroupsCommandOutput } from "./commands/AttachLoadBalancerTargetGroupsCommand";
|
|
6
|
+
import { AttachTrafficSourcesCommandInput, AttachTrafficSourcesCommandOutput } from "./commands/AttachTrafficSourcesCommand";
|
|
6
7
|
import { BatchDeleteScheduledActionCommandInput, BatchDeleteScheduledActionCommandOutput } from "./commands/BatchDeleteScheduledActionCommand";
|
|
7
8
|
import { BatchPutScheduledUpdateGroupActionCommandInput, BatchPutScheduledUpdateGroupActionCommandOutput } from "./commands/BatchPutScheduledUpdateGroupActionCommand";
|
|
8
9
|
import { CancelInstanceRefreshCommandInput, CancelInstanceRefreshCommandOutput } from "./commands/CancelInstanceRefreshCommand";
|
|
@@ -37,10 +38,12 @@ import { DescribeScalingProcessTypesCommandInput, DescribeScalingProcessTypesCom
|
|
|
37
38
|
import { DescribeScheduledActionsCommandInput, DescribeScheduledActionsCommandOutput } from "./commands/DescribeScheduledActionsCommand";
|
|
38
39
|
import { DescribeTagsCommandInput, DescribeTagsCommandOutput } from "./commands/DescribeTagsCommand";
|
|
39
40
|
import { DescribeTerminationPolicyTypesCommandInput, DescribeTerminationPolicyTypesCommandOutput } from "./commands/DescribeTerminationPolicyTypesCommand";
|
|
41
|
+
import { DescribeTrafficSourcesCommandInput, DescribeTrafficSourcesCommandOutput } from "./commands/DescribeTrafficSourcesCommand";
|
|
40
42
|
import { DescribeWarmPoolCommandInput, DescribeWarmPoolCommandOutput } from "./commands/DescribeWarmPoolCommand";
|
|
41
43
|
import { DetachInstancesCommandInput, DetachInstancesCommandOutput } from "./commands/DetachInstancesCommand";
|
|
42
44
|
import { DetachLoadBalancersCommandInput, DetachLoadBalancersCommandOutput } from "./commands/DetachLoadBalancersCommand";
|
|
43
45
|
import { DetachLoadBalancerTargetGroupsCommandInput, DetachLoadBalancerTargetGroupsCommandOutput } from "./commands/DetachLoadBalancerTargetGroupsCommand";
|
|
46
|
+
import { DetachTrafficSourcesCommandInput, DetachTrafficSourcesCommandOutput } from "./commands/DetachTrafficSourcesCommand";
|
|
44
47
|
import { DisableMetricsCollectionCommandInput, DisableMetricsCollectionCommandOutput } from "./commands/DisableMetricsCollectionCommand";
|
|
45
48
|
import { EnableMetricsCollectionCommandInput, EnableMetricsCollectionCommandOutput } from "./commands/EnableMetricsCollectionCommand";
|
|
46
49
|
import { EnterStandbyCommandInput, EnterStandbyCommandOutput } from "./commands/EnterStandbyCommand";
|
|
@@ -63,34 +66,21 @@ import { TerminateInstanceInAutoScalingGroupCommandInput, TerminateInstanceInAut
|
|
|
63
66
|
import { UpdateAutoScalingGroupCommandInput, UpdateAutoScalingGroupCommandOutput } from "./commands/UpdateAutoScalingGroupCommand";
|
|
64
67
|
/**
|
|
65
68
|
* <fullname>Amazon EC2 Auto Scaling</fullname>
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
|
|
69
|
+
* <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
|
|
80
70
|
* based on user-defined scaling policies, scheduled actions, and health checks.</p>
|
|
81
|
-
*
|
|
71
|
+
* <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">Amazon EC2 Auto Scaling User Guide</a> and the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html">Amazon EC2 Auto Scaling API Reference</a>.</p>
|
|
82
72
|
*/
|
|
83
73
|
export declare class AutoScaling extends AutoScalingClient {
|
|
84
74
|
/**
|
|
85
75
|
* <p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p>
|
|
86
|
-
*
|
|
76
|
+
* <p>When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the
|
|
87
77
|
* number of instances being attached. If the number of instances being attached plus the
|
|
88
78
|
* desired capacity of the group exceeds the maximum size of the group, the operation
|
|
89
79
|
* fails.</p>
|
|
90
|
-
*
|
|
80
|
+
* <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are
|
|
91
81
|
* also registered with the load balancer. If there are target groups attached to your Auto Scaling
|
|
92
82
|
* group, the instances are also registered with the target groups.</p>
|
|
93
|
-
*
|
|
83
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html">Attach EC2 instances to
|
|
94
84
|
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
95
85
|
*/
|
|
96
86
|
attachInstances(args: AttachInstancesCommandInput, options?: __HttpHandlerOptions): Promise<AttachInstancesCommandOutput>;
|
|
@@ -99,14 +89,14 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
99
89
|
/**
|
|
100
90
|
* <note>
|
|
101
91
|
* <p>To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the <a>AttachLoadBalancerTargetGroups</a> API operation instead.</p>
|
|
102
|
-
*
|
|
103
|
-
*
|
|
92
|
+
* </note>
|
|
93
|
+
* <p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the
|
|
104
94
|
* running instances with these Classic Load Balancers.</p>
|
|
105
|
-
*
|
|
95
|
+
* <p>To describe the load balancers for an Auto Scaling group, call the <a>DescribeLoadBalancers</a> API. To detach a load balancer from the Auto Scaling
|
|
106
96
|
* group, call the <a>DetachLoadBalancers</a> API.</p>
|
|
107
|
-
*
|
|
97
|
+
* <p>This operation is additive and does not detach existing Classic Load Balancers or
|
|
108
98
|
* target groups from the Auto Scaling group.</p>
|
|
109
|
-
*
|
|
99
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
|
|
110
100
|
* distribute traffic across the instances in your Auto Scaling group</a> in the
|
|
111
101
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
112
102
|
*/
|
|
@@ -115,31 +105,45 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
115
105
|
attachLoadBalancers(args: AttachLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachLoadBalancersCommandOutput) => void): void;
|
|
116
106
|
/**
|
|
117
107
|
* <p>Attaches one or more target groups to the specified Auto Scaling group.</p>
|
|
118
|
-
*
|
|
119
|
-
*
|
|
108
|
+
* <p>This operation is used with the following load balancer types: </p>
|
|
109
|
+
* <ul>
|
|
120
110
|
* <li>
|
|
121
|
-
*
|
|
111
|
+
* <p>Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and
|
|
122
112
|
* HTTPS. </p>
|
|
123
113
|
* </li>
|
|
124
114
|
* <li>
|
|
125
|
-
*
|
|
115
|
+
* <p>Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and
|
|
126
116
|
* UDP. </p>
|
|
127
117
|
* </li>
|
|
128
118
|
* <li>
|
|
129
|
-
*
|
|
119
|
+
* <p>Gateway Load Balancer - Operates at the network layer (layer 3).</p>
|
|
130
120
|
* </li>
|
|
131
121
|
* </ul>
|
|
132
|
-
*
|
|
122
|
+
* <p>To describe the target groups for an Auto Scaling group, call the <a>DescribeLoadBalancerTargetGroups</a> API. To detach the target group from
|
|
133
123
|
* the Auto Scaling group, call the <a>DetachLoadBalancerTargetGroups</a> API.</p>
|
|
134
|
-
*
|
|
124
|
+
* <p>This operation is additive and does not detach existing target groups or Classic Load
|
|
135
125
|
* Balancers from the Auto Scaling group.</p>
|
|
136
|
-
*
|
|
126
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
|
|
137
127
|
* distribute traffic across the instances in your Auto Scaling group</a> in the
|
|
138
128
|
* <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
|
|
139
129
|
*/
|
|
140
130
|
attachLoadBalancerTargetGroups(args: AttachLoadBalancerTargetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<AttachLoadBalancerTargetGroupsCommandOutput>;
|
|
141
131
|
attachLoadBalancerTargetGroups(args: AttachLoadBalancerTargetGroupsCommandInput, cb: (err: any, data?: AttachLoadBalancerTargetGroupsCommandOutput) => void): void;
|
|
142
132
|
attachLoadBalancerTargetGroups(args: AttachLoadBalancerTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachLoadBalancerTargetGroupsCommandOutput) => void): void;
|
|
133
|
+
/**
|
|
134
|
+
* <p>
|
|
135
|
+
* <b>Reserved for use with Amazon VPC Lattice, which is in preview and subject to change.
|
|
136
|
+
* Do not use this API for production workloads. This API is also subject to change.</b>
|
|
137
|
+
* </p>
|
|
138
|
+
* <p>Attaches one or more traffic sources to the specified Auto Scaling group.</p>
|
|
139
|
+
* <p>To describe the traffic sources for an Auto Scaling group, call the <a>DescribeTrafficSources</a> API. To detach a traffic source from the Auto Scaling
|
|
140
|
+
* group, call the <a>DetachTrafficSources</a> API.</p>
|
|
141
|
+
* <p>This operation is additive and does not detach existing traffic sources from the Auto Scaling
|
|
142
|
+
* group.</p>
|
|
143
|
+
*/
|
|
144
|
+
attachTrafficSources(args: AttachTrafficSourcesCommandInput, options?: __HttpHandlerOptions): Promise<AttachTrafficSourcesCommandOutput>;
|
|
145
|
+
attachTrafficSources(args: AttachTrafficSourcesCommandInput, cb: (err: any, data?: AttachTrafficSourcesCommandOutput) => void): void;
|
|
146
|
+
attachTrafficSources(args: AttachTrafficSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AttachTrafficSourcesCommandOutput) => void): void;
|
|
143
147
|
/**
|
|
144
148
|
* <p>Deletes one or more scheduled actions for the specified Auto Scaling group.</p>
|
|
145
149
|
*/
|
|
@@ -156,7 +160,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
156
160
|
* <p>Cancels an instance refresh operation in progress. Cancellation does not roll back any
|
|
157
161
|
* replacements that have already been completed, but it prevents new replacements from
|
|
158
162
|
* being started. </p>
|
|
159
|
-
*
|
|
163
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
|
|
160
164
|
* feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group
|
|
161
165
|
* after you make configuration changes.</p>
|
|
162
166
|
*/
|
|
@@ -166,41 +170,41 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
166
170
|
/**
|
|
167
171
|
* <p>Completes the lifecycle action for the specified token or instance with the specified
|
|
168
172
|
* result.</p>
|
|
169
|
-
*
|
|
173
|
+
* <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
|
|
170
174
|
* group:</p>
|
|
171
|
-
*
|
|
175
|
+
* <ol>
|
|
172
176
|
* <li>
|
|
173
|
-
*
|
|
177
|
+
* <p>(Optional) Create a launch template or launch configuration with a user data
|
|
174
178
|
* script that runs while an instance is in a wait state due to a lifecycle
|
|
175
179
|
* hook.</p>
|
|
176
180
|
* </li>
|
|
177
181
|
* <li>
|
|
178
|
-
*
|
|
182
|
+
* <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke
|
|
179
183
|
* your Lambda function when an instance is put into a wait state due to a
|
|
180
184
|
* lifecycle hook.</p>
|
|
181
185
|
* </li>
|
|
182
186
|
* <li>
|
|
183
|
-
*
|
|
187
|
+
* <p>(Optional) Create a notification target and an IAM role. The target can be
|
|
184
188
|
* either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish
|
|
185
189
|
* lifecycle notifications to the target.</p>
|
|
186
190
|
* </li>
|
|
187
191
|
* <li>
|
|
188
|
-
*
|
|
192
|
+
* <p>Create the lifecycle hook. Specify whether the hook is used when the instances
|
|
189
193
|
* launch or terminate.</p>
|
|
190
194
|
* </li>
|
|
191
195
|
* <li>
|
|
192
|
-
*
|
|
196
|
+
* <p>If you need more time, record the lifecycle action heartbeat to keep the
|
|
193
197
|
* instance in a wait state.</p>
|
|
194
198
|
* </li>
|
|
195
199
|
* <li>
|
|
196
|
-
*
|
|
197
|
-
*
|
|
200
|
+
* <p>
|
|
201
|
+
* <b>If you finish before the timeout period ends, send a
|
|
198
202
|
* callback by using the <a>CompleteLifecycleAction</a> API
|
|
199
203
|
* call.</b>
|
|
200
|
-
*
|
|
204
|
+
* </p>
|
|
201
205
|
* </li>
|
|
202
206
|
* </ol>
|
|
203
|
-
*
|
|
207
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
204
208
|
* hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
205
209
|
*/
|
|
206
210
|
completeLifecycleAction(args: CompleteLifecycleActionCommandInput, options?: __HttpHandlerOptions): Promise<CompleteLifecycleActionCommandOutput>;
|
|
@@ -210,17 +214,17 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
210
214
|
* <p>
|
|
211
215
|
* <b>We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.</b>
|
|
212
216
|
* </p>
|
|
213
|
-
*
|
|
214
|
-
*
|
|
217
|
+
* <p>Creates an Auto Scaling group with the specified name and attributes. </p>
|
|
218
|
+
* <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,
|
|
215
219
|
* call the <a>DescribeAccountLimits</a> API. For information about updating
|
|
216
220
|
* this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
|
|
217
221
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
218
|
-
*
|
|
222
|
+
* <p>For introductory exercises for creating an Auto Scaling group, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html">Getting started with
|
|
219
223
|
* Amazon EC2 Auto Scaling</a> and <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html">Tutorial: Set up a
|
|
220
224
|
* scaled and load-balanced application</a> in the
|
|
221
225
|
* <i>Amazon EC2 Auto Scaling User Guide</i>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html">Auto Scaling
|
|
222
226
|
* groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
223
|
-
*
|
|
227
|
+
* <p>Every Auto Scaling group has three size properties (<code>DesiredCapacity</code>,
|
|
224
228
|
* <code>MaxSize</code>, and <code>MinSize</code>). Usually, you set these sizes based
|
|
225
229
|
* on a specific number of instances. However, if you configure a mixed instances policy
|
|
226
230
|
* that defines weights for the instance types, you must specify these sizes with the same
|
|
@@ -231,13 +235,13 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
231
235
|
createAutoScalingGroup(args: CreateAutoScalingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoScalingGroupCommandOutput) => void): void;
|
|
232
236
|
/**
|
|
233
237
|
* <p>Creates a launch configuration.</p>
|
|
234
|
-
*
|
|
238
|
+
* <p>If you exceed your maximum limit of launch configurations, the call fails. To query
|
|
235
239
|
* this limit, call the <a>DescribeAccountLimits</a> API. For information about
|
|
236
240
|
* updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
|
|
237
241
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
238
|
-
*
|
|
242
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html">Launch
|
|
239
243
|
* configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
240
|
-
*
|
|
244
|
+
* <note>
|
|
241
245
|
* <p>Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a
|
|
242
246
|
* launch template or a launch configuration. We strongly recommend that you do not use
|
|
243
247
|
* launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.
|
|
@@ -249,9 +253,9 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
249
253
|
createLaunchConfiguration(args: CreateLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLaunchConfigurationCommandOutput) => void): void;
|
|
250
254
|
/**
|
|
251
255
|
* <p>Creates or updates tags for the specified Auto Scaling group.</p>
|
|
252
|
-
*
|
|
256
|
+
* <p>When you specify a tag with a key that already exists, the operation overwrites the
|
|
253
257
|
* previous tag definition, and you do not get an error message.</p>
|
|
254
|
-
*
|
|
258
|
+
* <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
|
|
255
259
|
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
256
260
|
*/
|
|
257
261
|
createOrUpdateTags(args: CreateOrUpdateTagsCommandInput, options?: __HttpHandlerOptions): Promise<CreateOrUpdateTagsCommandOutput>;
|
|
@@ -259,19 +263,19 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
259
263
|
createOrUpdateTags(args: CreateOrUpdateTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateOrUpdateTagsCommandOutput) => void): void;
|
|
260
264
|
/**
|
|
261
265
|
* <p>Deletes the specified Auto Scaling group.</p>
|
|
262
|
-
*
|
|
266
|
+
* <p>If the group has instances or scaling activities in progress, you must specify the
|
|
263
267
|
* option to force the deletion in order for it to succeed. The force delete operation will
|
|
264
268
|
* also terminate the EC2 instances. If the group has a warm pool, the force delete option
|
|
265
269
|
* also deletes the warm pool.</p>
|
|
266
|
-
*
|
|
270
|
+
* <p>To remove instances from the Auto Scaling group before deleting it, call the <a>DetachInstances</a> API with the list of instances and the option to
|
|
267
271
|
* decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement
|
|
268
272
|
* instances.</p>
|
|
269
|
-
*
|
|
273
|
+
* <p>To terminate all instances before deleting the Auto Scaling group, call the <a>UpdateAutoScalingGroup</a> API and set the minimum size and desired capacity
|
|
270
274
|
* of the Auto Scaling group to
|
|
271
275
|
* zero.</p>
|
|
272
|
-
*
|
|
276
|
+
* <p>If the group has scaling policies, deleting the group deletes the policies, the
|
|
273
277
|
* underlying alarm actions, and any alarm that no longer has an associated action.</p>
|
|
274
|
-
*
|
|
278
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html">Delete your Auto Scaling
|
|
275
279
|
* infrastructure</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
276
280
|
*/
|
|
277
281
|
deleteAutoScalingGroup(args: DeleteAutoScalingGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAutoScalingGroupCommandOutput>;
|
|
@@ -279,7 +283,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
279
283
|
deleteAutoScalingGroup(args: DeleteAutoScalingGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAutoScalingGroupCommandOutput) => void): void;
|
|
280
284
|
/**
|
|
281
285
|
* <p>Deletes the specified launch configuration.</p>
|
|
282
|
-
*
|
|
286
|
+
* <p>The launch configuration must not be attached to an Auto Scaling group. When this call
|
|
283
287
|
* completes, the launch configuration is no longer available for use.</p>
|
|
284
288
|
*/
|
|
285
289
|
deleteLaunchConfiguration(args: DeleteLaunchConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLaunchConfigurationCommandOutput>;
|
|
@@ -287,7 +291,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
287
291
|
deleteLaunchConfiguration(args: DeleteLaunchConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLaunchConfigurationCommandOutput) => void): void;
|
|
288
292
|
/**
|
|
289
293
|
* <p>Deletes the specified lifecycle hook.</p>
|
|
290
|
-
*
|
|
294
|
+
* <p>If there are any outstanding lifecycle actions, they are completed first
|
|
291
295
|
* (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating
|
|
292
296
|
* instances).</p>
|
|
293
297
|
*/
|
|
@@ -302,10 +306,10 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
302
306
|
deleteNotificationConfiguration(args: DeleteNotificationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNotificationConfigurationCommandOutput) => void): void;
|
|
303
307
|
/**
|
|
304
308
|
* <p>Deletes the specified scaling policy.</p>
|
|
305
|
-
*
|
|
309
|
+
* <p>Deleting either a step scaling policy or a simple scaling policy deletes the
|
|
306
310
|
* underlying alarm action, but does not delete the alarm, even if it no longer has an
|
|
307
311
|
* associated action.</p>
|
|
308
|
-
*
|
|
312
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/deleting-scaling-policy.html">Deleting a scaling
|
|
309
313
|
* policy</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
310
314
|
*/
|
|
311
315
|
deletePolicy(args: DeletePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeletePolicyCommandOutput>;
|
|
@@ -325,7 +329,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
325
329
|
deleteTags(args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
|
|
326
330
|
/**
|
|
327
331
|
* <p>Deletes the warm pool for the specified Auto Scaling group.</p>
|
|
328
|
-
*
|
|
332
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
|
|
329
333
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
330
334
|
*/
|
|
331
335
|
deleteWarmPool(args: DeleteWarmPoolCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWarmPoolCommandOutput>;
|
|
@@ -333,7 +337,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
333
337
|
deleteWarmPool(args: DeleteWarmPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWarmPoolCommandOutput) => void): void;
|
|
334
338
|
/**
|
|
335
339
|
* <p>Describes the current Amazon EC2 Auto Scaling resource quotas for your account.</p>
|
|
336
|
-
*
|
|
340
|
+
* <p>When you establish an Amazon Web Services account, the account has initial quotas on the maximum
|
|
337
341
|
* number of Auto Scaling groups and launch configurations that you can create in a given Region.
|
|
338
342
|
* For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for
|
|
339
343
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
@@ -344,22 +348,22 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
344
348
|
/**
|
|
345
349
|
* <p>Describes the available adjustment types for step scaling and simple scaling
|
|
346
350
|
* policies.</p>
|
|
347
|
-
*
|
|
348
|
-
*
|
|
351
|
+
* <p>The following adjustment types are supported:</p>
|
|
352
|
+
* <ul>
|
|
349
353
|
* <li>
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
354
|
+
* <p>
|
|
355
|
+
* <code>ChangeInCapacity</code>
|
|
356
|
+
* </p>
|
|
353
357
|
* </li>
|
|
354
358
|
* <li>
|
|
355
|
-
*
|
|
356
|
-
*
|
|
357
|
-
*
|
|
359
|
+
* <p>
|
|
360
|
+
* <code>ExactCapacity</code>
|
|
361
|
+
* </p>
|
|
358
362
|
* </li>
|
|
359
363
|
* <li>
|
|
360
|
-
*
|
|
361
|
-
*
|
|
362
|
-
*
|
|
364
|
+
* <p>
|
|
365
|
+
* <code>PercentChangeInCapacity</code>
|
|
366
|
+
* </p>
|
|
363
367
|
* </li>
|
|
364
368
|
* </ul>
|
|
365
369
|
*/
|
|
@@ -368,11 +372,11 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
368
372
|
describeAdjustmentTypes(args: DescribeAdjustmentTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAdjustmentTypesCommandOutput) => void): void;
|
|
369
373
|
/**
|
|
370
374
|
* <p>Gets information about the Auto Scaling groups in the account and Region.</p>
|
|
371
|
-
*
|
|
375
|
+
* <p>If you specify Auto Scaling group names, the output includes information for only the
|
|
372
376
|
* specified Auto Scaling groups. If you specify filters, the output includes information for only
|
|
373
377
|
* those Auto Scaling groups that meet the filter criteria. If you do not specify group names or
|
|
374
378
|
* filters, the output includes information for all Auto Scaling groups. </p>
|
|
375
|
-
*
|
|
379
|
+
* <p>This operation also returns information about instances in Auto Scaling groups. To retrieve
|
|
376
380
|
* information about the instances in a warm pool, you must call the <a>DescribeWarmPool</a> API. </p>
|
|
377
381
|
*/
|
|
378
382
|
describeAutoScalingGroups(args: DescribeAutoScalingGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAutoScalingGroupsCommandOutput>;
|
|
@@ -392,41 +396,41 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
392
396
|
describeAutoScalingNotificationTypes(args: DescribeAutoScalingNotificationTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoScalingNotificationTypesCommandOutput) => void): void;
|
|
393
397
|
/**
|
|
394
398
|
* <p>Gets information about the instance refreshes for the specified Auto Scaling group.</p>
|
|
395
|
-
*
|
|
399
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
|
|
396
400
|
* feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group
|
|
397
401
|
* after you make configuration changes.</p>
|
|
398
|
-
*
|
|
402
|
+
* <p>To help you determine the status of an instance refresh, this operation returns
|
|
399
403
|
* information about the instance refreshes you previously initiated, including their
|
|
400
404
|
* status, end time, the percentage of the instance refresh that is complete, and the
|
|
401
405
|
* number of instances remaining to update before the instance refresh is complete.</p>
|
|
402
|
-
*
|
|
403
|
-
*
|
|
406
|
+
* <p>The following are the possible statuses: </p>
|
|
407
|
+
* <ul>
|
|
404
408
|
* <li>
|
|
405
|
-
*
|
|
409
|
+
* <p>
|
|
406
410
|
* <code>Pending</code> - The request was created, but the operation has not
|
|
407
411
|
* started.</p>
|
|
408
412
|
* </li>
|
|
409
413
|
* <li>
|
|
410
|
-
*
|
|
414
|
+
* <p>
|
|
411
415
|
* <code>InProgress</code> - The operation is in progress.</p>
|
|
412
416
|
* </li>
|
|
413
417
|
* <li>
|
|
414
|
-
*
|
|
418
|
+
* <p>
|
|
415
419
|
* <code>Successful</code> - The operation completed successfully.</p>
|
|
416
420
|
* </li>
|
|
417
421
|
* <li>
|
|
418
|
-
*
|
|
422
|
+
* <p>
|
|
419
423
|
* <code>Failed</code> - The operation failed to complete. You can troubleshoot
|
|
420
424
|
* using the status reason and the scaling activities. </p>
|
|
421
425
|
* </li>
|
|
422
426
|
* <li>
|
|
423
|
-
*
|
|
427
|
+
* <p>
|
|
424
428
|
* <code>Cancelling</code> - An ongoing operation is being cancelled.
|
|
425
429
|
* Cancellation does not roll back any replacements that have already been
|
|
426
430
|
* completed, but it prevents new replacements from being started. </p>
|
|
427
431
|
* </li>
|
|
428
432
|
* <li>
|
|
429
|
-
*
|
|
433
|
+
* <p>
|
|
430
434
|
* <code>Cancelled</code> - The operation is cancelled. </p>
|
|
431
435
|
* </li>
|
|
432
436
|
* </ul>
|
|
@@ -448,17 +452,17 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
448
452
|
describeLifecycleHooks(args: DescribeLifecycleHooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLifecycleHooksCommandOutput) => void): void;
|
|
449
453
|
/**
|
|
450
454
|
* <p>Describes the available types of lifecycle hooks.</p>
|
|
451
|
-
*
|
|
452
|
-
*
|
|
455
|
+
* <p>The following hook types are supported:</p>
|
|
456
|
+
* <ul>
|
|
453
457
|
* <li>
|
|
454
|
-
*
|
|
455
|
-
*
|
|
456
|
-
*
|
|
458
|
+
* <p>
|
|
459
|
+
* <code>autoscaling:EC2_INSTANCE_LAUNCHING</code>
|
|
460
|
+
* </p>
|
|
457
461
|
* </li>
|
|
458
462
|
* <li>
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
463
|
+
* <p>
|
|
464
|
+
* <code>autoscaling:EC2_INSTANCE_TERMINATING</code>
|
|
465
|
+
* </p>
|
|
462
466
|
* </li>
|
|
463
467
|
* </ul>
|
|
464
468
|
*/
|
|
@@ -467,9 +471,9 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
467
471
|
describeLifecycleHookTypes(args: DescribeLifecycleHookTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLifecycleHookTypesCommandOutput) => void): void;
|
|
468
472
|
/**
|
|
469
473
|
* <p>Gets information about the load balancers for the specified Auto Scaling group.</p>
|
|
470
|
-
*
|
|
474
|
+
* <p>This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancer, use the
|
|
471
475
|
* <a>DescribeLoadBalancerTargetGroups</a> API instead.</p>
|
|
472
|
-
*
|
|
476
|
+
* <p>To determine the attachment status of the load balancer, use the <code>State</code>
|
|
473
477
|
* element in the response. When you attach a load balancer to an Auto Scaling group, the initial
|
|
474
478
|
* <code>State</code> value is <code>Adding</code>. The state transitions to
|
|
475
479
|
* <code>Added</code> after all Auto Scaling instances are registered with the load balancer.
|
|
@@ -479,12 +483,12 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
479
483
|
* and replace any instances that are reported as unhealthy. If no registered instances
|
|
480
484
|
* pass the health checks, the load balancer doesn't enter the <code>InService</code>
|
|
481
485
|
* state. </p>
|
|
482
|
-
*
|
|
486
|
+
* <p>Load balancers also have an <code>InService</code> state if you attach them in the
|
|
483
487
|
* <a>CreateAutoScalingGroup</a> API call. If your load balancer state is
|
|
484
488
|
* <code>InService</code>, but it is not working properly, check the scaling activities
|
|
485
489
|
* by calling <a>DescribeScalingActivities</a> and take any corrective actions
|
|
486
490
|
* necessary.</p>
|
|
487
|
-
*
|
|
491
|
+
* <p>For help with failed health checks, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html">Troubleshooting Amazon EC2 Auto Scaling:
|
|
488
492
|
* Health checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. For more
|
|
489
493
|
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
|
|
490
494
|
* distribute traffic across the instances in your Auto Scaling group</a> in the
|
|
@@ -495,7 +499,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
495
499
|
describeLoadBalancers(args: DescribeLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoadBalancersCommandOutput) => void): void;
|
|
496
500
|
/**
|
|
497
501
|
* <p>Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.</p>
|
|
498
|
-
*
|
|
502
|
+
* <p>To determine the attachment status of the target group, use the <code>State</code>
|
|
499
503
|
* element in the response. When you attach a target group to an Auto Scaling group, the initial
|
|
500
504
|
* <code>State</code> value is <code>Adding</code>. The state transitions to
|
|
501
505
|
* <code>Added</code> after all Auto Scaling instances are registered with the target group. If
|
|
@@ -504,16 +508,21 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
504
508
|
* When the target group is in the <code>InService</code> state, Amazon EC2 Auto Scaling can terminate and
|
|
505
509
|
* replace any instances that are reported as unhealthy. If no registered instances pass
|
|
506
510
|
* the health checks, the target group doesn't enter the <code>InService</code> state. </p>
|
|
507
|
-
*
|
|
511
|
+
* <p>Target groups also have an <code>InService</code> state if you attach them in the
|
|
508
512
|
* <a>CreateAutoScalingGroup</a> API call. If your target group state is
|
|
509
513
|
* <code>InService</code>, but it is not working properly, check the scaling activities
|
|
510
514
|
* by calling <a>DescribeScalingActivities</a> and take any corrective actions
|
|
511
515
|
* necessary.</p>
|
|
512
|
-
*
|
|
516
|
+
* <p>For help with failed health checks, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ts-as-healthchecks.html">Troubleshooting Amazon EC2 Auto Scaling:
|
|
513
517
|
* Health checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. For more
|
|
514
518
|
* information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html">Use Elastic Load Balancing to
|
|
515
519
|
* distribute traffic across the instances in your Auto Scaling group</a> in the
|
|
516
520
|
* <i>Amazon EC2 Auto Scaling User Guide</i>. </p>
|
|
521
|
+
* <note>
|
|
522
|
+
* <p>You can use this operation to describe target groups that were attached by using
|
|
523
|
+
* <a>AttachLoadBalancerTargetGroups</a>, but not for target groups that
|
|
524
|
+
* were attached by using <a>AttachTrafficSources</a>.</p>
|
|
525
|
+
* </note>
|
|
517
526
|
*/
|
|
518
527
|
describeLoadBalancerTargetGroups(args: DescribeLoadBalancerTargetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLoadBalancerTargetGroupsCommandOutput>;
|
|
519
528
|
describeLoadBalancerTargetGroups(args: DescribeLoadBalancerTargetGroupsCommandInput, cb: (err: any, data?: DescribeLoadBalancerTargetGroupsCommandOutput) => void): void;
|
|
@@ -539,10 +548,10 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
539
548
|
describePolicies(args: DescribePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePoliciesCommandOutput) => void): void;
|
|
540
549
|
/**
|
|
541
550
|
* <p>Gets information about the scaling activities in the account and Region.</p>
|
|
542
|
-
*
|
|
551
|
+
* <p>When scaling events occur, you see a record of the scaling activity in the scaling
|
|
543
552
|
* activities. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html">Verifying a scaling
|
|
544
553
|
* activity for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
545
|
-
*
|
|
554
|
+
* <p>If the scaling event succeeds, the value of the <code>StatusCode</code> element in the
|
|
546
555
|
* response is <code>Successful</code>. If an attempt to launch instances failed, the
|
|
547
556
|
* <code>StatusCode</code> value is <code>Failed</code> or <code>Cancelled</code> and
|
|
548
557
|
* the <code>StatusMessage</code> element in the response indicates the cause of the
|
|
@@ -561,7 +570,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
561
570
|
/**
|
|
562
571
|
* <p>Gets information about the scheduled actions that haven't run or that have not reached
|
|
563
572
|
* their end time.</p>
|
|
564
|
-
*
|
|
573
|
+
* <p>To describe the scaling activities for scheduled actions that have already run, call
|
|
565
574
|
* the <a>DescribeScalingActivities</a> API.</p>
|
|
566
575
|
*/
|
|
567
576
|
describeScheduledActions(args: DescribeScheduledActionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScheduledActionsCommandOutput>;
|
|
@@ -569,13 +578,13 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
569
578
|
describeScheduledActions(args: DescribeScheduledActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScheduledActionsCommandOutput) => void): void;
|
|
570
579
|
/**
|
|
571
580
|
* <p>Describes the specified tags.</p>
|
|
572
|
-
*
|
|
581
|
+
* <p>You can use filters to limit the results. For example, you can query for the tags for
|
|
573
582
|
* a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at
|
|
574
583
|
* least one of the specified values for it to be included in the results.</p>
|
|
575
|
-
*
|
|
584
|
+
* <p>You can also specify multiple filters. The result includes information for a
|
|
576
585
|
* particular tag only if it matches all the filters. If there's no match, no special
|
|
577
586
|
* message is returned.</p>
|
|
578
|
-
*
|
|
587
|
+
* <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
|
|
579
588
|
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
580
589
|
*/
|
|
581
590
|
describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTagsCommandOutput>;
|
|
@@ -583,16 +592,26 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
583
592
|
describeTags(args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
|
|
584
593
|
/**
|
|
585
594
|
* <p>Describes the termination policies supported by Amazon EC2 Auto Scaling.</p>
|
|
586
|
-
*
|
|
595
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
|
|
587
596
|
* Amazon EC2 Auto Scaling termination policies</a> in the
|
|
588
597
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
589
598
|
*/
|
|
590
599
|
describeTerminationPolicyTypes(args: DescribeTerminationPolicyTypesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTerminationPolicyTypesCommandOutput>;
|
|
591
600
|
describeTerminationPolicyTypes(args: DescribeTerminationPolicyTypesCommandInput, cb: (err: any, data?: DescribeTerminationPolicyTypesCommandOutput) => void): void;
|
|
592
601
|
describeTerminationPolicyTypes(args: DescribeTerminationPolicyTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTerminationPolicyTypesCommandOutput) => void): void;
|
|
602
|
+
/**
|
|
603
|
+
* <p>
|
|
604
|
+
* <b>Reserved for use with Amazon VPC Lattice, which is in preview and subject to change.
|
|
605
|
+
* Do not use this API for production workloads. This API is also subject to change.</b>
|
|
606
|
+
* </p>
|
|
607
|
+
* <p>Gets information about the traffic sources for the specified Auto Scaling group.</p>
|
|
608
|
+
*/
|
|
609
|
+
describeTrafficSources(args: DescribeTrafficSourcesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTrafficSourcesCommandOutput>;
|
|
610
|
+
describeTrafficSources(args: DescribeTrafficSourcesCommandInput, cb: (err: any, data?: DescribeTrafficSourcesCommandOutput) => void): void;
|
|
611
|
+
describeTrafficSources(args: DescribeTrafficSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTrafficSourcesCommandOutput) => void): void;
|
|
593
612
|
/**
|
|
594
613
|
* <p>Gets information about a warm pool and its instances.</p>
|
|
595
|
-
*
|
|
614
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
|
|
596
615
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
597
616
|
*/
|
|
598
617
|
describeWarmPool(args: DescribeWarmPoolCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWarmPoolCommandOutput>;
|
|
@@ -600,14 +619,14 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
600
619
|
describeWarmPool(args: DescribeWarmPoolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWarmPoolCommandOutput) => void): void;
|
|
601
620
|
/**
|
|
602
621
|
* <p>Removes one or more instances from the specified Auto Scaling group.</p>
|
|
603
|
-
*
|
|
622
|
+
* <p>After the instances are detached, you can manage them independent of the Auto Scaling
|
|
604
623
|
* group.</p>
|
|
605
|
-
*
|
|
624
|
+
* <p>If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches
|
|
606
625
|
* instances to replace the ones that are detached.</p>
|
|
607
|
-
*
|
|
626
|
+
* <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are
|
|
608
627
|
* deregistered from the load balancer. If there are target groups attached to the Auto Scaling
|
|
609
628
|
* group, the instances are deregistered from the target groups.</p>
|
|
610
|
-
*
|
|
629
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html">Detach EC2 instances from
|
|
611
630
|
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
612
631
|
*/
|
|
613
632
|
detachInstances(args: DetachInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DetachInstancesCommandOutput>;
|
|
@@ -615,9 +634,9 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
615
634
|
detachInstances(args: DetachInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachInstancesCommandOutput) => void): void;
|
|
616
635
|
/**
|
|
617
636
|
* <p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p>
|
|
618
|
-
*
|
|
637
|
+
* <p>This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or
|
|
619
638
|
* Gateway Load Balancer, use the <a>DetachLoadBalancerTargetGroups</a> API instead.</p>
|
|
620
|
-
*
|
|
639
|
+
* <p>When you detach a load balancer, it enters the <code>Removing</code> state while
|
|
621
640
|
* deregistering the instances in the group. When all instances are deregistered, then you
|
|
622
641
|
* can no longer describe the load balancer using the <a>DescribeLoadBalancers</a> API call. The instances remain running.</p>
|
|
623
642
|
*/
|
|
@@ -626,14 +645,29 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
626
645
|
detachLoadBalancers(args: DetachLoadBalancersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachLoadBalancersCommandOutput) => void): void;
|
|
627
646
|
/**
|
|
628
647
|
* <p>Detaches one or more target groups from the specified Auto Scaling group.</p>
|
|
629
|
-
*
|
|
648
|
+
* <p>When you detach a target group, it enters the <code>Removing</code> state while
|
|
630
649
|
* deregistering the instances in the group. When all instances are deregistered, then you
|
|
631
650
|
* can no longer describe the target group using the <a>DescribeLoadBalancerTargetGroups</a> API call. The instances remain
|
|
632
651
|
* running.</p>
|
|
652
|
+
* <note>
|
|
653
|
+
* <p>You can use this operation to detach target groups that were attached by using
|
|
654
|
+
* <a>AttachLoadBalancerTargetGroups</a>, but not for target groups that
|
|
655
|
+
* were attached by using <a>AttachTrafficSources</a>.</p>
|
|
656
|
+
* </note>
|
|
633
657
|
*/
|
|
634
658
|
detachLoadBalancerTargetGroups(args: DetachLoadBalancerTargetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DetachLoadBalancerTargetGroupsCommandOutput>;
|
|
635
659
|
detachLoadBalancerTargetGroups(args: DetachLoadBalancerTargetGroupsCommandInput, cb: (err: any, data?: DetachLoadBalancerTargetGroupsCommandOutput) => void): void;
|
|
636
660
|
detachLoadBalancerTargetGroups(args: DetachLoadBalancerTargetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachLoadBalancerTargetGroupsCommandOutput) => void): void;
|
|
661
|
+
/**
|
|
662
|
+
* <p>
|
|
663
|
+
* <b>Reserved for use with Amazon VPC Lattice, which is in preview and subject to change.
|
|
664
|
+
* Do not use this API for production workloads. This API is also subject to change.</b>
|
|
665
|
+
* </p>
|
|
666
|
+
* <p>Detaches one or more traffic sources from the specified Auto Scaling group.</p>
|
|
667
|
+
*/
|
|
668
|
+
detachTrafficSources(args: DetachTrafficSourcesCommandInput, options?: __HttpHandlerOptions): Promise<DetachTrafficSourcesCommandOutput>;
|
|
669
|
+
detachTrafficSources(args: DetachTrafficSourcesCommandInput, cb: (err: any, data?: DetachTrafficSourcesCommandOutput) => void): void;
|
|
670
|
+
detachTrafficSources(args: DetachTrafficSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetachTrafficSourcesCommandOutput) => void): void;
|
|
637
671
|
/**
|
|
638
672
|
* <p>Disables group metrics collection for the specified Auto Scaling group.</p>
|
|
639
673
|
*/
|
|
@@ -642,7 +676,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
642
676
|
disableMetricsCollection(args: DisableMetricsCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableMetricsCollectionCommandOutput) => void): void;
|
|
643
677
|
/**
|
|
644
678
|
* <p>Enables group metrics collection for the specified Auto Scaling group.</p>
|
|
645
|
-
*
|
|
679
|
+
* <p>You can use these metrics to track changes in an Auto Scaling group and to set alarms on
|
|
646
680
|
* threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch
|
|
647
681
|
* console. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html">Monitor
|
|
648
682
|
* CloudWatch metrics for your Auto Scaling groups and instances</a> in the
|
|
@@ -653,13 +687,13 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
653
687
|
enableMetricsCollection(args: EnableMetricsCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableMetricsCollectionCommandOutput) => void): void;
|
|
654
688
|
/**
|
|
655
689
|
* <p>Moves the specified instances into the standby state.</p>
|
|
656
|
-
*
|
|
690
|
+
* <p>If you choose to decrement the desired capacity of the Auto Scaling group, the instances can
|
|
657
691
|
* enter standby as long as the desired capacity of the Auto Scaling group after the instances are
|
|
658
692
|
* placed into standby is equal to or greater than the minimum capacity of the
|
|
659
693
|
* group.</p>
|
|
660
|
-
*
|
|
694
|
+
* <p>If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group
|
|
661
695
|
* launches new instances to replace the instances on standby.</p>
|
|
662
|
-
*
|
|
696
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html">Temporarily removing
|
|
663
697
|
* instances from your Auto Scaling group</a> in the
|
|
664
698
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
665
699
|
*/
|
|
@@ -675,9 +709,9 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
675
709
|
executePolicy(args: ExecutePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecutePolicyCommandOutput) => void): void;
|
|
676
710
|
/**
|
|
677
711
|
* <p>Moves the specified instances out of the standby state.</p>
|
|
678
|
-
*
|
|
712
|
+
* <p>After you put the instances back in service, the desired capacity is
|
|
679
713
|
* incremented.</p>
|
|
680
|
-
*
|
|
714
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html">Temporarily removing
|
|
681
715
|
* instances from your Auto Scaling group</a> in the
|
|
682
716
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
683
717
|
*/
|
|
@@ -686,13 +720,13 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
686
720
|
exitStandby(args: ExitStandbyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExitStandbyCommandOutput) => void): void;
|
|
687
721
|
/**
|
|
688
722
|
* <p>Retrieves the forecast data for a predictive scaling policy.</p>
|
|
689
|
-
*
|
|
723
|
+
* <p>Load forecasts are predictions of the hourly load values using historical load data
|
|
690
724
|
* from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as
|
|
691
725
|
* predicted values for the minimum capacity that is needed on an hourly basis, based on
|
|
692
726
|
* the hourly load forecast.</p>
|
|
693
|
-
*
|
|
727
|
+
* <p>A minimum of 24 hours of data is required to create the initial forecasts. However,
|
|
694
728
|
* having a full 14 days of historical data results in more accurate forecasts.</p>
|
|
695
|
-
*
|
|
729
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html">Predictive
|
|
696
730
|
* scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
697
731
|
*/
|
|
698
732
|
getPredictiveScalingForecast(args: GetPredictiveScalingForecastCommandInput, options?: __HttpHandlerOptions): Promise<GetPredictiveScalingForecastCommandOutput>;
|
|
@@ -700,47 +734,47 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
700
734
|
getPredictiveScalingForecast(args: GetPredictiveScalingForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPredictiveScalingForecastCommandOutput) => void): void;
|
|
701
735
|
/**
|
|
702
736
|
* <p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p>
|
|
703
|
-
*
|
|
737
|
+
* <p>Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance
|
|
704
738
|
* lifecycle, and then perform a custom action on instances when the corresponding
|
|
705
739
|
* lifecycle event occurs.</p>
|
|
706
|
-
*
|
|
740
|
+
* <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
|
|
707
741
|
* group:</p>
|
|
708
|
-
*
|
|
742
|
+
* <ol>
|
|
709
743
|
* <li>
|
|
710
|
-
*
|
|
744
|
+
* <p>(Optional) Create a launch template or launch configuration with a user data
|
|
711
745
|
* script that runs while an instance is in a wait state due to a lifecycle
|
|
712
746
|
* hook.</p>
|
|
713
747
|
* </li>
|
|
714
748
|
* <li>
|
|
715
|
-
*
|
|
749
|
+
* <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke
|
|
716
750
|
* your Lambda function when an instance is put into a wait state due to a
|
|
717
751
|
* lifecycle hook.</p>
|
|
718
752
|
* </li>
|
|
719
753
|
* <li>
|
|
720
|
-
*
|
|
754
|
+
* <p>(Optional) Create a notification target and an IAM role. The target can be
|
|
721
755
|
* either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish
|
|
722
756
|
* lifecycle notifications to the target.</p>
|
|
723
757
|
* </li>
|
|
724
758
|
* <li>
|
|
725
|
-
*
|
|
726
|
-
*
|
|
759
|
+
* <p>
|
|
760
|
+
* <b>Create the lifecycle hook. Specify whether the hook is
|
|
727
761
|
* used when the instances launch or terminate.</b>
|
|
728
|
-
*
|
|
762
|
+
* </p>
|
|
729
763
|
* </li>
|
|
730
764
|
* <li>
|
|
731
|
-
*
|
|
765
|
+
* <p>If you need more time, record the lifecycle action heartbeat to keep the
|
|
732
766
|
* instance in a wait state using the <a>RecordLifecycleActionHeartbeat</a> API call.</p>
|
|
733
767
|
* </li>
|
|
734
768
|
* <li>
|
|
735
|
-
*
|
|
769
|
+
* <p>If you finish before the timeout period ends, send a callback by using the
|
|
736
770
|
* <a>CompleteLifecycleAction</a> API call.</p>
|
|
737
771
|
* </li>
|
|
738
772
|
* </ol>
|
|
739
|
-
*
|
|
773
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
740
774
|
* hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
741
|
-
*
|
|
775
|
+
* <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling
|
|
742
776
|
* group, the call fails.</p>
|
|
743
|
-
*
|
|
777
|
+
* <p>You can view the lifecycle hooks for an Auto Scaling group using the <a>DescribeLifecycleHooks</a> API call. If you are no longer using a lifecycle
|
|
744
778
|
* hook, you can delete it by calling the <a>DeleteLifecycleHook</a> API.</p>
|
|
745
779
|
*/
|
|
746
780
|
putLifecycleHook(args: PutLifecycleHookCommandInput, options?: __HttpHandlerOptions): Promise<PutLifecycleHookCommandOutput>;
|
|
@@ -750,11 +784,11 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
750
784
|
* <p>Configures an Auto Scaling group to send notifications when specified events take place.
|
|
751
785
|
* Subscribers to the specified topic can have messages delivered to an endpoint such as a
|
|
752
786
|
* web server or an email address.</p>
|
|
753
|
-
*
|
|
754
|
-
*
|
|
787
|
+
* <p>This configuration overwrites any existing configuration.</p>
|
|
788
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html">Getting Amazon SNS
|
|
755
789
|
* notifications when your Auto Scaling group scales</a> in the
|
|
756
790
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
757
|
-
*
|
|
791
|
+
* <p>If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call
|
|
758
792
|
* fails.</p>
|
|
759
793
|
*/
|
|
760
794
|
putNotificationConfiguration(args: PutNotificationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutNotificationConfigurationCommandOutput>;
|
|
@@ -764,12 +798,12 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
764
798
|
* <p>Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to
|
|
765
799
|
* scale an Auto Scaling group based on configurable metrics. If no policies are defined, the
|
|
766
800
|
* dynamic scaling and predictive scaling features are not used. </p>
|
|
767
|
-
*
|
|
801
|
+
* <p>For more information about using dynamic scaling, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html">Target tracking
|
|
768
802
|
* scaling policies</a> and <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html">Step and simple scaling
|
|
769
803
|
* policies</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
770
|
-
*
|
|
804
|
+
* <p>For more information about using predictive scaling, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html">Predictive
|
|
771
805
|
* scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
772
|
-
*
|
|
806
|
+
* <p>You can view the scaling policies for an Auto Scaling group using the <a>DescribePolicies</a> API call. If you are no longer using a scaling policy,
|
|
773
807
|
* you can delete it by calling the <a>DeletePolicy</a> API.</p>
|
|
774
808
|
*/
|
|
775
809
|
putScalingPolicy(args: PutScalingPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutScalingPolicyCommandOutput>;
|
|
@@ -777,11 +811,11 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
777
811
|
putScalingPolicy(args: PutScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void): void;
|
|
778
812
|
/**
|
|
779
813
|
* <p>Creates or updates a scheduled scaling action for an Auto Scaling group.</p>
|
|
780
|
-
*
|
|
814
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html">Scheduled scaling</a> in the
|
|
781
815
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
782
|
-
*
|
|
816
|
+
* <p>You can view the scheduled actions for an Auto Scaling group using the <a>DescribeScheduledActions</a> API call. If you are no longer using a
|
|
783
817
|
* scheduled action, you can delete it by calling the <a>DeleteScheduledAction</a> API.</p>
|
|
784
|
-
*
|
|
818
|
+
* <p>If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error
|
|
785
819
|
* message.</p>
|
|
786
820
|
*/
|
|
787
821
|
putScheduledUpdateGroupAction(args: PutScheduledUpdateGroupActionCommandInput, options?: __HttpHandlerOptions): Promise<PutScheduledUpdateGroupActionCommandOutput>;
|
|
@@ -793,10 +827,10 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
793
827
|
* application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new
|
|
794
828
|
* desired capacity. For more information and example configurations, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
|
|
795
829
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
796
|
-
*
|
|
830
|
+
* <p>This operation must be called from the Region in which the Auto Scaling group was created.
|
|
797
831
|
* This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a
|
|
798
832
|
* launch template or launch configuration that requests Spot Instances.</p>
|
|
799
|
-
*
|
|
833
|
+
* <p>You can view the instances in the warm pool using the <a>DescribeWarmPool</a> API call. If you are no longer using a warm pool, you can delete it by calling the
|
|
800
834
|
* <a>DeleteWarmPool</a> API.</p>
|
|
801
835
|
*/
|
|
802
836
|
putWarmPool(args: PutWarmPoolCommandInput, options?: __HttpHandlerOptions): Promise<PutWarmPoolCommandOutput>;
|
|
@@ -805,40 +839,40 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
805
839
|
/**
|
|
806
840
|
* <p>Records a heartbeat for the lifecycle action associated with the specified token or
|
|
807
841
|
* instance. This extends the timeout by the length of time defined using the <a>PutLifecycleHook</a> API call.</p>
|
|
808
|
-
*
|
|
842
|
+
* <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
|
|
809
843
|
* group:</p>
|
|
810
|
-
*
|
|
844
|
+
* <ol>
|
|
811
845
|
* <li>
|
|
812
|
-
*
|
|
846
|
+
* <p>(Optional) Create a launch template or launch configuration with a user data
|
|
813
847
|
* script that runs while an instance is in a wait state due to a lifecycle
|
|
814
848
|
* hook.</p>
|
|
815
849
|
* </li>
|
|
816
850
|
* <li>
|
|
817
|
-
*
|
|
851
|
+
* <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke
|
|
818
852
|
* your Lambda function when an instance is put into a wait state due to a
|
|
819
853
|
* lifecycle hook.</p>
|
|
820
854
|
* </li>
|
|
821
855
|
* <li>
|
|
822
|
-
*
|
|
856
|
+
* <p>(Optional) Create a notification target and an IAM role. The target can be
|
|
823
857
|
* either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish
|
|
824
858
|
* lifecycle notifications to the target.</p>
|
|
825
859
|
* </li>
|
|
826
860
|
* <li>
|
|
827
|
-
*
|
|
861
|
+
* <p>Create the lifecycle hook. Specify whether the hook is used when the instances
|
|
828
862
|
* launch or terminate.</p>
|
|
829
863
|
* </li>
|
|
830
864
|
* <li>
|
|
831
|
-
*
|
|
832
|
-
*
|
|
865
|
+
* <p>
|
|
866
|
+
* <b>If you need more time, record the lifecycle action
|
|
833
867
|
* heartbeat to keep the instance in a wait state.</b>
|
|
834
|
-
*
|
|
868
|
+
* </p>
|
|
835
869
|
* </li>
|
|
836
870
|
* <li>
|
|
837
|
-
*
|
|
871
|
+
* <p>If you finish before the timeout period ends, send a callback by using the
|
|
838
872
|
* <a>CompleteLifecycleAction</a> API call.</p>
|
|
839
873
|
* </li>
|
|
840
874
|
* </ol>
|
|
841
|
-
*
|
|
875
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
842
876
|
* hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
843
877
|
*/
|
|
844
878
|
recordLifecycleActionHeartbeat(args: RecordLifecycleActionHeartbeatCommandInput, options?: __HttpHandlerOptions): Promise<RecordLifecycleActionHeartbeatCommandOutput>;
|
|
@@ -847,7 +881,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
847
881
|
/**
|
|
848
882
|
* <p>Resumes the specified suspended auto scaling processes, or all suspended process, for
|
|
849
883
|
* the specified Auto Scaling group.</p>
|
|
850
|
-
*
|
|
884
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
|
|
851
885
|
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
852
886
|
*/
|
|
853
887
|
resumeProcesses(args: ResumeProcessesCommandInput, options?: __HttpHandlerOptions): Promise<ResumeProcessesCommandOutput>;
|
|
@@ -855,10 +889,10 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
855
889
|
resumeProcesses(args: ResumeProcessesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeProcessesCommandOutput) => void): void;
|
|
856
890
|
/**
|
|
857
891
|
* <p>Sets the size of the specified Auto Scaling group.</p>
|
|
858
|
-
*
|
|
892
|
+
* <p>If a scale-in activity occurs as a result of a new <code>DesiredCapacity</code> value
|
|
859
893
|
* that is lower than the current size of the group, the Auto Scaling group uses its termination
|
|
860
894
|
* policy to determine which instances to terminate. </p>
|
|
861
|
-
*
|
|
895
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html">Manual scaling</a> in the
|
|
862
896
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
863
897
|
*/
|
|
864
898
|
setDesiredCapacity(args: SetDesiredCapacityCommandInput, options?: __HttpHandlerOptions): Promise<SetDesiredCapacityCommandOutput>;
|
|
@@ -866,7 +900,7 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
866
900
|
setDesiredCapacity(args: SetDesiredCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDesiredCapacityCommandOutput) => void): void;
|
|
867
901
|
/**
|
|
868
902
|
* <p>Sets the health status of the specified instance.</p>
|
|
869
|
-
*
|
|
903
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html">Health checks for Auto Scaling
|
|
870
904
|
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
871
905
|
*/
|
|
872
906
|
setInstanceHealth(args: SetInstanceHealthCommandInput, options?: __HttpHandlerOptions): Promise<SetInstanceHealthCommandOutput>;
|
|
@@ -875,11 +909,11 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
875
909
|
/**
|
|
876
910
|
* <p>Updates the instance protection settings of the specified instances. This operation
|
|
877
911
|
* cannot be called on instances in a warm pool.</p>
|
|
878
|
-
*
|
|
912
|
+
* <p>For more information about preventing instances that are part of an Auto Scaling group from
|
|
879
913
|
* terminating on scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Using
|
|
880
914
|
* instance scale-in protection</a> in the
|
|
881
915
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
882
|
-
*
|
|
916
|
+
* <p>If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call
|
|
883
917
|
* fails.</p>
|
|
884
918
|
*/
|
|
885
919
|
setInstanceProtection(args: SetInstanceProtectionCommandInput, options?: __HttpHandlerOptions): Promise<SetInstanceProtectionCommandOutput>;
|
|
@@ -890,13 +924,13 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
890
924
|
* replacement of all or some instances in an Auto Scaling group. Each instance is terminated first
|
|
891
925
|
* and then replaced, which temporarily reduces the capacity available within your Auto Scaling
|
|
892
926
|
* group.</p>
|
|
893
|
-
*
|
|
927
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
|
|
894
928
|
* feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.
|
|
895
929
|
* This feature is helpful, for example, when you have a new AMI or a new user data script.
|
|
896
930
|
* You just need to create a new launch template that specifies the new AMI or user data
|
|
897
931
|
* script. Then start an instance refresh to immediately begin the process of updating
|
|
898
932
|
* instances in the group. </p>
|
|
899
|
-
*
|
|
933
|
+
* <p>If the call succeeds, it creates a new instance refresh request with a unique ID that
|
|
900
934
|
* you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that
|
|
901
935
|
* have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an
|
|
902
936
|
* instance refresh operation in progress, use the <a>CancelInstanceRefresh</a>
|
|
@@ -908,11 +942,11 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
908
942
|
/**
|
|
909
943
|
* <p>Suspends the specified auto scaling processes, or all processes, for the specified
|
|
910
944
|
* Auto Scaling group.</p>
|
|
911
|
-
*
|
|
945
|
+
* <p>If you suspend either the <code>Launch</code> or <code>Terminate</code> process types,
|
|
912
946
|
* it can prevent other process types from functioning properly. For more information, see
|
|
913
947
|
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
|
|
914
948
|
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
915
|
-
*
|
|
949
|
+
* <p>To resume processes that have been suspended, call the <a>ResumeProcesses</a> API.</p>
|
|
916
950
|
*/
|
|
917
951
|
suspendProcesses(args: SuspendProcessesCommandInput, options?: __HttpHandlerOptions): Promise<SuspendProcessesCommandOutput>;
|
|
918
952
|
suspendProcesses(args: SuspendProcessesCommandInput, cb: (err: any, data?: SuspendProcessesCommandOutput) => void): void;
|
|
@@ -920,13 +954,13 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
920
954
|
/**
|
|
921
955
|
* <p>Terminates the specified instance and optionally adjusts the desired group size. This
|
|
922
956
|
* operation cannot be called on instances in a warm pool.</p>
|
|
923
|
-
*
|
|
957
|
+
* <p>This call simply makes a termination request. The instance is not terminated
|
|
924
958
|
* immediately. When an instance is terminated, the instance status changes to
|
|
925
959
|
* <code>terminated</code>. You can't connect to or start an instance after you've
|
|
926
960
|
* terminated it.</p>
|
|
927
|
-
*
|
|
961
|
+
* <p>If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches
|
|
928
962
|
* instances to replace the ones that are terminated. </p>
|
|
929
|
-
*
|
|
963
|
+
* <p>By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you
|
|
930
964
|
* decrement the desired capacity, your Auto Scaling group can become unbalanced between
|
|
931
965
|
* Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might
|
|
932
966
|
* terminate instances in other zones. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage">Rebalancing activities</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
@@ -938,12 +972,12 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
938
972
|
* <p>
|
|
939
973
|
* <b>We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.</b>
|
|
940
974
|
* </p>
|
|
941
|
-
*
|
|
942
|
-
*
|
|
975
|
+
* <p>Updates the configuration for the specified Auto Scaling group.</p>
|
|
976
|
+
* <p>To update an Auto Scaling group, specify the name of the group and the property that you want
|
|
943
977
|
* to change. Any properties that you don't specify are not changed by this update request.
|
|
944
978
|
* The new settings take effect on any scaling activities after this call returns.
|
|
945
979
|
* </p>
|
|
946
|
-
*
|
|
980
|
+
* <p>If you associate a new launch configuration or template with an Auto Scaling group, all new
|
|
947
981
|
* instances will get the updated configuration. Existing instances continue to run with
|
|
948
982
|
* the configuration that they were originally launched with. When you update a group to
|
|
949
983
|
* specify a mixed instances policy instead of a launch configuration or template, existing
|
|
@@ -953,29 +987,29 @@ export declare class AutoScaling extends AutoScalingClient {
|
|
|
953
987
|
* terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches
|
|
954
988
|
* new instances before terminating the old ones, so that updating your group does not
|
|
955
989
|
* compromise the performance or availability of your application.</p>
|
|
956
|
-
*
|
|
990
|
+
* <p>Note the following about changing <code>DesiredCapacity</code>, <code>MaxSize</code>,
|
|
957
991
|
* or <code>MinSize</code>:</p>
|
|
958
|
-
*
|
|
992
|
+
* <ul>
|
|
959
993
|
* <li>
|
|
960
|
-
*
|
|
994
|
+
* <p>If a scale-in activity occurs as a result of a new
|
|
961
995
|
* <code>DesiredCapacity</code> value that is lower than the current size of
|
|
962
996
|
* the group, the Auto Scaling group uses its termination policy to determine which
|
|
963
997
|
* instances to terminate.</p>
|
|
964
998
|
* </li>
|
|
965
999
|
* <li>
|
|
966
|
-
*
|
|
1000
|
+
* <p>If you specify a new value for <code>MinSize</code> without specifying a value
|
|
967
1001
|
* for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger
|
|
968
1002
|
* than the current size of the group, this sets the group's
|
|
969
1003
|
* <code>DesiredCapacity</code> to the new <code>MinSize</code> value.</p>
|
|
970
1004
|
* </li>
|
|
971
1005
|
* <li>
|
|
972
|
-
*
|
|
1006
|
+
* <p>If you specify a new value for <code>MaxSize</code> without specifying a value
|
|
973
1007
|
* for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller
|
|
974
1008
|
* than the current size of the group, this sets the group's
|
|
975
1009
|
* <code>DesiredCapacity</code> to the new <code>MaxSize</code> value.</p>
|
|
976
1010
|
* </li>
|
|
977
1011
|
* </ul>
|
|
978
|
-
*
|
|
1012
|
+
* <p>To see which properties have been set, call the <a>DescribeAutoScalingGroups</a> API. To view the scaling policies for an Auto Scaling
|
|
979
1013
|
* group, call the <a>DescribePolicies</a> API. If the group has scaling
|
|
980
1014
|
* policies, you can update them by calling the <a>PutScalingPolicy</a>
|
|
981
1015
|
* API.</p>
|