AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The configuration of an Amazon FSx for OpenZFS volume.

Inheritance Hierarchy

System.Object
  Amazon.FSx.Model.OpenZFSVolumeConfiguration

Namespace: Amazon.FSx.Model
Assembly: AWSSDK.FSx.dll
Version: 3.x.y.z

Syntax

C#
public class OpenZFSVolumeConfiguration

The OpenZFSVolumeConfiguration type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CopyStrategy Amazon.FSx.OpenZFSCopyStrategy

Gets and sets the property CopyStrategy.

Specifies the strategy used when copying data from the snapshot to the new volume.

  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

  • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

Public Property CopyTagsToSnapshots System.Boolean

Gets and sets the property CopyTagsToSnapshots.

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

Public Property DataCompressionType Amazon.FSx.OpenZFSDataCompressionType

Gets and sets the property DataCompressionType.

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.

  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

Public Property DeleteClonedVolumes System.Boolean

Gets and sets the property DeleteClonedVolumes.

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

Public Property DeleteIntermediateData System.Boolean

Gets and sets the property DeleteIntermediateData.

A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

Public Property DeleteIntermediateSnaphots System.Boolean

Gets and sets the property DeleteIntermediateSnaphots.

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

Public Property DestinationSnapshot System.String

Gets and sets the property DestinationSnapshot.

The ID of the snapshot that's being copied or was most recently copied to the destination volume.

Public Property NfsExports System.Collections.Generic.List<Amazon.FSx.Model.OpenZFSNfsExport>

Gets and sets the property NfsExports.

The configuration object for mounting a Network File System (NFS) file system.

Public Property OriginSnapshot Amazon.FSx.Model.OpenZFSOriginSnapshotConfiguration

Gets and sets the property OriginSnapshot.

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

Public Property ParentVolumeId System.String

Gets and sets the property ParentVolumeId.

The ID of the parent volume.

Public Property ReadOnly System.Boolean

Gets and sets the property ReadOnly.

A Boolean value indicating whether the volume is read-only.

Public Property RecordSizeKiB System.Int32

Gets and sets the property RecordSizeKiB.

The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

Public Property RestoreToSnapshot System.String

Gets and sets the property RestoreToSnapshot.

Specifies the ID of the snapshot to which the volume was restored.

Public Property SourceSnapshotARN System.String

Gets and sets the property SourceSnapshotARN.

Public Property StorageCapacityQuotaGiB System.Int32

Gets and sets the property StorageCapacityQuotaGiB.

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

Public Property StorageCapacityReservationGiB System.Int32

Gets and sets the property StorageCapacityReservationGiB.

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

Public Property UserAndGroupQuotas System.Collections.Generic.List<Amazon.FSx.Model.OpenZFSUserOrGroupQuota>

Gets and sets the property UserAndGroupQuotas.

An object specifying how much storage users or groups can use on the volume.

Public Property VolumePath System.String

Gets and sets the property VolumePath.

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5