software.amazon.awssdk.services.securityhub.model

Interface AwsWafWebAclRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsWafWebAclRule.Builder,AwsWafWebAclRule>, SdkBuilder<AwsWafWebAclRule.Builder,AwsWafWebAclRule>, SdkPojo

Enclosing class:

AwsWafWebAclRule

public static interface AwsWafWebAclRule.Builder
extends SdkPojo, CopyableBuilder<AwsWafWebAclRule.Builder,AwsWafWebAclRule>

Method Summary

Modifier and Type	Method and Description
default AwsWafWebAclRule.Builder	action(Consumer<WafAction.Builder> action) Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
AwsWafWebAclRule.Builder	action(WafAction action) Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
AwsWafWebAclRule.Builder	excludedRules(Collection<WafExcludedRule> excludedRules) Rules to exclude from a rule group.
AwsWafWebAclRule.Builder	excludedRules(Consumer<WafExcludedRule.Builder>... excludedRules) Rules to exclude from a rule group.
AwsWafWebAclRule.Builder	excludedRules(WafExcludedRule... excludedRules) Rules to exclude from a rule group.
default AwsWafWebAclRule.Builder	overrideAction(Consumer<WafOverrideAction.Builder> overrideAction) Use the OverrideAction to test your RuleGroup.
AwsWafWebAclRule.Builder	overrideAction(WafOverrideAction overrideAction) Use the OverrideAction to test your RuleGroup.
AwsWafWebAclRule.Builder	priority(Integer priority) Specifies the order in which the rules in a web ACL are evaluated.
AwsWafWebAclRule.Builder	ruleId(String ruleId) The identifier for a rule.
AwsWafWebAclRule.Builder	type(String type) The rule type.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

action

AwsWafWebAclRule.Builder action(WafAction action)

Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

Parameters:

action - Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

action

default AwsWafWebAclRule.Builder action(Consumer<WafAction.Builder> action)

Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

This is a convenience method that creates an instance of the WafAction.Builder avoiding the need to create one manually via WafAction.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to action(WafAction).

Parameters:

action - a consumer that will call methods on WafAction.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

action(WafAction)

excludedRules

AwsWafWebAclRule.Builder excludedRules(Collection<WafExcludedRule> excludedRules)

Rules to exclude from a rule group.

Parameters:

excludedRules - Rules to exclude from a rule group.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludedRules

AwsWafWebAclRule.Builder excludedRules(WafExcludedRule... excludedRules)

Rules to exclude from a rule group.

Parameters:

excludedRules - Rules to exclude from a rule group.

Returns:

Returns a reference to this object so that method calls can be chained together.

excludedRules

AwsWafWebAclRule.Builder excludedRules(Consumer<WafExcludedRule.Builder>... excludedRules)

Rules to exclude from a rule group.

This is a convenience method that creates an instance of the WafExcludedRule.Builder avoiding the need to create one manually via WafExcludedRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #excludedRules(List).

Parameters:

excludedRules - a consumer that will call methods on WafExcludedRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#excludedRules(java.util.Collection)

overrideAction

AwsWafWebAclRule.Builder overrideAction(WafOverrideAction overrideAction)

Use the OverrideAction to test your RuleGroup.

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you do not use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

Parameters:

overrideAction - Use the OverrideAction to test your RuleGroup.

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you do not use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideAction

default AwsWafWebAclRule.Builder overrideAction(Consumer<WafOverrideAction.Builder> overrideAction)

Use the OverrideAction to test your RuleGroup.

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you do not use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

This is a convenience method that creates an instance of the WafOverrideAction.Builder avoiding the need to create one manually via WafOverrideAction.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideAction(WafOverrideAction).

Parameters:

overrideAction - a consumer that will call methods on WafOverrideAction.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

overrideAction(WafOverrideAction)

priority

AwsWafWebAclRule.Builder priority(Integer priority)

Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values do not need to be consecutive.

Parameters:

priority - Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values do not need to be consecutive.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleId

AwsWafWebAclRule.Builder ruleId(String ruleId)

The identifier for a rule.

Parameters:

ruleId - The identifier for a rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

AwsWafWebAclRule.Builder type(String type)

The rule type.

Valid values: REGULAR | RATE_BASED | GROUP

The default is REGULAR.

Parameters:

type - The rule type.

Valid values: REGULAR | RATE_BASED | GROUP

The default is REGULAR.

Returns:

Returns a reference to this object so that method calls can be chained together.