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 OpsWorks SetLoadBasedAutoScaling API operation.

Syntax

Set-OPSLoadBasedAutoScaling
-LayerId <String>
-Enable <Boolean>
-DownScaling_Alarm <String[]>
-UpScaling_Alarm <String[]>
-DownScaling_CpuThreshold <Double>
-UpScaling_CpuThreshold <Double>
-DownScaling_IgnoreMetricsTime <Int32>
-UpScaling_IgnoreMetricsTime <Int32>
-DownScaling_InstanceCount <Int32>
-UpScaling_InstanceCount <Int32>
-DownScaling_LoadThreshold <Double>
-UpScaling_LoadThreshold <Double>
-DownScaling_MemoryThreshold <Double>
-UpScaling_MemoryThreshold <Double>
-DownScaling_ThresholdsWaitTime <Int32>
-UpScaling_ThresholdsWaitTime <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonOpsWorksConfig>

Description

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances. To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

-ClientConfig <AmazonOpsWorksConfig>
Amazon.PowerShell.Cmdlets.OPS.AmazonOpsWorksClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DownScaling_Alarm <String[]>
Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDownScaling_Alarms
-DownScaling_CpuThreshold <Double>
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DownScaling_IgnoreMetricsTime <Int32>
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DownScaling_InstanceCount <Int32>
The number of instances to add or remove when the load exceeds a threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DownScaling_LoadThreshold <Double>
The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DownScaling_MemoryThreshold <Double>
The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DownScaling_ThresholdsWaitTime <Int32>
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Enable <Boolean>
Enables load-based auto scaling for the layer.
Required?False
Position?2
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)
-LayerId <String>
The layer ID.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the LayerId parameter. The -PassThru parameter is deprecated, use -Select '^LayerId' instead. This parameter will be removed in a future version.
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.OpsWorks.Model.SetLoadBasedAutoScalingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpScaling_Alarm <String[]>
Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUpScaling_Alarms
-UpScaling_CpuThreshold <Double>
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpScaling_IgnoreMetricsTime <Int32>
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpScaling_InstanceCount <Int32>
The number of instances to add or remove when the load exceeds a threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpScaling_LoadThreshold <Double>
The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpScaling_MemoryThreshold <Double>
The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpScaling_ThresholdsWaitTime <Int32>
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
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.OpsWorks.Model.SetLoadBasedAutoScalingResponse
This cmdlet does not generate any output.The service response (type Amazon.OpsWorks.Model.SetLoadBasedAutoScalingResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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