software.amazon.awssdk.services.securityhub.model

Class AwsWafv2WebAclDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsWafv2WebAclDetails

All Implemented Interfaces:

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

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

Details about an WAFv2 web Access Control List (ACL).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsWafv2WebAclDetails.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
static AwsWafv2WebAclDetails.Builder	builder()
Long	capacity() The web ACL capacity units (WCUs) currently being used by this web ACL.
AwsWafv2WebAclCaptchaConfigDetails	captchaConfig() Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
AwsWafv2WebAclActionDetails	defaultAction() The action to perform if none of the Rules contained in the web ACL match.
String	description() A description of the web ACL 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 web ACL.
Boolean	managedbyFirewallManager() Indicates whether this web ACL is managed by Firewall Manager.
String	name() The name of the web ACL.
List<AwsWafv2RulesDetails>	rules() The Rule statements used to identify the web requests that you want to allow, block, or count.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsWafv2WebAclDetails.Builder>	serializableBuilderClass()
AwsWafv2WebAclDetails.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

name

public final String name()

The name of the web ACL.

Returns:

The name of the web ACL.

arn

public final String arn()

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

Returns:

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

managedbyFirewallManager

public final Boolean managedbyFirewallManager()

Indicates whether this web ACL is managed by Firewall Manager.

Returns:

Indicates whether this web ACL is managed by Firewall Manager.

id

public final String id()

A unique identifier for the web ACL.

Returns:

A unique identifier for the web ACL.

capacity

public final Long capacity()

The web ACL capacity units (WCUs) currently being used by this web ACL.

Returns:

The web ACL capacity units (WCUs) currently being used by this web ACL.

captchaConfig

public final AwsWafv2WebAclCaptchaConfigDetails captchaConfig()

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.

Returns:

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.

defaultAction

public final AwsWafv2WebAclActionDetails defaultAction()

The action to perform if none of the Rules contained in the web ACL match.

Returns:

The action to perform if none of the Rules contained in the web ACL match.

description

public final String description()

A description of the web ACL that helps with identification.

Returns:

A description of the web ACL that helps with identification.

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.

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 AwsWafv2WebAclDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsWafv2WebAclDetails.Builder,AwsWafv2WebAclDetails>

builder

public static AwsWafv2WebAclDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsWafv2WebAclDetails.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