Class WafRule

java.lang.Object
software.amazon.awssdk.services.lightsail.model.WafRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WafRule.Builder,WafRule>
@Generated("software.amazon.awssdk:codegen") public final class WafRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WafRule.Builder,WafRule>

Describes a Web Application Firewall (WAF) rule group for a Lightsail distribution. A WAF rule group is a set of rules managed by AWS. The rules inspect viewer requests and block requests that match them.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the WAF rule group (for example, AWSManagedRulesCommonRuleSet).

      For the WAF rule groups that you can specify for each bundle, see the wafRules parameter of the CreateDistribution action.

      Returns:
      The name of the WAF rule group (for example, AWSManagedRulesCommonRuleSet).

      For the WAF rule groups that you can specify for each bundle, see the wafRules parameter of the CreateDistribution action.

    • atpConfig

      public final WafAtpConfig atpConfig()

      An object that describes the configuration of the account takeover prevention rule group.

      Constraints:

      • Define this parameter only when the name is AWSManagedRulesATPRuleSet.

      • This parameter is required when the name is AWSManagedRulesATPRuleSet.

      Returns:
      An object that describes the configuration of the account takeover prevention rule group.

      Constraints:

      • Define this parameter only when the name is AWSManagedRulesATPRuleSet.

      • This parameter is required when the name is AWSManagedRulesATPRuleSet.

    • acfpConfig

      public final WafAcfpConfig acfpConfig()

      An object that describes the configuration of the account creation fraud prevention rule group.

      Constraints:

      • Define this parameter only when the name is AWSManagedRulesACFPRuleSet.

      • This parameter is required when the name is AWSManagedRulesACFPRuleSet.

      Returns:
      An object that describes the configuration of the account creation fraud prevention rule group.

      Constraints:

      • Define this parameter only when the name is AWSManagedRulesACFPRuleSet.

      • This parameter is required when the name is AWSManagedRulesACFPRuleSet.

    • botControlConfig

      public final WafBotControlConfig botControlConfig()

      An object that describes the configuration of the bot control rule group.

      Constraints:

      • Define this parameter only when the name is AWSManagedRulesBotControlRuleSet.

      • This parameter is required when the name is AWSManagedRulesBotControlRuleSet.

      Returns:
      An object that describes the configuration of the bot control rule group.

      Constraints:

      • Define this parameter only when the name is AWSManagedRulesBotControlRuleSet.

      • This parameter is required when the name is AWSManagedRulesBotControlRuleSet.

    • toBuilder

      public WafRule.Builder 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 interface ToCopyableBuilder<WafRule.Builder,WafRule>
      Returns:
      a builder for type T

    • builder

      public static WafRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WafRule.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.