Interface WebACL.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WebACL.Builder,
,WebACL> SdkBuilder<WebACL.Builder,
,WebACL> SdkPojo
- Enclosing class:
WebACL
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.default WebACL.Builder
associationConfig
(Consumer<AssociationConfig.Builder> associationConfig) Specifies custom configurations for the associations between the web ACL and protected resources.associationConfig
(AssociationConfig associationConfig) Specifies custom configurations for the associations between the web ACL and protected resources.The web ACL capacity units (WCUs) currently being used by this web ACL.default WebACL.Builder
captchaConfig
(Consumer<CaptchaConfig.Builder> captchaConfig) Specifies how WAF should handleCAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings.captchaConfig
(CaptchaConfig captchaConfig) Specifies how WAF should handleCAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings.default WebACL.Builder
challengeConfig
(Consumer<ChallengeConfig.Builder> challengeConfig) Specifies how WAF should handle challenge evaluations for rules that don't have their ownChallengeConfig
settings.challengeConfig
(ChallengeConfig challengeConfig) Specifies how WAF should handle challenge evaluations for rules that don't have their ownChallengeConfig
settings.customResponseBodies
(Map<String, CustomResponseBody> customResponseBodies) A map of custom response keys and content bodies.default WebACL.Builder
defaultAction
(Consumer<DefaultAction.Builder> defaultAction) The action to perform if none of theRules
contained in theWebACL
match.defaultAction
(DefaultAction defaultAction) The action to perform if none of theRules
contained in theWebACL
match.description
(String description) A description of the web ACL that helps with identification.A unique identifier for theWebACL
.labelNamespace
(String labelNamespace) The label namespace prefix for this web ACL.managedByFirewallManager
(Boolean managedByFirewallManager) Indicates whether this web ACL is managed by Firewall Manager.The name of the web ACL.postProcessFirewallManagerRuleGroups
(Collection<FirewallManagerRuleGroup> postProcessFirewallManagerRuleGroups) The last set of rules for WAF to process in the web ACL.postProcessFirewallManagerRuleGroups
(Consumer<FirewallManagerRuleGroup.Builder>... postProcessFirewallManagerRuleGroups) The last set of rules for WAF to process in the web ACL.postProcessFirewallManagerRuleGroups
(FirewallManagerRuleGroup... postProcessFirewallManagerRuleGroups) The last set of rules for WAF to process in the web ACL.preProcessFirewallManagerRuleGroups
(Collection<FirewallManagerRuleGroup> preProcessFirewallManagerRuleGroups) The first set of rules for WAF to process in the web ACL.preProcessFirewallManagerRuleGroups
(Consumer<FirewallManagerRuleGroup.Builder>... preProcessFirewallManagerRuleGroups) The first set of rules for WAF to process in the web ACL.preProcessFirewallManagerRuleGroups
(FirewallManagerRuleGroup... preProcessFirewallManagerRuleGroups) The first set of rules for WAF to process in the web ACL.rules
(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to manage.rules
(Consumer<Rule.Builder>... rules) The Rule statements used to identify the web requests that you want to manage.The Rule statements used to identify the web requests that you want to manage.tokenDomains
(String... tokenDomains) Specifies the domains that WAF should accept in a web request token.tokenDomains
(Collection<String> tokenDomains) Specifies the domains that WAF should accept in a web request token.default WebACL.Builder
visibilityConfig
(Consumer<VisibilityConfig.Builder> visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.visibilityConfig
(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Parameters:
name
- The name of the web ACL. You cannot change the name of a web ACL after you create it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
id
A unique identifier for the
WebACL
. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete aWebACL
.- Parameters:
id
- A unique identifier for theWebACL
. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete aWebACL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultAction
The action to perform if none of the
Rules
contained in theWebACL
match.- Parameters:
defaultAction
- The action to perform if none of theRules
contained in theWebACL
match.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultAction
The action to perform if none of the
This is a convenience method that creates an instance of theRules
contained in theWebACL
match.DefaultAction.Builder
avoiding the need to create one manually viaDefaultAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultAction(DefaultAction)
.- Parameters:
defaultAction
- a consumer that will call methods onDefaultAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
A description of the web ACL that helps with identification.
- Parameters:
description
- A description of the web ACL that helps with identification.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theRule.Builder
avoiding the need to create one manually viaRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torules(List<Rule>)
.- Parameters:
rules
- a consumer that will call methods onRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
- Parameters:
visibilityConfig
- Defines and enables Amazon CloudWatch metrics and web request sample collection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
This is a convenience method that creates an instance of theVisibilityConfig.Builder
avoiding the need to create one manually viaVisibilityConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisibilityConfig(VisibilityConfig)
.- Parameters:
visibilityConfig
- a consumer that will call methods onVisibilityConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
capacity
The web ACL capacity units (WCUs) currently being used by this web ACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
- Parameters:
capacity
- The web ACL capacity units (WCUs) currently being used by this web ACL.WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preProcessFirewallManagerRuleGroups
WebACL.Builder preProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> preProcessFirewallManagerRuleGroups) The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Parameters:
preProcessFirewallManagerRuleGroups
- The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preProcessFirewallManagerRuleGroups
WebACL.Builder preProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... preProcessFirewallManagerRuleGroups) The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Parameters:
preProcessFirewallManagerRuleGroups
- The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preProcessFirewallManagerRuleGroups
WebACL.Builder preProcessFirewallManagerRuleGroups(Consumer<FirewallManagerRuleGroup.Builder>... preProcessFirewallManagerRuleGroups) The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
This is a convenience method that creates an instance of theFirewallManagerRuleGroup.Builder
avoiding the need to create one manually viaFirewallManagerRuleGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topreProcessFirewallManagerRuleGroups(List<FirewallManagerRuleGroup>)
.- Parameters:
preProcessFirewallManagerRuleGroups
- a consumer that will call methods onFirewallManagerRuleGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
postProcessFirewallManagerRuleGroups
WebACL.Builder postProcessFirewallManagerRuleGroups(Collection<FirewallManagerRuleGroup> postProcessFirewallManagerRuleGroups) The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Parameters:
postProcessFirewallManagerRuleGroups
- The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postProcessFirewallManagerRuleGroups
WebACL.Builder postProcessFirewallManagerRuleGroups(FirewallManagerRuleGroup... postProcessFirewallManagerRuleGroups) The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Parameters:
postProcessFirewallManagerRuleGroups
- The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postProcessFirewallManagerRuleGroups
WebACL.Builder postProcessFirewallManagerRuleGroups(Consumer<FirewallManagerRuleGroup.Builder>... postProcessFirewallManagerRuleGroups) The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
This is a convenience method that creates an instance of theFirewallManagerRuleGroup.Builder
avoiding the need to create one manually viaFirewallManagerRuleGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topostProcessFirewallManagerRuleGroups(List<FirewallManagerRuleGroup>)
.- Parameters:
postProcessFirewallManagerRuleGroups
- a consumer that will call methods onFirewallManagerRuleGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
managedByFirewallManager
Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
- Parameters:
managedByFirewallManager
- Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
labelNamespace
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
-
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
-
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
- Parameters:
labelNamespace
- The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.-
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
-
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 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.
- Parameters:
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 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
captchaConfig
Specifies how WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, WAF uses its default settings forCaptchaConfig
.- Parameters:
captchaConfig
- Specifies how WAF should handleCAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, WAF uses its default settings forCaptchaConfig
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
captchaConfig
Specifies how WAF should handle
This is a convenience method that creates an instance of theCAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, WAF uses its default settings forCaptchaConfig
.CaptchaConfig.Builder
avoiding the need to create one manually viaCaptchaConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocaptchaConfig(CaptchaConfig)
.- Parameters:
captchaConfig
- a consumer that will call methods onCaptchaConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 forChallengeConfig
.- Parameters:
challengeConfig
- Specifies how WAF should handle challenge evaluations for rules that don't have their ownChallengeConfig
settings. If you don't specify this, WAF uses its default settings forChallengeConfig
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
challengeConfig
Specifies how WAF should handle challenge evaluations for rules that don't have their own
This is a convenience method that creates an instance of theChallengeConfig
settings. If you don't specify this, WAF uses its default settings forChallengeConfig
.ChallengeConfig.Builder
avoiding the need to create one manually viaChallengeConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochallengeConfig(ChallengeConfig)
.- Parameters:
challengeConfig
- a consumer that will call methods onChallengeConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tokenDomains
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.
- Parameters:
tokenDomains
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tokenDomains
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.
- Parameters:
tokenDomains
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
- Parameters:
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).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
This is a convenience method that creates an instance of theAssociationConfig.Builder
avoiding the need to create one manually viaAssociationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toassociationConfig(AssociationConfig)
.- Parameters:
associationConfig
- a consumer that will call methods onAssociationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-