aws_sdk_autoscaling/client/
cancel_instance_refresh.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CancelInstanceRefresh`](crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`auto_scaling_group_name(impl Into<String>)`](crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder::auto_scaling_group_name) / [`set_auto_scaling_group_name(Option<String>)`](crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder::set_auto_scaling_group_name):<br>required: **true**<br><p>The name of the Auto Scaling group.</p><br>
7    ///   - [`wait_for_transitioning_instances(bool)`](crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder::wait_for_transitioning_instances) / [`set_wait_for_transitioning_instances(Option<bool>)`](crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder::set_wait_for_transitioning_instances):<br>required: **false**<br><p>When cancelling an instance refresh, this indicates whether to wait for in-flight launches and terminations to complete. The default is true.</p> <p>When set to false, Amazon EC2 Auto Scaling cancels the instance refresh without waiting for any pending launches or terminations to complete.</p><br>
8    /// - On success, responds with [`CancelInstanceRefreshOutput`](crate::operation::cancel_instance_refresh::CancelInstanceRefreshOutput) with field(s):
9    ///   - [`instance_refresh_id(Option<String>)`](crate::operation::cancel_instance_refresh::CancelInstanceRefreshOutput::instance_refresh_id): <p>The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.</p>
10    /// - On failure, responds with [`SdkError<CancelInstanceRefreshError>`](crate::operation::cancel_instance_refresh::CancelInstanceRefreshError)
11    pub fn cancel_instance_refresh(&self) -> crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder {
12        crate::operation::cancel_instance_refresh::builders::CancelInstanceRefreshFluentBuilder::new(self.handle.clone())
13    }
14}