Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

TerminateInstanceInAutoScalingGroupCommand

Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.

This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, TerminateInstanceInAutoScalingGroupCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, TerminateInstanceInAutoScalingGroupCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // TerminateInstanceInAutoScalingGroupType
  InstanceId: "STRING_VALUE", // required
  ShouldDecrementDesiredCapacity: true || false, // required
};
const command = new TerminateInstanceInAutoScalingGroupCommand(input);
const response = await client.send(command);
// { // ActivityType
//   Activity: { // Activity
//     ActivityId: "STRING_VALUE", // required
//     AutoScalingGroupName: "STRING_VALUE", // required
//     Description: "STRING_VALUE",
//     Cause: "STRING_VALUE", // required
//     StartTime: new Date("TIMESTAMP"), // required
//     EndTime: new Date("TIMESTAMP"),
//     StatusCode: "PendingSpotBidPlacement" || "WaitingForSpotInstanceRequestId" || "WaitingForSpotInstanceId" || "WaitingForInstanceId" || "PreInService" || "InProgress" || "WaitingForELBConnectionDraining" || "MidLifecycleAction" || "WaitingForInstanceWarmup" || "Successful" || "Failed" || "Cancelled" || "WaitingForConnectionDraining", // required
//     StatusMessage: "STRING_VALUE",
//     Progress: Number("int"),
//     Details: "STRING_VALUE",
//     AutoScalingGroupState: "STRING_VALUE",
//     AutoScalingGroupARN: "STRING_VALUE",
//   },
// };

Example Usage

There was an error loading the code editor. Retry