AmazonAutoScalingClient.SetDesiredCapacity Method (SetDesiredCapacityRequest)

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.

Note:

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

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

Syntax

public virtual SetDesiredCapacityResponse SetDesiredCapacity(
         SetDesiredCapacityRequest request
)

Parameters

request: Type: Amazon.AutoScaling.Model.SetDesiredCapacityRequest

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

Return Value

Type: SetDesiredCapacityResponse

The response from the SetDesiredCapacity 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).
ScalingActivityInProgressException	The operation can't be performed because there are scaling activities in progress.

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 Framework:
Supported in: 4.5, 4.0, 3.5

AmazonAutoScalingClient.SetDesiredCapacity (SetDesiredCapacityRequest)

Method