Package software.amazon.awssdk.services.dlm.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeprecateRule.Builder

Method Summary

Modifier and Type	Method	Description
static DeprecateRule.Builder	builder()
Integer	count()	If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
RetentionIntervalUnitValues	intervalUnit()	The unit of time in which to measure the Interval.
String	intervalUnitAsString()	The unit of time in which to measure the Interval.
List<SdkField<?>>	sdkFields()
static Class<? extends DeprecateRule.Builder>	serializableBuilderClass()
DeprecateRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

RetentionIntervalUnitValues

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:

RetentionIntervalUnitValues

toBuilder

public DeprecateRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeprecateRule.Builder,DeprecateRule>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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