#[non_exhaustive]pub struct ZonalShiftInResourceBuilder { /* private fields */ }
Expand description
A builder for ZonalShiftInResource
.
Implementations§
Source§impl ZonalShiftInResourceBuilder
impl ZonalShiftInResourceBuilder
Sourcepub fn applied_status(self, input: AppliedStatus) -> Self
pub fn applied_status(self, input: AppliedStatus) -> Self
The appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus
field for a shift that is in progress for a resource can have one of two values: APPLIED
or NOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus
set to APPLIED
.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.
This field is required.Sourcepub fn set_applied_status(self, input: Option<AppliedStatus>) -> Self
pub fn set_applied_status(self, input: Option<AppliedStatus>) -> Self
The appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus
field for a shift that is in progress for a resource can have one of two values: APPLIED
or NOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus
set to APPLIED
.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.
Sourcepub fn get_applied_status(&self) -> &Option<AppliedStatus>
pub fn get_applied_status(&self) -> &Option<AppliedStatus>
The appliedStatus
field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus
field for a shift that is in progress for a resource can have one of two values: APPLIED
or NOT_APPLIED
. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus
set to APPLIED
.
The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.
For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.
Sourcepub fn zonal_shift_id(self, input: impl Into<String>) -> Self
pub fn zonal_shift_id(self, input: impl Into<String>) -> Self
The identifier of a zonal shift.
This field is required.Sourcepub fn set_zonal_shift_id(self, input: Option<String>) -> Self
pub fn set_zonal_shift_id(self, input: Option<String>) -> Self
The identifier of a zonal shift.
Sourcepub fn get_zonal_shift_id(&self) -> &Option<String>
pub fn get_zonal_shift_id(&self) -> &Option<String>
The identifier of a zonal shift.
Sourcepub fn resource_identifier(self, input: impl Into<String>) -> Self
pub fn resource_identifier(self, input: impl Into<String>) -> Self
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:
This field is required.Sourcepub fn set_resource_identifier(self, input: Option<String>) -> Self
pub fn set_resource_identifier(self, input: Option<String>) -> Self
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:
Sourcepub fn get_resource_identifier(&self) -> &Option<String>
pub fn get_resource_identifier(&self) -> &Option<String>
The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.
Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:
Sourcepub fn away_from(self, input: impl Into<String>) -> Self
pub fn away_from(self, input: impl Into<String>) -> Self
The Availability Zone (for example, use1-az1
) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
Sourcepub fn set_away_from(self, input: Option<String>) -> Self
pub fn set_away_from(self, input: Option<String>) -> Self
The Availability Zone (for example, use1-az1
) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
Sourcepub fn get_away_from(&self) -> &Option<String>
pub fn get_away_from(&self) -> &Option<String>
The Availability Zone (for example, use1-az1
) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.
Sourcepub fn expiry_time(self, input: DateTime) -> Self
pub fn expiry_time(self, input: DateTime) -> Self
The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
This field is required.Sourcepub fn set_expiry_time(self, input: Option<DateTime>) -> Self
pub fn set_expiry_time(self, input: Option<DateTime>) -> Self
The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
Sourcepub fn get_expiry_time(&self) -> &Option<DateTime>
pub fn get_expiry_time(&self) -> &Option<DateTime>
The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.
When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The time (UTC) when the zonal shift starts.
This field is required.Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The time (UTC) when the zonal shift starts.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The time (UTC) when the zonal shift starts.
Sourcepub fn comment(self, input: impl Into<String>) -> Self
pub fn comment(self, input: impl Into<String>) -> Self
A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
This field is required.Sourcepub fn set_comment(self, input: Option<String>) -> Self
pub fn set_comment(self, input: Option<String>) -> Self
A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
Sourcepub fn get_comment(&self) -> &Option<String>
pub fn get_comment(&self) -> &Option<String>
A comment that you enter for a customer-initiated zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.
Sourcepub fn shift_type(self, input: ShiftType) -> Self
pub fn shift_type(self, input: ShiftType) -> Self
Defines the zonal shift type.
Sourcepub fn set_shift_type(self, input: Option<ShiftType>) -> Self
pub fn set_shift_type(self, input: Option<ShiftType>) -> Self
Defines the zonal shift type.
Sourcepub fn get_shift_type(&self) -> &Option<ShiftType>
pub fn get_shift_type(&self) -> &Option<ShiftType>
Defines the zonal shift type.
Sourcepub fn practice_run_outcome(self, input: PracticeRunOutcome) -> Self
pub fn practice_run_outcome(self, input: PracticeRunOutcome) -> Self
The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed. -
CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.
Sourcepub fn set_practice_run_outcome(self, input: Option<PracticeRunOutcome>) -> Self
pub fn set_practice_run_outcome(self, input: Option<PracticeRunOutcome>) -> Self
The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed. -
CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.
Sourcepub fn get_practice_run_outcome(&self) -> &Option<PracticeRunOutcome>
pub fn get_practice_run_outcome(&self) -> &Option<PracticeRunOutcome>
The outcome, or end state, returned for a practice run. The following values can be returned:
-
PENDING: Outcome value when a practice run is in progress.
-
SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed the expected 30 minute zonal shift. -
INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, or there was another problem with the practice run that created an inconclusive outcome.
-
FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an
ALARM
state during the practice run, and the practice run was not interrupted before it completed. -
CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.
For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.
Sourcepub fn build(self) -> Result<ZonalShiftInResource, BuildError>
pub fn build(self) -> Result<ZonalShiftInResource, BuildError>
Consumes the builder and constructs a ZonalShiftInResource
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ZonalShiftInResourceBuilder
impl Clone for ZonalShiftInResourceBuilder
Source§fn clone(&self) -> ZonalShiftInResourceBuilder
fn clone(&self) -> ZonalShiftInResourceBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ZonalShiftInResourceBuilder
impl Debug for ZonalShiftInResourceBuilder
Source§impl Default for ZonalShiftInResourceBuilder
impl Default for ZonalShiftInResourceBuilder
Source§fn default() -> ZonalShiftInResourceBuilder
fn default() -> ZonalShiftInResourceBuilder
impl StructuralPartialEq for ZonalShiftInResourceBuilder
Auto Trait Implementations§
impl Freeze for ZonalShiftInResourceBuilder
impl RefUnwindSafe for ZonalShiftInResourceBuilder
impl Send for ZonalShiftInResourceBuilder
impl Sync for ZonalShiftInResourceBuilder
impl Unpin for ZonalShiftInResourceBuilder
impl UnwindSafe for ZonalShiftInResourceBuilder
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);