opsworks_set_load_based_auto_scaling: Specify the load-based auto scaling configuration for a...

Description Usage Arguments Value Request syntax

View source: R/opsworks_operations.R

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

1
2
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, AWS 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, AWS OpsWorks Stacks stops a specified number of instances.

Value

An empty list.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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"
    )
  )
)

paws.management documentation built on March 8, 2021, 1:07 a.m.