AWS CDK Reference

Appearance

v2.273.0

OpenZFSConfigurationProperty Struct ​

The OpenZFS configuration for the file system that's being created.

Source
Generated code
Type last changed
v2.214.0 · 2 Sep 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const openZFSConfigurationProperty: fsx.CfnFileSystem.OpenZFSConfigurationProperty = {
  deploymentType: 'deploymentType',

  // the properties below are optional
  automaticBackupRetentionDays: 123,
  copyTagsToBackups: false,
  copyTagsToVolumes: false,
  dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
  diskIopsConfiguration: {
    iops: 123,
    mode: 'mode',
  },
  endpointIpAddressRange: 'endpointIpAddressRange',
  endpointIpv6AddressRange: 'endpointIpv6AddressRange',
  options: ['options'],
  preferredSubnetId: 'preferredSubnetId',
  readCacheConfiguration: {
    sizeGiB: 123,
    sizingMode: 'sizingMode',
  },
  rootVolumeConfiguration: {
    copyTagsToSnapshots: false,
    dataCompressionType: 'dataCompressionType',
    nfsExports: [{
      clientConfigurations: [{
        clients: 'clients',
        options: ['options'],
      }],
    }],
    readOnly: false,
    recordSizeKiB: 123,
    userAndGroupQuotas: [{
      id: 123,
      storageCapacityQuotaGiB: 123,
      type: 'type',
    }],
  },
  routeTableIds: ['routeTableIds'],
  throughputCapacity: 123,
  weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
};

Properties ​

automaticBackupRetentionDaysnumberautomatic_backup_retention_daysint | floatautomaticBackupRetentionDaysNumberAutomaticBackupRetentionDaysdoubleAutomaticBackupRetentionDays*float64#
The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .

copyTagsToBackupsboolean | IResolvablecopy_tags_to_backupstyping.Union[bool, IResolvable]copyTagsToBackupsBooleanCopyTagsToBackupsboolCopyTagsToBackupsinterface{}#
A Boolean value indicating whether tags for the file system should be copied to backups.
notes

This value defaults to false . If it's set to true , all tags for the file system are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

copyTagsToVolumesboolean | IResolvablecopy_tags_to_volumestyping.Union[bool, IResolvable]copyTagsToVolumesBooleanCopyTagsToVolumesboolCopyTagsToVolumesinterface{}#
A Boolean value indicating whether tags for the file system should be copied to volumes.
notes

This value defaults to false . If it's set to true , all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

dailyAutomaticBackupStartTimestringdaily_automatic_backup_start_timestrdailyAutomaticBackupStartTimeStringDailyAutomaticBackupStartTimestringDailyAutomaticBackupStartTime*string#
A recurring daily time, in the format `HH:MM` .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

deploymentTypestringdeployment_typestrdeploymentTypeStringDeploymentTypestringDeploymentType*stringrequired#
Specifies the file system deployment type. Valid values are the following:.
notes
  • MULTI_AZ_1 - Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same AWS Region .
  • SINGLE_AZ_HA_2 - Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.
  • SINGLE_AZ_HA_1 - Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.
  • SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.
  • SINGLE_AZ_1 - Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

For a list of which AWS Regions each deployment type is available in, see Deployment type availability . For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide .

diskIopsConfigurationIResolvable | CfnFileSystem.DiskIopsConfigurationPropertydisk_iops_configurationtyping.Union[IResolvable, DiskIopsConfigurationProperty]diskIopsConfigurationIResolvableDiskIopsConfigurationIResolvableDiskIopsConfigurationinterface{}#
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.
notes

By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

endpointIpAddressRangestringendpoint_ip_address_rangestrendpointIpAddressRangeStringEndpointIpAddressRangestringEndpointIpAddressRange*string#
(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created.
notes

By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

endpointIpv6AddressRangestringendpoint_ipv6_address_rangestrendpointIpv6AddressRangeStringEndpointIpv6AddressRangestringEndpointIpv6AddressRange*string#
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
notes

By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

optionsstring[]optionstyping.List[str]optionsList<String>Optionsstring[]Options*[]*string#
To delete a file system if there are child volumes present below the root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS` .

If your file system has child volumes and you don't use this option, the delete request will fail.

preferredSubnetIdstringpreferred_subnet_idstrpreferredSubnetIdStringPreferredSubnetIdstringPreferredSubnetId*string#
Required when `DeploymentType` is set to `MULTI_AZ_1` .

This specifies the subnet in which you want the preferred file server to be located.

readCacheConfigurationIResolvable | CfnFileSystem.ReadCacheConfigurationPropertyread_cache_configurationtyping.Union[IResolvable, ReadCacheConfigurationProperty]readCacheConfigurationIResolvableReadCacheConfigurationIResolvableReadCacheConfigurationinterface{}#
Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.
rootVolumeConfigurationIResolvable | CfnFileSystem.RootVolumeConfigurationPropertyroot_volume_configurationtyping.Union[IResolvable, RootVolumeConfigurationProperty]rootVolumeConfigurationIResolvableRootVolumeConfigurationIResolvableRootVolumeConfigurationinterface{}#
The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.

All volumes are children of the root volume.

routeTableIdsstring[]route_table_idstyping.List[str]routeTableIdsList<String>RouteTableIdsstring[]RouteTableIds*[]*string#
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.

You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

throughputCapacitynumberthroughput_capacityint | floatthroughputCapacityNumberThroughputCapacitydoubleThroughputCapacity*float64#
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).
notes

Required if you are creating a new file system.

Valid values depend on the DeploymentType that you choose, as follows:

  • For MULTI_AZ_1 and SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
  • For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

weeklyMaintenanceStartTimestringweekly_maintenance_start_timestrweeklyMaintenanceStartTimeStringWeeklyMaintenanceStartTimestringWeeklyMaintenanceStartTime*string#
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

For example, 1:05:00 specifies maintenance at 5 AM Monday.