LongTermRetentionPolicyProperties interface
Properties of a long term retention policy
Properties
| monthly |
The monthly retention policy for an LTR backup in an ISO 8601 format. |
| time |
The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled. |
| time |
The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked. |
| weekly |
The weekly retention policy for an LTR backup in an ISO 8601 format. |
| week |
The week of year to take the yearly backup in an ISO 8601 format. |
| yearly |
The yearly retention policy for an LTR backup in an ISO 8601 format. |
Property Details
monthlyRetention
The monthly retention policy for an LTR backup in an ISO 8601 format.
monthlyRetention?: string
Property Value
string
timeBasedImmutability
The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled.
timeBasedImmutability?: string
Property Value
string
timeBasedImmutabilityMode
The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked.
timeBasedImmutabilityMode?: string
Property Value
string
weeklyRetention
The weekly retention policy for an LTR backup in an ISO 8601 format.
weeklyRetention?: string
Property Value
string
weekOfYear
The week of year to take the yearly backup in an ISO 8601 format.
weekOfYear?: number
Property Value
number
yearlyRetention
The yearly retention policy for an LTR backup in an ISO 8601 format.
yearlyRetention?: string
Property Value
string