#[non_exhaustive]pub struct OrganizationCustomRuleMetadataBuilder { /* private fields */ }
Expand description
A builder for OrganizationCustomRuleMetadata
.
Implementations§
Source§impl OrganizationCustomRuleMetadataBuilder
impl OrganizationCustomRuleMetadataBuilder
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description that you provide for your organization 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 your organization Config rule.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description that you provide for your organization Config rule.
Sourcepub fn lambda_function_arn(self, input: impl Into<String>) -> Self
pub fn lambda_function_arn(self, input: impl Into<String>) -> Self
The lambda function ARN.
This field is required.Sourcepub fn set_lambda_function_arn(self, input: Option<String>) -> Self
pub fn set_lambda_function_arn(self, input: Option<String>) -> Self
The lambda function ARN.
Sourcepub fn get_lambda_function_arn(&self) -> &Option<String>
pub fn get_lambda_function_arn(&self) -> &Option<String>
The lambda function ARN.
Sourcepub fn organization_config_rule_trigger_types(
self,
input: OrganizationConfigRuleTriggerType,
) -> Self
pub fn organization_config_rule_trigger_types( self, input: OrganizationConfigRuleTriggerType, ) -> Self
Appends an item to organization_config_rule_trigger_types
.
To override the contents of this collection use set_organization_config_rule_trigger_types
.
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
-
ConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers a configuration item as a result of a resource change. -
OversizedConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. -
ScheduledNotification
- Triggers a periodic evaluation at the frequency specified forMaximumExecutionFrequency
.
Sourcepub fn set_organization_config_rule_trigger_types(
self,
input: Option<Vec<OrganizationConfigRuleTriggerType>>,
) -> Self
pub fn set_organization_config_rule_trigger_types( self, input: Option<Vec<OrganizationConfigRuleTriggerType>>, ) -> Self
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
-
ConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers a configuration item as a result of a resource change. -
OversizedConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. -
ScheduledNotification
- Triggers a periodic evaluation at the frequency specified forMaximumExecutionFrequency
.
Sourcepub fn get_organization_config_rule_trigger_types(
&self,
) -> &Option<Vec<OrganizationConfigRuleTriggerType>>
pub fn get_organization_config_rule_trigger_types( &self, ) -> &Option<Vec<OrganizationConfigRuleTriggerType>>
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
-
ConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers a configuration item as a result of a resource change. -
OversizedConfigurationItemChangeNotification
- Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. -
ScheduledNotification
- Triggers a periodic evaluation at the frequency specified forMaximumExecutionFrequency
.
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 your organization 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 your organization 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 your organization 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. 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. 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. 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 resource_types_scope(self, input: impl Into<String>) -> Self
pub fn resource_types_scope(self, input: impl Into<String>) -> Self
Appends an item to resource_types_scope
.
To override the contents of this collection use set_resource_types_scope
.
The type of the Amazon Web Services resource that was evaluated.
Sourcepub fn set_resource_types_scope(self, input: Option<Vec<String>>) -> Self
pub fn set_resource_types_scope(self, input: Option<Vec<String>>) -> Self
The type of the Amazon Web Services resource that was evaluated.
Sourcepub fn get_resource_types_scope(&self) -> &Option<Vec<String>>
pub fn get_resource_types_scope(&self) -> &Option<Vec<String>>
The type of the Amazon Web Services resource that was evaluated.
Sourcepub fn resource_id_scope(self, input: impl Into<String>) -> Self
pub fn resource_id_scope(self, input: impl Into<String>) -> Self
The ID of the Amazon Web Services resource that was evaluated.
Sourcepub fn set_resource_id_scope(self, input: Option<String>) -> Self
pub fn set_resource_id_scope(self, input: Option<String>) -> Self
The ID of the Amazon Web Services resource that was evaluated.
Sourcepub fn get_resource_id_scope(&self) -> &Option<String>
pub fn get_resource_id_scope(&self) -> &Option<String>
The ID of the Amazon Web Services resource that was evaluated.
Sourcepub fn tag_key_scope(self, input: impl Into<String>) -> Self
pub fn tag_key_scope(self, input: impl Into<String>) -> Self
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Sourcepub fn set_tag_key_scope(self, input: Option<String>) -> Self
pub fn set_tag_key_scope(self, input: Option<String>) -> Self
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Sourcepub fn get_tag_key_scope(&self) -> &Option<String>
pub fn get_tag_key_scope(&self) -> &Option<String>
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Sourcepub fn tag_value_scope(self, input: impl Into<String>) -> Self
pub fn tag_value_scope(self, input: impl Into<String>) -> Self
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Sourcepub fn set_tag_value_scope(self, input: Option<String>) -> Self
pub fn set_tag_value_scope(self, input: Option<String>) -> Self
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Sourcepub fn get_tag_value_scope(&self) -> &Option<String>
pub fn get_tag_value_scope(&self) -> &Option<String>
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Sourcepub fn build(self) -> Result<OrganizationCustomRuleMetadata, BuildError>
pub fn build(self) -> Result<OrganizationCustomRuleMetadata, BuildError>
Consumes the builder and constructs a OrganizationCustomRuleMetadata
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for OrganizationCustomRuleMetadataBuilder
impl Clone for OrganizationCustomRuleMetadataBuilder
Source§fn clone(&self) -> OrganizationCustomRuleMetadataBuilder
fn clone(&self) -> OrganizationCustomRuleMetadataBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for OrganizationCustomRuleMetadataBuilder
impl Default for OrganizationCustomRuleMetadataBuilder
Source§fn default() -> OrganizationCustomRuleMetadataBuilder
fn default() -> OrganizationCustomRuleMetadataBuilder
Source§impl PartialEq for OrganizationCustomRuleMetadataBuilder
impl PartialEq for OrganizationCustomRuleMetadataBuilder
Source§fn eq(&self, other: &OrganizationCustomRuleMetadataBuilder) -> bool
fn eq(&self, other: &OrganizationCustomRuleMetadataBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for OrganizationCustomRuleMetadataBuilder
Auto Trait Implementations§
impl Freeze for OrganizationCustomRuleMetadataBuilder
impl RefUnwindSafe for OrganizationCustomRuleMetadataBuilder
impl Send for OrganizationCustomRuleMetadataBuilder
impl Sync for OrganizationCustomRuleMetadataBuilder
impl Unpin for OrganizationCustomRuleMetadataBuilder
impl UnwindSafe for OrganizationCustomRuleMetadataBuilder
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);