aws-cdk-lib.aws_fsx.CfnVolume.SnaplockConfigurationProperty

SnaplockConfigurationProperty Struct

Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const snaplockConfigurationProperty: fsx.CfnVolume.SnaplockConfigurationProperty = {
  snaplockType: 'snaplockType',

  // the properties below are optional
  auditLogVolume: 'auditLogVolume',
  autocommitPeriod: {
    type: 'type',

    // the properties below are optional
    value: 123,
  },
  privilegedDelete: 'privilegedDelete',
  retentionPeriod: {
    defaultRetention: {
      type: 'type',

      // the properties below are optional
      value: 123,
    },
    maximumRetention: {
      type: 'type',

      // the properties below are optional
      value: 123,
    },
    minimumRetention: {
      type: 'type',

      // the properties below are optional
      value: 123,
    },
  },
  volumeAppendModeEnabled: 'volumeAppendModeEnabled',
};

Properties

auditLogVolume?optionalstringaudit_log_volume?optionalstrauditLogVolume?optionalStringAuditLogVolume?optionalstringAuditLogVolume?optional*string#

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.

notes

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?optionalIResolvable | CfnVolume.AutocommitPeriodPropertyautocommit_period?optionaltyping.Union[IResolvable, AutocommitPeriodProperty]autocommitPeriod?optionalIResolvableAutocommitPeriod?optionalIResolvableAutocommitPeriod?optionalinterface{}#

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

privilegedDelete?optionalstringprivileged_delete?optionalstrprivilegedDelete?optionalStringPrivilegedDelete?optionalstringPrivilegedDelete?optional*string#

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.

notes

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?optionalIResolvable | CfnVolume.SnaplockRetentionPeriodPropertyretention_period?optionaltyping.Union[IResolvable, SnaplockRetentionPeriodProperty]retentionPeriod?optionalIResolvableRetentionPeriod?optionalIResolvableRetentionPeriod?optionalinterface{}#

Specifies the retention period of an FSx for ONTAP SnapLock volume.

snaplockTypestringsnaplock_typestrsnaplockTypeStringSnaplockTypestringSnaplockType*stringrequired#

Specifies the retention mode of an FSx for ONTAP SnapLock volume.

notes

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 .

volumeAppendModeEnabled?optionalstringvolume_append_mode_enabled?optionalstrvolumeAppendModeEnabled?optionalStringVolumeAppendModeEnabled?optionalstringVolumeAppendModeEnabled?optional*string#

Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.

notes

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 .