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 AWS Auto Scaling CreateAutoScalingGroup API operation.

Syntax

New-ASAutoScalingGroup
-AutoScalingGroupName <String>
-LaunchConfigurationName <String>
-MinSize <Int32>
-MaxSize <Int32>
-AvailabilityZone <String[]>
-AvailabilityZoneDistribution_CapacityDistributionStrategy <CapacityDistributionStrategy>
-CapacityRebalance <Boolean>
-CapacityReservationTarget_CapacityReservationId <String[]>
-CapacityReservationSpecification_CapacityReservationPreference <CapacityReservationPreference>
-CapacityReservationTarget_CapacityReservationResourceGroupArn <String[]>
-Context <String>
-DefaultCooldown <Int32>
-DefaultInstanceWarmup <Int32>
-DesiredCapacity <Int32>
-DesiredCapacityType <String>
-HealthCheckGracePeriod <Int32>
-HealthCheckType <String>
-AvailabilityZoneImpairmentPolicy_ImpairedZoneHealthCheckBehavior <ImpairedZoneHealthCheckBehavior>
-InstanceId <String>
-LaunchTemplate_LaunchTemplateId <String>
-LaunchTemplate_LaunchTemplateName <String>
-LifecycleHookSpecificationList <LifecycleHookSpecification[]>
-LoadBalancerName <String[]>
-InstanceMaintenancePolicy_MaxHealthyPercentage <Int32>
-MaxInstanceLifetime <Int32>
-InstanceMaintenancePolicy_MinHealthyPercentage <Int32>
-MixedInstancesPolicy <MixedInstancesPolicy>
-NewInstancesProtectedFromScaleIn <Boolean>
-PlacementGroup <String>
-ServiceLinkedRoleARN <String>
-SkipZonalShiftValidation <Boolean>
-Tag <Tag[]>
-TargetGroupARNs <String[]>
-TerminationPolicy <String[]>
-TrafficSource <TrafficSourceIdentifier[]>
-LaunchTemplate_Version <String>
-VPCZoneIdentifier <String>
-AvailabilityZoneImpairmentPolicy_ZonalShiftEnabled <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonAutoScalingConfig>

Description

We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

Parameters

-AutoScalingGroupName <String>
The name of the Auto Scaling group. This name must be unique per Region per account.The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.You cannot use a colon (:) in the name.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AvailabilityZone <String[]>
A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAvailabilityZones
-AvailabilityZoneDistribution_CapacityDistributionStrategy <CapacityDistributionStrategy>
If launches fail in an Availability Zone, the following strategies are available. The default is balanced-best-effort.
  • balanced-only - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.
  • balanced-best-effort - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZoneImpairmentPolicy_ImpairedZoneHealthCheckBehavior <ImpairedZoneHealthCheckBehavior>
Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select Replace unhealthy, instances that appear unhealthy will be replaced in all Availability Zones. If you select Ignore unhealthy, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZoneImpairmentPolicy_ZonalShiftEnabled <Boolean>
If true, enable zonal shift for your Auto Scaling group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CapacityRebalance <Boolean>
Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CapacityReservationSpecification_CapacityReservationPreference <CapacityReservationPreference>
The capacity reservation preference. The following options are available:
  • capacity-reservations-only - Auto Scaling will only launch instances into a Capacity Reservation or Capacity Reservation resource group. If capacity isn't available, instances will fail to launch.
  • capacity-reservations-first - Auto Scaling will try to launch instances into a Capacity Reservation or Capacity Reservation resource group first. If capacity isn't available, instances will run in On-Demand capacity.
  • none - Auto Scaling will not launch instances into a Capacity Reservation. Instances will run in On-Demand capacity.
  • default - Auto Scaling uses the Capacity Reservation preference from your launch template or an open Capacity Reservation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CapacityReservationTarget_CapacityReservationId <String[]>
The Capacity Reservation IDs to launch instances into.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacityReservationSpecification_CapacityReservationTarget_CapacityReservationIds
-CapacityReservationTarget_CapacityReservationResourceGroupArn <String[]>
The resource group ARNs of the Capacity Reservation to launch instances into.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapacityReservationSpecification_CapacityReservationTarget_CapacityReservationResourceGroupArns
-ClientConfig <AmazonAutoScalingConfig>
Amazon.PowerShell.Cmdlets.AS.AmazonAutoScalingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context <String>
Reserved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultCooldown <Int32>
Only needed if you use simple scaling policies.The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.Default: 300 seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultInstanceWarmup <Int32>
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.Default: None
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DesiredCapacity <Int32>
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. 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?True (ByPropertyName)
-DesiredCapacityType <String>
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.Valid values: units | vcpu | memory-mib
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-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 and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.Default: 0 seconds
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HealthCheckType <String>
A comma-separated value string of one or more health check types.The valid values are EC2, EBS, ELB, and VPC_LATTICE. EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.Only specify EC2 if you must clear a value that was previously set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceMaintenancePolicy_MaxHealthyPercentage <Int32>
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of -1.Both MinHealthyPercentage and MaxHealthyPercentage must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceMaintenancePolicy_MinHealthyPercentage <Int32>
Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of -1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchConfigurationName <String>
The name of the launch configuration to use to launch instances. Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-LaunchTemplate_LaunchTemplateId <String>
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchTemplate_LaunchTemplateName <String>
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API. Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchTemplate_Version <String>
The version number, $Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. 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?True (ByPropertyName)
-LifecycleHookSpecificationList <LifecycleHookSpecification[]>
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoadBalancerName <String[]>
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerNames
-MaxInstanceLifetime <Int32>
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxSize <Int32>
The maximum size of the group.With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).
Required?True
Position?4
Accept pipeline input?True (ByPropertyName)
-MinSize <Int32>
The minimum size of the group.
Required?True
Position?3
Accept pipeline input?True (ByPropertyName)
-MixedInstancesPolicy <MixedInstancesPolicy>
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AutoScalingGroupName parameter. The -PassThru parameter is deprecated, use -Select '^AutoScalingGroupName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PlacementGroup <String>
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AutoScaling.Model.CreateAutoScalingGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceLinkedRoleARN <String>
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services service 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?True (ByPropertyName)
-SkipZonalShiftValidation <Boolean>
If you enable zonal shift with cross-zone disabled load balancers, capacity could become imbalanced across Availability Zones. To skip the validation, specify true. For more information, see Auto Scaling group zonal shift in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TargetGroupARNs <String[]>
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TerminationPolicy <String[]>
A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTerminationPolicies
-TrafficSource <TrafficSourceIdentifier[]>
The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrafficSources
-VPCZoneIdentifier <String>
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.AutoScaling.Model.CreateAutoScalingGroupResponse
This cmdlet does not generate any output.The service response (type Amazon.AutoScaling.Model.CreateAutoScalingGroupResponse) be returned by specifying '-Select *'.

Examples

Example 1

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.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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