Table of Contents

Class OntapVolumeConfiguration

Namespace
Amazon.FSx.Model
Assembly
AWSSDK.FSx.dll

The configuration of an Amazon FSx for NetApp ONTAP volume.

public class OntapVolumeConfiguration
Inheritance
OntapVolumeConfiguration
Inherited Members

Constructors

OntapVolumeConfiguration() 

public OntapVolumeConfiguration()

Properties

AggregateConfiguration

Gets and sets the property AggregateConfiguration.

This structure specifies configuration options for a volume’s storage aggregate or aggregates. 

public AggregateConfiguration AggregateConfiguration { get; set; }

Property Value

AggregateConfiguration

CopyTagsToBackups

Gets and sets the property CopyTagsToBackups.

A boolean flag indicating whether tags for the volume should be copied to backups. 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. 

public bool CopyTagsToBackups { get; set; }

Property Value

bool

FlexCacheEndpointType

Gets and sets the property FlexCacheEndpointType.

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

  • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

  • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

  • CACHE specifies that the volume is a FlexCache volume. 

public FlexCacheEndpointType FlexCacheEndpointType { get; set; }

Property Value

FlexCacheEndpointType

JunctionPath

Gets and sets the property JunctionPath.

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3. 

public string JunctionPath { get; set; }

Property Value

string

OntapVolumeType

Gets and sets the property OntapVolumeType.

Specifies the type of volume. Valid values are the following:

  • RW specifies a read/write volume. RW is the default.

  • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

  • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients. 

public OntapVolumeType OntapVolumeType { get; set; }

Property Value

OntapVolumeType

SecurityStyle

Gets and sets the property SecurityStyle.

The security style for the volume, which can be UNIX, NTFS, or MIXED. 

public SecurityStyle SecurityStyle { get; set; }

Property Value

SecurityStyle

SizeInBytes

Gets and sets the property SizeInBytes.

The configured size of the volume, in bytes. 

public long SizeInBytes { get; set; }

Property Value

long

SizeInMegabytes

Gets and sets the property SizeInMegabytes.

The configured size of the volume, in megabytes (MBs). 

public int SizeInMegabytes { get; set; }

Property Value

int

SnaplockConfiguration

Gets and sets the property SnaplockConfiguration.

The SnapLock configuration object for an FSx for ONTAP SnapLock volume. 

public SnaplockConfiguration SnaplockConfiguration { get; set; }

Property Value

SnaplockConfiguration

SnapshotPolicy

Gets and sets the property SnapshotPolicy.

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

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. 

public string SnapshotPolicy { get; set; }

Property Value

string

StorageEfficiencyEnabled

Gets and sets the property StorageEfficiencyEnabled.

The volume's storage efficiency setting. 

public bool StorageEfficiencyEnabled { get; set; }

Property Value

bool

StorageVirtualMachineId

Gets and sets the property StorageVirtualMachineId.

The ID of the volume's storage virtual machine. 

public string StorageVirtualMachineId { get; set; }

Property Value

string

StorageVirtualMachineRoot

Gets and sets the property StorageVirtualMachineRoot.

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM. 

public bool StorageVirtualMachineRoot { get; set; }

Property Value

bool

TieringPolicy

Gets and sets the property TieringPolicy.

The volume's TieringPolicy setting. 

public TieringPolicy TieringPolicy { get; set; }

Property Value

TieringPolicy

UUID

Gets and sets the property UUID.

The volume's universally unique identifier (UUID). 

public string UUID { get; set; }

Property Value

string

VolumeStyle

Gets and sets the property VolumeStyle.

Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide. 

public VolumeStyle VolumeStyle { get; set; }

Property Value

VolumeStyle