Class FirewallManagerRuleGroup
- java.lang.Object
-
- software.amazon.awssdk.services.wafv2.model.FirewallManagerRuleGroup
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FirewallManagerRuleGroup.Builder,FirewallManagerRuleGroup>
@Generated("software.amazon.awssdk:codegen") public final class FirewallManagerRuleGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FirewallManagerRuleGroup.Builder,FirewallManagerRuleGroup>
A rule group that's defined for an Firewall Manager WAF policy.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFirewallManagerRuleGroup.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FirewallManagerRuleGroup.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FirewallManagerStatementfirewallManagerStatement()The processing guidance for an Firewall Manager rule.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()The name of the rule group.OverrideActionoverrideAction()The action to use in the place of the action that results from the rule group evaluation.Integerpriority()If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends FirewallManagerRuleGroup.Builder>serializableBuilderClass()FirewallManagerRuleGroup.BuildertoBuilder()StringtoString()Returns a string representation of this object.VisibilityConfigvisibilityConfig()Defines and enables Amazon CloudWatch metrics and web request sample collection.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the rule group. You cannot change the name of a rule group after you create it.
- Returns:
- The name of the rule group. You cannot change the name of a rule group after you create it.
-
priority
public final Integer priority()
If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
- Returns:
- If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
-
firewallManagerStatement
public final FirewallManagerStatement firewallManagerStatement()
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
- Returns:
- The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
-
overrideAction
public final OverrideAction overrideAction()
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like
RuleGroupReferenceStatementandManagedRuleGroupStatement.This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with
Countaction, in your rule group reference statement settings.- Returns:
- The action to use in the place of the action that results from the rule group evaluation. Set the
override action to none to leave the result of the rule group alone. Set it to count to override the
result to count only.
You can only use this for rule statements that reference a rule group, like
RuleGroupReferenceStatementandManagedRuleGroupStatement.This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with
Countaction, in your rule group reference statement settings.
-
visibilityConfig
public final VisibilityConfig visibilityConfig()
Defines and enables Amazon CloudWatch metrics and web request sample collection.
- Returns:
- Defines and enables Amazon CloudWatch metrics and web request sample collection.
-
toBuilder
public FirewallManagerRuleGroup.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FirewallManagerRuleGroup.Builder,FirewallManagerRuleGroup>
-
builder
public static FirewallManagerRuleGroup.Builder builder()
-
serializableBuilderClass
public static Class<? extends FirewallManagerRuleGroup.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-