amazonka-dlm-2.0: Amazon Data Lifecycle Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DLM.Types.RetentionArchiveTier

Description

 
Synopsis

Documentation

data RetentionArchiveTier Source #

[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: newRetentionArchiveTier smart constructor.

Constructors

RetentionArchiveTier' 

Fields

  • count :: Maybe Natural

    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 :: Maybe Natural

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

  • intervalUnit :: Maybe 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.

Instances

Instances details
FromJSON RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

ToJSON RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

Generic RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

Associated Types

type Rep RetentionArchiveTier :: Type -> Type #

Read RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

Show RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

NFData RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

Methods

rnf :: RetentionArchiveTier -> () #

Eq RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

Hashable RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

type Rep RetentionArchiveTier Source # 
Instance details

Defined in Amazonka.DLM.Types.RetentionArchiveTier

type Rep RetentionArchiveTier = D1 ('MetaData "RetentionArchiveTier" "Amazonka.DLM.Types.RetentionArchiveTier" "amazonka-dlm-2.0-KlPkRzsIoa0q62N0Ereji" 'False) (C1 ('MetaCons "RetentionArchiveTier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "intervalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionIntervalUnitValues)))))

newRetentionArchiveTier :: RetentionArchiveTier Source #

Create a value of RetentionArchiveTier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:count:RetentionArchiveTier', retentionArchiveTier_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.

$sel:interval:RetentionArchiveTier', retentionArchiveTier_interval - Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted.

$sel:intervalUnit:RetentionArchiveTier', retentionArchiveTier_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 and IntervalUnit=MONTHS.

retentionArchiveTier_count :: Lens' RetentionArchiveTier (Maybe Natural) Source #

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.

retentionArchiveTier_interval :: Lens' RetentionArchiveTier (Maybe Natural) Source #

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

retentionArchiveTier_intervalUnit :: Lens' RetentionArchiveTier (Maybe RetentionIntervalUnitValues) Source #

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.