CreateSnaplockConfiguration
Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.
Contents
- SnaplockType
-
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:
-
COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance. -
ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.
Type: String
Valid Values:
COMPLIANCE | ENTERPRISERequired: Yes
-
- AuditLogVolume
-
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is
false. If you setAuditLogVolumetotrue, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.For more information, see SnapLock audit log volumes.
Type: Boolean
Required: No
- AutocommitPeriod
-
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
Type: AutocommitPeriod object
Required: No
- PrivilegedDelete
-
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods.
PERMANENTLY_DISABLEDis a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value isDISABLED.For more information, see Privileged delete.
Type: String
Valid Values:
DISABLED | ENABLED | PERMANENTLY_DISABLEDRequired: No
- RetentionPeriod
-
Specifies the retention period of an FSx for ONTAP SnapLock volume.
Type: SnaplockRetentionPeriod object
Required: No
- VolumeAppendModeEnabled
-
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is
false.For more information, see Volume-append mode.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
