@aws-sdk/client-auto-scaling 3.267.0 → 3.269.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/dist-cjs/AutoScaling.js +15 -0
  2. package/dist-cjs/commands/RollbackInstanceRefreshCommand.js +46 -0
  3. package/dist-cjs/commands/index.js +1 -0
  4. package/dist-cjs/endpoint/ruleset.js +3 -3
  5. package/dist-cjs/models/models_0.js +45 -5
  6. package/dist-cjs/protocols/Aws_query.js +142 -2
  7. package/dist-es/AutoScaling.js +15 -0
  8. package/dist-es/commands/RollbackInstanceRefreshCommand.js +42 -0
  9. package/dist-es/commands/index.js +1 -0
  10. package/dist-es/endpoint/ruleset.js +3 -3
  11. package/dist-es/models/models_0.js +36 -0
  12. package/dist-es/protocols/Aws_query.js +139 -1
  13. package/dist-types/AutoScaling.d.ts +56 -45
  14. package/dist-types/AutoScalingClient.d.ts +3 -2
  15. package/dist-types/commands/CancelInstanceRefreshCommand.d.ts +5 -3
  16. package/dist-types/commands/DescribeInstanceRefreshesCommand.d.ts +6 -35
  17. package/dist-types/commands/RollbackInstanceRefreshCommand.d.ts +59 -0
  18. package/dist-types/commands/StartInstanceRefreshCommand.d.ts +16 -7
  19. package/dist-types/commands/index.d.ts +1 -0
  20. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  21. package/dist-types/models/models_0.d.ts +280 -89
  22. package/dist-types/protocols/Aws_query.d.ts +3 -0
  23. package/dist-types/ts3.4/AutoScaling.d.ts +17 -0
  24. package/dist-types/ts3.4/AutoScalingClient.d.ts +6 -0
  25. package/dist-types/ts3.4/commands/RollbackInstanceRefreshCommand.d.ts +41 -0
  26. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  27. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  28. package/dist-types/ts3.4/models/models_0.d.ts +49 -0
  29. package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
  30. package/package.json +1 -1
@@ -8,21 +8,30 @@ export interface StartInstanceRefreshCommandInput extends StartInstanceRefreshTy
8
8
  export interface StartInstanceRefreshCommandOutput extends StartInstanceRefreshAnswer, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Starts a new instance refresh operation. An instance refresh performs a rolling
12
- * replacement of all or some instances in an Auto Scaling group. Each instance is terminated first
13
- * and then replaced, which temporarily reduces the capacity available within your Auto Scaling
14
- * group.</p>
11
+ * <p>Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling
12
+ * update of instances in an Auto Scaling group. Instances are terminated first and then replaced,
13
+ * which temporarily reduces the capacity available within your Auto Scaling group.</p>
15
14
  * <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh
16
15
  * feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.
17
16
  * This feature is helpful, for example, when you have a new AMI or a new user data script.
18
17
  * You just need to create a new launch template that specifies the new AMI or user data
19
18
  * script. Then start an instance refresh to immediately begin the process of updating
20
19
  * instances in the group. </p>
21
- * <p>If the call succeeds, it creates a new instance refresh request with a unique ID that
22
- * you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that
20
+ * <p>If successful, the request's response contains a unique ID that you can use to track
21
+ * the progress of the instance refresh. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that
23
22
  * have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an
24
- * instance refresh operation in progress, use the <a>CancelInstanceRefresh</a>
23
+ * instance refresh that is in progress, use the <a>CancelInstanceRefresh</a>
25
24
  * API. </p>
25
+ * <p>An instance refresh might fail for several reasons, such as EC2 launch failures,
26
+ * misconfigured health checks, or not ignoring or allowing the termination of instances
27
+ * that are in <code>Standby</code> state or protected from scale in. You can monitor for
28
+ * failed EC2 launches using the scaling activities. To find the scaling activities, call
29
+ * the <a>DescribeScalingActivities</a> API.</p>
30
+ * <p>If you enable auto rollback, your Auto Scaling group will be rolled back automatically when
31
+ * the instance refresh fails. You can enable this feature before starting an instance
32
+ * refresh by specifying the <code>AutoRollback</code> property in the instance refresh
33
+ * preferences. Otherwise, to roll back an instance refresh before it finishes, use the
34
+ * <a>RollbackInstanceRefresh</a> API. </p>
26
35
  * @example
27
36
  * Use a bare-bones client and the command you need to make an API call.
28
37
  * ```javascript
@@ -55,6 +55,7 @@ export * from "./PutScheduledUpdateGroupActionCommand";
55
55
  export * from "./PutWarmPoolCommand";
56
56
  export * from "./RecordLifecycleActionHeartbeatCommand";
57
57
  export * from "./ResumeProcessesCommand";
58
+ export * from "./RollbackInstanceRefreshCommand";
58
59
  export * from "./SetDesiredCapacityCommand";
59
60
  export * from "./SetInstanceHealthCommand";
60
61
  export * from "./SetInstanceProtectionCommand";
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;