Interface Rule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Rule.Builder,
,Rule> SdkBuilder<Rule.Builder,
,Rule> SdkPojo
- Enclosing class:
Rule
-
Method Summary
Modifier and TypeMethodDescriptionmetricName
(String metricName) A friendly name or description for the metrics for thisRule
.The friendly name or description for theRule
.predicates
(Collection<Predicate> predicates) ThePredicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.predicates
(Consumer<Predicate.Builder>... predicates) ThePredicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.predicates
(Predicate... predicates) ThePredicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.A unique identifier for aRule
.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
-
ruleId
A unique identifier for a
Rule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Parameters:
ruleId
- A unique identifier for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The friendly name or description for the
Rule
. You can't change the name of aRule
after you create it.- Parameters:
name
- The friendly name or description for theRule
. You can't change the name of aRule
after you create it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricName
A friendly name or description for the metrics for this
Rule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't changeMetricName
after you create theRule
.- Parameters:
metricName
- A friendly name or description for the metrics for thisRule
. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't changeMetricName
after you create theRule
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predicates
The
Predicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.- Parameters:
predicates
- ThePredicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predicates
The
Predicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.- Parameters:
predicates
- ThePredicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
predicates
The
This is a convenience method that creates an instance of thePredicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.Predicate.Builder
avoiding the need to create one manually viaPredicate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topredicates(List<Predicate>)
.- Parameters:
predicates
- a consumer that will call methods onPredicate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-