paws.management (version 0.1.0)

autoscaling_enter_standby: Moves the specified instances into the standby state

Description

Moves the specified instances into the standby state.

Usage

autoscaling_enter_standby(InstanceIds, AutoScalingGroupName,
  ShouldDecrementDesiredCapacity)

Arguments

InstanceIds

The IDs of the instances. You can specify up to 20 instances.

AutoScalingGroupName

[required] The name of the Auto Scaling group.

ShouldDecrementDesiredCapacity

[required] Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

Request syntax

svc$enter_standby(
  InstanceIds = list(
    "string"
  ),
  AutoScalingGroupName = "string",
  ShouldDecrementDesiredCapacity = TRUE|FALSE
)

Details

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Examples

# NOT RUN {
# This example puts the specified instance into standby mode.
# }
# NOT RUN {
svc$enter_standby(
  AutoScalingGroupName = "my-auto-scaling-group",
  InstanceIds = list(
    "i-93633f9b"
  ),
  ShouldDecrementDesiredCapacity = TRUE
)
# }
# NOT RUN {
# }