AWS Tools for Windows PowerShell
Command 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.

Synopsis

Invokes the UpdateAutoScalingGroup operation against Auto Scaling.

Syntax

Update-ASAutoScalingGroup
-AutoScalingGroupName <String>
-LaunchConfigurationName <String>
-MinSize <Int32>
-MaxSize <Int32>
-DesiredCapacity <Int32>
-AvailabilityZone <String[]>
-DefaultCooldown <Int32>
-HealthCheckGracePeriod <Int32>
-HealthCheckType <String>
-NewInstancesProtectedFromScaleIn <Boolean>
-PlacementGroup <String>
-TerminationPolicy <String[]>
-VPCZoneIdentifier <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Updates the configuration for the specified Auto Scaling group. 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. The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. Note the following:
  • If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.
  • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.
  • All other optional parameters are left unchanged if not specified.

Parameters

-AutoScalingGroupName <String>
The name of the Auto Scaling group.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AvailabilityZone <String[]>
One or more Availability Zones for the group.
Required?False
Position?Named
Accept pipeline input?False
-DefaultCooldown <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
-DesiredCapacity <Int32>
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.
Required?False
Position?5
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckGracePeriod <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
-HealthCheckType <String>
The service to use for the health checks. The valid values are EC2 and ELB.
Required?False
Position?Named
Accept pipeline input?False
-LaunchConfigurationName <String>
The name of the launch configuration.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-MaxSize <Int32>
The maximum size of the Auto Scaling group.
Required?False
Position?4
Accept pipeline input?False
-MinSize <Int32>
The minimum size of the Auto Scaling group.
Required?False
Position?3
Accept pipeline input?False
-NewInstancesProtectedFromScaleIn <Boolean>
Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
Required?False
Position?Named
Accept pipeline input?False
-PassThru <SwitchParameter>
Returns the value passed to the AutoScalingGroupName parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-PlacementGroup <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-TerminationPolicy <String[]>
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.
Required?False
Position?Named
Accept pipeline input?False
-VPCZoneIdentifier <String>
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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the AutoScalingGroupName parameter.

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the AutoScalingGroupName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.AutoScaling.Model.UpdateAutoScalingGroupResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -MaxSize 5 -MinSize 1
This example updates the minimum and maximum size of the specified Auto Scaling group.

Example 2

PS C:\> Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -DefaultCooldown 10
This example updates the default cooldown period of the specified Auto Scaling group.

Example 3

PS C:\> Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -AvailabilityZone @("us-west-2a", "us-west-2b")
This example updates the Availability Zones of the specified Auto Scaling group.

Example 4

PS C:\> Update-ASAutoScalingGroup -AutoScalingGroupName my-asg -HealthCheckType ELB -HealthCheckGracePeriod 60
This example updates the specified Auto Scaling group to use Elastic Load Balancing health checks.

Supported Version

AWS Tools for PowerShell: 2.x.y.z