@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
|
@@ -9,10 +9,10 @@ export interface DescribeScalingActivitiesCommandOutput extends ActivitiesType,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about the scaling activities in the account and Region.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When scaling events occur, you see a record of the scaling activity in the scaling
|
|
13
13
|
* activities. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html">Verifying a scaling
|
|
14
14
|
* activity for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If the scaling event succeeds, the value of the <code>StatusCode</code> element in the
|
|
16
16
|
* response is <code>Successful</code>. If an attempt to launch instances failed, the
|
|
17
17
|
* <code>StatusCode</code> value is <code>Failed</code> or <code>Cancelled</code> and
|
|
18
18
|
* the <code>StatusMessage</code> element in the response indicates the cause of the
|
|
@@ -10,7 +10,7 @@ export interface DescribeScheduledActionsCommandOutput extends ScheduledActionsT
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about the scheduled actions that haven't run or that have not reached
|
|
12
12
|
* their end time.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To describe the scaling activities for scheduled actions that have already run, call
|
|
14
14
|
* the <a>DescribeScalingActivities</a> API.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,13 +9,13 @@ export interface DescribeTagsCommandOutput extends TagsType, __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes the specified tags.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can use filters to limit the results. For example, you can query for the tags for
|
|
13
13
|
* a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at
|
|
14
14
|
* least one of the specified values for it to be included in the results.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can also specify multiple filters. The result includes information for a
|
|
16
16
|
* particular tag only if it matches all the filters. If there's no match, no special
|
|
17
17
|
* message is returned.</p>
|
|
18
|
-
*
|
|
18
|
+
* <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
|
|
19
19
|
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface DescribeTerminationPolicyTypesCommandOutput extends DescribeTer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes the termination policies supported by Amazon EC2 Auto Scaling.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html">Work with
|
|
13
13
|
* Amazon EC2 Auto Scaling termination policies</a> in the
|
|
14
14
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
15
15
|
* @example
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { AutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingClient";
|
|
5
|
+
import { DescribeTrafficSourcesRequest, DescribeTrafficSourcesResponse } from "../models/models_0";
|
|
6
|
+
export interface DescribeTrafficSourcesCommandInput extends DescribeTrafficSourcesRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface DescribeTrafficSourcesCommandOutput extends DescribeTrafficSourcesResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>
|
|
12
|
+
* <b>Reserved for use with Amazon VPC Lattice, which is in preview and subject to change.
|
|
13
|
+
* Do not use this API for production workloads. This API is also subject to change.</b>
|
|
14
|
+
* </p>
|
|
15
|
+
* <p>Gets information about the traffic sources for the specified Auto Scaling group.</p>
|
|
16
|
+
* @example
|
|
17
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
18
|
+
* ```javascript
|
|
19
|
+
* import { AutoScalingClient, DescribeTrafficSourcesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
|
|
20
|
+
* // const { AutoScalingClient, DescribeTrafficSourcesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
|
|
21
|
+
* const client = new AutoScalingClient(config);
|
|
22
|
+
* const command = new DescribeTrafficSourcesCommand(input);
|
|
23
|
+
* const response = await client.send(command);
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @see {@link DescribeTrafficSourcesCommandInput} for command's `input` shape.
|
|
27
|
+
* @see {@link DescribeTrafficSourcesCommandOutput} for command's `response` shape.
|
|
28
|
+
* @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
export declare class DescribeTrafficSourcesCommand extends $Command<DescribeTrafficSourcesCommandInput, DescribeTrafficSourcesCommandOutput, AutoScalingClientResolvedConfig> {
|
|
32
|
+
readonly input: DescribeTrafficSourcesCommandInput;
|
|
33
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
34
|
+
constructor(input: DescribeTrafficSourcesCommandInput);
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeTrafficSourcesCommandInput, DescribeTrafficSourcesCommandOutput>;
|
|
39
|
+
private serialize;
|
|
40
|
+
private deserialize;
|
|
41
|
+
}
|
|
@@ -9,7 +9,7 @@ export interface DescribeWarmPoolCommandOutput extends DescribeWarmPoolAnswer, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about a warm pool and its instances.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for
|
|
13
13
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,14 +9,14 @@ export interface DetachInstancesCommandOutput extends DetachInstancesAnswer, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes one or more instances from the specified Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>After the instances are detached, you can manage them independent of the Auto Scaling
|
|
13
13
|
* group.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches
|
|
15
15
|
* instances to replace the ones that are detached.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are
|
|
17
17
|
* deregistered from the load balancer. If there are target groups attached to the Auto Scaling
|
|
18
18
|
* group, the instances are deregistered from the target groups.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html">Detach EC2 instances from
|
|
20
20
|
* your Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,10 +9,15 @@ export interface DetachLoadBalancerTargetGroupsCommandOutput extends DetachLoadB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Detaches one or more target groups from the specified Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When you detach a target group, it enters the <code>Removing</code> state while
|
|
13
13
|
* deregistering the instances in the group. When all instances are deregistered, then you
|
|
14
14
|
* can no longer describe the target group using the <a>DescribeLoadBalancerTargetGroups</a> API call. The instances remain
|
|
15
15
|
* running.</p>
|
|
16
|
+
* <note>
|
|
17
|
+
* <p>You can use this operation to detach target groups that were attached by using
|
|
18
|
+
* <a>AttachLoadBalancerTargetGroups</a>, but not for target groups that
|
|
19
|
+
* were attached by using <a>AttachTrafficSources</a>.</p>
|
|
20
|
+
* </note>
|
|
16
21
|
* @example
|
|
17
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
23
|
* ```javascript
|
|
@@ -9,9 +9,9 @@ export interface DetachLoadBalancersCommandOutput extends DetachLoadBalancersRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or
|
|
13
13
|
* Gateway Load Balancer, use the <a>DetachLoadBalancerTargetGroups</a> API instead.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>When you detach a load balancer, it enters the <code>Removing</code> state while
|
|
15
15
|
* deregistering the instances in the group. When all instances are deregistered, then you
|
|
16
16
|
* can no longer describe the load balancer using the <a>DescribeLoadBalancers</a> API call. The instances remain running.</p>
|
|
17
17
|
* @example
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { AutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingClient";
|
|
5
|
+
import { DetachTrafficSourcesResultType, DetachTrafficSourcesType } from "../models/models_0";
|
|
6
|
+
export interface DetachTrafficSourcesCommandInput extends DetachTrafficSourcesType {
|
|
7
|
+
}
|
|
8
|
+
export interface DetachTrafficSourcesCommandOutput extends DetachTrafficSourcesResultType, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>
|
|
12
|
+
* <b>Reserved for use with Amazon VPC Lattice, which is in preview and subject to change.
|
|
13
|
+
* Do not use this API for production workloads. This API is also subject to change.</b>
|
|
14
|
+
* </p>
|
|
15
|
+
* <p>Detaches one or more traffic sources from the specified Auto Scaling group.</p>
|
|
16
|
+
* @example
|
|
17
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
18
|
+
* ```javascript
|
|
19
|
+
* import { AutoScalingClient, DetachTrafficSourcesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
|
|
20
|
+
* // const { AutoScalingClient, DetachTrafficSourcesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
|
|
21
|
+
* const client = new AutoScalingClient(config);
|
|
22
|
+
* const command = new DetachTrafficSourcesCommand(input);
|
|
23
|
+
* const response = await client.send(command);
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @see {@link DetachTrafficSourcesCommandInput} for command's `input` shape.
|
|
27
|
+
* @see {@link DetachTrafficSourcesCommandOutput} for command's `response` shape.
|
|
28
|
+
* @see {@link AutoScalingClientResolvedConfig | config} for AutoScalingClient's `config` shape.
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
export declare class DetachTrafficSourcesCommand extends $Command<DetachTrafficSourcesCommandInput, DetachTrafficSourcesCommandOutput, AutoScalingClientResolvedConfig> {
|
|
32
|
+
readonly input: DetachTrafficSourcesCommandInput;
|
|
33
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
34
|
+
constructor(input: DetachTrafficSourcesCommandInput);
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetachTrafficSourcesCommandInput, DetachTrafficSourcesCommandOutput>;
|
|
39
|
+
private serialize;
|
|
40
|
+
private deserialize;
|
|
41
|
+
}
|
|
@@ -9,7 +9,7 @@ export interface EnableMetricsCollectionCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Enables group metrics collection for the specified Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can use these metrics to track changes in an Auto Scaling group and to set alarms on
|
|
13
13
|
* threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch
|
|
14
14
|
* console. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html">Monitor
|
|
15
15
|
* CloudWatch metrics for your Auto Scaling groups and instances</a> in the
|
|
@@ -9,13 +9,13 @@ export interface EnterStandbyCommandOutput extends EnterStandbyAnswer, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Moves the specified instances into the standby state.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you choose to decrement the desired capacity of the Auto Scaling group, the instances can
|
|
13
13
|
* enter standby as long as the desired capacity of the Auto Scaling group after the instances are
|
|
14
14
|
* placed into standby is equal to or greater than the minimum capacity of the
|
|
15
15
|
* group.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group
|
|
17
17
|
* launches new instances to replace the instances on standby.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html">Temporarily removing
|
|
19
19
|
* instances from your Auto Scaling group</a> in the
|
|
20
20
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
21
21
|
* @example
|
|
@@ -9,9 +9,9 @@ export interface ExitStandbyCommandOutput extends ExitStandbyAnswer, __MetadataB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Moves the specified instances out of the standby state.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>After you put the instances back in service, the desired capacity is
|
|
13
13
|
* incremented.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html">Temporarily removing
|
|
15
15
|
* instances from your Auto Scaling group</a> in the
|
|
16
16
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
17
17
|
* @example
|
|
@@ -9,13 +9,13 @@ export interface GetPredictiveScalingForecastCommandOutput extends GetPredictive
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the forecast data for a predictive scaling policy.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Load forecasts are predictions of the hourly load values using historical load data
|
|
13
13
|
* from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as
|
|
14
14
|
* predicted values for the minimum capacity that is needed on an hourly basis, based on
|
|
15
15
|
* the hourly load forecast.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>A minimum of 24 hours of data is required to create the initial forecasts. However,
|
|
17
17
|
* having a full 14 days of historical data results in more accurate forecasts.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-predictive-scaling.html">Predictive
|
|
19
19
|
* scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,47 +9,47 @@ export interface PutLifecycleHookCommandOutput extends PutLifecycleHookAnswer, _
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates or updates a lifecycle hook for the specified Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance
|
|
13
13
|
* lifecycle, and then perform a custom action on instances when the corresponding
|
|
14
14
|
* lifecycle event occurs.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
|
|
16
16
|
* group:</p>
|
|
17
|
-
*
|
|
17
|
+
* <ol>
|
|
18
18
|
* <li>
|
|
19
|
-
*
|
|
19
|
+
* <p>(Optional) Create a launch template or launch configuration with a user data
|
|
20
20
|
* script that runs while an instance is in a wait state due to a lifecycle
|
|
21
21
|
* hook.</p>
|
|
22
22
|
* </li>
|
|
23
23
|
* <li>
|
|
24
|
-
*
|
|
24
|
+
* <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke
|
|
25
25
|
* your Lambda function when an instance is put into a wait state due to a
|
|
26
26
|
* lifecycle hook.</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>(Optional) Create a notification target and an IAM role. The target can be
|
|
30
30
|
* either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish
|
|
31
31
|
* lifecycle notifications to the target.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <p>
|
|
35
|
+
* <b>Create the lifecycle hook. Specify whether the hook is
|
|
36
36
|
* used when the instances launch or terminate.</b>
|
|
37
|
-
*
|
|
37
|
+
* </p>
|
|
38
38
|
* </li>
|
|
39
39
|
* <li>
|
|
40
|
-
*
|
|
40
|
+
* <p>If you need more time, record the lifecycle action heartbeat to keep the
|
|
41
41
|
* instance in a wait state using the <a>RecordLifecycleActionHeartbeat</a> API call.</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* <li>
|
|
44
|
-
*
|
|
44
|
+
* <p>If you finish before the timeout period ends, send a callback by using the
|
|
45
45
|
* <a>CompleteLifecycleAction</a> API call.</p>
|
|
46
46
|
* </li>
|
|
47
47
|
* </ol>
|
|
48
|
-
*
|
|
48
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
49
49
|
* hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
50
|
-
*
|
|
50
|
+
* <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling
|
|
51
51
|
* group, the call fails.</p>
|
|
52
|
-
*
|
|
52
|
+
* <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
|
|
53
53
|
* hook, you can delete it by calling the <a>DeleteLifecycleHook</a> API.</p>
|
|
54
54
|
* @example
|
|
55
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,11 +11,11 @@ export interface PutNotificationConfigurationCommandOutput extends __MetadataBea
|
|
|
11
11
|
* <p>Configures an Auto Scaling group to send notifications when specified events take place.
|
|
12
12
|
* Subscribers to the specified topic can have messages delivered to an endpoint such as a
|
|
13
13
|
* web server or an email address.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p>This configuration overwrites any existing configuration.</p>
|
|
15
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html">Getting Amazon SNS
|
|
16
16
|
* notifications when your Auto Scaling group scales</a> in the
|
|
17
17
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call
|
|
19
19
|
* fails.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,12 +11,12 @@ export interface PutScalingPolicyCommandOutput extends PolicyARNType, __Metadata
|
|
|
11
11
|
* <p>Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to
|
|
12
12
|
* scale an Auto Scaling group based on configurable metrics. If no policies are defined, the
|
|
13
13
|
* dynamic scaling and predictive scaling features are not used. </p>
|
|
14
|
-
*
|
|
14
|
+
* <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
|
|
15
15
|
* scaling policies</a> and <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html">Step and simple scaling
|
|
16
16
|
* policies</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <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
|
|
18
18
|
* scaling for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <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,
|
|
20
20
|
* you can delete it by calling the <a>DeletePolicy</a> API.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,11 +9,11 @@ export interface PutScheduledUpdateGroupActionCommandOutput extends __MetadataBe
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates or updates a scheduled scaling action for an Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html">Scheduled scaling</a> in the
|
|
13
13
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <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
|
|
15
15
|
* scheduled action, you can delete it by calling the <a>DeleteScheduledAction</a> API.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error
|
|
17
17
|
* message.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -13,10 +13,10 @@ export interface PutWarmPoolCommandOutput extends PutWarmPoolAnswer, __MetadataB
|
|
|
13
13
|
* application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new
|
|
14
14
|
* 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
|
|
15
15
|
* Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>This operation must be called from the Region in which the Auto Scaling group was created.
|
|
17
17
|
* This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a
|
|
18
18
|
* launch template or launch configuration that requests Spot Instances.</p>
|
|
19
|
-
*
|
|
19
|
+
* <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
|
|
20
20
|
* <a>DeleteWarmPool</a> API.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,40 +10,40 @@ export interface RecordLifecycleActionHeartbeatCommandOutput extends RecordLifec
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Records a heartbeat for the lifecycle action associated with the specified token or
|
|
12
12
|
* instance. This extends the timeout by the length of time defined using the <a>PutLifecycleHook</a> API call.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling
|
|
14
14
|
* group:</p>
|
|
15
|
-
*
|
|
15
|
+
* <ol>
|
|
16
16
|
* <li>
|
|
17
|
-
*
|
|
17
|
+
* <p>(Optional) Create a launch template or launch configuration with a user data
|
|
18
18
|
* script that runs while an instance is in a wait state due to a lifecycle
|
|
19
19
|
* hook.</p>
|
|
20
20
|
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke
|
|
23
23
|
* your Lambda function when an instance is put into a wait state due to a
|
|
24
24
|
* lifecycle hook.</p>
|
|
25
25
|
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>(Optional) Create a notification target and an IAM role. The target can be
|
|
28
28
|
* either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish
|
|
29
29
|
* lifecycle notifications to the target.</p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>Create the lifecycle hook. Specify whether the hook is used when the instances
|
|
33
33
|
* launch or terminate.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
37
|
-
*
|
|
36
|
+
* <p>
|
|
37
|
+
* <b>If you need more time, record the lifecycle action
|
|
38
38
|
* heartbeat to keep the instance in a wait state.</b>
|
|
39
|
-
*
|
|
39
|
+
* </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
42
|
+
* <p>If you finish before the timeout period ends, send a callback by using the
|
|
43
43
|
* <a>CompleteLifecycleAction</a> API call.</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* </ol>
|
|
46
|
-
*
|
|
46
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html">Amazon EC2 Auto Scaling lifecycle
|
|
47
47
|
* hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
48
48
|
* @example
|
|
49
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface ResumeProcessesCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Resumes the specified suspended auto scaling processes, or all suspended process, for
|
|
12
12
|
* the specified Auto Scaling group.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
|
|
14
14
|
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,10 +9,10 @@ export interface SetDesiredCapacityCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Sets the size of the specified Auto Scaling group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If a scale-in activity occurs as a result of a new <code>DesiredCapacity</code> value
|
|
13
13
|
* that is lower than the current size of the group, the Auto Scaling group uses its termination
|
|
14
14
|
* policy to determine which instances to terminate. </p>
|
|
15
|
-
*
|
|
15
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html">Manual scaling</a> in the
|
|
16
16
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface SetInstanceHealthCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Sets the health status of the specified instance.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html">Health checks for Auto Scaling
|
|
13
13
|
* instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,11 +10,11 @@ export interface SetInstanceProtectionCommandOutput extends SetInstanceProtectio
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the instance protection settings of the specified instances. This operation
|
|
12
12
|
* cannot be called on instances in a warm pool.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information about preventing instances that are part of an Auto Scaling group from
|
|
14
14
|
* terminating on scale in, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html">Using
|
|
15
15
|
* instance scale-in protection</a> in the
|
|
16
16
|
* <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call
|
|
18
18
|
* fails.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,13 +12,13 @@ export interface StartInstanceRefreshCommandOutput extends StartInstanceRefreshA
|
|
|
12
12
|
* replacement of all or some instances in an Auto Scaling group. Each instance is terminated first
|
|
13
13
|
* and then replaced, which temporarily reduces the capacity available within your Auto Scaling
|
|
14
14
|
* group.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
|
|
16
16
|
* feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.
|
|
17
17
|
* This feature is helpful, for example, when you have a new AMI or a new user data script.
|
|
18
18
|
* You just need to create a new launch template that specifies the new AMI or user data
|
|
19
19
|
* script. Then start an instance refresh to immediately begin the process of updating
|
|
20
20
|
* instances in the group. </p>
|
|
21
|
-
*
|
|
21
|
+
* <p>If the call succeeds, it creates a new instance refresh request with a unique ID that
|
|
22
22
|
* you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that
|
|
23
23
|
* have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an
|
|
24
24
|
* instance refresh operation in progress, use the <a>CancelInstanceRefresh</a>
|
|
@@ -10,11 +10,11 @@ export interface SuspendProcessesCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Suspends the specified auto scaling processes, or all processes, for the specified
|
|
12
12
|
* Auto Scaling group.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If you suspend either the <code>Launch</code> or <code>Terminate</code> process types,
|
|
14
14
|
* it can prevent other process types from functioning properly. For more information, see
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html">Suspending and
|
|
16
16
|
* resuming scaling processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>To resume processes that have been suspended, call the <a>ResumeProcesses</a> API.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -10,13 +10,13 @@ export interface TerminateInstanceInAutoScalingGroupCommandOutput extends Activi
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Terminates the specified instance and optionally adjusts the desired group size. This
|
|
12
12
|
* operation cannot be called on instances in a warm pool.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This call simply makes a termination request. The instance is not terminated
|
|
14
14
|
* immediately. When an instance is terminated, the instance status changes to
|
|
15
15
|
* <code>terminated</code>. You can't connect to or start an instance after you've
|
|
16
16
|
* terminated it.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches
|
|
18
18
|
* instances to replace the ones that are terminated. </p>
|
|
19
|
-
*
|
|
19
|
+
* <p>By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you
|
|
20
20
|
* decrement the desired capacity, your Auto Scaling group can become unbalanced between
|
|
21
21
|
* Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might
|
|
22
22
|
* 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>
|