AmazonAutoScalingClient.EnterStandby Method (EnterStandbyRequest)

Moves the specified instances into the standby state.

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.

For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to EnterStandbyAsync.

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

Syntax

public virtual EnterStandbyResponse EnterStandby(
         EnterStandbyRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.EnterStandbyRequest

Container for the necessary parameters to execute the EnterStandby service method.

Return Value

Type: EnterStandbyResponse

The response from the EnterStandby service method, as returned by AutoScaling.

Exceptions

Exception	Condition
ResourceContentionException	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

Examples

This example puts the specified instance into standby mode.

To move instances into standby mode


var client = new AmazonAutoScalingClient();
var response = client.EnterStandby(new EnterStandbyRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    InstanceIds = new List<string> {
        "i-93633f9b"
    },
    ShouldDecrementDesiredCapacity = true
});

List<Activity> activities = response.Activities;

Version Information

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

AmazonAutoScalingClient.EnterStandby (EnterStandbyRequest)

Method