Class: Aws::DLM::Types::RetentionArchiveTier

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

Overview

**[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.

<note markdown=“1”> The archive retention rule must retain snapshots in the archive tier for a minimum of 90 days.

</note>

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

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#countInteger

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:

  • (Integer)


1360
1361
1362
1363
1364
1365
1366
# File 'lib/aws-sdk-dlm/types.rb', line 1360

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

#intervalInteger

Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.

Returns:

  • (Integer)


1360
1361
1362
1363
1364
1365
1366
# File 'lib/aws-sdk-dlm/types.rb', line 1360

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

#interval_unitString

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` and `IntervalUnit=MONTHS`.

Returns:

  • (String)


1360
1361
1362
1363
1364
1365
1366
# File 'lib/aws-sdk-dlm/types.rb', line 1360

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