Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Interface CfnVolumePropsMixin.SnaplockRetentionPeriodProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolumePropsMixin.SnaplockRetentionPeriodProperty.Jsii$Proxy

Enclosing class:

CfnVolumePropsMixin

@Stability(Stable)
public static interface CfnVolumePropsMixin.SnaplockRetentionPeriodProperty
extends software.amazon.jsii.JsiiSerializable

The configuration to set the retention period of an FSx for ONTAP SnapLock volume.

The retention period includes default, maximum, and minimum settings. 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.cfnpropertymixins.services.fsx.*;
 SnaplockRetentionPeriodProperty snaplockRetentionPeriodProperty = SnaplockRetentionPeriodProperty.builder()
         .defaultRetention(RetentionPeriodProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .maximumRetention(RetentionPeriodProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .minimumRetention(RetentionPeriodProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVolumePropsMixin.SnaplockRetentionPeriodProperty.Builder	builder()
default Object	getDefaultRetention()	The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume.
default Object	getMaximumRetention()	The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
default Object	getMinimumRetention()	The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultRetention

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

The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume.

The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

Returns union: either IResolvable or CfnVolumePropsMixin.RetentionPeriodProperty

See Also:

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

getMaximumRetention

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

The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Returns union: either IResolvable or CfnVolumePropsMixin.RetentionPeriodProperty

See Also:

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

getMinimumRetention

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

The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Returns union: either IResolvable or CfnVolumePropsMixin.RetentionPeriodProperty

See Also:

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

builder

@Stability(Stable)
static CfnVolumePropsMixin.SnaplockRetentionPeriodProperty.Builder builder()

Returns:

a CfnVolumePropsMixin.SnaplockRetentionPeriodProperty.Builder of CfnVolumePropsMixin.SnaplockRetentionPeriodProperty