fsx/aws.sdk.kotlin.services.fsx.model/RetentionPeriod

RetentionPeriod

Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock.

Types

Builder

class Builder

Companion

object Companion

Properties

type

val type: 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

val value: Int?

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:

Functions

copy

inline fun copy(block: RetentionPeriod.Builder.() -> Unit = {}): RetentionPeriod

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String