com.amazonaws.services.wafv2.model

Class CreateRuleGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.wafv2.model.CreateRuleGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRuleGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRuleGroupRequest()

Method Summary

Modifier and Type	Method and Description
CreateRuleGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getCapacity() The web ACL capacity units (WCUs) required for this rule group.
String	getDescription() A friendly description of the rule group.
String	getName() A friendly name of the rule group.
List<Rule>	getRules() The Rule statements used to identify the web requests that you want to allow, block, or count.
String	getScope() Specifies whether this is for an AWS CloudFront distribution or for a regional application.
List<Tag>	getTags() An array of key:value pairs to associate with the resource.
VisibilityConfig	getVisibilityConfig() Defines and enables Amazon CloudWatch metrics and web request sample collection.
int	hashCode()
void	setCapacity(Long capacity) The web ACL capacity units (WCUs) required for this rule group.
void	setDescription(String description) A friendly description of the rule group.
void	setName(String name) A friendly name of the rule group.
void	setRules(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to allow, block, or count.
void	setScope(String scope) Specifies whether this is for an AWS CloudFront distribution or for a regional application.
void	setTags(Collection<Tag> tags) An array of key:value pairs to associate with the resource.
void	setVisibilityConfig(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.
String	toString() Returns a string representation of this object.
CreateRuleGroupRequest	withCapacity(Long capacity) The web ACL capacity units (WCUs) required for this rule group.
CreateRuleGroupRequest	withDescription(String description) A friendly description of the rule group.
CreateRuleGroupRequest	withName(String name) A friendly name of the rule group.
CreateRuleGroupRequest	withRules(Collection<Rule> rules) The Rule statements used to identify the web requests that you want to allow, block, or count.
CreateRuleGroupRequest	withRules(Rule... rules) The Rule statements used to identify the web requests that you want to allow, block, or count.
CreateRuleGroupRequest	withScope(Scope scope) Specifies whether this is for an AWS CloudFront distribution or for a regional application.
CreateRuleGroupRequest	withScope(String scope) Specifies whether this is for an AWS CloudFront distribution or for a regional application.
CreateRuleGroupRequest	withTags(Collection<Tag> tags) An array of key:value pairs to associate with the resource.
CreateRuleGroupRequest	withTags(Tag... tags) An array of key:value pairs to associate with the resource.
CreateRuleGroupRequest	withVisibilityConfig(VisibilityConfig visibilityConfig) Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRuleGroupRequest

public CreateRuleGroupRequest()

Method Detail

setName

public void setName(String name)

A friendly name of the rule group. You cannot change the name of a rule group after you create it.

Parameters:

name - A friendly name of the rule group. You cannot change the name of a rule group after you create it.

getName

public String getName()

A friendly name of the rule group. You cannot change the name of a rule group after you create it.

Returns:

A friendly name of the rule group. You cannot change the name of a rule group after you create it.

withName

public CreateRuleGroupRequest withName(String name)

A friendly name of the rule group. You cannot change the name of a rule group after you create it.

Parameters:

name - A friendly name of the rule group. You cannot change the name of a rule group after you create it.

Returns:

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

setScope

public void setScope(String scope)

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

See Also:

Scope

getScope

public String getScope()

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

See Also:

Scope

withScope

public CreateRuleGroupRequest withScope(String scope)

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

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

See Also:

Scope

withScope

public CreateRuleGroupRequest withScope(Scope scope)

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

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

See Also:

Scope

setCapacity

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, 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.

Parameters:

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.

getCapacity

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, 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.

Returns:

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.

withCapacity

public CreateRuleGroupRequest 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, 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.

Parameters:

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.

Returns:

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

setDescription

public void setDescription(String description)

A friendly description of the rule group. You cannot change the description of a rule group after you create it.

Parameters:

description - A friendly description of the rule group. You cannot change the description of a rule group after you create it.

getDescription

public String getDescription()

A friendly description of the rule group. You cannot change the description of a rule group after you create it.

Returns:

A friendly description of the rule group. You cannot change the description of a rule group after you create it.

withDescription

public CreateRuleGroupRequest withDescription(String description)

A friendly description of the rule group. You cannot change the description of a rule group after you create it.

Parameters:

description - A friendly description of the rule group. You cannot change the description of a rule group after you create it.

Returns:

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

getRules

public List<Rule> getRules()

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.

Returns:

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.

setRules

public void setRules(Collection<Rule> 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.

Parameters:

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.

withRules

public CreateRuleGroupRequest withRules(Rule... 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 setRules(java.util.Collection) or withRules(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withRules

public CreateRuleGroupRequest withRules(Collection<Rule> 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.

Parameters:

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.

Returns:

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

setVisibilityConfig

public void setVisibilityConfig(VisibilityConfig visibilityConfig)

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Parameters:

visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.

getVisibilityConfig

public VisibilityConfig getVisibilityConfig()

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Returns:

Defines and enables Amazon CloudWatch metrics and web request sample collection.

withVisibilityConfig

public CreateRuleGroupRequest withVisibilityConfig(VisibilityConfig visibilityConfig)

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Parameters:

visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.

Returns:

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

getTags

public List<Tag> getTags()

An array of key:value pairs to associate with the resource.

Returns:

An array of key:value pairs to associate with the resource.

setTags

public void setTags(Collection<Tag> tags)

An array of key:value pairs to associate with the resource.

Parameters:

tags - An array of key:value pairs to associate with the resource.

withTags

public CreateRuleGroupRequest withTags(Tag... tags)

An array of key:value pairs to associate with the resource.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - An array of key:value pairs to associate with the resource.

Returns:

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

withTags

public CreateRuleGroupRequest withTags(Collection<Tag> tags)

An array of key:value pairs to associate with the resource.

Parameters:

tags - An array of key:value pairs to associate with the resource.

Returns:

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

toString

public 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateRuleGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()