[ aws . autoscaling ]
cancel-instance-refresh¶
Description¶
Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
cancel-instance-refresh
--auto-scaling-group-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--auto-scaling-group-name (string)
The name of the Auto Scaling group.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To cancel an instance refresh
The following cancel-instance-refresh example cancels an instance refresh operation in progress.
aws autoscaling cancel-instance-refresh \
--auto-scaling-group-name my-asg
Output:
{
"InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"
}
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh in the Amazon EC2 Auto Scaling User Guide.