Package software.amazon.awssdk.services.securityhub.model

Class AwsWafv2RuleGroupDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsWafv2RuleGroupDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsWafv2RuleGroupDetails.Builder,AwsWafv2RuleGroupDetails>

@Generated("software.amazon.awssdk:codegen")
public final class AwsWafv2RuleGroupDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsWafv2RuleGroupDetails.Builder,AwsWafv2RuleGroupDetails>

Details about an WAFv2 rule group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsWafv2RuleGroupDetails.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the entity.
static AwsWafv2RuleGroupDetails.Builder	builder()
Long	capacity()	The web ACL capacity units (WCUs) required for this rule group.
String	description()	A description of the rule group that helps with identification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
String	id()	A unique identifier for the rule group.
String	name()	The name of the rule group.
List<AwsWafv2RulesDetails>	rules()	The Rule statements used to identify the web requests that you want to allow, block, or count.
String	scope()	Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AwsWafv2RuleGroupDetails.Builder>	serializableBuilderClass()
AwsWafv2RuleGroupDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AwsWafv2VisibilityConfigDetails	visibilityConfig()	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

capacity

public final Long capacity()

The web ACL capacity units (WCUs) required for this rule group.

Returns:

The web ACL capacity units (WCUs) required for this rule group.

description

public final String description()

A description of the rule group that helps with identification.

Returns:

A description of the rule group that helps with identification.

id

public final String id()

A unique identifier for the rule group.

Returns:

A unique identifier for the rule group.

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.

arn

public final String arn()

The Amazon Resource Name (ARN) of the entity.

Returns:

The Amazon Resource Name (ARN) of the entity.

hasRules

public final boolean hasRules()

For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

rules

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRules() method.

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.

scope

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

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.

visibilityConfig

public final AwsWafv2VisibilityConfigDetails 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 AwsWafv2RuleGroupDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsWafv2RuleGroupDetails.Builder,AwsWafv2RuleGroupDetails>

builder

public static AwsWafv2RuleGroupDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsWafv2RuleGroupDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo