Class CfnVolume.SnaplockConfigurationProperty
Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SnaplockConfigurationProperty : Object, CfnVolume.ISnaplockConfigurationProperty
Syntax (vb)
Public Class SnaplockConfigurationProperty
Inherits Object
Implements CfnVolume.ISnaplockConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;
var snaplockConfigurationProperty = new SnaplockConfigurationProperty {
SnaplockType = "snaplockType",
// the properties below are optional
AuditLogVolume = "auditLogVolume",
AutocommitPeriod = new AutocommitPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
},
PrivilegedDelete = "privilegedDelete",
RetentionPeriod = new SnaplockRetentionPeriodProperty {
DefaultRetention = new RetentionPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
},
MaximumRetention = new RetentionPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
},
MinimumRetention = new RetentionPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
}
},
VolumeAppendModeEnabled = "volumeAppendModeEnabled"
};
Synopsis
Constructors
SnaplockConfigurationProperty() |
Properties
AuditLogVolume | Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. |
AutocommitPeriod | The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. |
PrivilegedDelete | Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. |
RetentionPeriod | Specifies the retention period of an FSx for ONTAP SnapLock volume. |
SnaplockType | Specifies the retention mode of an FSx for ONTAP SnapLock volume. |
VolumeAppendModeEnabled | Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. |
Constructors
SnaplockConfigurationProperty()
public SnaplockConfigurationProperty()
Properties
AuditLogVolume
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
public string AuditLogVolume { get; set; }
Property Value
System.String
Remarks
The default value is false
. If you set AuditLogVolume
to true
, 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 .
AutocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
public object AutocommitPeriod { get; set; }
Property Value
System.Object
Remarks
PrivilegedDelete
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
public string PrivilegedDelete { get; set; }
Property Value
System.String
Remarks
Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED
is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED
.
For more information, see Privileged delete .
RetentionPeriod
Specifies the retention period of an FSx for ONTAP SnapLock volume.
public object RetentionPeriod { get; set; }
Property Value
System.Object
Remarks
SnaplockType
Specifies the retention mode of an FSx for ONTAP SnapLock volume.
public string SnaplockType { get; set; }
Property Value
System.String
Remarks
After it is set, it can't be changed. You can choose one of the following retention modes:
VolumeAppendModeEnabled
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
public string VolumeAppendModeEnabled { get; set; }
Property Value
System.String
Remarks
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 .