Class AwsWafv2WebAclDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsWafv2WebAclDetails.Builder,
AwsWafv2WebAclDetails>
Details about an WAFv2 web Access Control List (ACL).
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.builder()
final Long
capacity()
The web ACL capacity units (WCUs) currently being used by this web ACL.Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their ownCaptchaConfig
settings.The action to perform if none of the Rules contained in the web ACL match.final String
A description of the web ACL that helps with identification.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasRules()
For responses, this returns true if the service returned a value for the Rules property.final String
id()
A unique identifier for the web ACL.final Boolean
Indicates whether this web ACL is managed by Firewall Manager.final String
name()
The name of the web ACL.final List
<AwsWafv2RulesDetails> rules()
The Rule statements used to identify the web requests that you want to allow, block, or count.static Class
<? extends AwsWafv2WebAclDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Defines and enables Amazon CloudWatch metrics and web request sample collection.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the web ACL.
- Returns:
- The name of the web ACL.
-
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
Indicates whether this web ACL is managed by Firewall Manager.
- Returns:
- Indicates whether this web ACL is managed by Firewall Manager.
-
id
A unique identifier for the web ACL.
- Returns:
- A unique identifier for the web ACL.
-
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
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
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
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 theisEmpty()
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
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
Defines and enables Amazon CloudWatch metrics and web request sample collection.
- Returns:
- Defines and enables Amazon CloudWatch metrics and web request sample collection.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsWafv2WebAclDetails.Builder,
AwsWafv2WebAclDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-