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[]>
-MixedInstancesPolicy <MixedInstancesPolicy>
-NewInstancesProtectedFromScaleIn <Boolean>
-PlacementGroup <String>
-ServiceLinkedRoleARN <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, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

Parameters

-AutoScalingGroupName <String>
The name of the Auto Scaling group. This name must be unique per Region per 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 for VPCZoneIdentifier.Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
Required?False
Position?Named
Accept pipeline input?False
AliasesAvailabilityZones
-DefaultCooldown <Int32>
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
-DesiredCapacity <Int32>
The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. 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 Amazon EC2 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 value is 0.For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.Conditional: This parameter is required if you are adding an ELB health check.
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. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 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.When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchConfigurationName <String>
The name of the launch configuration.For more information, see Creating an Auto Scaling Group Using a Launch Configuration in the Amazon EC2 Auto Scaling User Guide.If you do not specify LaunchConfigurationName, you must specify one of the following parameters: InstanceId, LaunchTemplate, or MixedInstancesPolicy.
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, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
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[]>
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead.For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
AliasesLoadBalancerNames
-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
-MixedInstancesPolicy <MixedInstancesPolicy>
An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.
Required?False
Position?Named
Accept pipeline input?False
-NewInstancesProtectedFromScaleIn <Boolean>
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
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 to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
Required?False
Position?Named
Accept pipeline input?False
-ServiceLinkedRoleARN <String>
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling 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 Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
AliasesTags
-TargetGroupARNs <String[]>
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group.For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
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 Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?False
AliasesTerminationPolicies
-VPCZoneIdentifier <String>
A comma-separated list of subnet IDs for your virtual private cloud (VPC).If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
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