@Stability(value=Stable) public static final class CfnWebACLProps.Builder extends Object implements software.amazon.jsii.Builder<CfnWebACLProps>
CfnWebACLProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnWebACLProps.Builder defaultAction(CfnWebACL.DefaultActionProperty defaultAction)
CfnWebACLProps.getDefaultAction()defaultAction - The action to perform if none of the `Rules` contained in the `WebACL` match. This parameter is required.this@Stability(value=Stable) public CfnWebACLProps.Builder defaultAction(IResolvable defaultAction)
CfnWebACLProps.getDefaultAction()defaultAction - The action to perform if none of the `Rules` contained in the `WebACL` match. This parameter is required.this@Stability(value=Stable) public CfnWebACLProps.Builder scope(String scope)
CfnWebACLProps.getScope()scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. This parameter is required.
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. 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 .
this@Stability(value=Stable) public CfnWebACLProps.Builder visibilityConfig(CfnWebACL.VisibilityConfigProperty visibilityConfig)
CfnWebACLProps.getVisibilityConfig()visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. This parameter is required.this@Stability(value=Stable) public CfnWebACLProps.Builder visibilityConfig(IResolvable visibilityConfig)
CfnWebACLProps.getVisibilityConfig()visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection. This parameter is required.this@Stability(value=Stable) public CfnWebACLProps.Builder captchaConfig(CfnWebACL.CaptchaConfigProperty captchaConfig)
CfnWebACLProps.getCaptchaConfig()captchaConfig - 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 .this@Stability(value=Stable) public CfnWebACLProps.Builder captchaConfig(IResolvable captchaConfig)
CfnWebACLProps.getCaptchaConfig()captchaConfig - 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 .this@Stability(value=Stable) public CfnWebACLProps.Builder customResponseBodies(IResolvable customResponseBodies)
CfnWebACLProps.getCustomResponseBodies()customResponseBodies - 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 .
this@Stability(value=Stable) public CfnWebACLProps.Builder customResponseBodies(Map<String,? extends Object> customResponseBodies)
CfnWebACLProps.getCustomResponseBodies()customResponseBodies - 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 .
this@Stability(value=Stable) public CfnWebACLProps.Builder description(String description)
CfnWebACLProps.getDescription()description - A description of the web ACL that helps with identification.this@Stability(value=Stable) public CfnWebACLProps.Builder name(String name)
CfnWebACLProps.getName()name - The name of the web ACL.
You cannot change the name of a web ACL after you create it.this@Stability(value=Stable) public CfnWebACLProps.Builder rules(IResolvable rules)
CfnWebACLProps.getRules()rules - 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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.this@Stability(value=Stable) public CfnWebACLProps.Builder rules(List<? extends Object> rules)
CfnWebACLProps.getRules()rules - 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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.this@Stability(value=Stable) public CfnWebACLProps.Builder tags(List<? extends CfnTag> tags)
CfnWebACLProps.getTags()tags - 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.
this@Stability(value=Stable) public CfnWebACLProps build()
build in interface software.amazon.jsii.Builder<CfnWebACLProps>CfnWebACLPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.