Struct aws_sdk_wafv2::input::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>,
}

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, or an AppSync GraphQL API.

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 allow, block, or count. 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.

Implementations

impl CreateWebAclInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateWebACL, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateWebACL>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateWebAclInput

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, or an AppSync GraphQL API.

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) -> Option<&[Rule]>

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

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

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

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

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

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.

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<CreateWebAclInput> for CreateWebAclInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for CreateWebAclInput