Package software.amazon.awscdk.services.fsx

Interface CfnVolume.RetentionPeriodProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolume.RetentionPeriodProperty.Jsii$Proxy

Enclosing class:

CfnVolume

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

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

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 .

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.*;
 RetentionPeriodProperty retentionPeriodProperty = RetentionPeriodProperty.builder()
         .type("type")
         // the properties below are optional
         .value(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVolume.RetentionPeriodProperty.Builder	builder()
String	getType()	Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
default Number	getValue()	Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

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

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 Also:

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

getValue

@Stability(Stable)
@Nullable
default Number getValue()

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

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

• Seconds : 0 - 65,535
• Minutes : 0 - 65,535
• Hours : 0 - 24
• Days : 0 - 365
• Months : 0 - 12
• Years : 0 - 100

See Also:

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

builder

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

Returns:

a CfnVolume.RetentionPeriodProperty.Builder of CfnVolume.RetentionPeriodProperty