#[non_exhaustive]pub struct AwsManagedRulesAcfpRuleSetBuilder { /* private fields */ }
Expand description
A builder for AwsManagedRulesAcfpRuleSet
.
Implementations§
Source§impl AwsManagedRulesAcfpRuleSetBuilder
impl AwsManagedRulesAcfpRuleSetBuilder
Sourcepub fn creation_path(self, input: impl Into<String>) -> Self
pub fn creation_path(self, input: impl Into<String>) -> Self
The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST
requests.
For example, for the URL https://example.com/web/newaccount
, you would provide the path /web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount
matches the account creation paths /web/newaccount
, /web/newaccount/
, /web/newaccountPage
, and /web/newaccount/thisPage
, but doesn't match the path /home/web/newaccount
or /website/newaccount
.
Sourcepub fn set_creation_path(self, input: Option<String>) -> Self
pub fn set_creation_path(self, input: Option<String>) -> Self
The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST
requests.
For example, for the URL https://example.com/web/newaccount
, you would provide the path /web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount
matches the account creation paths /web/newaccount
, /web/newaccount/
, /web/newaccountPage
, and /web/newaccount/thisPage
, but doesn't match the path /home/web/newaccount
or /website/newaccount
.
Sourcepub fn get_creation_path(&self) -> &Option<String>
pub fn get_creation_path(&self) -> &Option<String>
The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST
requests.
For example, for the URL https://example.com/web/newaccount
, you would provide the path /web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example /web/newaccount
matches the account creation paths /web/newaccount
, /web/newaccount/
, /web/newaccountPage
, and /web/newaccount/thisPage
, but doesn't match the path /home/web/newaccount
or /website/newaccount
.
Sourcepub fn registration_page_path(self, input: impl Into<String>) -> Self
pub fn registration_page_path(self, input: impl Into<String>) -> Self
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept GET
text/html requests.
For example, for the URL https://example.com/web/registration
, you would provide the path /web/registration
. Registration page paths that start with the path that you provide are considered a match. For example /web/registration
matches the registration paths /web/registration
, /web/registration/
, /web/registrationPage
, and /web/registration/thisPage
, but doesn't match the path /home/web/registration
or /website/registration
.
Sourcepub fn set_registration_page_path(self, input: Option<String>) -> Self
pub fn set_registration_page_path(self, input: Option<String>) -> Self
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept GET
text/html requests.
For example, for the URL https://example.com/web/registration
, you would provide the path /web/registration
. Registration page paths that start with the path that you provide are considered a match. For example /web/registration
matches the registration paths /web/registration
, /web/registration/
, /web/registrationPage
, and /web/registration/thisPage
, but doesn't match the path /home/web/registration
or /website/registration
.
Sourcepub fn get_registration_page_path(&self) -> &Option<String>
pub fn get_registration_page_path(&self) -> &Option<String>
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept GET
text/html requests.
For example, for the URL https://example.com/web/registration
, you would provide the path /web/registration
. Registration page paths that start with the path that you provide are considered a match. For example /web/registration
matches the registration paths /web/registration
, /web/registration/
, /web/registrationPage
, and /web/registration/thisPage
, but doesn't match the path /home/web/registration
or /website/registration
.
Sourcepub fn request_inspection(self, input: RequestInspectionAcfp) -> Self
pub fn request_inspection(self, input: RequestInspectionAcfp) -> Self
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
This field is required.Sourcepub fn set_request_inspection(
self,
input: Option<RequestInspectionAcfp>,
) -> Self
pub fn set_request_inspection( self, input: Option<RequestInspectionAcfp>, ) -> Self
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
Sourcepub fn get_request_inspection(&self) -> &Option<RequestInspectionAcfp>
pub fn get_request_inspection(&self) -> &Option<RequestInspectionAcfp>
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
Sourcepub fn response_inspection(self, input: ResponseInspection) -> Self
pub fn response_inspection(self, input: ResponseInspection) -> Self
The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
Sourcepub fn set_response_inspection(self, input: Option<ResponseInspection>) -> Self
pub fn set_response_inspection(self, input: Option<ResponseInspection>) -> Self
The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
Sourcepub fn get_response_inspection(&self) -> &Option<ResponseInspection>
pub fn get_response_inspection(&self) -> &Option<ResponseInspection>
The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
Sourcepub fn enable_regex_in_path(self, input: bool) -> Self
pub fn enable_regex_in_path(self, input: bool) -> Self
Allow the use of regular expressions in the registration page path and the account creation path.
Sourcepub fn set_enable_regex_in_path(self, input: Option<bool>) -> Self
pub fn set_enable_regex_in_path(self, input: Option<bool>) -> Self
Allow the use of regular expressions in the registration page path and the account creation path.
Sourcepub fn get_enable_regex_in_path(&self) -> &Option<bool>
pub fn get_enable_regex_in_path(&self) -> &Option<bool>
Allow the use of regular expressions in the registration page path and the account creation path.
Sourcepub fn build(self) -> Result<AwsManagedRulesAcfpRuleSet, BuildError>
pub fn build(self) -> Result<AwsManagedRulesAcfpRuleSet, BuildError>
Consumes the builder and constructs a AwsManagedRulesAcfpRuleSet
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AwsManagedRulesAcfpRuleSetBuilder
impl Clone for AwsManagedRulesAcfpRuleSetBuilder
Source§fn clone(&self) -> AwsManagedRulesAcfpRuleSetBuilder
fn clone(&self) -> AwsManagedRulesAcfpRuleSetBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for AwsManagedRulesAcfpRuleSetBuilder
impl Default for AwsManagedRulesAcfpRuleSetBuilder
Source§fn default() -> AwsManagedRulesAcfpRuleSetBuilder
fn default() -> AwsManagedRulesAcfpRuleSetBuilder
Source§impl PartialEq for AwsManagedRulesAcfpRuleSetBuilder
impl PartialEq for AwsManagedRulesAcfpRuleSetBuilder
Source§fn eq(&self, other: &AwsManagedRulesAcfpRuleSetBuilder) -> bool
fn eq(&self, other: &AwsManagedRulesAcfpRuleSetBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AwsManagedRulesAcfpRuleSetBuilder
Auto Trait Implementations§
impl Freeze for AwsManagedRulesAcfpRuleSetBuilder
impl RefUnwindSafe for AwsManagedRulesAcfpRuleSetBuilder
impl Send for AwsManagedRulesAcfpRuleSetBuilder
impl Sync for AwsManagedRulesAcfpRuleSetBuilder
impl Unpin for AwsManagedRulesAcfpRuleSetBuilder
impl UnwindSafe for AwsManagedRulesAcfpRuleSetBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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);