#[non_exhaustive]pub struct RemediationConfigurationBuilder { /* private fields */ }
Expand description
A builder for RemediationConfiguration
.
Implementations§
Source§impl RemediationConfigurationBuilder
impl RemediationConfigurationBuilder
Sourcepub fn config_rule_name(self, input: impl Into<String>) -> Self
pub fn config_rule_name(self, input: impl Into<String>) -> Self
The name of the Config rule.
This field is required.Sourcepub fn set_config_rule_name(self, input: Option<String>) -> Self
pub fn set_config_rule_name(self, input: Option<String>) -> Self
The name of the Config rule.
Sourcepub fn get_config_rule_name(&self) -> &Option<String>
pub fn get_config_rule_name(&self) -> &Option<String>
The name of the Config rule.
Sourcepub fn target_type(self, input: RemediationTargetType) -> Self
pub fn target_type(self, input: RemediationTargetType) -> Self
The type of the target. Target executes remediation. For example, SSM document.
This field is required.Sourcepub fn set_target_type(self, input: Option<RemediationTargetType>) -> Self
pub fn set_target_type(self, input: Option<RemediationTargetType>) -> Self
The type of the target. Target executes remediation. For example, SSM document.
Sourcepub fn get_target_type(&self) -> &Option<RemediationTargetType>
pub fn get_target_type(&self) -> &Option<RemediationTargetType>
The type of the target. Target executes remediation. For example, SSM document.
Sourcepub fn target_id(self, input: impl Into<String>) -> Self
pub fn target_id(self, input: impl Into<String>) -> Self
Target ID is the name of the SSM document.
This field is required.Sourcepub fn set_target_id(self, input: Option<String>) -> Self
pub fn set_target_id(self, input: Option<String>) -> Self
Target ID is the name of the SSM document.
Sourcepub fn get_target_id(&self) -> &Option<String>
pub fn get_target_id(&self) -> &Option<String>
Target ID is the name of the SSM document.
Sourcepub fn target_version(self, input: impl Into<String>) -> Self
pub fn target_version(self, input: impl Into<String>) -> Self
Version of the target. For example, version of the SSM document.
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
Sourcepub fn set_target_version(self, input: Option<String>) -> Self
pub fn set_target_version(self, input: Option<String>) -> Self
Version of the target. For example, version of the SSM document.
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
Sourcepub fn get_target_version(&self) -> &Option<String>
pub fn get_target_version(&self) -> &Option<String>
Version of the target. For example, version of the SSM document.
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
Sourcepub fn parameters(
self,
k: impl Into<String>,
v: RemediationParameterValue,
) -> Self
pub fn parameters( self, k: impl Into<String>, v: RemediationParameterValue, ) -> Self
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
An object of the RemediationParameterValue.
Sourcepub fn set_parameters(
self,
input: Option<HashMap<String, RemediationParameterValue>>,
) -> Self
pub fn set_parameters( self, input: Option<HashMap<String, RemediationParameterValue>>, ) -> Self
An object of the RemediationParameterValue.
Sourcepub fn get_parameters(
&self,
) -> &Option<HashMap<String, RemediationParameterValue>>
pub fn get_parameters( &self, ) -> &Option<HashMap<String, RemediationParameterValue>>
An object of the RemediationParameterValue.
Sourcepub fn resource_type(self, input: impl Into<String>) -> Self
pub fn resource_type(self, input: impl Into<String>) -> Self
The type of a resource.
Sourcepub fn set_resource_type(self, input: Option<String>) -> Self
pub fn set_resource_type(self, input: Option<String>) -> Self
The type of a resource.
Sourcepub fn get_resource_type(&self) -> &Option<String>
pub fn get_resource_type(&self) -> &Option<String>
The type of a resource.
Sourcepub fn set_automatic(self, input: Option<bool>) -> Self
pub fn set_automatic(self, input: Option<bool>) -> Self
The remediation is triggered automatically.
Sourcepub fn get_automatic(&self) -> &Option<bool>
pub fn get_automatic(&self) -> &Option<bool>
The remediation is triggered automatically.
Sourcepub fn execution_controls(self, input: ExecutionControls) -> Self
pub fn execution_controls(self, input: ExecutionControls) -> Self
An ExecutionControls object.
Sourcepub fn set_execution_controls(self, input: Option<ExecutionControls>) -> Self
pub fn set_execution_controls(self, input: Option<ExecutionControls>) -> Self
An ExecutionControls object.
Sourcepub fn get_execution_controls(&self) -> &Option<ExecutionControls>
pub fn get_execution_controls(&self) -> &Option<ExecutionControls>
An ExecutionControls object.
Sourcepub fn maximum_automatic_attempts(self, input: i32) -> Self
pub fn maximum_automatic_attempts(self, input: i32) -> Self
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
Sourcepub fn set_maximum_automatic_attempts(self, input: Option<i32>) -> Self
pub fn set_maximum_automatic_attempts(self, input: Option<i32>) -> Self
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
Sourcepub fn get_maximum_automatic_attempts(&self) -> &Option<i32>
pub fn get_maximum_automatic_attempts(&self) -> &Option<i32>
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
Sourcepub fn retry_attempt_seconds(self, input: i64) -> Self
pub fn retry_attempt_seconds(self, input: i64) -> Self
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts
remediation attempts have been made under RetryAttemptSeconds
, a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds
as 50 seconds and MaximumAutomaticAttempts
as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.
Sourcepub fn set_retry_attempt_seconds(self, input: Option<i64>) -> Self
pub fn set_retry_attempt_seconds(self, input: Option<i64>) -> Self
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts
remediation attempts have been made under RetryAttemptSeconds
, a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds
as 50 seconds and MaximumAutomaticAttempts
as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.
Sourcepub fn get_retry_attempt_seconds(&self) -> &Option<i64>
pub fn get_retry_attempt_seconds(&self) -> &Option<i64>
Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts
remediation attempts have been made under RetryAttemptSeconds
, a remediation exception will be added to the resource. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds
as 50 seconds and MaximumAutomaticAttempts
as 5, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
Amazon Resource Name (ARN) of remediation configuration.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
Amazon Resource Name (ARN) of remediation configuration.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
Amazon Resource Name (ARN) of remediation configuration.
Sourcepub fn created_by_service(self, input: impl Into<String>) -> Self
pub fn created_by_service(self, input: impl Into<String>) -> Self
Name of the service that owns the service-linked rule, if applicable.
Sourcepub fn set_created_by_service(self, input: Option<String>) -> Self
pub fn set_created_by_service(self, input: Option<String>) -> Self
Name of the service that owns the service-linked rule, if applicable.
Sourcepub fn get_created_by_service(&self) -> &Option<String>
pub fn get_created_by_service(&self) -> &Option<String>
Name of the service that owns the service-linked rule, if applicable.
Sourcepub fn build(self) -> Result<RemediationConfiguration, BuildError>
pub fn build(self) -> Result<RemediationConfiguration, BuildError>
Consumes the builder and constructs a RemediationConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RemediationConfigurationBuilder
impl Clone for RemediationConfigurationBuilder
Source§fn clone(&self) -> RemediationConfigurationBuilder
fn clone(&self) -> RemediationConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for RemediationConfigurationBuilder
impl Default for RemediationConfigurationBuilder
Source§fn default() -> RemediationConfigurationBuilder
fn default() -> RemediationConfigurationBuilder
Source§impl PartialEq for RemediationConfigurationBuilder
impl PartialEq for RemediationConfigurationBuilder
Source§fn eq(&self, other: &RemediationConfigurationBuilder) -> bool
fn eq(&self, other: &RemediationConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for RemediationConfigurationBuilder
Auto Trait Implementations§
impl Freeze for RemediationConfigurationBuilder
impl RefUnwindSafe for RemediationConfigurationBuilder
impl Send for RemediationConfigurationBuilder
impl Sync for RemediationConfigurationBuilder
impl Unpin for RemediationConfigurationBuilder
impl UnwindSafe for RemediationConfigurationBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);