#[non_exhaustive]pub struct CreateWebAclInputBuilder { /* private fields */ }
Expand description
A builder for CreateWebAclInput
.
Implementations§
Source§impl CreateWebAclInputBuilder
impl CreateWebAclInputBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the web ACL. You cannot change the name of a web ACL after you create it.
This field is required.Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the web ACL. You cannot change the name of a web ACL after you create it.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the web ACL. You cannot change the name of a web ACL after you create it.
Sourcepub fn scope(self, input: Scope) -> Self
pub fn scope(self, input: Scope) -> Self
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
Sourcepub fn set_scope(self, input: Option<Scope>) -> Self
pub fn set_scope(self, input: Option<Scope>) -> Self
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
Sourcepub fn get_scope(&self) -> &Option<Scope>
pub fn get_scope(&self) -> &Option<Scope>
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
Sourcepub fn default_action(self, input: DefaultAction) -> Self
pub fn default_action(self, input: DefaultAction) -> Self
The action to perform if none of the Rules
contained in the WebACL
match.
Sourcepub fn set_default_action(self, input: Option<DefaultAction>) -> Self
pub fn set_default_action(self, input: Option<DefaultAction>) -> Self
The action to perform if none of the Rules
contained in the WebACL
match.
Sourcepub fn get_default_action(&self) -> &Option<DefaultAction>
pub fn get_default_action(&self) -> &Option<DefaultAction>
The action to perform if none of the Rules
contained in the WebACL
match.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the web ACL that helps with identification.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the web ACL that helps with identification.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the web ACL that helps with identification.
Sourcepub fn rules(self, input: Rule) -> Self
pub fn rules(self, input: Rule) -> Self
Appends an item to rules
.
To override the contents of this collection use set_rules
.
The Rule
statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
Sourcepub fn set_rules(self, input: Option<Vec<Rule>>) -> Self
pub fn set_rules(self, input: Option<Vec<Rule>>) -> Self
The Rule
statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
Sourcepub fn get_rules(&self) -> &Option<Vec<Rule>>
pub fn get_rules(&self) -> &Option<Vec<Rule>>
The Rule
statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
Sourcepub fn visibility_config(self, input: VisibilityConfig) -> Self
pub fn visibility_config(self, input: VisibilityConfig) -> Self
Defines and enables Amazon CloudWatch metrics and web request sample collection.
This field is required.Sourcepub fn set_visibility_config(self, input: Option<VisibilityConfig>) -> Self
pub fn set_visibility_config(self, input: Option<VisibilityConfig>) -> Self
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Sourcepub fn get_visibility_config(&self) -> &Option<VisibilityConfig>
pub fn get_visibility_config(&self) -> &Option<VisibilityConfig>
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
An array of key:value pairs to associate with the resource.
An array of key:value pairs to associate with the resource.
An array of key:value pairs to associate with the resource.
Sourcepub fn custom_response_bodies(
self,
k: impl Into<String>,
v: CustomResponseBody,
) -> Self
pub fn custom_response_bodies( self, k: impl Into<String>, v: CustomResponseBody, ) -> Self
Adds a key-value pair to custom_response_bodies
.
To override the contents of this collection use set_custom_response_bodies
.
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
Sourcepub fn set_custom_response_bodies(
self,
input: Option<HashMap<String, CustomResponseBody>>,
) -> Self
pub fn set_custom_response_bodies( self, input: Option<HashMap<String, CustomResponseBody>>, ) -> Self
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
Sourcepub fn get_custom_response_bodies(
&self,
) -> &Option<HashMap<String, CustomResponseBody>>
pub fn get_custom_response_bodies( &self, ) -> &Option<HashMap<String, CustomResponseBody>>
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
Sourcepub fn captcha_config(self, input: CaptchaConfig) -> Self
pub fn captcha_config(self, input: CaptchaConfig) -> Self
Specifies how WAF should handle CAPTCHA
evaluations for rules that don't have their own CaptchaConfig
settings. If you don't specify this, WAF uses its default settings for CaptchaConfig
.
Sourcepub fn set_captcha_config(self, input: Option<CaptchaConfig>) -> Self
pub fn set_captcha_config(self, input: Option<CaptchaConfig>) -> Self
Specifies how WAF should handle CAPTCHA
evaluations for rules that don't have their own CaptchaConfig
settings. If you don't specify this, WAF uses its default settings for CaptchaConfig
.
Sourcepub fn get_captcha_config(&self) -> &Option<CaptchaConfig>
pub fn get_captcha_config(&self) -> &Option<CaptchaConfig>
Specifies how WAF should handle CAPTCHA
evaluations for rules that don't have their own CaptchaConfig
settings. If you don't specify this, WAF uses its default settings for CaptchaConfig
.
Sourcepub fn challenge_config(self, input: ChallengeConfig) -> Self
pub fn challenge_config(self, input: ChallengeConfig) -> Self
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig
settings. If you don't specify this, WAF uses its default settings for ChallengeConfig
.
Sourcepub fn set_challenge_config(self, input: Option<ChallengeConfig>) -> Self
pub fn set_challenge_config(self, input: Option<ChallengeConfig>) -> Self
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig
settings. If you don't specify this, WAF uses its default settings for ChallengeConfig
.
Sourcepub fn get_challenge_config(&self) -> &Option<ChallengeConfig>
pub fn get_challenge_config(&self) -> &Option<ChallengeConfig>
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig
settings. If you don't specify this, WAF uses its default settings for ChallengeConfig
.
Sourcepub fn token_domains(self, input: impl Into<String>) -> Self
pub fn token_domains(self, input: impl Into<String>) -> Self
Appends an item to token_domains
.
To override the contents of this collection use set_token_domains
.
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use gov.au
or co.uk
as token domains.
Sourcepub fn set_token_domains(self, input: Option<Vec<String>>) -> Self
pub fn set_token_domains(self, input: Option<Vec<String>>) -> Self
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use gov.au
or co.uk
as token domains.
Sourcepub fn get_token_domains(&self) -> &Option<Vec<String>>
pub fn get_token_domains(&self) -> &Option<Vec<String>>
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use gov.au
or co.uk
as token domains.
Sourcepub fn association_config(self, input: AssociationConfig) -> Self
pub fn association_config(self, input: AssociationConfig) -> Self
Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
Sourcepub fn set_association_config(self, input: Option<AssociationConfig>) -> Self
pub fn set_association_config(self, input: Option<AssociationConfig>) -> Self
Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
Sourcepub fn get_association_config(&self) -> &Option<AssociationConfig>
pub fn get_association_config(&self) -> &Option<AssociationConfig>
Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
Sourcepub fn build(self) -> Result<CreateWebAclInput, BuildError>
pub fn build(self) -> Result<CreateWebAclInput, BuildError>
Consumes the builder and constructs a CreateWebAclInput
.
Source§impl CreateWebAclInputBuilder
impl CreateWebAclInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateWebAclOutput, SdkError<CreateWebACLError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateWebAclOutput, SdkError<CreateWebACLError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateWebAclInputBuilder
impl Clone for CreateWebAclInputBuilder
Source§fn clone(&self) -> CreateWebAclInputBuilder
fn clone(&self) -> CreateWebAclInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateWebAclInputBuilder
impl Debug for CreateWebAclInputBuilder
Source§impl Default for CreateWebAclInputBuilder
impl Default for CreateWebAclInputBuilder
Source§fn default() -> CreateWebAclInputBuilder
fn default() -> CreateWebAclInputBuilder
Source§impl PartialEq for CreateWebAclInputBuilder
impl PartialEq for CreateWebAclInputBuilder
impl StructuralPartialEq for CreateWebAclInputBuilder
Auto Trait Implementations§
impl Freeze for CreateWebAclInputBuilder
impl RefUnwindSafe for CreateWebAclInputBuilder
impl Send for CreateWebAclInputBuilder
impl Sync for CreateWebAclInputBuilder
impl Unpin for CreateWebAclInputBuilder
impl UnwindSafe for CreateWebAclInputBuilder
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);