Package software.amazon.awscdk.services.fsx

Interface CfnVolume.SnaplockConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolume.SnaplockConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnVolume

@Stability(Stable)
public static interface CfnVolume.SnaplockConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 SnaplockConfigurationProperty snaplockConfigurationProperty = SnaplockConfigurationProperty.builder()
         .snaplockType("snaplockType")
         // the properties below are optional
         .auditLogVolume("auditLogVolume")
         .autocommitPeriod(AutocommitPeriodProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .value(123)
                 .build())
         .privilegedDelete("privilegedDelete")
         .retentionPeriod(SnaplockRetentionPeriodProperty.builder()
                 .defaultRetention(RetentionPeriodProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .value(123)
                         .build())
                 .maximumRetention(RetentionPeriodProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .value(123)
                         .build())
                 .minimumRetention(RetentionPeriodProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .value(123)
                         .build())
                 .build())
         .volumeAppendModeEnabled("volumeAppendModeEnabled")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVolume.SnaplockConfigurationProperty.Builder	A builder for CfnVolume.SnaplockConfigurationProperty
static final class	CfnVolume.SnaplockConfigurationProperty.Jsii$Proxy	An implementation for CfnVolume.SnaplockConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnVolume.SnaplockConfigurationProperty.Builder	builder()
default String	getAuditLogVolume()	Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
default Object	getAutocommitPeriod()	The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
default String	getPrivilegedDelete()	Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
default Object	getRetentionPeriod()	Specifies the retention period of an FSx for ONTAP SnapLock volume.
String	getSnaplockType()	Specifies the retention mode of an FSx for ONTAP SnapLock volume.
default String	getVolumeAppendModeEnabled()	Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSnaplockType

@Stability(Stable)
@NotNull
String getSnaplockType()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html#cfn-fsx-volume-snaplockconfiguration-snaplocktype

getAuditLogVolume

@Stability(Stable)
@Nullable
default String getAuditLogVolume()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html#cfn-fsx-volume-snaplockconfiguration-auditlogvolume

getAutocommitPeriod

@Stability(Stable)
@Nullable
default Object getAutocommitPeriod()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html#cfn-fsx-volume-snaplockconfiguration-autocommitperiod

getPrivilegedDelete

@Stability(Stable)
@Nullable
default String getPrivilegedDelete()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html#cfn-fsx-volume-snaplockconfiguration-privilegeddelete

getRetentionPeriod

@Stability(Stable)
@Nullable
default Object getRetentionPeriod()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html#cfn-fsx-volume-snaplockconfiguration-retentionperiod

getVolumeAppendModeEnabled

@Stability(Stable)
@Nullable
default String getVolumeAppendModeEnabled()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-snaplockconfiguration.html#cfn-fsx-volume-snaplockconfiguration-volumeappendmodeenabled

builder

@Stability(Stable)
static CfnVolume.SnaplockConfigurationProperty.Builder builder()

Returns:

a CfnVolume.SnaplockConfigurationProperty.Builder of CfnVolume.SnaplockConfigurationProperty