Class CfnVolume.SnaplockConfigurationProperty

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

Inheritance

object

CfnVolume.SnaplockConfigurationProperty

Implements

CfnVolume.ISnaplockConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.FSx

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnVolume.SnaplockConfigurationProperty : CfnVolume.ISnaplockConfigurationProperty

Syntax (vb)

Public Class CfnVolume.SnaplockConfigurationProperty Implements CfnVolume.ISnaplockConfigurationProperty

Remarks

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

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()

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

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()

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

public SnaplockConfigurationProperty()

Remarks

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

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"
             };

Properties

AuditLogVolume

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

public string? AuditLogVolume { get; set; }

Property Value

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 .

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

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

object

Remarks

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

Type union: either IResolvable or CfnVolume.IAutocommitPeriodProperty

PrivilegedDelete

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

public string? PrivilegedDelete { get; set; }

Property Value

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 .

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

RetentionPeriod

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

public object? RetentionPeriod { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnVolume.ISnaplockRetentionPeriodProperty

SnaplockType

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

public string SnaplockType { get; set; }

Property Value

string

Remarks

After it is set, it can't be changed. You can choose one of the following retention modes:

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

VolumeAppendModeEnabled

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

public string? VolumeAppendModeEnabled { get; set; }

Property Value

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 .

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

Implements

CfnVolume.ISnaplockConfigurationProperty