Class RetainRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RetainRule.Builder,
RetainRule>
[Custom snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.
For snapshot policies that have an ArchiveRule, this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier.
For snapshot policies that do not have an ArchiveRule, snapshots are permanently deleted when this retention threshold is met.
You can retain snapshots based on either a count or a time interval.
-
Count-based retention
You must specify Count. If you specify an ArchiveRule for the schedule, then you can specify a retention count of
0
to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention count of1
or more. -
Age-based retention
You must specify Interval and IntervalUnit. If you specify an ArchiveRule for the schedule, then you can specify a retention interval of
0
days to archive snapshots immediately after creation. If you specify a FastRestoreRule, ShareRule, or a CrossRegionCopyRule, then you must specify a retention interval of1
day or more.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RetainRule.Builder
builder()
final Integer
count()
The number of snapshots to retain for each volume, up to a maximum of 1000.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()
The amount of time to retain each snapshot.The unit of time for time-based retention.final String
The unit of time for time-based retention.static Class
<? extends RetainRule.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 number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify
3
. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.- Returns:
- The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to
retain a maximum of three snapshots, specify
3
. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
-
interval
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
- Returns:
- The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
-
intervalUnit
The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
Interval=3
andIntervalUnit=MONTHS
. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.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 for time-based retention. For example, to retain snapshots for 3 months, specify
Interval=3
andIntervalUnit=MONTHS
. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule. - See Also:
-
intervalUnitAsString
The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify
Interval=3
andIntervalUnit=MONTHS
. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.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 for time-based retention. For example, to retain snapshots for 3 months, specify
Interval=3
andIntervalUnit=MONTHS
. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule. - 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<RetainRule.Builder,
RetainRule> - 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
-