Class CfnVolumePropsMixin.RetentionPeriodProperty

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

Inheritance
object
CfnVolumePropsMixin.RetentionPeriodProperty
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.FSx.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnVolumePropsMixin.RetentionPeriodProperty : CfnVolumePropsMixin.IRetentionPeriodProperty
Syntax (vb)
Public Class CfnVolumePropsMixin.RetentionPeriodProperty Implements CfnVolumePropsMixin.IRetentionPeriodProperty
Remarks

After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.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.Mixins.Preview.AWS.FSx.Mixins;

             var retentionPeriodProperty = new RetentionPeriodProperty {
                 Type = "type",
                 Value = 123
             };

Synopsis

Constructors

RetentionPeriodProperty()

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

Properties

Type

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
Value

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

Constructors

RetentionPeriodProperty()

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

public RetentionPeriodProperty()
Remarks

After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.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.Mixins.Preview.AWS.FSx.Mixins;

             var retentionPeriodProperty = new RetentionPeriodProperty {
                 Type = "type",
                 Value = 123
             };

Properties

Type

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.

public string? Type { get; set; }
Property Value

string

Remarks

Set it to one of the valid types. If you set it to INFINITE , the files are retained forever. If you set it to UNSPECIFIED , the files are retained until you set an explicit retention period.

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

Value

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

public double? Value { get; set; }
Property Value

double?

Remarks

You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

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

    Implements