pub struct StartPlanExecutionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartPlanExecution
.
Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.
In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.
Implementations§
Source§impl StartPlanExecutionFluentBuilder
impl StartPlanExecutionFluentBuilder
Sourcepub fn as_input(&self) -> &StartPlanExecutionInputBuilder
pub fn as_input(&self) -> &StartPlanExecutionInputBuilder
Access the StartPlanExecution as a reference.
Sourcepub async fn send(
self,
) -> Result<StartPlanExecutionOutput, SdkError<StartPlanExecutionError, HttpResponse>>
pub async fn send( self, ) -> Result<StartPlanExecutionOutput, SdkError<StartPlanExecutionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartPlanExecutionOutput, StartPlanExecutionError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartPlanExecutionOutput, StartPlanExecutionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn plan_arn(self, input: impl Into<String>) -> Self
pub fn plan_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the plan to execute.
Sourcepub fn set_plan_arn(self, input: Option<String>) -> Self
pub fn set_plan_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the plan to execute.
Sourcepub fn get_plan_arn(&self) -> &Option<String>
pub fn get_plan_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the plan to execute.
Sourcepub fn target_region(self, input: impl Into<String>) -> Self
pub fn target_region(self, input: impl Into<String>) -> Self
The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.
Sourcepub fn set_target_region(self, input: Option<String>) -> Self
pub fn set_target_region(self, input: Option<String>) -> Self
The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.
Sourcepub fn get_target_region(&self) -> &Option<String>
pub fn get_target_region(&self) -> &Option<String>
The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.
Sourcepub fn action(self, input: ExecutionAction) -> Self
pub fn action(self, input: ExecutionAction) -> Self
The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
Sourcepub fn set_action(self, input: Option<ExecutionAction>) -> Self
pub fn set_action(self, input: Option<ExecutionAction>) -> Self
The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
Sourcepub fn get_action(&self) -> &Option<ExecutionAction>
pub fn get_action(&self) -> &Option<ExecutionAction>
The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).
Sourcepub fn mode(self, input: ExecutionMode) -> Self
pub fn mode(self, input: ExecutionMode) -> Self
The plan execution mode. Valid values are Practice
, for testing without making actual changes, or Recovery
, for actual traffic shifting and application recovery.
Sourcepub fn set_mode(self, input: Option<ExecutionMode>) -> Self
pub fn set_mode(self, input: Option<ExecutionMode>) -> Self
The plan execution mode. Valid values are Practice
, for testing without making actual changes, or Recovery
, for actual traffic shifting and application recovery.
Sourcepub fn get_mode(&self) -> &Option<ExecutionMode>
pub fn get_mode(&self) -> &Option<ExecutionMode>
The plan execution mode. Valid values are Practice
, for testing without making actual changes, or Recovery
, for actual traffic shifting and application recovery.
Sourcepub fn comment(self, input: impl Into<String>) -> Self
pub fn comment(self, input: impl Into<String>) -> Self
An optional comment explaining why the plan execution is being started.
Sourcepub fn set_comment(self, input: Option<String>) -> Self
pub fn set_comment(self, input: Option<String>) -> Self
An optional comment explaining why the plan execution is being started.
Sourcepub fn get_comment(&self) -> &Option<String>
pub fn get_comment(&self) -> &Option<String>
An optional comment explaining why the plan execution is being started.
Sourcepub fn latest_version(self, input: impl Into<String>) -> Self
pub fn latest_version(self, input: impl Into<String>) -> Self
A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
Sourcepub fn set_latest_version(self, input: Option<String>) -> Self
pub fn set_latest_version(self, input: Option<String>) -> Self
A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
Sourcepub fn get_latest_version(&self) -> &Option<String>
pub fn get_latest_version(&self) -> &Option<String>
A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.
Trait Implementations§
Source§impl Clone for StartPlanExecutionFluentBuilder
impl Clone for StartPlanExecutionFluentBuilder
Source§fn clone(&self) -> StartPlanExecutionFluentBuilder
fn clone(&self) -> StartPlanExecutionFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartPlanExecutionFluentBuilder
impl !RefUnwindSafe for StartPlanExecutionFluentBuilder
impl Send for StartPlanExecutionFluentBuilder
impl Sync for StartPlanExecutionFluentBuilder
impl Unpin for StartPlanExecutionFluentBuilder
impl !UnwindSafe for StartPlanExecutionFluentBuilder
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);