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 UpdateAutoScalingGroup operation. Updates the configuration for the specified Auto Scaling group.

The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

Note the following:

Inheritance Hierarchy

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

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

Syntax

C#
public class UpdateAutoScalingGroupRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The UpdateAutoScalingGroupRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

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

Gets and sets the property AvailabilityZones.

One or more Availability Zones for the group.

Public Property DefaultCooldown System.Int32

Gets and sets the property DefaultCooldown.

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

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. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

Public Property HealthCheckGracePeriod System.Int32

Gets and sets the property HealthCheckGracePeriod.

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.

For more information, see Health Checks in the Auto Scaling User Guide.

Public Property HealthCheckType System.String

Gets and sets the property HealthCheckType.

The service to use for the health checks. The valid values are EC2 and ELB.

Public Property LaunchConfigurationName System.String

Gets and sets the property LaunchConfigurationName.

The name of the launch configuration.

Public Property MaxSize System.Int32

Gets and sets the property MaxSize.

The maximum size of the Auto Scaling group.

Public Property MinSize System.Int32

Gets and sets the property MinSize.

The minimum size of the Auto Scaling group.

Public Property NewInstancesProtectedFromScaleIn System.Boolean

Gets and sets the property NewInstancesProtectedFromScaleIn.

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

Public Property PlacementGroup System.String

Gets and sets the property PlacementGroup.

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

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

Gets and sets the property TerminationPolicies.

A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.

Public Property VPCZoneIdentifier System.String

Gets and sets the property VPCZoneIdentifier.

The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets' Availability Zones match the values you specify for AvailabilityZones.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Examples

This example updates the launch configuration of the specified Auto Scaling group.

To update the launch configuration


var response = client.UpdateAutoScalingGroup(new UpdateAutoScalingGroupRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    LaunchConfigurationName = "new-launch-config"
});


            

This example updates the minimum size and maximum size of the specified Auto Scaling group.

To update the minimum and maximum size


var response = client.UpdateAutoScalingGroup(new UpdateAutoScalingGroupRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    MaxSize = 3,
    MinSize = 1
});


            

This example enables instance protection for the specified Auto Scaling group.

To enable instance protection


var response = client.UpdateAutoScalingGroup(new UpdateAutoScalingGroupRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    NewInstancesProtectedFromScaleIn = 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