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 DetachInstances operation. Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

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

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling User Guide.

Inheritance Hierarchy

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

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

Syntax

C#
public class DetachInstancesRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The DetachInstancesRequest type exposes the following members

Constructors

NameDescription
Public Method DetachInstancesRequest()

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the group.

Public Property InstanceIds System.Collections.Generic.List<System.String>

Gets and sets the property InstanceIds.

One or more instance IDs.

Public Property ShouldDecrementDesiredCapacity System.Boolean

Gets and sets the property ShouldDecrementDesiredCapacity.

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Examples

This example detaches the specified instance from the specified Auto Scaling group.

To detach an instance from an Auto Scaling group


var response = client.DetachInstances(new DetachInstancesRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    InstanceIds = new List {
        "i-93633f9b"
    },
    ShouldDecrementDesiredCapacity = true
});

List activities = response.Activities;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms