Struct CreateWebAclInput

#[non_exhaustive]
pub struct CreateWebAclInput {
    pub name: Option<String>,
    pub scope: Option<Scope>,
    pub default_action: Option<DefaultAction>,
    pub description: Option<String>,
    pub rules: Option<Vec<Rule>>,
    pub visibility_config: Option<VisibilityConfig>,
    pub tags: Option<Vec<Tag>>,
    pub custom_response_bodies: Option<HashMap<String, CustomResponseBody>>,
    pub captcha_config: Option<CaptchaConfig>,
    pub challenge_config: Option<ChallengeConfig>,
    pub token_domains: Option<Vec<String>>,
    pub association_config: Option<AssociationConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the web ACL. You cannot change the name of a web ACL after you create it.

scope: 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.

default_action: Option<DefaultAction>

The action to perform if none of the Rules contained in the WebACL match.

description: Option<String>

A description of the web ACL that helps with identification.

rules: 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.

visibility_config: Option<VisibilityConfig>

Defines and enables Amazon CloudWatch metrics and web request sample collection.

tags: Option<Vec<Tag>>

An array of key:value pairs to associate with the resource.

custom_response_bodies: 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.

captcha_config: 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.

challenge_config: 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.

token_domains: 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.

association_config: 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).

Implementations

impl CreateWebAclInput

pub fn name(&self) -> Option<&str>

The name of the web ACL. You cannot change the name of a web ACL after you create it.

pub fn 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.

pub fn default_action(&self) -> Option<&DefaultAction>

The action to perform if none of the Rules contained in the WebACL match.

pub fn description(&self) -> Option<&str>

A description of the web ACL that helps with identification.

pub fn rules(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rules.is_none().

pub fn visibility_config(&self) -> Option<&VisibilityConfig>

Defines and enables Amazon CloudWatch metrics and web request sample collection.

pub fn tags(&self) -> &[Tag]

An array of key:value pairs to associate with the resource.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn 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.

pub fn 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.

pub fn 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.

pub fn token_domains(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .token_domains.is_none().

pub fn 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).

impl CreateWebAclInput

pub fn builder() -> CreateWebAclInputBuilder

Creates a new builder-style object to manufacture CreateWebAclInput.

Trait Implementations

impl Clone for CreateWebAclInput

fn clone(&self) -> CreateWebAclInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWebAclInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateWebAclInput

fn eq(&self, other: &CreateWebAclInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateWebAclInput