#[non_exhaustive]pub struct ConfigRuleBuilder { /* private fields */ }
Expand description
A builder for ConfigRule
.
Implementations§
Source§impl ConfigRuleBuilder
impl ConfigRuleBuilder
Sourcepub fn config_rule_name(self, input: impl Into<String>) -> Self
pub fn config_rule_name(self, input: impl Into<String>) -> Self
The name that you assign to the Config rule. The name is required if you are adding a new rule.
Sourcepub fn set_config_rule_name(self, input: Option<String>) -> Self
pub fn set_config_rule_name(self, input: Option<String>) -> Self
The name that you assign to the Config rule. The name is required if you are adding a new rule.
Sourcepub fn get_config_rule_name(&self) -> &Option<String>
pub fn get_config_rule_name(&self) -> &Option<String>
The name that you assign to the Config rule. The name is required if you are adding a new rule.
Sourcepub fn config_rule_arn(self, input: impl Into<String>) -> Self
pub fn config_rule_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the Config rule.
Sourcepub fn set_config_rule_arn(self, input: Option<String>) -> Self
pub fn set_config_rule_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the Config rule.
Sourcepub fn get_config_rule_arn(&self) -> &Option<String>
pub fn get_config_rule_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Config rule.
Sourcepub fn config_rule_id(self, input: impl Into<String>) -> Self
pub fn config_rule_id(self, input: impl Into<String>) -> Self
The ID of the Config rule.
Sourcepub fn set_config_rule_id(self, input: Option<String>) -> Self
pub fn set_config_rule_id(self, input: Option<String>) -> Self
The ID of the Config rule.
Sourcepub fn get_config_rule_id(&self) -> &Option<String>
pub fn get_config_rule_id(&self) -> &Option<String>
The ID of the Config rule.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description that you provide for the Config rule.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description that you provide for the Config rule.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description that you provide for the Config rule.
Sourcepub fn scope(self, input: Scope) -> Self
pub fn scope(self, input: Scope) -> Self
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
Sourcepub fn set_scope(self, input: Option<Scope>) -> Self
pub fn set_scope(self, input: Option<Scope>) -> Self
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
Sourcepub fn get_scope(&self) -> &Option<Scope>
pub fn get_scope(&self) -> &Option<Scope>
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
The scope can be empty.
Sourcepub fn source(self, input: Source) -> Self
pub fn source(self, input: Source) -> Self
Provides the rule owner (Amazon Web Services
for managed rules, CUSTOM_POLICY
for Custom Policy rules, and CUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
Sourcepub fn set_source(self, input: Option<Source>) -> Self
pub fn set_source(self, input: Option<Source>) -> Self
Provides the rule owner (Amazon Web Services
for managed rules, CUSTOM_POLICY
for Custom Policy rules, and CUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
Sourcepub fn get_source(&self) -> &Option<Source>
pub fn get_source(&self) -> &Option<Source>
Provides the rule owner (Amazon Web Services
for managed rules, CUSTOM_POLICY
for Custom Policy rules, and CUSTOM_LAMBDA
for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
Sourcepub fn input_parameters(self, input: impl Into<String>) -> Self
pub fn input_parameters(self, input: impl Into<String>) -> Self
A string, in JSON format, that is passed to the Config rule Lambda function.
Sourcepub fn set_input_parameters(self, input: Option<String>) -> Self
pub fn set_input_parameters(self, input: Option<String>) -> Self
A string, in JSON format, that is passed to the Config rule Lambda function.
Sourcepub fn get_input_parameters(&self) -> &Option<String>
pub fn get_input_parameters(&self) -> &Option<String>
A string, in JSON format, that is passed to the Config rule Lambda function.
Sourcepub fn maximum_execution_frequency(
self,
input: MaximumExecutionFrequency,
) -> Self
pub fn maximum_execution_frequency( self, input: MaximumExecutionFrequency, ) -> Self
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency
when:
-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see
ConfigSnapshotDeliveryProperties
.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency
parameter.
Sourcepub fn set_maximum_execution_frequency(
self,
input: Option<MaximumExecutionFrequency>,
) -> Self
pub fn set_maximum_execution_frequency( self, input: Option<MaximumExecutionFrequency>, ) -> Self
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency
when:
-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see
ConfigSnapshotDeliveryProperties
.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency
parameter.
Sourcepub fn get_maximum_execution_frequency(
&self,
) -> &Option<MaximumExecutionFrequency>
pub fn get_maximum_execution_frequency( &self, ) -> &Option<MaximumExecutionFrequency>
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency
when:
-
This is for an Config managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see
ConfigSnapshotDeliveryProperties
.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency
parameter.
Sourcepub fn config_rule_state(self, input: ConfigRuleState) -> Self
pub fn config_rule_state(self, input: ConfigRuleState) -> Self
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
Config sets the state of the rule to DELETING_RESULTS
temporarily after you use the DeleteEvaluationResults
request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING
after you use the DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
Sourcepub fn set_config_rule_state(self, input: Option<ConfigRuleState>) -> Self
pub fn set_config_rule_state(self, input: Option<ConfigRuleState>) -> Self
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
Config sets the state of the rule to DELETING_RESULTS
temporarily after you use the DeleteEvaluationResults
request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING
after you use the DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
Sourcepub fn get_config_rule_state(&self) -> &Option<ConfigRuleState>
pub fn get_config_rule_state(&self) -> &Option<ConfigRuleState>
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING
temporarily after you use the StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
Config sets the state of the rule to DELETING_RESULTS
temporarily after you use the DeleteEvaluationResults
request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING
after you use the DeleteConfigRule
request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
Sourcepub fn created_by(self, input: impl Into<String>) -> Self
pub fn created_by(self, input: impl Into<String>) -> Self
Service principal name of the service that created the rule.
The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
Sourcepub fn set_created_by(self, input: Option<String>) -> Self
pub fn set_created_by(self, input: Option<String>) -> Self
Service principal name of the service that created the rule.
The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
Sourcepub fn get_created_by(&self) -> &Option<String>
pub fn get_created_by(&self) -> &Option<String>
Service principal name of the service that created the rule.
The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.
Sourcepub fn evaluation_modes(self, input: EvaluationModeConfiguration) -> Self
pub fn evaluation_modes(self, input: EvaluationModeConfiguration) -> Self
Appends an item to evaluation_modes
.
To override the contents of this collection use set_evaluation_modes
.
The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
Sourcepub fn set_evaluation_modes(
self,
input: Option<Vec<EvaluationModeConfiguration>>,
) -> Self
pub fn set_evaluation_modes( self, input: Option<Vec<EvaluationModeConfiguration>>, ) -> Self
The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
Sourcepub fn get_evaluation_modes(&self) -> &Option<Vec<EvaluationModeConfiguration>>
pub fn get_evaluation_modes(&self) -> &Option<Vec<EvaluationModeConfiguration>>
The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.
Sourcepub fn build(self) -> ConfigRule
pub fn build(self) -> ConfigRule
Consumes the builder and constructs a ConfigRule
.
Trait Implementations§
Source§impl Clone for ConfigRuleBuilder
impl Clone for ConfigRuleBuilder
Source§fn clone(&self) -> ConfigRuleBuilder
fn clone(&self) -> ConfigRuleBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ConfigRuleBuilder
impl Debug for ConfigRuleBuilder
Source§impl Default for ConfigRuleBuilder
impl Default for ConfigRuleBuilder
Source§fn default() -> ConfigRuleBuilder
fn default() -> ConfigRuleBuilder
Source§impl PartialEq for ConfigRuleBuilder
impl PartialEq for ConfigRuleBuilder
impl StructuralPartialEq for ConfigRuleBuilder
Auto Trait Implementations§
impl Freeze for ConfigRuleBuilder
impl RefUnwindSafe for ConfigRuleBuilder
impl Send for ConfigRuleBuilder
impl Sync for ConfigRuleBuilder
impl Unpin for ConfigRuleBuilder
impl UnwindSafe for ConfigRuleBuilder
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);