#[non_exhaustive]pub struct InstanceRefreshBuilder { /* private fields */ }Expand description
A builder for InstanceRefresh.
Implementations§
Source§impl InstanceRefreshBuilder
impl InstanceRefreshBuilder
Sourcepub fn instance_refresh_id(self, input: impl Into<String>) -> Self
pub fn instance_refresh_id(self, input: impl Into<String>) -> Self
The instance refresh ID.
Sourcepub fn set_instance_refresh_id(self, input: Option<String>) -> Self
pub fn set_instance_refresh_id(self, input: Option<String>) -> Self
The instance refresh ID.
Sourcepub fn get_instance_refresh_id(&self) -> &Option<String>
pub fn get_instance_refresh_id(&self) -> &Option<String>
The instance refresh ID.
Sourcepub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self
pub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self
The name of the Auto Scaling group.
Sourcepub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self
pub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self
The name of the Auto Scaling group.
Sourcepub fn get_auto_scaling_group_name(&self) -> &Option<String>
pub fn get_auto_scaling_group_name(&self) -> &Option<String>
The name of the Auto Scaling group.
Sourcepub fn status(self, input: InstanceRefreshStatus) -> Self
pub fn status(self, input: InstanceRefreshStatus) -> Self
The current status for the instance refresh operation:
-
Pending- The request was created, but the instance refresh has not started. -
InProgress- An instance refresh is in progress. -
Successful- An instance refresh completed successfully. -
Failed- An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities. -
Cancelling- An ongoing instance refresh is being cancelled. -
Cancelled- The instance refresh is cancelled. -
RollbackInProgress- An instance refresh is being rolled back. -
RollbackFailed- The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities. -
RollbackSuccessful- The rollback completed successfully. -
Baking- Waiting the specified bake time after an instance refresh has finished updating instances.
Sourcepub fn set_status(self, input: Option<InstanceRefreshStatus>) -> Self
pub fn set_status(self, input: Option<InstanceRefreshStatus>) -> Self
The current status for the instance refresh operation:
-
Pending- The request was created, but the instance refresh has not started. -
InProgress- An instance refresh is in progress. -
Successful- An instance refresh completed successfully. -
Failed- An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities. -
Cancelling- An ongoing instance refresh is being cancelled. -
Cancelled- The instance refresh is cancelled. -
RollbackInProgress- An instance refresh is being rolled back. -
RollbackFailed- The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities. -
RollbackSuccessful- The rollback completed successfully. -
Baking- Waiting the specified bake time after an instance refresh has finished updating instances.
Sourcepub fn get_status(&self) -> &Option<InstanceRefreshStatus>
pub fn get_status(&self) -> &Option<InstanceRefreshStatus>
The current status for the instance refresh operation:
-
Pending- The request was created, but the instance refresh has not started. -
InProgress- An instance refresh is in progress. -
Successful- An instance refresh completed successfully. -
Failed- An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities. -
Cancelling- An ongoing instance refresh is being cancelled. -
Cancelled- The instance refresh is cancelled. -
RollbackInProgress- An instance refresh is being rolled back. -
RollbackFailed- The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities. -
RollbackSuccessful- The rollback completed successfully. -
Baking- Waiting the specified bake time after an instance refresh has finished updating instances.
Sourcepub fn status_reason(self, input: impl Into<String>) -> Self
pub fn status_reason(self, input: impl Into<String>) -> Self
The explanation for the specific status assigned to this operation.
Sourcepub fn set_status_reason(self, input: Option<String>) -> Self
pub fn set_status_reason(self, input: Option<String>) -> Self
The explanation for the specific status assigned to this operation.
Sourcepub fn get_status_reason(&self) -> &Option<String>
pub fn get_status_reason(&self) -> &Option<String>
The explanation for the specific status assigned to this operation.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The date and time at which the instance refresh began.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The date and time at which the instance refresh began.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The date and time at which the instance refresh began.
Sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
The date and time at which the instance refresh ended.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The date and time at which the instance refresh ended.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The date and time at which the instance refresh ended.
Sourcepub fn percentage_complete(self, input: i32) -> Self
pub fn percentage_complete(self, input: i32) -> Self
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
Sourcepub fn set_percentage_complete(self, input: Option<i32>) -> Self
pub fn set_percentage_complete(self, input: Option<i32>) -> Self
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
Sourcepub fn get_percentage_complete(&self) -> &Option<i32>
pub fn get_percentage_complete(&self) -> &Option<i32>
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
Sourcepub fn instances_to_update(self, input: i32) -> Self
pub fn instances_to_update(self, input: i32) -> Self
The number of instances remaining to update before the instance refresh is complete.
If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
Sourcepub fn set_instances_to_update(self, input: Option<i32>) -> Self
pub fn set_instances_to_update(self, input: Option<i32>) -> Self
The number of instances remaining to update before the instance refresh is complete.
If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
Sourcepub fn get_instances_to_update(&self) -> &Option<i32>
pub fn get_instances_to_update(&self) -> &Option<i32>
The number of instances remaining to update before the instance refresh is complete.
If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
Sourcepub fn progress_details(self, input: InstanceRefreshProgressDetails) -> Self
pub fn progress_details(self, input: InstanceRefreshProgressDetails) -> Self
Additional progress details for an Auto Scaling group that has a warm pool.
Sourcepub fn set_progress_details(
self,
input: Option<InstanceRefreshProgressDetails>,
) -> Self
pub fn set_progress_details( self, input: Option<InstanceRefreshProgressDetails>, ) -> Self
Additional progress details for an Auto Scaling group that has a warm pool.
Sourcepub fn get_progress_details(&self) -> &Option<InstanceRefreshProgressDetails>
pub fn get_progress_details(&self) -> &Option<InstanceRefreshProgressDetails>
Additional progress details for an Auto Scaling group that has a warm pool.
Sourcepub fn preferences(self, input: RefreshPreferences) -> Self
pub fn preferences(self, input: RefreshPreferences) -> Self
The preferences for an instance refresh.
Sourcepub fn set_preferences(self, input: Option<RefreshPreferences>) -> Self
pub fn set_preferences(self, input: Option<RefreshPreferences>) -> Self
The preferences for an instance refresh.
Sourcepub fn get_preferences(&self) -> &Option<RefreshPreferences>
pub fn get_preferences(&self) -> &Option<RefreshPreferences>
The preferences for an instance refresh.
Sourcepub fn desired_configuration(self, input: DesiredConfiguration) -> Self
pub fn desired_configuration(self, input: DesiredConfiguration) -> Self
Describes the desired configuration for the instance refresh.
Sourcepub fn set_desired_configuration(
self,
input: Option<DesiredConfiguration>,
) -> Self
pub fn set_desired_configuration( self, input: Option<DesiredConfiguration>, ) -> Self
Describes the desired configuration for the instance refresh.
Sourcepub fn get_desired_configuration(&self) -> &Option<DesiredConfiguration>
pub fn get_desired_configuration(&self) -> &Option<DesiredConfiguration>
Describes the desired configuration for the instance refresh.
Sourcepub fn rollback_details(self, input: RollbackDetails) -> Self
pub fn rollback_details(self, input: RollbackDetails) -> Self
The rollback details.
Sourcepub fn set_rollback_details(self, input: Option<RollbackDetails>) -> Self
pub fn set_rollback_details(self, input: Option<RollbackDetails>) -> Self
The rollback details.
Sourcepub fn get_rollback_details(&self) -> &Option<RollbackDetails>
pub fn get_rollback_details(&self) -> &Option<RollbackDetails>
The rollback details.
Sourcepub fn strategy(self, input: RefreshStrategy) -> Self
pub fn strategy(self, input: RefreshStrategy) -> Self
The strategy to use for the instance refresh. This determines how instances in the Auto Scaling group are updated. Default is Rolling.
-
Rolling– Terminates instances and launches replacements in batches -
ReplaceRootVolume– Updates instances by replacing only the root volume without terminating the instance
Sourcepub fn set_strategy(self, input: Option<RefreshStrategy>) -> Self
pub fn set_strategy(self, input: Option<RefreshStrategy>) -> Self
The strategy to use for the instance refresh. This determines how instances in the Auto Scaling group are updated. Default is Rolling.
-
Rolling– Terminates instances and launches replacements in batches -
ReplaceRootVolume– Updates instances by replacing only the root volume without terminating the instance
Sourcepub fn get_strategy(&self) -> &Option<RefreshStrategy>
pub fn get_strategy(&self) -> &Option<RefreshStrategy>
The strategy to use for the instance refresh. This determines how instances in the Auto Scaling group are updated. Default is Rolling.
-
Rolling– Terminates instances and launches replacements in batches -
ReplaceRootVolume– Updates instances by replacing only the root volume without terminating the instance
Sourcepub fn build(self) -> InstanceRefresh
pub fn build(self) -> InstanceRefresh
Consumes the builder and constructs a InstanceRefresh.
Trait Implementations§
Source§impl Clone for InstanceRefreshBuilder
impl Clone for InstanceRefreshBuilder
Source§fn clone(&self) -> InstanceRefreshBuilder
fn clone(&self) -> InstanceRefreshBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for InstanceRefreshBuilder
impl Debug for InstanceRefreshBuilder
Source§impl Default for InstanceRefreshBuilder
impl Default for InstanceRefreshBuilder
Source§fn default() -> InstanceRefreshBuilder
fn default() -> InstanceRefreshBuilder
Source§impl PartialEq for InstanceRefreshBuilder
impl PartialEq for InstanceRefreshBuilder
impl StructuralPartialEq for InstanceRefreshBuilder
Auto Trait Implementations§
impl Freeze for InstanceRefreshBuilder
impl RefUnwindSafe for InstanceRefreshBuilder
impl Send for InstanceRefreshBuilder
impl Sync for InstanceRefreshBuilder
impl Unpin for InstanceRefreshBuilder
impl UnwindSafe for InstanceRefreshBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);