Package software.amazon.awssdk.services.wafv2.model

Class ManagedRuleSet

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<ManagedRuleSet.Builder,​ManagedRuleSet>
    @Generated("software.amazon.awssdk:codegen")
public final class ManagedRuleSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ManagedRuleSet.Builder,​ManagedRuleSet>

    A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.

    This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

    Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

    See Also:
    Serialized Form

    • Method Detail

      • name

        public final String name()

        The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

        This name is assigned to the corresponding managed rule group, which your customers can access and use.

        Returns:
        The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

        This name is assigned to the corresponding managed rule group, which your customers can access and use.

      • id

        public final String id()

        A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

        Returns:
        A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the entity.

        Returns:
        The Amazon Resource Name (ARN) of the entity.

      • description

        public final String description()

        A description of the set that helps with identification.

        Returns:
        A description of the set that helps with identification.

      • hasPublishedVersions

        public final boolean hasPublishedVersions()
        For responses, this returns true if the service returned a value for the PublishedVersions 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.

      • publishedVersions

        public final Map<String,​ManagedRuleSetVersion> publishedVersions()

        The versions of this managed rule set that are available for use by customers.

        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 hasPublishedVersions() method.

        Returns:
        The versions of this managed rule set that are available for use by customers.

      • recommendedVersion

        public final String recommendedVersion()

        The version that you would like your customers to use.

        Returns:
        The version that you would like your customers to use.

      • labelNamespace

        public final String labelNamespace()

        The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

        • The syntax for the label namespace prefix for a managed rule group is the following:

          awswaf:managed:<vendor>:<rule group name>:

        • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

          <label namespace>:<label from rule>

        Returns:
        The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

        • The syntax for the label namespace prefix for a managed rule group is the following:

          awswaf:managed:<vendor>:<rule group name>:

        • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

          <label namespace>:<label from rule>

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)