Package software.amazon.awscdk.services.fsx

Interface CfnVolume.TieringPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolume.TieringPolicyProperty.Jsii$Proxy

Enclosing class:

CfnVolume

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

Describes the data tiering policy for an ONTAP volume.

When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

• SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.
• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

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.*;
 TieringPolicyProperty tieringPolicyProperty = TieringPolicyProperty.builder()
         .coolingPeriod(123)
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVolume.TieringPolicyProperty.Builder	builder()
default Number	getCoolingPeriod()	Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.
default String	getName()	Specifies the tiering policy used to transition data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCoolingPeriod

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

Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.

Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .

See Also:

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

getName

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

Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

• SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

See Also:

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

builder

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

Returns:

a CfnVolume.TieringPolicyProperty.Builder of CfnVolume.TieringPolicyProperty