Class DeprecateRule

java.lang.Object
software.amazon.awssdk.services.dlm.model.DeprecateRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeprecateRule.Builder,DeprecateRule>

@Generated("software.amazon.awssdk:codegen") public final class DeprecateRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeprecateRule.Builder,DeprecateRule>

[Custom AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.

For age-based schedules, you must specify Interval and IntervalUnit. For count-based schedules, you must specify Count.

See Also:
  • Method Details

    • count

      public final Integer count()

      If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.

      Returns:
      If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000.
    • interval

      public final Integer interval()

      If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.

      Returns:
      If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days.
    • intervalUnit

      public final RetentionIntervalUnitValues intervalUnit()

      The unit of time in which to measure the Interval.

      If the service returns an enum value that is not available in the current SDK version, intervalUnit will return RetentionIntervalUnitValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalUnitAsString().

      Returns:
      The unit of time in which to measure the Interval.
      See Also:
    • intervalUnitAsString

      public final String intervalUnitAsString()

      The unit of time in which to measure the Interval.

      If the service returns an enum value that is not available in the current SDK version, intervalUnit will return RetentionIntervalUnitValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalUnitAsString().

      Returns:
      The unit of time in which to measure the Interval.
      See Also:
    • toBuilder

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

      public static DeprecateRule.Builder builder()
    • serializableBuilderClass

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