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 EnterStandby operation. Moves the specified instances into the standby state.

For more information, see Temporarily Removing 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.EnterStandbyRequest

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

Syntax

C#
public class EnterStandbyRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The EnterStandbyRequest type exposes the following members

Constructors

NameDescription
Public Method EnterStandbyRequest()

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

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

Gets and sets the property InstanceIds.

One or more instances to move into Standby mode. You must specify at least one instance ID.

Public Property ShouldDecrementDesiredCapacity System.Boolean

Gets and sets the property ShouldDecrementDesiredCapacity.

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Examples

This example puts the specified instance into standby mode.

To move instances into standby mode


var response = client.EnterStandby(new EnterStandbyRequest 
{
    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