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 Application Auto Scaling PutScalingPolicy API operation.

Syntax

Set-AASScalingPolicy
-ServiceNamespace <ServiceNamespace>
-StepScalingPolicyConfiguration_AdjustmentType <AdjustmentType>
-StepScalingPolicyConfiguration_Cooldown <Int32>
-CustomizedMetricSpecification_Dimension <MetricDimension[]>
-TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
-StepScalingPolicyConfiguration_MetricAggregationType <MetricAggregationType>
-CustomizedMetricSpecification_MetricName <String>
-CustomizedMetricSpecification_Metric <TargetTrackingMetricDataQuery[]>
-StepScalingPolicyConfiguration_MinAdjustmentMagnitude <Int32>
-CustomizedMetricSpecification_Namespace <String>
-PolicyName <String>
-PolicyType <PolicyType>
-PredefinedMetricSpecification_PredefinedMetricType <MetricType>
-ResourceId <String>
-PredefinedMetricSpecification_ResourceLabel <String>
-ScalableDimension <ScalableDimension>
-TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
-TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
-CustomizedMetricSpecification_Statistic <MetricStatistic>
-StepScalingPolicyConfiguration_StepAdjustment <StepAdjustment[]>
-TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
-CustomizedMetricSpecification_Unit <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonApplicationAutoScalingConfig>

Description

Creates or updates a scaling policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target. Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again. For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.

Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Write-AASScalingPolicy.

Parameters

-ClientConfig <AmazonApplicationAutoScalingConfig>
Amazon.PowerShell.Cmdlets.AAS.AmazonApplicationAutoScalingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomizedMetricSpecification_Dimension <MetricDimension[]>
The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_CustomizedMetricSpecification_Dimensions
-CustomizedMetricSpecification_Metric <TargetTrackingMetricDataQuery[]>
The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_CustomizedMetricSpecification_Metrics
-CustomizedMetricSpecification_MetricName <String>
The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_CustomizedMetricSpecification_MetricName
-CustomizedMetricSpecification_Namespace <String>
The namespace of the metric.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_CustomizedMetricSpecification_Namespace
-CustomizedMetricSpecification_Statistic <MetricStatistic>
The statistic of the metric.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_CustomizedMetricSpecification_Statistic
-CustomizedMetricSpecification_Unit <String>
The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_CustomizedMetricSpecification_Unit
-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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ServiceNamespace parameter. The -PassThru parameter is deprecated, use -Select '^ServiceNamespace' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyName <String>
The name of the scaling policy.You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyType <PolicyType>
The scaling policy type. This parameter is required if you are creating a scaling policy.The following policy types are supported: TargetTrackingScaling—Not supported for Amazon EMR.StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PredefinedMetricSpecification_PredefinedMetricType <MetricType>
The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_PredefinedMetricSpecification_PredefinedMetricType
-PredefinedMetricSpecification_ResourceLabel <String>
Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.Where:
  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargetTrackingScalingPolicyConfiguration_PredefinedMetricSpecification_ResourceLabel
-ResourceId <String>
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
  • Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  • DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  • DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  • SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  • Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  • Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  • Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  • Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  • Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  • Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  • Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  • SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScalableDimension <ScalableDimension>
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
  • ecs:service:DesiredCount - The desired task count of an ECS service.
  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  • comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  • comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  • lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  • cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  • cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  • kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  • elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  • elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  • neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  • sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
  • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationAutoScaling.Model.PutScalingPolicyResponse). Specifying the name of a property of type Amazon.ApplicationAutoScaling.Model.PutScalingPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceNamespace <ServiceNamespace>
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-StepScalingPolicyConfiguration_AdjustmentType <AdjustmentType>
Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.AdjustmentType is required if you are adding a new step scaling policy configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StepScalingPolicyConfiguration_Cooldown <Int32>
The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StepScalingPolicyConfiguration_MetricAggregationType <MetricAggregationType>
The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StepScalingPolicyConfiguration_MinAdjustmentMagnitude <Int32>
The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StepScalingPolicyConfiguration_StepAdjustment <StepAdjustment[]>
A set of adjustments that enable you to scale based on the size of the alarm breach.At least one step adjustment is required if you are adding a new step scaling policy configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStepScalingPolicyConfiguration_StepAdjustments
-TargetTrackingScalingPolicyConfiguration_DisableScaleIn <Boolean>
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetTrackingScalingPolicyConfiguration_ScaleInCooldown <Int32>
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown <Int32>
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetTrackingScalingPolicyConfiguration_TargetValue <Double>
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.
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

Amazon.ApplicationAutoScaling.Model.PutScalingPolicyResponse
This cmdlet returns an Amazon.ApplicationAutoScaling.Model.PutScalingPolicyResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

Set-AASScalingPolicy -ServiceNamespace AppStream -PolicyName ASFleetScaleInPolicy -PolicyType StepScaling  -ResourceId fleet/MyFleet -ScalableDimension appstream:fleet:DesiredCapacity -StepScalingPolicyConfiguration_AdjustmentType ChangeInCapacity -StepScalingPolicyConfiguration_Cooldown 360 -StepScalingPolicyConfiguration_MetricAggregationType Average -StepScalingPolicyConfiguration_StepAdjustments @{ScalingAdjustment = -1; MetricIntervalUpperBound = 0}

Alarms    PolicyARN
------    ---------
{}        arn:aws:autoscaling:us-west-2:012345678912:scalingPolicy:4897ca24-3caa-4bf1-8484-851a089b243c:resource/appstream/fleet/MyFleet:policyName/ASFleetScaleInPolicy
This cmdlet creates or updates a policy for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension.
AWS Tools for PowerShell User Guide

Supported Version

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