pub struct UpdateRuleGroupFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateRuleGroup
.
Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.
To update a rule group, first call DescribeRuleGroup
to retrieve the current RuleGroup
object, update the object as needed, and then provide the updated object to this call.
Implementations§
Source§impl UpdateRuleGroupFluentBuilder
impl UpdateRuleGroupFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateRuleGroupInputBuilder
pub fn as_input(&self) -> &UpdateRuleGroupInputBuilder
Access the UpdateRuleGroup as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateRuleGroupOutput, SdkError<UpdateRuleGroupError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateRuleGroupOutput, SdkError<UpdateRuleGroupError, 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<UpdateRuleGroupOutput, UpdateRuleGroupError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateRuleGroupOutput, UpdateRuleGroupError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn update_token(self, input: impl Into<String>) -> Self
pub fn update_token(self, input: impl Into<String>) -> Self
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException
. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
Sourcepub fn set_update_token(self, input: Option<String>) -> Self
pub fn set_update_token(self, input: Option<String>) -> Self
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException
. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
Sourcepub fn get_update_token(&self) -> &Option<String>
pub fn get_update_token(&self) -> &Option<String>
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException
. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
Sourcepub fn rule_group_arn(self, input: impl Into<String>) -> Self
pub fn rule_group_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
Sourcepub fn set_rule_group_arn(self, input: Option<String>) -> Self
pub fn set_rule_group_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
Sourcepub fn get_rule_group_arn(&self) -> &Option<String>
pub fn get_rule_group_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
Sourcepub fn rule_group_name(self, input: impl Into<String>) -> Self
pub fn rule_group_name(self, input: impl Into<String>) -> Self
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Sourcepub fn set_rule_group_name(self, input: Option<String>) -> Self
pub fn set_rule_group_name(self, input: Option<String>) -> Self
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Sourcepub fn get_rule_group_name(&self) -> &Option<String>
pub fn get_rule_group_name(&self) -> &Option<String>
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Sourcepub fn rule_group(self, input: RuleGroup) -> Self
pub fn rule_group(self, input: RuleGroup) -> Self
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules
setting, but not both.
Sourcepub fn set_rule_group(self, input: Option<RuleGroup>) -> Self
pub fn set_rule_group(self, input: Option<RuleGroup>) -> Self
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules
setting, but not both.
Sourcepub fn get_rule_group(&self) -> &Option<RuleGroup>
pub fn get_rule_group(&self) -> &Option<RuleGroup>
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules
setting, but not both.
Sourcepub fn rules(self, input: impl Into<String>) -> Self
pub fn rules(self, input: impl Into<String>) -> Self
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup
object that Network Firewall has populated from your string.
Sourcepub fn set_rules(self, input: Option<String>) -> Self
pub fn set_rules(self, input: Option<String>) -> Self
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup
object that Network Firewall has populated from your string.
Sourcepub fn get_rules(&self) -> &Option<String>
pub fn get_rules(&self) -> &Option<String>
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a RuleGroup
object that Network Firewall has populated from your string.
Sourcepub fn type(self, input: RuleGroupType) -> Self
pub fn type(self, input: RuleGroupType) -> Self
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN
.
Sourcepub fn set_type(self, input: Option<RuleGroupType>) -> Self
pub fn set_type(self, input: Option<RuleGroupType>) -> Self
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN
.
Sourcepub fn get_type(&self) -> &Option<RuleGroupType>
pub fn get_type(&self) -> &Option<RuleGroupType>
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the RuleGroupARN
.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the rule group.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the rule group.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the rule group.
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE
, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE
, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE
, Network Firewall makes the requested changes to your resources.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE
, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE
, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE
, Network Firewall makes the requested changes to your resources.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE
, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE
, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE
, Network Firewall makes the requested changes to your resources.
Sourcepub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
pub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
A complex type that contains settings for encryption of your rule group resources.
Sourcepub fn set_encryption_configuration(
self,
input: Option<EncryptionConfiguration>,
) -> Self
pub fn set_encryption_configuration( self, input: Option<EncryptionConfiguration>, ) -> Self
A complex type that contains settings for encryption of your rule group resources.
Sourcepub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
pub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
A complex type that contains settings for encryption of your rule group resources.
Sourcepub fn source_metadata(self, input: SourceMetadata) -> Self
pub fn source_metadata(self, input: SourceMetadata) -> Self
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
Sourcepub fn set_source_metadata(self, input: Option<SourceMetadata>) -> Self
pub fn set_source_metadata(self, input: Option<SourceMetadata>) -> Self
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
Sourcepub fn get_source_metadata(&self) -> &Option<SourceMetadata>
pub fn get_source_metadata(&self) -> &Option<SourceMetadata>
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
Sourcepub fn analyze_rule_group(self, input: bool) -> Self
pub fn analyze_rule_group(self, input: bool) -> Self
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun
to TRUE
.
Sourcepub fn set_analyze_rule_group(self, input: Option<bool>) -> Self
pub fn set_analyze_rule_group(self, input: Option<bool>) -> Self
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun
to TRUE
.
Sourcepub fn get_analyze_rule_group(&self) -> &Option<bool>
pub fn get_analyze_rule_group(&self) -> &Option<bool>
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the rule group for you. To run the stateless rule group analyzer without updating the rule group, set DryRun
to TRUE
.
Sourcepub fn summary_configuration(self, input: SummaryConfiguration) -> Self
pub fn summary_configuration(self, input: SummaryConfiguration) -> Self
Updates the selected summary configuration for a rule group.
Changes affect subsequent responses from DescribeRuleGroupSummary
.
Sourcepub fn set_summary_configuration(
self,
input: Option<SummaryConfiguration>,
) -> Self
pub fn set_summary_configuration( self, input: Option<SummaryConfiguration>, ) -> Self
Updates the selected summary configuration for a rule group.
Changes affect subsequent responses from DescribeRuleGroupSummary
.
Sourcepub fn get_summary_configuration(&self) -> &Option<SummaryConfiguration>
pub fn get_summary_configuration(&self) -> &Option<SummaryConfiguration>
Updates the selected summary configuration for a rule group.
Changes affect subsequent responses from DescribeRuleGroupSummary
.
Trait Implementations§
Source§impl Clone for UpdateRuleGroupFluentBuilder
impl Clone for UpdateRuleGroupFluentBuilder
Source§fn clone(&self) -> UpdateRuleGroupFluentBuilder
fn clone(&self) -> UpdateRuleGroupFluentBuilder
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 UpdateRuleGroupFluentBuilder
impl !RefUnwindSafe for UpdateRuleGroupFluentBuilder
impl Send for UpdateRuleGroupFluentBuilder
impl Sync for UpdateRuleGroupFluentBuilder
impl Unpin for UpdateRuleGroupFluentBuilder
impl !UnwindSafe for UpdateRuleGroupFluentBuilder
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);