Set Load Based Auto Scaling

opsworks_set_load_based_auto_scaling

R Documentation

Specify the load-based auto scaling configuration for a specified layer¶

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.

Usage¶

opsworks_set_load_based_auto_scaling(LayerId, Enable, UpScaling,
  DownScaling)

Arguments¶

LayerId: [required] The layer ID.
Enable: Enables load-based auto scaling for the layer.
UpScaling: 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.
DownScaling: 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.

Value¶

An empty list.

Request syntax¶

svc$set_load_based_auto_scaling(
  LayerId = "string",
  Enable = TRUE|FALSE,
  UpScaling = list(
    InstanceCount = 123,
    ThresholdsWaitTime = 123,
    IgnoreMetricsTime = 123,
    CpuThreshold = 123.0,
    MemoryThreshold = 123.0,
    LoadThreshold = 123.0,
    Alarms = list(
      "string"
    )
  ),
  DownScaling = list(
    InstanceCount = 123,
    ThresholdsWaitTime = 123,
    IgnoreMetricsTime = 123,
    CpuThreshold = 123.0,
    MemoryThreshold = 123.0,
    LoadThreshold = 123.0,
    Alarms = list(
      "string"
    )
  )
)