#[non_exhaustive]pub struct ClientSideActionBuilder { /* private fields */ }
Expand description
A builder for ClientSideAction
.
Implementations§
Source§impl ClientSideActionBuilder
impl ClientSideActionBuilder
Sourcepub fn usage_of_action(self, input: UsageOfAction) -> Self
pub fn usage_of_action(self, input: UsageOfAction) -> Self
Determines whether to use the AWSManagedRulesAntiDDoSRuleSet
rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
in the rule group evaluation and the related label awswaf:managed:aws:anti-ddos:challengeable-request
.
-
If usage is enabled:
-
The managed rule group adds the label
awswaf:managed:aws:anti-ddos:challengeable-request
to any web request whose URL does NOT match the regular expressions provided in theClientSideAction
settingExemptUriRegularExpressions
. -
The two rules are evaluated against web requests for protected resources that are experiencing a DDoS attack. The two rules only apply their action to matching requests that have the label
awswaf:managed:aws:anti-ddos:challengeable-request
.
-
-
If usage is disabled:
-
The managed rule group doesn't add the label
awswaf:managed:aws:anti-ddos:challengeable-request
to any web requests. -
The two rules are not evaluated.
-
None of the other
ClientSideAction
settings have any effect.
-
This setting only enables or disables the use of the two anti-DDOS rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
in the anti-DDoS managed rule group.
This setting doesn't alter the action setting in the two rules. To override the actions used by the rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
, enable this setting, and then override the rule actions in the usual way, in your managed rule group configuration.
Sourcepub fn set_usage_of_action(self, input: Option<UsageOfAction>) -> Self
pub fn set_usage_of_action(self, input: Option<UsageOfAction>) -> Self
Determines whether to use the AWSManagedRulesAntiDDoSRuleSet
rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
in the rule group evaluation and the related label awswaf:managed:aws:anti-ddos:challengeable-request
.
-
If usage is enabled:
-
The managed rule group adds the label
awswaf:managed:aws:anti-ddos:challengeable-request
to any web request whose URL does NOT match the regular expressions provided in theClientSideAction
settingExemptUriRegularExpressions
. -
The two rules are evaluated against web requests for protected resources that are experiencing a DDoS attack. The two rules only apply their action to matching requests that have the label
awswaf:managed:aws:anti-ddos:challengeable-request
.
-
-
If usage is disabled:
-
The managed rule group doesn't add the label
awswaf:managed:aws:anti-ddos:challengeable-request
to any web requests. -
The two rules are not evaluated.
-
None of the other
ClientSideAction
settings have any effect.
-
This setting only enables or disables the use of the two anti-DDOS rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
in the anti-DDoS managed rule group.
This setting doesn't alter the action setting in the two rules. To override the actions used by the rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
, enable this setting, and then override the rule actions in the usual way, in your managed rule group configuration.
Sourcepub fn get_usage_of_action(&self) -> &Option<UsageOfAction>
pub fn get_usage_of_action(&self) -> &Option<UsageOfAction>
Determines whether to use the AWSManagedRulesAntiDDoSRuleSet
rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
in the rule group evaluation and the related label awswaf:managed:aws:anti-ddos:challengeable-request
.
-
If usage is enabled:
-
The managed rule group adds the label
awswaf:managed:aws:anti-ddos:challengeable-request
to any web request whose URL does NOT match the regular expressions provided in theClientSideAction
settingExemptUriRegularExpressions
. -
The two rules are evaluated against web requests for protected resources that are experiencing a DDoS attack. The two rules only apply their action to matching requests that have the label
awswaf:managed:aws:anti-ddos:challengeable-request
.
-
-
If usage is disabled:
-
The managed rule group doesn't add the label
awswaf:managed:aws:anti-ddos:challengeable-request
to any web requests. -
The two rules are not evaluated.
-
None of the other
ClientSideAction
settings have any effect.
-
This setting only enables or disables the use of the two anti-DDOS rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
in the anti-DDoS managed rule group.
This setting doesn't alter the action setting in the two rules. To override the actions used by the rules ChallengeAllDuringEvent
and ChallengeDDoSRequests
, enable this setting, and then override the rule actions in the usual way, in your managed rule group configuration.
Sourcepub fn sensitivity(self, input: SensitivityToAct) -> Self
pub fn sensitivity(self, input: SensitivityToAct) -> Self
The sensitivity that the rule group rule ChallengeDDoSRequests
uses when matching against the DDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the ChallengeDDoSRequests
rule runs.
The higher the sensitivity, the more levels of labeling that the rule matches:
-
Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label
awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request
. -
Medium sensitivity causes the rule to match on the medium and high suspicion labels.
-
High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.
Default: HIGH
Sourcepub fn set_sensitivity(self, input: Option<SensitivityToAct>) -> Self
pub fn set_sensitivity(self, input: Option<SensitivityToAct>) -> Self
The sensitivity that the rule group rule ChallengeDDoSRequests
uses when matching against the DDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the ChallengeDDoSRequests
rule runs.
The higher the sensitivity, the more levels of labeling that the rule matches:
-
Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label
awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request
. -
Medium sensitivity causes the rule to match on the medium and high suspicion labels.
-
High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.
Default: HIGH
Sourcepub fn get_sensitivity(&self) -> &Option<SensitivityToAct>
pub fn get_sensitivity(&self) -> &Option<SensitivityToAct>
The sensitivity that the rule group rule ChallengeDDoSRequests
uses when matching against the DDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the ChallengeDDoSRequests
rule runs.
The higher the sensitivity, the more levels of labeling that the rule matches:
-
Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label
awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request
. -
Medium sensitivity causes the rule to match on the medium and high suspicion labels.
-
High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.
Default: HIGH
Sourcepub fn exempt_uri_regular_expressions(self, input: Regex) -> Self
pub fn exempt_uri_regular_expressions(self, input: Regex) -> Self
Appends an item to exempt_uri_regular_expressions
.
To override the contents of this collection use set_exempt_uri_regular_expressions
.
The regular expression to match against the web request URI, used to identify requests that can't handle a silent browser challenge. When the ClientSideAction
setting UsageOfAction
is enabled, the managed rule group uses this setting to determine which requests to label with awswaf:managed:aws:anti-ddos:challengeable-request
. If UsageOfAction
is disabled, this setting has no effect and the managed rule group doesn't add the label to any requests.
The anti-DDoS managed rule group doesn't evaluate the rules ChallengeDDoSRequests
or ChallengeAllDuringEvent
for web requests whose URIs match this regex. This is true regardless of whether you override the rule action for either of the rules in your web ACL configuration.
Amazon Web Services recommends using a regular expression.
This setting is required if UsageOfAction
is set to ENABLED
. If required, you can provide between 1 and 5 regex objects in the array of settings.
Amazon Web Services recommends starting with the following setting. Review and update it for your application's needs:
\/api\/|\.(acc|avi|css|gif|jpe?g|js|mp\[34\]|ogg|otf|pdf|png|tiff?|ttf|webm|webp|woff2?)$
Sourcepub fn set_exempt_uri_regular_expressions(
self,
input: Option<Vec<Regex>>,
) -> Self
pub fn set_exempt_uri_regular_expressions( self, input: Option<Vec<Regex>>, ) -> Self
The regular expression to match against the web request URI, used to identify requests that can't handle a silent browser challenge. When the ClientSideAction
setting UsageOfAction
is enabled, the managed rule group uses this setting to determine which requests to label with awswaf:managed:aws:anti-ddos:challengeable-request
. If UsageOfAction
is disabled, this setting has no effect and the managed rule group doesn't add the label to any requests.
The anti-DDoS managed rule group doesn't evaluate the rules ChallengeDDoSRequests
or ChallengeAllDuringEvent
for web requests whose URIs match this regex. This is true regardless of whether you override the rule action for either of the rules in your web ACL configuration.
Amazon Web Services recommends using a regular expression.
This setting is required if UsageOfAction
is set to ENABLED
. If required, you can provide between 1 and 5 regex objects in the array of settings.
Amazon Web Services recommends starting with the following setting. Review and update it for your application's needs:
\/api\/|\.(acc|avi|css|gif|jpe?g|js|mp\[34\]|ogg|otf|pdf|png|tiff?|ttf|webm|webp|woff2?)$
Sourcepub fn get_exempt_uri_regular_expressions(&self) -> &Option<Vec<Regex>>
pub fn get_exempt_uri_regular_expressions(&self) -> &Option<Vec<Regex>>
The regular expression to match against the web request URI, used to identify requests that can't handle a silent browser challenge. When the ClientSideAction
setting UsageOfAction
is enabled, the managed rule group uses this setting to determine which requests to label with awswaf:managed:aws:anti-ddos:challengeable-request
. If UsageOfAction
is disabled, this setting has no effect and the managed rule group doesn't add the label to any requests.
The anti-DDoS managed rule group doesn't evaluate the rules ChallengeDDoSRequests
or ChallengeAllDuringEvent
for web requests whose URIs match this regex. This is true regardless of whether you override the rule action for either of the rules in your web ACL configuration.
Amazon Web Services recommends using a regular expression.
This setting is required if UsageOfAction
is set to ENABLED
. If required, you can provide between 1 and 5 regex objects in the array of settings.
Amazon Web Services recommends starting with the following setting. Review and update it for your application's needs:
\/api\/|\.(acc|avi|css|gif|jpe?g|js|mp\[34\]|ogg|otf|pdf|png|tiff?|ttf|webm|webp|woff2?)$
Sourcepub fn build(self) -> Result<ClientSideAction, BuildError>
pub fn build(self) -> Result<ClientSideAction, BuildError>
Consumes the builder and constructs a ClientSideAction
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ClientSideActionBuilder
impl Clone for ClientSideActionBuilder
Source§fn clone(&self) -> ClientSideActionBuilder
fn clone(&self) -> ClientSideActionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClientSideActionBuilder
impl Debug for ClientSideActionBuilder
Source§impl Default for ClientSideActionBuilder
impl Default for ClientSideActionBuilder
Source§fn default() -> ClientSideActionBuilder
fn default() -> ClientSideActionBuilder
Source§impl PartialEq for ClientSideActionBuilder
impl PartialEq for ClientSideActionBuilder
Source§fn eq(&self, other: &ClientSideActionBuilder) -> bool
fn eq(&self, other: &ClientSideActionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ClientSideActionBuilder
Auto Trait Implementations§
impl Freeze for ClientSideActionBuilder
impl RefUnwindSafe for ClientSideActionBuilder
impl Send for ClientSideActionBuilder
impl Sync for ClientSideActionBuilder
impl Unpin for ClientSideActionBuilder
impl UnwindSafe for ClientSideActionBuilder
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);