Skip to content

Resource: awsFsxOpenzfsVolume

Manages an Amazon FSx for OpenZFS volume. See the FSx OpenZFS User Guide for more information.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.fsxOpenzfsVolume.FsxOpenzfsVolume(this, "test", {
  name: "testvolume",
  parentVolumeId: "${aws_fsx_openzfs_file_system.test.root_volume_id}",
});

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
  • parentVolumeId - (Required) The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the awsFsxOpenzfsFileSystem resource with the rootVolumeId or the id property of another awsFsxOpenzfsVolume.
  • originSnapshot - (Optional) The ARN of the source snapshot to create the volume from.
  • copyTagsToSnapshots - (Optional) A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false.
  • dataCompressionType - (Optional) Method used to compress the data on the volume. Valid values are none or zstd. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.
  • nfsExports - (Optional) NFS export configuration for the root volume. Exactly 1 item. See NFS Exports Below.
  • readOnly - (Optional) specifies whether the volume is read-only. Default is false.
  • recordSizeKib - (Optional) 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.
  • storageCapacityQuotaGib - (Optional) The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.
  • storageCapacityReservationGib - (Optional) The amount of storage in gibibytes (GiB) to reserve from the parent volume.
  • userAndGroupQuotas - (Optional) - Specify how much storage users or groups can use on the volume. Maximum of 100 items. See User and Group Quotas Below.
  • tags - (Optional) A map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

NFS Exports

  • clientConfigurations - (Required) - A list of configuration objects that contain the client and options for mounting the OpenZFS file system. Maximum of 25 items. See [Client Configurations](#client configurations) Below.

Client Configurations

  • clients - (Required) - A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24. By default, Amazon FSx uses the wildcard character when specifying the client.
  • options - (Required) - The options to use when mounting the file system. Maximum of 20 items. See the Linix NFS exports man page for more information. crossmount and sync are used by default.

User and Group Quotas

  • id - (Required) - The ID of the user or group. Valid values between 0 and 2147483647
  • storageCapacityQuotaGib - (Required) - The amount of storage that the user or group can use in gibibytes (GiB). Valid values between 0 and 2147483647
  • type - (Required) - A value that specifies whether the quota applies to a user or group. Valid values are user or group.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name of the file system.
  • id - Identifier of the file system, e.g., fsvol12345678
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Timeouts

Configuration options:

  • create - (Default 30M)
  • update - (Default 30M)
  • delete - (Default 30M)

Import

FSx Volumes can be imported using the id, e.g.,

$ terraform import aws_fsx_openzfs_volume.example fsvol-543ab12b1ca672f33