Struct RetentionArchiveTier

#[non_exhaustive]
pub struct RetentionArchiveTier {
    pub count: Option<i32>,
    pub interval: Option<i32>,
    pub interval_unit: Option<RetentionIntervalUnitValues>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

count: Option<i32>

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: Option<i32>

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

interval_unit: Option<RetentionIntervalUnitValues>

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.

Implementations

impl RetentionArchiveTier

pub fn count(&self) -> Option<i32>

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.

pub fn interval(&self) -> Option<i32>

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

pub fn interval_unit(&self) -> Option<&RetentionIntervalUnitValues>

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.

impl RetentionArchiveTier

pub fn builder() -> RetentionArchiveTierBuilder

Creates a new builder-style object to manufacture RetentionArchiveTier.

Trait Implementations

impl Clone for RetentionArchiveTier

fn clone(&self) -> RetentionArchiveTier

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetentionArchiveTier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RetentionArchiveTier

fn eq(&self, other: &RetentionArchiveTier) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RetentionArchiveTier