Module Values.CreateFileSystemOpenZFSConfigurationSource

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

Sourcetype nonrec t = {
  1. automaticBackupRetentionDays : AutomaticBackupRetentionDays.t option;
  2. copyTagsToBackups : Flag.t option;
    (*

    A Boolean value indicating whether tags for the file system should be copied to backups. 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.

    *)
  3. copyTagsToVolumes : Flag.t option;
    (*

    A Boolean value indicating whether tags for the file system should be copied to volumes. 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.

    *)
  4. dailyAutomaticBackupStartTime : DailyTime.t option;
  5. deploymentType : OpenZFSDeploymentType.t;
    (*

    Specifies the file system deployment type. Valid values are the following: 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 Amazon Web Services 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 Amazon Web Services 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.

    *)
  6. throughputCapacity : MegabytesPerSecond.t;
    (*

    Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). 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.

    *)
  7. weeklyMaintenanceStartTime : WeeklyTime.t option;
  8. diskIopsConfiguration : DiskIopsConfiguration.t option;
  9. rootVolumeConfiguration : OpenZFSCreateRootVolumeConfiguration.t option;
    (*

    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.

    *)
  10. preferredSubnetId : SubnetId.t option;
    (*

    Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

    *)
  11. endpointIpAddressRange : IpAddressRange.t option;
    (*

    (Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created. 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.

    *)
  12. endpointIpv6AddressRange : Ipv6AddressRange.t option;
    (*

    (Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. 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.

    *)
  13. routeTableIds : RouteTableIds.t option;
    (*

    (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.

    *)
  14. readCacheConfiguration : OpenZFSReadCacheConfiguration.t option;
    (*

    Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.

    *)
}
Sourceval context_ : string
Sourceval make : ?automaticBackupRetentionDays:??? -> ?copyTagsToBackups:??? -> ?copyTagsToVolumes:??? -> ?dailyAutomaticBackupStartTime:??? -> ?weeklyMaintenanceStartTime:??? -> ?diskIopsConfiguration:??? -> ?rootVolumeConfiguration:??? -> ?preferredSubnetId:??? -> ?endpointIpAddressRange:??? -> ?endpointIpv6AddressRange:??? -> ?routeTableIds:??? -> ?readCacheConfiguration:??? -> deploymentType:OpenZFSDeploymentType.t -> throughputCapacity:MegabytesPerSecond.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Flag.t | `Enum of string | `Integer of AutomaticBackupRetentionDays.t | `List of [> `String of RouteTableId.t ] list | `String of DailyTime.t | `Structure of (string * [> `Boolean of Flag.t | `Enum of string | `Integer of IntegerRecordSizeKiB.t | `List of [> `Structure of (string * [> `Enum of string | `Integer of IntegerNoMax.t | `List of [> `Structure of (string * [> `List of [> `String of OpenZFSNfsExportOption.t ] list | `String of OpenZFSClients.t ]) list ] list ]) list ] list | `Long of Iops.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t