Skip to content

UpdateSnaplockConfiguration

Source code in docs_src/capo_fsx/types/update_snaplock_configuration.py
class UpdateSnaplockConfiguration(TypedDict, closed=True):
    audit_log_volume: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is <code>false</code>. If you set <code>AuditLogVolume</code> to <code>true</code>, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume"> SnapLock audit log volumes</a>. </p>"""
    autocommit_period: NotRequired["capo_fsx.types.autocommit_period.AutocommitPeriod"]
    """<p>The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. </p>"""
    privileged_delete: NotRequired["capo_fsx.types.privileged_delete.PrivilegedDelete"]
    """<p>Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. <code>PERMANENTLY_DISABLED</code> is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is <code>DISABLED</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete">Privileged delete</a>. </p>"""
    retention_period: NotRequired[
        "capo_fsx.types.snaplock_retention_period.SnaplockRetentionPeriod"
    ]
    """<p>Specifies the retention period of an FSx for ONTAP SnapLock volume. </p>"""
    volume_append_mode_enabled: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>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 <code>false</code>. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append">Volume-append mode</a>. </p>"""

audit_log_volume instance-attribute

audit_log_volume: NotRequired[Flag]

Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. 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.

autocommit_period instance-attribute

autocommit_period: NotRequired[AutocommitPeriod]

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

privileged_delete instance-attribute

privileged_delete: NotRequired[PrivilegedDelete]

Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. 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.

retention_period instance-attribute

retention_period: NotRequired[SnaplockRetentionPeriod]

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

volume_append_mode_enabled instance-attribute

volume_append_mode_enabled: NotRequired[Flag]

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.