Cancel Instance Refresh

autoscaling_cancel_instance_refresh

R Documentation

Cancels an instance refresh or rollback that is in progress¶

Description¶

Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.

This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

When you cancel an instance refresh, this does not roll back any changes that it made. Use the rollback_instance_refresh API to roll back instead.

Usage¶

autoscaling_cancel_instance_refresh(AutoScalingGroupName)

Arguments¶

AutoScalingGroupName: [required] The name of the Auto Scaling group.

Value¶

A list with the following syntax:

list(
  InstanceRefreshId = "string"
)

Request syntax¶

svc$cancel_instance_refresh(
  AutoScalingGroupName = "string"
)

Examples¶

## Not run: 
# This example cancels an instance refresh operation in progress.
svc$cancel_instance_refresh(
  AutoScalingGroupName = "my-auto-scaling-group"
)

## End(Not run)