Class CfnVolume.OpenZFSConfigurationProperty
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class OpenZFSConfigurationProperty : Object, CfnVolume.IOpenZFSConfigurationProperty
Syntax (vb)
Public Class OpenZFSConfigurationProperty
Inherits Object
Implements CfnVolume.IOpenZFSConfigurationProperty
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 openZFSConfigurationProperty = new OpenZFSConfigurationProperty {
ParentVolumeId = "parentVolumeId",
// the properties below are optional
CopyTagsToSnapshots = false,
DataCompressionType = "dataCompressionType",
NfsExports = new [] { new NfsExportsProperty {
ClientConfigurations = new [] { new ClientConfigurationsProperty {
Clients = "clients",
Options = new [] { "options" }
} }
} },
Options = new [] { "options" },
OriginSnapshot = new OriginSnapshotProperty {
CopyStrategy = "copyStrategy",
SnapshotArn = "snapshotArn"
},
ReadOnly = false,
RecordSizeKiB = 123,
StorageCapacityQuotaGiB = 123,
StorageCapacityReservationGiB = 123,
UserAndGroupQuotas = new [] { new UserAndGroupQuotasProperty {
Id = 123,
StorageCapacityQuotaGiB = 123,
Type = "type"
} }
};
Synopsis
Constructors
OpenZFSConfigurationProperty() |
Properties
CopyTagsToSnapshots | A Boolean value indicating whether tags for the volume should be copied to snapshots. |
DataCompressionType | Specifies the method used to compress the data on the volume. The compression type is |
NfsExports | The configuration object for mounting a Network File System (NFS) file system. |
Options | To delete the volume's child volumes, snapshots, and clones, use the string |
OriginSnapshot | The configuration object that specifies the snapshot to use as the origin of the data for the volume. |
ParentVolumeId | The ID of the volume to use as the parent volume of the volume that you are creating. |
ReadOnly | A Boolean value indicating whether the volume is read-only. |
RecordSizeKiB | Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). |
StorageCapacityQuotaGiB | Sets the maximum storage size in gibibytes (GiB) for the volume. |
StorageCapacityReservationGiB | Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. |
UserAndGroupQuotas | An object specifying how much storage users or groups can use on the volume. |
Constructors
OpenZFSConfigurationProperty()
public OpenZFSConfigurationProperty()
Properties
CopyTagsToSnapshots
A Boolean value indicating whether tags for the volume should be copied to snapshots.
public object CopyTagsToSnapshots { get; set; }
Property Value
System.Object
Remarks
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.
DataCompressionType
Specifies the method used to compress the data on the volume. The compression type is NONE
by default.
public string DataCompressionType { get; set; }
Property Value
System.String
Remarks
NfsExports
The configuration object for mounting a Network File System (NFS) file system.
public object NfsExports { get; set; }
Property Value
System.Object
Remarks
Options
To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
.
public string[] Options { get; set; }
Property Value
System.String[]
Remarks
OriginSnapshot
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
public object OriginSnapshot { get; set; }
Property Value
System.Object
Remarks
ParentVolumeId
The ID of the volume to use as the parent volume of the volume that you are creating.
public string ParentVolumeId { get; set; }
Property Value
System.String
Remarks
ReadOnly
A Boolean value indicating whether the volume is read-only.
public object ReadOnly { get; set; }
Property Value
System.Object
Remarks
RecordSizeKiB
Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
public Nullable<double> RecordSizeKiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
StorageCapacityQuotaGiB
Sets the maximum storage size in gibibytes (GiB) for the volume.
public Nullable<double> StorageCapacityQuotaGiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB
. To not specify a storage capacity quota, set this to -1
.
For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
StorageCapacityReservationGiB
Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
public Nullable<double> StorageCapacityReservationGiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Setting StorageCapacityReservationGiB
guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0
or -1
. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
UserAndGroupQuotas
An object specifying how much storage users or groups can use on the volume.
public object UserAndGroupQuotas { get; set; }
Property Value
System.Object