AwsWafv2RuleGroupDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsWafv2RuleGroupDetails

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Details about an WAFv2 rule group.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsWafv2RuleGroupDetails()

Constructors
Constructor and Description
`AwsWafv2RuleGroupDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsWafv2RuleGroupDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the entity.
`Long`	`getCapacity()` The web ACL capacity units (WCUs) required for this rule group.
`String`	`getDescription()` A description of the rule group that helps with identification.
`String`	`getId()` A unique identifier for the rule group.
`String`	`getName()` The name of the rule group.
`List<AwsWafv2RulesDetails>`	`getRules()` The Rule statements used to identify the web requests that you want to allow, block, or count.
`String`	`getScope()` Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application.
`AwsWafv2VisibilityConfigDetails`	`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`	`setCapacity(Long capacity)` The web ACL capacity units (WCUs) required for this rule group.
`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`	`setName(String name)` The name of the rule group.
`void`	`setRules(Collection<AwsWafv2RulesDetails> rules)` The Rule statements used to identify the web requests that you want to allow, block, or count.
`void`	`setScope(String scope)` Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application.
`void`	`setVisibilityConfig(AwsWafv2VisibilityConfigDetails visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.
`String`	`toString()` Returns a string representation of this object.
`AwsWafv2RuleGroupDetails`	`withArn(String arn)` The Amazon Resource Name (ARN) of the entity.
`AwsWafv2RuleGroupDetails`	`withCapacity(Long capacity)` The web ACL capacity units (WCUs) required for this rule group.
`AwsWafv2RuleGroupDetails`	`withDescription(String description)` A description of the rule group that helps with identification.
`AwsWafv2RuleGroupDetails`	`withId(String id)` A unique identifier for the rule group.
`AwsWafv2RuleGroupDetails`	`withName(String name)` The name of the rule group.
`AwsWafv2RuleGroupDetails`	`withRules(AwsWafv2RulesDetails... rules)` The Rule statements used to identify the web requests that you want to allow, block, or count.
`AwsWafv2RuleGroupDetails`	`withRules(Collection<AwsWafv2RulesDetails> rules)` The Rule statements used to identify the web requests that you want to allow, block, or count.
`AwsWafv2RuleGroupDetails`	`withScope(String scope)` Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application.
`AwsWafv2RuleGroupDetails`	`withVisibilityConfig(AwsWafv2VisibilityConfigDetails visibilityConfig)` Defines and enables Amazon CloudWatch metrics and web request sample collection.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsWafv2RuleGroupDetails
```
public AwsWafv2RuleGroupDetails()
```
- Method Detail
  - setCapacity
```
public void setCapacity(Long capacity)
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    Parameters:
    
    capacity - The web ACL capacity units (WCUs) required for this rule group.
  - getCapacity
```
public Long getCapacity()
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    Returns:
    
    The web ACL capacity units (WCUs) required for this rule group.
  - withCapacity
```
public AwsWafv2RuleGroupDetails withCapacity(Long capacity)
```
    The web ACL capacity units (WCUs) required for this rule group.
    
    Parameters:
    
    capacity - The web ACL capacity units (WCUs) required for this rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the rule group that helps with identification.
    
    Parameters:
    
    description - A description of the rule group that helps with identification.
  - getDescription
```
public String getDescription()
```
    A description of the rule group that helps with identification.
    
    Returns:
    
    A description of the rule group that helps with identification.
  - withDescription
```
public AwsWafv2RuleGroupDetails withDescription(String description)
```
    A description of the rule group that helps with identification.
    
    Parameters:
    
    description - A description of the rule group that helps with identification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the rule group.
    
    Parameters:
    
    id - A unique identifier for the rule group.
  - getId
```
public String getId()
```
    A unique identifier for the rule group.
    
    Returns:
    
    A unique identifier for the rule group.
  - withId
```
public AwsWafv2RuleGroupDetails withId(String id)
```
    A unique identifier for the rule group.
    
    Parameters:
    
    id - A unique identifier for the rule group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the rule group. You cannot change the name of a rule group after you create it.
    
    Parameters:
    
    name - The name of the rule group. You cannot change the name of a rule group after you create it.
  - getName
```
public String getName()
```
    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.
  - withName
```
public AwsWafv2RuleGroupDetails withName(String name)
```
    The name of the rule group. You cannot change the name of a rule group after you create it.
    
    Parameters:
    
    name - The 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.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the entity.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withArn
```
public AwsWafv2RuleGroupDetails withArn(String arn)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRules
```
public List<AwsWafv2RulesDetails> 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 WAF uses to identify matching web requests, and parameters that govern how 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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
  - setRules
```
public void setRules(Collection<AwsWafv2RulesDetails> 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 WAF uses to identify matching web requests, and parameters that govern how 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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
  - withRules
```
public AwsWafv2RuleGroupDetails withRules(AwsWafv2RulesDetails... 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 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.
    
    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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRules
```
public AwsWafv2RuleGroupDetails withRules(Collection<AwsWafv2RulesDetails> 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 WAF uses to identify matching web requests, and parameters that govern how 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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScope
```
public void setScope(String scope)
```
    Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
    
    Parameters:
    
    scope - Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
  - getScope
```
public String getScope()
```
    Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
    
    Returns:
    
    Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
  - withScope
```
public AwsWafv2RuleGroupDetails withScope(String scope)
```
    Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
    
    Parameters:
    
    scope - Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibilityConfig
```
public void setVisibilityConfig(AwsWafv2VisibilityConfigDetails 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 AwsWafv2VisibilityConfigDetails 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 AwsWafv2RuleGroupDetails withVisibilityConfig(AwsWafv2VisibilityConfigDetails 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.
  - 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 AwsWafv2RuleGroupDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AwsWafv2RuleGroupDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsWafv2RuleGroupDetails

Method Detail

setCapacity

getCapacity

withCapacity

setDescription

getDescription

withDescription

setId

getId

withId

setName

getName

withName

setArn

getArn

withArn

getRules

setRules

withRules

withRules

setScope

getScope

withScope

setVisibilityConfig

getVisibilityConfig

withVisibilityConfig

toString

equals

hashCode

clone

marshall