OpenZfsVolumeArgs class
The set of arguments for OpenZfsVolume. The set of arguments for OpenZfsVolume.
Constructors
-
OpenZfsVolumeArgs({Input<
bool?> ? copyTagsToSnapshots, Input<String?> ? dataCompressionType, Input<String?> ? deleteVolumeOptions, Input<String?> ? name, Input<OpenZfsVolumeNfsExports?> ? nfsExports, Input<OpenZfsVolumeOriginSnapshot?> ? originSnapshot, required Input<String> parentVolumeId, Input<bool?> ? readOnly, Input<int?> ? recordSizeKib, Input<String?> ? region, Input<int?> ? storageCapacityQuotaGib, Input<int?> ? storageCapacityReservationGib, Input<Map< ? tags, Input<String, String> ?>List< ? userAndGroupQuotas, Input<OpenZfsVolumeUserAndGroupQuota> ?>String?> ? volumeType}) -
Creates a new OpenZfsVolumeArgs.
copyTagsToSnapshotsWhether tags for the file system should be copied to snapshots. Default is false.dataCompressionTypeMethod used to compress the data on the volume. Valid values areNONEorZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.deleteVolumeOptionsWhether to delete all child volumes and snapshots. Valid values:DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..nameName of the volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.nfsExportsNFS export configuration for the root volume. Exactly 1 item. SeenfsExportsBlock Below for details.originSnapshotConfiguration to use when creating the OpenZFS volume. SeeoriginSnapshotBlock below for details.parentVolumeIdVolume ID of the volume that will be the parent volume for the volume being created, this could be the root volume created from theaws.fsx.OpenZfsFileSystemresource with therootVolumeIdor theidproperty of anotheraws.fsx.OpenZfsVolume.readOnlyWhether the volume is read-only. Default is false.recordSizeKibRecord size of an OpenZFS volume, in kibibytes (KiB). Valid values are4,8,16,32,64,128,256,512, or1024KiB. Default is128KiB.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.storageCapacityQuotaGibMaximum amount of storage in gibibytes (GiB) that the volume can use from its parent.storageCapacityReservationGibAmount of storage in gibibytes (GiB) to reserve from the parent volume.tagsMap of tags to assign to the file system. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.userAndGroupQuotasSpecify how much storage users or groups can use on the volume. Maximum number of items defined by FSx for OpenZFS Resource quota. SeeuserAndGroupQuotasBlock Below.volumeTypeVolume type. Default isOPENZFS.const -
OpenZfsVolumeArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
copyTagsToSnapshots
→ Input<
bool?> ? -
Whether tags for the file system should be copied to snapshots. Default is false.
final
-
dataCompressionType
→ Input<
String?> ? -
Method used to compress the data on the volume. Valid values are
NONEorZSTD. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.final -
deleteVolumeOptions
→ Input<
String?> ? -
Whether to delete all child volumes and snapshots. Valid values:
DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..final - hashCode → int
-
The hash code for this object.
no setterinherited
-
name
→ Input<
String?> ? -
Name of the volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
final
-
nfsExports
→ Input<
OpenZfsVolumeNfsExports?> ? -
NFS export configuration for the root volume. Exactly 1 item. See
nfsExportsBlock Below for details.final -
originSnapshot
→ Input<
OpenZfsVolumeOriginSnapshot?> ? -
Configuration to use when creating the OpenZFS volume. See
originSnapshotBlock below for details.final -
parentVolumeId
→ Input<
String> -
Volume ID of the volume that will be the parent volume for the volume being created, this could be the root volume created from the
aws.fsx.OpenZfsFileSystemresource with therootVolumeIdor theidproperty of anotheraws.fsx.OpenZfsVolume.final -
readOnly
→ Input<
bool?> ? -
Whether the volume is read-only. Default is false.
final
-
recordSizeKib
→ Input<
int?> ? -
Record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
4,8,16,32,64,128,256,512, or1024KiB. Default is128KiB.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storageCapacityQuotaGib
→ Input<
int?> ? -
Maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
final
-
storageCapacityReservationGib
→ Input<
int?> ? -
Amount of storage in gibibytes (GiB) to reserve from the parent volume.
final
-
Map of tags to assign to the file system. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
userAndGroupQuotas
→ Input<
List< ?OpenZfsVolumeUserAndGroupQuota> ?> -
Specify how much storage users or groups can use on the volume. Maximum number of items defined by FSx for OpenZFS Resource quota. See
userAndGroupQuotasBlock Below.final -
volumeType
→ Input<
String?> ? -
Volume type. Default is
OPENZFS.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited