Skip to content

RetentionPeriod

Source code in docs_src/capo_fsx/types/retention_period.py 
12
13
14
15
16
class RetentionPeriod(TypedDict, closed=True):
    type: NotRequired["capo_fsx.types.retention_period_type.RetentionPeriodType"]
    """<p>Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to <code>INFINITE</code>, the files are retained forever. If you set it to <code>UNSPECIFIED</code>, the files are retained until you set an explicit retention period. </p>"""
    value: NotRequired["capo_fsx.types.retention_period_value.RetentionPeriodValue"]
    """<p>Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for <code>INFINITE</code> or <code>UNSPECIFIED</code>. For all other options, the following ranges are valid: </p> <ul> <li> <p> <code>Seconds</code>: 0 - 65,535</p> </li> <li> <p> <code>Minutes</code>: 0 - 65,535</p> </li> <li> <p> <code>Hours</code>: 0 - 24</p> </li> <li> <p> <code>Days</code>: 0 - 365</p> </li> <li> <p> <code>Months</code>: 0 - 12</p> </li> <li> <p> <code>Years</code>: 0 - 100</p> </li> </ul>"""

type instance-attribute 

type: NotRequired[RetentionPeriodType]

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

value instance-attribute 

value: NotRequired[RetentionPeriodValue]

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

  • Seconds: 0 - 65,535

  • Minutes: 0 - 65,535

  • Hours: 0 - 24

  • Days: 0 - 365

  • Months: 0 - 12

  • Years: 0 - 100