Class ManagedProductDescriptor

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

The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.

See Also:

  • Method Details

    • vendorName

      public final String vendorName()

      The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

      Returns:
      The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

    • managedRuleSetName

      public final String managedRuleSetName()

      The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

      Returns:
      The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet.

    • productId

      public final String productId()

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      Returns:
      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • productLink

      public final String productLink()

      For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

      Returns:
      For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.

    • productTitle

      public final String productTitle()

      The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

      Returns:
      The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention.

    • productDescription

      public final String productDescription()

      A short description of the managed rule group.

      Returns:
      A short description of the managed rule group.

    • snsTopicArn

      public final String snsTopicArn()

      The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

      Returns:
      The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.

    • isVersioningSupported

      public final Boolean isVersioningSupported()

      Indicates whether the rule group is versioned.

      Returns:
      Indicates whether the rule group is versioned.

    • isAdvancedManagedRuleSet

      public final Boolean isAdvancedManagedRuleSet()

      Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.

      Returns:
      Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.

    • toBuilder

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

    • builder

      public static ManagedProductDescriptor.Builder builder()

    • serializableBuilderClass

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