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

Calls the Auto Scaling CreateAutoScalingGroup API operation.

Syntax

New-ASAutoScalingGroup
-AutoScalingGroupName <String>
-LaunchConfigurationName <String>
-MinSize <Int32>
-MaxSize <Int32>
-AvailabilityZone <String[]>
-DefaultCooldown <Int32>
-DesiredCapacity <Int32>
-HealthCheckGracePeriod <Int32>
-HealthCheckType <String>
-InstanceId <String>
-LaunchTemplate_LaunchTemplateId <String>
-LaunchTemplate_LaunchTemplateName <String>
-LifecycleHookSpecificationList <LifecycleHookSpecification[]>
-LoadBalancerName <String[]>
-NewInstancesProtectedFromScaleIn <Boolean>
-PlacementGroup <String>
-Tag <Tag[]>
-TargetGroupARNs <String[]>
-TerminationPolicy <String[]>
-LaunchTemplate_Version <String>
-VPCZoneIdentifier <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits. For more information, see Auto Scaling Groups in the Auto Scaling User Guide.

Parameters

-AutoScalingGroupName <String>
The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AvailabilityZone <String[]>
One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.
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 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. If you do not specify a desired capacity, the default is the minimum size of the group.
Required?False
Position?Named
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. During this time, any health check failures for the instance are ignored. The default is 0.This parameter is required if you are adding an ELB health check.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.By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
-InstanceId <String>
The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchConfigurationName <String>
The name of the launch configuration. You must specify one of the following: a launch configuration, a launch template, or an EC2 instance.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-LaunchTemplate_LaunchTemplateId <String>
The ID of the launch template. You must specify either a template ID or a template name.
Required?False
Position?Named
Accept pipeline input?False
-LaunchTemplate_LaunchTemplateName <String>
The name of the launch template. You must specify either a template name or a template ID.
Required?False
Position?Named
Accept pipeline input?False
-LaunchTemplate_Version <String>
The version number. By default, the default version of the launch template is used.
Required?False
Position?Named
Accept pipeline input?False
-LifecycleHookSpecificationList <LifecycleHookSpecification[]>
One or more lifecycle hooks.
Required?False
Position?Named
Accept pipeline input?False
-LoadBalancerName <String[]>
One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
-MaxSize <Int32>
The maximum size of the group.
Required?False
Position?4
Accept pipeline input?False
-MinSize <Int32>
The minimum size of the 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
-Tag <Tag[]>
One or more tags.For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
-TargetGroupARNs <String[]>
The Amazon Resource Names (ARN) of the target groups.
Required?False
Position?Named
Accept pipeline input?False
-TerminationPolicy <String[]>
One or more termination policies used to select the instance to terminate. These 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>
A comma-separated list of subnet identifiers for your virtual private cloud (VPC).If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.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.CreateAutoScalingGroupResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> New-ASAutoScalingGroup -AutoScalingGroupName my-asg -LaunchConfigurationName my-lc -MinSize 2 -MaxSize 6 -AvailabilityZone @("us-west-2a", "us-west-2b")
This example creates an Auto Scaling group with the specified name and attributes. The default desired capacity is the minimum size. Therefore, this Auto Scaling group launches two instances, one in each of the specified two Availability Zones.

Supported Version

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