AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the TerminateInstanceInAutoScalingGroup operation. 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 Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C#
public class TerminateInstanceInAutoScalingGroupRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The TerminateInstanceInAutoScalingGroupRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the instance.

Public Property ShouldDecrementDesiredCapacity System.Boolean

Gets and sets the property ShouldDecrementDesiredCapacity.

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

Examples

This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.

To terminate an instance in an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.TerminateInstanceInAutoScalingGroup(new TerminateInstanceInAutoScalingGroupRequest 
{
    InstanceId = "i-93633f9b",
    ShouldDecrementDesiredCapacity = false
});


            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5