Class CfnVolume.OntapConfigurationProperty
Specifies the configuration of the ONTAP volume that you are creating.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class OntapConfigurationProperty : Object, CfnVolume.IOntapConfigurationProperty
Syntax (vb)
Public Class OntapConfigurationProperty
Inherits Object
Implements CfnVolume.IOntapConfigurationProperty
Remarks
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.AWS.FSx;
var ontapConfigurationProperty = new OntapConfigurationProperty {
SizeInMegabytes = "sizeInMegabytes",
StorageVirtualMachineId = "storageVirtualMachineId",
// the properties below are optional
CopyTagsToBackups = "copyTagsToBackups",
JunctionPath = "junctionPath",
OntapVolumeType = "ontapVolumeType",
SecurityStyle = "securityStyle",
SnapshotPolicy = "snapshotPolicy",
StorageEfficiencyEnabled = "storageEfficiencyEnabled",
TieringPolicy = new TieringPolicyProperty {
CoolingPeriod = 123,
Name = "name"
}
};
Synopsis
Constructors
OntapConfigurationProperty() |
Properties
CopyTagsToBackups | A boolean flag indicating whether tags for the volume should be copied to backups. |
JunctionPath | Specifies the location in the SVM's namespace where the volume is mounted. |
OntapVolumeType | Specifies the type of volume you are creating. Valid values are the following:. |
SecurityStyle | Specifies the security style for the volume. |
SizeInMegabytes | Specifies the size of the volume, in megabytes (MB), that you are creating. |
SnapshotPolicy | Specifies the snapshot policy for the volume. There are three built-in snapshot policies:. |
StorageEfficiencyEnabled | Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. |
StorageVirtualMachineId | Specifies the ONTAP SVM in which to create the volume. |
TieringPolicy | Describes the data tiering policy for an ONTAP volume. |
Constructors
OntapConfigurationProperty()
public OntapConfigurationProperty()
Properties
CopyTagsToBackups
A boolean flag indicating whether tags for the volume should be copied to backups.
public string CopyTagsToBackups { get; set; }
Property Value
System.String
Remarks
This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
JunctionPath
Specifies the location in the SVM's namespace where the volume is mounted.
public string JunctionPath { get; set; }
Property Value
System.String
Remarks
This parameter is required. The JunctionPath
must have a leading forward slash, such as /vol3
.
OntapVolumeType
Specifies the type of volume you are creating. Valid values are the following:.
public string OntapVolumeType { get; set; }
Property Value
System.String
Remarks
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide .
SecurityStyle
Specifies the security style for the volume.
public string SecurityStyle { get; set; }
Property Value
System.String
Remarks
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:
SizeInMegabytes
Specifies the size of the volume, in megabytes (MB), that you are creating.
public string SizeInMegabytes { get; set; }
Property Value
System.String
Remarks
Provide any whole number in the range of 20–104857600 to specify the size of the volume.
SnapshotPolicy
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:.
public string SnapshotPolicy { get; set; }
Property Value
System.String
Remarks
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide .
StorageEfficiencyEnabled
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
public string StorageEfficiencyEnabled { get; set; }
Property Value
System.String
Remarks
StorageVirtualMachineId
Specifies the ONTAP SVM in which to create the volume.
public string StorageVirtualMachineId { get; set; }
Property Value
System.String
Remarks
TieringPolicy
Describes the data tiering policy for an ONTAP volume.
public object TieringPolicy { get; set; }
Property Value
System.Object
Remarks
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: