@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RuleGroup extends Object implements Serializable, Cloneable, StructuredPojo
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
Constructor and Description |
---|
RuleGroup() |
Modifier and Type | Method and Description |
---|---|
RuleGroup |
addCustomResponseBodiesEntry(String key,
CustomResponseBody value)
Add a single CustomResponseBodies entry
|
RuleGroup |
clearCustomResponseBodiesEntries()
Removes all the entries added into CustomResponseBodies.
|
RuleGroup |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The Amazon Resource Name (ARN) of the entity.
|
List<LabelSummary> |
getAvailableLabels()
The labels that one or more rules in this rule group add to matching web requests.
|
Long |
getCapacity()
The web ACL capacity units (WCUs) required for this rule group.
|
List<LabelSummary> |
getConsumedLabels()
The labels that one or more rules in this rule group match against in label match statements.
|
Map<String,CustomResponseBody> |
getCustomResponseBodies()
A map of custom response keys and content bodies.
|
String |
getDescription()
A description of the rule group that helps with identification.
|
String |
getId()
A unique identifier for the rule group.
|
String |
getLabelNamespace()
The label namespace prefix for this rule group.
|
String |
getName()
The name of the rule group.
|
List<Rule> |
getRules()
The Rule statements used to identify the web requests that you want to manage.
|
VisibilityConfig |
getVisibilityConfig()
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
|
void |
setAvailableLabels(Collection<LabelSummary> availableLabels)
The labels that one or more rules in this rule group add to matching web requests.
|
void |
setCapacity(Long capacity)
The web ACL capacity units (WCUs) required for this rule group.
|
void |
setConsumedLabels(Collection<LabelSummary> consumedLabels)
The labels that one or more rules in this rule group match against in label match statements.
|
void |
setCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies)
A map of custom response keys and content bodies.
|
void |
setDescription(String description)
A description of the rule group that helps with identification.
|
void |
setId(String id)
A unique identifier for the rule group.
|
void |
setLabelNamespace(String labelNamespace)
The label namespace prefix for this rule group.
|
void |
setName(String name)
The name of the rule group.
|
void |
setRules(Collection<Rule> rules)
The Rule statements used to identify the web requests that you want to manage.
|
void |
setVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
String |
toString()
Returns a string representation of this object.
|
RuleGroup |
withARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
|
RuleGroup |
withAvailableLabels(Collection<LabelSummary> availableLabels)
The labels that one or more rules in this rule group add to matching web requests.
|
RuleGroup |
withAvailableLabels(LabelSummary... availableLabels)
The labels that one or more rules in this rule group add to matching web requests.
|
RuleGroup |
withCapacity(Long capacity)
The web ACL capacity units (WCUs) required for this rule group.
|
RuleGroup |
withConsumedLabels(Collection<LabelSummary> consumedLabels)
The labels that one or more rules in this rule group match against in label match statements.
|
RuleGroup |
withConsumedLabels(LabelSummary... consumedLabels)
The labels that one or more rules in this rule group match against in label match statements.
|
RuleGroup |
withCustomResponseBodies(Map<String,CustomResponseBody> customResponseBodies)
A map of custom response keys and content bodies.
|
RuleGroup |
withDescription(String description)
A description of the rule group that helps with identification.
|
RuleGroup |
withId(String id)
A unique identifier for the rule group.
|
RuleGroup |
withLabelNamespace(String labelNamespace)
The label namespace prefix for this rule group.
|
RuleGroup |
withName(String name)
The name of the rule group.
|
RuleGroup |
withRules(Collection<Rule> rules)
The Rule statements used to identify the web requests that you want to manage.
|
RuleGroup |
withRules(Rule... rules)
The Rule statements used to identify the web requests that you want to manage.
|
RuleGroup |
withVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
public void setName(String name)
The name of the rule group. You cannot change the name of a rule group after you create it.
name
- The name of the rule group. You cannot change the name of a rule group after you create it.public String getName()
The name of the rule group. You cannot change the name of a rule group after you create it.
public RuleGroup withName(String name)
The name of the rule group. You cannot change the name of a rule group after you create it.
name
- The name of the rule group. You cannot change the name of a rule group after you create it.public void setId(String id)
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
id
- A unique identifier for the rule group. This ID is returned in the responses to create and list commands.
You provide it to operations like update and delete.public String getId()
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
public RuleGroup withId(String id)
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
id
- A unique identifier for the rule group. This ID is returned in the responses to create and list commands.
You provide it to operations like update and delete.public void setCapacity(Long capacity)
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
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.
capacity
- The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
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.
public Long getCapacity()
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
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.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
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.
public RuleGroup withCapacity(Long capacity)
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
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.
capacity
- The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
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.
public void setARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
aRN
- The Amazon Resource Name (ARN) of the entity.public String getARN()
The Amazon Resource Name (ARN) of the entity.
public RuleGroup withARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
aRN
- The Amazon Resource Name (ARN) of the entity.public void setDescription(String description)
A description of the rule group that helps with identification.
description
- A description of the rule group that helps with identification.public String getDescription()
A description of the rule group that helps with identification.
public RuleGroup withDescription(String description)
A description of the rule group that helps with identification.
description
- A description of the rule group that helps with identification.public List<Rule> getRules()
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.
public void setRules(Collection<Rule> 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.
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.public RuleGroup withRules(Rule... 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.
NOTE: This method appends the values to the existing list (if any). Use
setRules(java.util.Collection)
or withRules(java.util.Collection)
if you want to override the
existing values.
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.public RuleGroup withRules(Collection<Rule> 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.
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.public void setVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
visibilityConfig
- Defines and enables Amazon CloudWatch metrics and web request sample collection.public VisibilityConfig getVisibilityConfig()
Defines and enables Amazon CloudWatch metrics and web request sample collection.
public RuleGroup withVisibilityConfig(VisibilityConfig visibilityConfig)
Defines and enables Amazon CloudWatch metrics and web request sample collection.
visibilityConfig
- Defines and enables Amazon CloudWatch metrics and web request sample collection.public void setLabelNamespace(String labelNamespace)
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group 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>
labelNamespace
- The label namespace prefix for this rule group. All labels added by rules in this rule group have this
prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group 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>
public String getLabelNamespace()
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group 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>
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group 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>
public RuleGroup withLabelNamespace(String labelNamespace)
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group 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>
labelNamespace
- The label namespace prefix for this rule group. All labels added by rules in this rule group have this
prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group 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>
public Map<String,CustomResponseBody> getCustomResponseBodies()
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 rule group, and then use them in the rules that you define in the rule group.
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.
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.
public void setCustomResponseBodies(Map<String,CustomResponseBody> 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 rule group, and then use them in the rules that you define in the rule group.
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.
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 rule group, and then use them in the rules
that you define in the rule group.
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.
public RuleGroup withCustomResponseBodies(Map<String,CustomResponseBody> 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 rule group, and then use them in the rules that you define in the rule group.
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.
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 rule group, and then use them in the rules
that you define in the rule group.
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.
public RuleGroup addCustomResponseBodiesEntry(String key, CustomResponseBody value)
public RuleGroup clearCustomResponseBodiesEntries()
public List<LabelSummary> getAvailableLabels()
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels
for a Rule.
RuleLabels
for a Rule.public void setAvailableLabels(Collection<LabelSummary> availableLabels)
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels
for a Rule.
availableLabels
- The labels that one or more rules in this rule group add to matching web requests. These labels are
defined in the RuleLabels
for a Rule.public RuleGroup withAvailableLabels(LabelSummary... availableLabels)
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels
for a Rule.
NOTE: This method appends the values to the existing list (if any). Use
setAvailableLabels(java.util.Collection)
or withAvailableLabels(java.util.Collection)
if you
want to override the existing values.
availableLabels
- The labels that one or more rules in this rule group add to matching web requests. These labels are
defined in the RuleLabels
for a Rule.public RuleGroup withAvailableLabels(Collection<LabelSummary> availableLabels)
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels
for a Rule.
availableLabels
- The labels that one or more rules in this rule group add to matching web requests. These labels are
defined in the RuleLabels
for a Rule.public List<LabelSummary> getConsumedLabels()
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement
specification, in the Statement definition of a rule.
LabelMatchStatement
specification, in the Statement
definition of a rule.public void setConsumedLabels(Collection<LabelSummary> consumedLabels)
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement
specification, in the Statement definition of a rule.
consumedLabels
- The labels that one or more rules in this rule group match against in label match statements. These labels
are defined in a LabelMatchStatement
specification, in the Statement definition of a
rule.public RuleGroup withConsumedLabels(LabelSummary... consumedLabels)
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement
specification, in the Statement definition of a rule.
NOTE: This method appends the values to the existing list (if any). Use
setConsumedLabels(java.util.Collection)
or withConsumedLabels(java.util.Collection)
if you want
to override the existing values.
consumedLabels
- The labels that one or more rules in this rule group match against in label match statements. These labels
are defined in a LabelMatchStatement
specification, in the Statement definition of a
rule.public RuleGroup withConsumedLabels(Collection<LabelSummary> consumedLabels)
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement
specification, in the Statement definition of a rule.
consumedLabels
- The labels that one or more rules in this rule group match against in label match statements. These labels
are defined in a LabelMatchStatement
specification, in the Statement definition of a
rule.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.