Class RetentionArchiveTier
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RetentionArchiveTier.Builder,
RetentionArchiveTier>
[Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive retention threshold is met, the snapshots are permanently deleted from the archive tier.
The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.
For count-based schedules, you must specify Count. For age-based schedules, you must specify Interval and IntervalUnit.
For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RetentionArchiveTier.Builder
builder()
final Integer
count()
The maximum number of snapshots to retain in the archive storage tier for each volume.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
interval()
Specifies the period of time to retain snapshots in the archive tier.The unit of time in which to measure the Interval.final String
The unit of time in which to measure the Interval.static Class
<? extends RetentionArchiveTier.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
count
The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
- Returns:
- The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days.
-
interval
Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
- Returns:
- Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.
-
intervalUnit
The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify
Interval=6
andIntervalUnit=MONTHS
.If the service returns an enum value that is not available in the current SDK version,
intervalUnit
will returnRetentionIntervalUnitValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintervalUnitAsString()
.- Returns:
- The unit of time in which to measure the Interval. For example, to retain a snapshots in the
archive tier for 6 months, specify
Interval=6
andIntervalUnit=MONTHS
. - See Also:
-
intervalUnitAsString
The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify
Interval=6
andIntervalUnit=MONTHS
.If the service returns an enum value that is not available in the current SDK version,
intervalUnit
will returnRetentionIntervalUnitValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintervalUnitAsString()
.- Returns:
- The unit of time in which to measure the Interval. For example, to retain a snapshots in the
archive tier for 6 months, specify
Interval=6
andIntervalUnit=MONTHS
. - See Also:
-
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 interfaceToCopyableBuilder<RetentionArchiveTier.Builder,
RetentionArchiveTier> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-