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 SetDesiredCapacity operation. Sets the size of the specified Auto Scaling group.

If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.

Inheritance Hierarchy

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

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

Syntax

C#
public class SetDesiredCapacityRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The SetDesiredCapacityRequest type exposes the following members

Constructors

NameDescription
Public Method SetDesiredCapacityRequest()

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

Public Property DesiredCapacity System.Int32

Gets and sets the property DesiredCapacity.

The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.

Public Property HonorCooldown System.Boolean

Gets and sets the property HonorCooldown.

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

Examples

This example sets the desired capacity for the specified Auto Scaling group.

To set the desired capacity for an Auto Scaling group


var client = new AmazonAutoScalingClient();
var response = client.SetDesiredCapacity(new SetDesiredCapacityRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    DesiredCapacity = 2,
    HonorCooldown = true
});


            

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