Class: Aws::DLM::Types::RetainRule

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dlm/types.rb

Overview

**[Custom snapshot and AMI policies only]** Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.

<note markdown=“1”> 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.

</note>

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 of `1` 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 of `1` day or more.

[1]: docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html [2]: docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html [3]: docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html [4]: docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ Integer

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].

[1]: docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html

Returns:

  • (Integer) 


1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-dlm/types.rb', line 1309

class RetainRule < Struct.new(
  :count,
  :interval,
  :interval_unit)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

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:

  • (Integer) 


1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-dlm/types.rb', line 1309

class RetainRule < Struct.new(
  :count,
  :interval,
  :interval_unit)
  SENSITIVE = []
  include Aws::Structure
end

#interval_unit ⇒ String

The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify ‘Interval=3` and `IntervalUnit=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].

[1]: docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html

Returns:

  • (String) 


1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/aws-sdk-dlm/types.rb', line 1309

class RetainRule < Struct.new(
  :count,
  :interval,
  :interval_unit)
  SENSITIVE = []
  include Aws::Structure
end