#[non_exhaustive]pub struct AutomationExecutionPreviewBuilder { /* private fields */ }
Expand description
A builder for AutomationExecutionPreview
.
Implementations§
Source§impl AutomationExecutionPreviewBuilder
impl AutomationExecutionPreviewBuilder
Sourcepub fn step_previews(self, k: ImpactType, v: i32) -> Self
pub fn step_previews(self, k: ImpactType, v: i32) -> Self
Adds a key-value pair to step_previews
.
To override the contents of this collection use set_step_previews
.
Information about the type of impact a runbook step would have on a resource.
-
Mutating
: The runbook step would make changes to the targets through actions that create, modify, or delete resources. -
Non_Mutating
: The runbook step would retrieve data about resources but not make changes to them. This category generally includesDescribe*
,List*
,Get*
, and similar read-only API actions. -
Undetermined
: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.
Sourcepub fn set_step_previews(self, input: Option<HashMap<ImpactType, i32>>) -> Self
pub fn set_step_previews(self, input: Option<HashMap<ImpactType, i32>>) -> Self
Information about the type of impact a runbook step would have on a resource.
-
Mutating
: The runbook step would make changes to the targets through actions that create, modify, or delete resources. -
Non_Mutating
: The runbook step would retrieve data about resources but not make changes to them. This category generally includesDescribe*
,List*
,Get*
, and similar read-only API actions. -
Undetermined
: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.
Sourcepub fn get_step_previews(&self) -> &Option<HashMap<ImpactType, i32>>
pub fn get_step_previews(&self) -> &Option<HashMap<ImpactType, i32>>
Information about the type of impact a runbook step would have on a resource.
-
Mutating
: The runbook step would make changes to the targets through actions that create, modify, or delete resources. -
Non_Mutating
: The runbook step would retrieve data about resources but not make changes to them. This category generally includesDescribe*
,List*
,Get*
, and similar read-only API actions. -
Undetermined
: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.
Sourcepub fn regions(self, input: impl Into<String>) -> Self
pub fn regions(self, input: impl Into<String>) -> Self
Appends an item to regions
.
To override the contents of this collection use set_regions
.
Information about the Amazon Web Services Regions targeted by the execution preview.
Sourcepub fn set_regions(self, input: Option<Vec<String>>) -> Self
pub fn set_regions(self, input: Option<Vec<String>>) -> Self
Information about the Amazon Web Services Regions targeted by the execution preview.
Sourcepub fn get_regions(&self) -> &Option<Vec<String>>
pub fn get_regions(&self) -> &Option<Vec<String>>
Information about the Amazon Web Services Regions targeted by the execution preview.
Sourcepub fn target_previews(self, input: TargetPreview) -> Self
pub fn target_previews(self, input: TargetPreview) -> Self
Appends an item to target_previews
.
To override the contents of this collection use set_target_previews
.
Information that provides a preview of what the impact of running the specified Automation runbook would be.
Sourcepub fn set_target_previews(self, input: Option<Vec<TargetPreview>>) -> Self
pub fn set_target_previews(self, input: Option<Vec<TargetPreview>>) -> Self
Information that provides a preview of what the impact of running the specified Automation runbook would be.
Sourcepub fn get_target_previews(&self) -> &Option<Vec<TargetPreview>>
pub fn get_target_previews(&self) -> &Option<Vec<TargetPreview>>
Information that provides a preview of what the impact of running the specified Automation runbook would be.
Sourcepub fn total_accounts(self, input: i32) -> Self
pub fn total_accounts(self, input: i32) -> Self
Information about the Amazon Web Services accounts that were included in the execution preview.
Sourcepub fn set_total_accounts(self, input: Option<i32>) -> Self
pub fn set_total_accounts(self, input: Option<i32>) -> Self
Information about the Amazon Web Services accounts that were included in the execution preview.
Sourcepub fn get_total_accounts(&self) -> &Option<i32>
pub fn get_total_accounts(&self) -> &Option<i32>
Information about the Amazon Web Services accounts that were included in the execution preview.
Sourcepub fn build(self) -> AutomationExecutionPreview
pub fn build(self) -> AutomationExecutionPreview
Consumes the builder and constructs a AutomationExecutionPreview
.
Trait Implementations§
Source§impl Clone for AutomationExecutionPreviewBuilder
impl Clone for AutomationExecutionPreviewBuilder
Source§fn clone(&self) -> AutomationExecutionPreviewBuilder
fn clone(&self) -> AutomationExecutionPreviewBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for AutomationExecutionPreviewBuilder
impl Default for AutomationExecutionPreviewBuilder
Source§fn default() -> AutomationExecutionPreviewBuilder
fn default() -> AutomationExecutionPreviewBuilder
Source§impl PartialEq for AutomationExecutionPreviewBuilder
impl PartialEq for AutomationExecutionPreviewBuilder
Source§fn eq(&self, other: &AutomationExecutionPreviewBuilder) -> bool
fn eq(&self, other: &AutomationExecutionPreviewBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AutomationExecutionPreviewBuilder
Auto Trait Implementations§
impl Freeze for AutomationExecutionPreviewBuilder
impl RefUnwindSafe for AutomationExecutionPreviewBuilder
impl Send for AutomationExecutionPreviewBuilder
impl Sync for AutomationExecutionPreviewBuilder
impl Unpin for AutomationExecutionPreviewBuilder
impl UnwindSafe for AutomationExecutionPreviewBuilder
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);