autoscaling_delete_auto_scaling_group: Deletes the specified Auto Scaling group

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call the detach_instances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call the update_auto_scaling_group API and set the minimum size and desired capacity of the Auto Scaling group to zero.

Usage

1
autoscaling_delete_auto_scaling_group(AutoScalingGroupName, ForceDelete)

Arguments

AutoScalingGroupName

[required] The name of the Auto Scaling group.

ForceDelete

Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

Value

An empty list.

Request syntax

1
2
3
4
svc$delete_auto_scaling_group(
  AutoScalingGroupName = "string",
  ForceDelete = TRUE|FALSE
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
# This example deletes the specified Auto Scaling group.
svc$delete_auto_scaling_group(
  AutoScalingGroupName = "my-auto-scaling-group"
)

# This example deletes the specified Auto Scaling group and all its
# instances.
svc$delete_auto_scaling_group(
  AutoScalingGroupName = "my-auto-scaling-group",
  ForceDelete = TRUE
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.