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.

For more information about desired capacity, see What Is Auto Scaling? in the 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 number of EC2 instances that should be running in the Auto Scaling group.

Public Property HonorCooldown System.Boolean

Gets and sets the property HonorCooldown.

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

Examples

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

To set the desired capacity for an Auto Scaling group


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


            

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