com.amazonaws.services.wafv2.model.RuleGroup Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
*
* This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including
* how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
*
*
*
* 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.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroup implements Serializable, Cloneable, StructuredPojo {
/**
*
* A friendly name of the rule group. You cannot change the name of a rule group after you create it.
*
*/
private String name;
/**
*
* 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.
*
*/
private String id;
/**
*
* 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, AWS WAF enforces this limit. You can check the capacity for a set of rules
* using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups,
* and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
*
*/
private Long capacity;
/**
*
* The Amazon Resource Name (ARN) of the entity.
*
*/
private String aRN;
/**
*
* A friendly description of the rule group. You cannot change the description of a rule group after you create it.
*
*/
private String description;
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*/
private java.util.List rules;
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*/
private VisibilityConfig visibilityConfig;
/**
*
* A friendly name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @param name
* A friendly name of the rule group. You cannot change the name of a rule group after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @return A friendly name of the rule group. You cannot change the name of a rule group after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @param name
* A friendly name of the rule group. You cannot change the name of a rule group after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
* @param 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 setId(String id) {
this.id = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withId(String id) {
setId(id);
return this;
}
/**
*
* 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, AWS WAF enforces this limit. You can check the capacity for a set of rules
* using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups,
* and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
*
*
* @param 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, AWS WAF enforces this limit. You can check the capacity for a set
* of rules using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
*/
public void setCapacity(Long capacity) {
this.capacity = 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, AWS WAF enforces this limit. You can check the capacity for a set of rules
* using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups,
* and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
*
*
* @return 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, AWS WAF enforces this limit. You can check the capacity for a
* set of rules using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
*/
public Long getCapacity() {
return this.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, AWS WAF enforces this limit. You can check the capacity for a set of rules
* using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups,
* and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
*
*
* @param 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, AWS WAF enforces this limit. You can check the capacity for a set
* of rules using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withCapacity(Long capacity) {
setCapacity(capacity);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the entity.
*
*
* @param aRN
* The Amazon Resource Name (ARN) of the entity.
*/
public void setARN(String aRN) {
this.aRN = aRN;
}
/**
*
* The Amazon Resource Name (ARN) of the entity.
*
*
* @return The Amazon Resource Name (ARN) of the entity.
*/
public String getARN() {
return this.aRN;
}
/**
*
* The Amazon Resource Name (ARN) of the entity.
*
*
* @param aRN
* The Amazon Resource Name (ARN) of the entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withARN(String aRN) {
setARN(aRN);
return this;
}
/**
*
* A friendly description of the rule group. You cannot change the description of a rule group after you create it.
*
*
* @param description
* A friendly description of the rule group. You cannot change the description of a rule group after you
* create it.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A friendly description of the rule group. You cannot change the description of a rule group after you create it.
*
*
* @return A friendly description of the rule group. You cannot change the description of a rule group after you
* create it.
*/
public String getDescription() {
return this.description;
}
/**
*
* A friendly description of the rule group. You cannot change the description of a rule group after you create it.
*
*
* @param description
* A friendly description of the rule group. You cannot change the description of a rule group after you
* create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* @return The Rule statements used to identify the web requests that you want to allow, block, or count.
* Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and
* parameters that govern how AWS WAF handles them.
*/
public java.util.List getRules() {
return rules;
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each
* rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters
* that govern how AWS WAF handles them.
*/
public void setRules(java.util.Collection rules) {
if (rules == null) {
this.rules = null;
return;
}
this.rules = new java.util.ArrayList(rules);
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRules(java.util.Collection)} or {@link #withRules(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each
* rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters
* that govern how AWS WAF handles them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withRules(Rule... rules) {
if (this.rules == null) {
setRules(new java.util.ArrayList(rules.length));
}
for (Rule ele : rules) {
this.rules.add(ele);
}
return this;
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each
* rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters
* that govern how AWS WAF handles them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withRules(java.util.Collection rules) {
setRules(rules);
return this;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public void setVisibilityConfig(VisibilityConfig visibilityConfig) {
this.visibilityConfig = visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @return Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public VisibilityConfig getVisibilityConfig() {
return this.visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroup withVisibilityConfig(VisibilityConfig visibilityConfig) {
setVisibilityConfig(visibilityConfig);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getCapacity() != null)
sb.append("Capacity: ").append(getCapacity()).append(",");
if (getARN() != null)
sb.append("ARN: ").append(getARN()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getRules() != null)
sb.append("Rules: ").append(getRules()).append(",");
if (getVisibilityConfig() != null)
sb.append("VisibilityConfig: ").append(getVisibilityConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RuleGroup == false)
return false;
RuleGroup other = (RuleGroup) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getCapacity() == null ^ this.getCapacity() == null)
return false;
if (other.getCapacity() != null && other.getCapacity().equals(this.getCapacity()) == false)
return false;
if (other.getARN() == null ^ this.getARN() == null)
return false;
if (other.getARN() != null && other.getARN().equals(this.getARN()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getRules() == null ^ this.getRules() == null)
return false;
if (other.getRules() != null && other.getRules().equals(this.getRules()) == false)
return false;
if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null)
return false;
if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getCapacity() == null) ? 0 : getCapacity().hashCode());
hashCode = prime * hashCode + ((getARN() == null) ? 0 : getARN().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getRules() == null) ? 0 : getRules().hashCode());
hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode());
return hashCode;
}
@Override
public RuleGroup clone() {
try {
return (RuleGroup) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.wafv2.model.transform.RuleGroupMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}