Package software.amazon.awscdk.services.wafv2

Interface CfnWebACLProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACLProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:17.448Z")
@Stability(Stable)
public interface CfnWebACLProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWebACL.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebACLProps.Builder	A builder for CfnWebACLProps
static final class	CfnWebACLProps.Jsii$Proxy	An implementation for CfnWebACLProps

Method Summary

Modifier and Type	Method	Description
static CfnWebACLProps.Builder	builder()
default Object	getAssociationConfig()	Specifies custom configurations for the associations between the web ACL and protected resources.
default Object	getCaptchaConfig()	Specifies how AWS WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
default Object	getChallengeConfig()	Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings.
default Object	getCustomResponseBodies()	A map of custom response keys and content bodies.
Object	getDefaultAction()	The action to perform if none of the Rules contained in the WebACL match.
default String	getDescription()	A description of the web ACL that helps with identification.
default String	getName()	The name of the web ACL.
default Object	getRules()	The rule statements used to identify the web requests that you want to manage.
String	getScope()	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
default List<CfnTag>	getTags()	Key:value pairs associated with an AWS resource.
default List<String>	getTokenDomains()	Specifies the domains that AWS WAF should accept in a web request token.
Object	getVisibilityConfig()	Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultAction

@Stability(Stable)
@NotNull
Object getDefaultAction()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-defaultaction

getScope

@Stability(Stable)
@NotNull
String getScope()

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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For CLOUDFRONT , you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1 .

For information about how to define the association of the web ACL with your resource, see WebACLAssociation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-scope

getVisibilityConfig

@Stability(Stable)
@NotNull
Object getVisibilityConfig()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-visibilityconfig

getAssociationConfig

@Stability(Stable)
@Nullable
default Object getAssociationConfig()

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 AWS 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 AWS WAF Pricing .

For Application Load Balancer and AWS AppSync , the limit is fixed at 8 KB (8,192 bytes).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-associationconfig

getCaptchaConfig

@Stability(Stable)
@Nullable
default Object getCaptchaConfig()

Specifies how AWS WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.

If you don't specify this, AWS WAF uses its default settings for CaptchaConfig .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-captchaconfig

getChallengeConfig

@Stability(Stable)
@Nullable
default Object getChallengeConfig()

Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings.

If you don't specify this, AWS WAF uses its default settings for ChallengeConfig .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-challengeconfig

getCustomResponseBodies

@Stability(Stable)
@Nullable
default Object getCustomResponseBodies()

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 AWS WAF in the AWS WAF Developer Guide .

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-customresponsebodies

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the web ACL that helps with identification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the web ACL.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-name

getRules

@Stability(Stable)
@Nullable
default Object getRules()

The rule statements used to identify the web requests that you want to manage.

Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-rules

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Key:value pairs associated with an AWS resource.

The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.

To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tags

getTokenDomains

@Stability(Stable)
@Nullable
default List<String> getTokenDomains()

Specifies the domains that AWS WAF should accept in a web request token.

This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html#cfn-wafv2-webacl-tokendomains

builder

@Stability(Stable)
static CfnWebACLProps.Builder builder()

Returns:

a CfnWebACLProps.Builder of CfnWebACLProps