import { Value } from '../../../cloudformation/Value';
import { NfsExportsProps } from './NfsExportsProps';
import { OriginSnapshotProps } from './OriginSnapshotProps';
import { UserAndGroupQuotasProps } from './UserAndGroupQuotasProps';
/**
  Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html">the AWS Docs</a>
*/
export interface OpenZFSConfigurationProps {
    /** <code>ReadOnly</code>  <a name="cfn-fsx-volume-openzfsconfiguration-readonly"></a>
  A Boolean value indicating whether the volume is read-only.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    readOnly?: Value<boolean>;
    /** <code>Options</code>  <a name="cfn-fsx-volume-openzfsconfiguration-options"></a>
  To delete the volume’s child volumes, snapshots, and clones, use the string <code>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</code>.<br />
  
  Required: No<br />
  
  Maximum: <code>1</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    options?: Value<Value<string>[]>;
    /** <p> */
    dataCompressionType?: Value<string>;
    /** <code>NfsExports</code>  <a name="cfn-fsx-volume-openzfsconfiguration-nfsexports"></a>
  The configuration object for mounting a Network File System (NFS) file system.<br />
  
  Required: No<br />
  
  Maximum: <code>1</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    nfsExports?: NfsExportsProps[];
    /** <code>StorageCapacityQuotaGiB</code>  <a name="cfn-fsx-volume-openzfsconfiguration-storagecapacityquotagib"></a>
  Sets the maximum storage size in gibibytes (GiB) for the volume. 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 <code>StorageCapacityReservationGiB</code>. To
  not: pecify a storage capacity quota, set this to <code>-1</code>.<br />
  For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a> in the
  Amazon FSx for OpenZFS User Guide: br />
  
  Required: No<br />
  
  Minimum: <code>-1</code><br />
  
  Maximum: <code>2147483647</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    storageCapacityQuotaGiB?: Value<number>;
    /** <code>CopyTagsToSnapshots</code>  <a name="cfn-fsx-volume-openzfsconfiguration-copytagstosnapshots"></a>
  A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it’s set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn’t specify tags. If this value is <code>true</code>, 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.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    copyTagsToSnapshots?: Value<boolean>;
    /** <code>ParentVolumeId</code>  <a name="cfn-fsx-volume-openzfsconfiguration-parentvolumeid"></a>
  The ID of the volume to use as the parent volume of the volume that you are creating.<br />
  
  Required: Yes<br />
  
  Minimum: <code>23</code><br />
  
  Maximum: <code>23</code><br />
  
  Pattern: <code>^(fsvol-[0-9a-f]{17,})$</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">Replacement</a> */
    parentVolumeId: Value<string>;
    /** <code>StorageCapacityReservationGiB</code>  <a name="cfn-fsx-volume-openzfsconfiguration-storagecapacityreservationgib"></a>
  Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting <code>StorageCapacityReservationGiB</code> 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: pecify a storage capacity reservation, set this to <code>0</code> or <code>-1</code>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a> in the
  Amazon FSx for OpenZFS User Guide: br />
  
  Required: No<br />
  
  Minimum: <code>-1</code><br />
  
  Maximum: <code>2147483647</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    storageCapacityReservationGiB?: Value<number>;
    /** <code>RecordSizeKiB</code>  <a name="cfn-fsx-volume-openzfsconfiguration-recordsizekib"></a>
  Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). 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 <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance"> ZFS Record size</a> in the
  Amazon FSx for OpenZFS User Guide: br />
  
  Required: No<br />
  
  Minimum: <code>4</code><br />
  
  Maximum: <code>1024</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    recordSizeKiB?: Value<number>;
    /** <code>OriginSnapshot</code>  <a name="cfn-fsx-volume-openzfsconfiguration-originsnapshot"></a>
  The configuration object that specifies the snapshot to use as the origin of the data for the volume.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">Replacement</a> */
    originSnapshot?: OriginSnapshotProps;
    /** <code>UserAndGroupQuotas</code>  <a name="cfn-fsx-volume-openzfsconfiguration-userandgroupquotas"></a>
  An object specifying how much storage users or groups can use on the volume.<br />
  
  Required: No<br />
  
  Maximum: <code>500</code><br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    userAndGroupQuotas?: UserAndGroupQuotasProps[];
}
