Container for the parameters to the EnterStandby operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.AutoScaling.AmazonAutoScalingRequest
Amazon.AutoScaling.Model.EnterStandbyRequest
Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z
Syntax
public class EnterStandbyRequest : AmazonAutoScalingRequest IAmazonWebServiceRequest
The EnterStandbyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
EnterStandbyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AutoScalingGroupName | System.String |
Gets and sets the property AutoScalingGroupName. The name of the Auto Scaling group. |
|
|
InstanceIds | System.Collections.Generic.List<System.String> |
Gets and sets the property InstanceIds. The IDs of the instances. You can specify up to 20 instances. |
|
|
ShouldDecrementDesiredCapacity | System.Boolean |
Gets and sets the property ShouldDecrementDesiredCapacity.
Indicates whether to decrement the desired capacity of the Auto Scaling group by the
number of instances moved to |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5