Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DLM.Types.RetainRule

Description

Synopsis

Documentation

data RetainRule Source #

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

See: newRetainRule smart constructor.

Constructors

RetainRule'

Fields

count :: Maybe Natural
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 :: Maybe Natural
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 :: Maybe RetentionIntervalUnitValues
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.

Instances

Instances details

FromJSON RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods parseJSON :: Value -> Parser RetainRule # parseJSONList :: Value -> Parser [RetainRule] #
ToJSON RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods toJSON :: RetainRule -> Value # toEncoding :: RetainRule -> Encoding # toJSONList :: [RetainRule] -> Value # toEncodingList :: [RetainRule] -> Encoding #
Generic RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Associated Types type Rep RetainRule :: Type -> Type # Methods from :: RetainRule -> Rep RetainRule x # to :: Rep RetainRule x -> RetainRule #
Read RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods readsPrec :: Int -> ReadS RetainRule # readList :: ReadS [RetainRule] # readPrec :: ReadPrec RetainRule # readListPrec :: ReadPrec [RetainRule] #
Show RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods showsPrec :: Int -> RetainRule -> ShowS # show :: RetainRule -> String # showList :: [RetainRule] -> ShowS #
NFData RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods rnf :: RetainRule -> () #
Eq RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods (==) :: RetainRule -> RetainRule -> Bool # (/=) :: RetainRule -> RetainRule -> Bool #
Hashable RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule Methods hashWithSalt :: Int -> RetainRule -> Int # hash :: RetainRule -> Int #
type Rep RetainRule Source #
Instance details Defined in Amazonka.DLM.Types.RetainRule type Rep RetainRule = D1 ('MetaData "RetainRule" "Amazonka.DLM.Types.RetainRule" "amazonka-dlm-2.0-KlPkRzsIoa0q62N0Ereji" 'False) (C1 ('MetaCons "RetainRule'" '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)))))

newRetainRule :: RetainRule Source #

Create a value of RetainRule 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:RetainRule', retainRule_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.

$sel:interval:RetainRule', retainRule_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.

$sel:intervalUnit:RetainRule', retainRule_intervalUnit - 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.

retainRule_count :: Lens' RetainRule (Maybe Natural) Source #

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.

retainRule_interval :: Lens' RetainRule (Maybe Natural) Source #

The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

retainRule_intervalUnit :: Lens' RetainRule (Maybe RetentionIntervalUnitValues) Source #

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.