Skip to content

RetainRule

Source code in docs_src/capo_dlm/types/retain_rule.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class RetainRule(TypedDict, closed=True):
    count: NotRequired[
        "capo_dlm.types.standard_tier_retain_rule_count.StandardTierRetainRuleCount"
    ]
    """<p>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 <code>3</code>. 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 <a href="https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html">ArchiveRule</a>.</p>"""
    interval: NotRequired[
        "capo_dlm.types.standard_tier_retain_rule_interval.StandardTierRetainRuleInterval"
    ]
    """<p>The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.</p>"""
    interval_unit: NotRequired[
        "capo_dlm.types.retention_interval_unit_values.RetentionIntervalUnitValues"
    ]
    """<p>The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify <code>Interval=3</code> and <code>IntervalUnit=MONTHS</code>. 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 <a href="https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html">ArchiveRule</a>.</p>"""

count instance-attribute 

count: NotRequired[StandardTierRetainRuleCount]

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 instance-attribute 

interval: NotRequired[StandardTierRetainRuleInterval]

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

interval_unit instance-attribute 

interval_unit: NotRequired[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.