Class ManagedRuleSetVersion

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

Information for a single version of a managed rule set.

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:

  • Method Details

    • associatedRuleGroupArn

      public final String associatedRuleGroupArn()

      The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.

      Returns:
      The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.

    • capacity

      public final Long capacity()

      The web ACL capacity units (WCUs) required for this rule group.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

      Returns:
      The web ACL capacity units (WCUs) required for this rule group.

      WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.

    • forecastedLifetime

      public final Integer forecastedLifetime()

      The amount of time you expect this version of your managed rule group to last, in days.

      Returns:
      The amount of time you expect this version of your managed rule group to last, in days.

    • publishTimestamp

      public final Instant publishTimestamp()

      The time that you first published this version.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

      Returns:
      The time that you first published this version.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

    • lastUpdateTimestamp

      public final Instant lastUpdateTimestamp()

      The last time that you updated this version.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

      Returns:
      The last time that you updated this version.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

    • expiryTimestamp

      public final Instant expiryTimestamp()

      The time that this version is set to expire.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

      Returns:
      The time that this version is set to expire.

      Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".

    • toBuilder

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

    • builder

      public static ManagedRuleSetVersion.Builder builder()

    • serializableBuilderClass

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