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,
  WaitForTransitioningInstances)

Arguments

AutoScalingGroupName	[required] The name of the Auto Scaling group.
WaitForTransitioningInstances	When cancelling an instance refresh, this indicates whether to wait for in-flight launches and terminations to complete. The default is true. When set to false, Amazon EC2 Auto Scaling cancels the instance refresh without waiting for any pending launches or terminations to complete.

Value

A list with the following syntax:

list(
  InstanceRefreshId = "string"
)

Request syntax

svc$cancel_instance_refresh(
  AutoScalingGroupName = "string",
  WaitForTransitioningInstances = TRUE|FALSE
)

Examples

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

## End(Not run)