Skip to content

/AWS1/CL_OWX=>SETLOADBASEDAUTOSCALING()

About SetLoadBasedAutoScaling

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.

Method Signature

IMPORTING

Required arguments:

IV_LAYERID TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The layer ID.

Optional arguments:

IV_ENABLE TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

Enables load-based auto scaling for the layer.

IO_UPSCALING TYPE REF TO /AWS1/CL_OWXAUTOSCTHRESHOLDS /AWS1/CL_OWXAUTOSCTHRESHOLDS

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified number of instances.

IO_DOWNSCALING TYPE REF TO /AWS1/CL_OWXAUTOSCTHRESHOLDS /AWS1/CL_OWXAUTOSCTHRESHOLDS

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified number of instances.