Class OpenZFSVolumeConfiguration
The configuration of an Amazon FSx for OpenZFS volume.
public class OpenZFSVolumeConfiguration- Inheritance
-
OpenZFSVolumeConfiguration
- Inherited Members
Constructors
OpenZFSVolumeConfiguration()
public OpenZFSVolumeConfiguration()Properties
CopyStrategy
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.
note
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 OpenZFSCopyStrategy CopyStrategy { get; set; }Property Value
CopyTagsToSnapshots
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 bool CopyTagsToSnapshots { get; set; }Property Value
DataCompressionType
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.NONEis 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 OpenZFSDataCompressionType DataCompressionType { get; set; }Property Value
DeleteClonedVolumes
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 bool DeleteClonedVolumes { get; set; }Property Value
DeleteIntermediateData
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 bool DeleteIntermediateData { get; set; }Property Value
DeleteIntermediateSnaphots
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 bool DeleteIntermediateSnaphots { get; set; }Property Value
DestinationSnapshot
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 string DestinationSnapshot { get; set; }Property Value
NfsExports
Gets and sets the property NfsExports.
The configuration object for mounting a Network File System (NFS) file system.
public List<OpenZFSNfsExport> NfsExports { get; set; }Property Value
OriginSnapshot
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 OpenZFSOriginSnapshotConfiguration OriginSnapshot { get; set; }Property Value
ParentVolumeId
Gets and sets the property ParentVolumeId.
The ID of the parent volume.
public string ParentVolumeId { get; set; }Property Value
ReadOnly
Gets and sets the property ReadOnly.
A Boolean value indicating whether the volume is read-only.
public bool ReadOnly { get; set; }Property Value
RecordSizeKiB
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 int RecordSizeKiB { get; set; }Property Value
RestoreToSnapshot
Gets and sets the property RestoreToSnapshot.
Specifies the ID of the snapshot to which the volume was restored.
public string RestoreToSnapshot { get; set; }Property Value
SourceSnapshotARN
Gets and sets the property SourceSnapshotARN.
public string SourceSnapshotARN { get; set; }Property Value
StorageCapacityQuotaGiB
Gets and sets the property StorageCapacityQuotaGiB.
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
public int StorageCapacityQuotaGiB { get; set; }Property Value
StorageCapacityReservationGiB
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 int StorageCapacityReservationGiB { get; set; }Property Value
UserAndGroupQuotas
Gets and sets the property UserAndGroupQuotas.
An object specifying how much storage users or groups can use on the volume.
public List<OpenZFSUserOrGroupQuota> UserAndGroupQuotas { get; set; }Property Value
VolumePath
Gets and sets the property VolumePath.
The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
public string VolumePath { get; set; }