software.amazon.awscdk.services.fsx

Interface CfnVolume.OntapConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolume.OntapConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnVolume

@Stability(value=Stable)
public static interface CfnVolume.OntapConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration of the ONTAP volume that you are creating.

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.*;
 OntapConfigurationProperty ontapConfigurationProperty = OntapConfigurationProperty.builder()
         .junctionPath("junctionPath")
         .sizeInMegabytes("sizeInMegabytes")
         .storageEfficiencyEnabled("storageEfficiencyEnabled")
         .storageVirtualMachineId("storageVirtualMachineId")
         // the properties below are optional
         .securityStyle("securityStyle")
         .tieringPolicy(TieringPolicyProperty.builder()
                 .coolingPeriod(123)
                 .name("name")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnVolume.OntapConfigurationProperty.Builder	builder()
String	getJunctionPath() Specifies the location in the SVM's namespace where the volume is mounted.
default String	getSecurityStyle() Specifies the security style for the volume.
String	getSizeInMegabytes() Specifies the size of the volume, in megabytes (MB), that you are creating.
String	getStorageEfficiencyEnabled() Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
String	getStorageVirtualMachineId() Specifies the ONTAP SVM in which to create the volume.
default Object	getTieringPolicy() Describes the data tiering policy for an ONTAP volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getJunctionPath

@Stability(value=Stable)
 @NotNull
String getJunctionPath()

Specifies the location in the SVM's namespace where the volume is mounted.

The JunctionPath must have a leading forward slash, such as /vol3 .

getSizeInMegabytes

@Stability(value=Stable)
 @NotNull
String getSizeInMegabytes()

Specifies the size of the volume, in megabytes (MB), that you are creating.

getStorageEfficiencyEnabled

@Stability(value=Stable)
 @NotNull
String getStorageEfficiencyEnabled()

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.

getStorageVirtualMachineId

@Stability(value=Stable)
 @NotNull
String getStorageVirtualMachineId()

Specifies the ONTAP SVM in which to create the volume.

getSecurityStyle

@Stability(value=Stable)
 @Nullable
default String getSecurityStyle()

Specifies the security style for the volume.

If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide . Specify one of the following values:

• UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
• NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
• MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

getTieringPolicy

@Stability(value=Stable)
 @Nullable
default Object getTieringPolicy()

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.

builder

@Stability(value=Stable)
static CfnVolume.OntapConfigurationProperty.Builder builder()

Returns:

a CfnVolume.OntapConfigurationProperty.Builder of CfnVolume.OntapConfigurationProperty