amazonka-fsx-2.0: Amazon FSx SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FSx.Lens

Contents

Description

 
Synopsis

Operations

AssociateFileSystemAliases

associateFileSystemAliases_clientRequestToken :: Lens' AssociateFileSystemAliases (Maybe Text) Source #

Undocumented member.

associateFileSystemAliases_fileSystemId :: Lens' AssociateFileSystemAliases Text Source #

Specifies the file system with which you want to associate one or more DNS aliases.

associateFileSystemAliases_aliases :: Lens' AssociateFileSystemAliases [Text] Source #

An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.
  • Can contain alphanumeric characters and the hyphen (-).
  • Cannot start or end with a hyphen.
  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

associateFileSystemAliasesResponse_aliases :: Lens' AssociateFileSystemAliasesResponse (Maybe [Alias]) Source #

An array of the DNS aliases that Amazon FSx is associating with the file system.

associateFileSystemAliasesResponse_httpStatus :: Lens' AssociateFileSystemAliasesResponse Int Source #

The response's http status code.

CancelDataRepositoryTask

cancelDataRepositoryTask_taskId :: Lens' CancelDataRepositoryTask Text Source #

Specifies the data repository task to cancel.

cancelDataRepositoryTaskResponse_lifecycle :: Lens' CancelDataRepositoryTaskResponse (Maybe DataRepositoryTaskLifecycle) Source #

The lifecycle status of the data repository task, as follows:

  • PENDING - Amazon FSx has not started the task.
  • EXECUTING - Amazon FSx is processing the task.
  • FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
  • SUCCEEDED - FSx completed the task successfully.
  • CANCELED - Amazon FSx canceled the task and it did not complete.
  • CANCELING - FSx is in process of canceling the task.

cancelDataRepositoryTaskResponse_taskId :: Lens' CancelDataRepositoryTaskResponse (Maybe Text) Source #

The ID of the task being canceled.

cancelDataRepositoryTaskResponse_httpStatus :: Lens' CancelDataRepositoryTaskResponse Int Source #

The response's http status code.

CopyBackup

copyBackup_clientRequestToken :: Lens' CopyBackup (Maybe Text) Source #

Undocumented member.

copyBackup_copyTags :: Lens' CopyBackup (Maybe Bool) Source #

A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

copyBackup_kmsKeyId :: Lens' CopyBackup (Maybe Text) Source #

Undocumented member.

copyBackup_sourceRegion :: Lens' CopyBackup (Maybe Text) Source #

The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

copyBackup_tags :: Lens' CopyBackup (Maybe (NonEmpty Tag)) Source #

Undocumented member.

copyBackup_sourceBackupId :: Lens' CopyBackup Text Source #

The ID of the source backup. Specifies the ID of the backup that's being copied.

copyBackupResponse_backup :: Lens' CopyBackupResponse (Maybe Backup) Source #

Undocumented member.

copyBackupResponse_httpStatus :: Lens' CopyBackupResponse Int Source #

The response's http status code.

CreateBackup

createBackup_clientRequestToken :: Lens' CreateBackup (Maybe Text) Source #

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

createBackup_fileSystemId :: Lens' CreateBackup (Maybe Text) Source #

The ID of the file system to back up.

createBackup_tags :: Lens' CreateBackup (Maybe (NonEmpty Tag)) Source #

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

createBackup_volumeId :: Lens' CreateBackup (Maybe Text) Source #

(Optional) The ID of the FSx for ONTAP volume to back up.

createBackupResponse_backup :: Lens' CreateBackupResponse (Maybe Backup) Source #

A description of the backup.

createBackupResponse_httpStatus :: Lens' CreateBackupResponse Int Source #

The response's http status code.

CreateDataRepositoryAssociation

createDataRepositoryAssociation_batchImportMetaDataOnCreate :: Lens' CreateDataRepositoryAssociation (Maybe Bool) Source #

Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.

createDataRepositoryAssociation_clientRequestToken :: Lens' CreateDataRepositoryAssociation (Maybe Text) Source #

Undocumented member.

createDataRepositoryAssociation_fileSystemPath :: Lens' CreateDataRepositoryAssociation (Maybe Text) Source #

A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

createDataRepositoryAssociation_importedFileChunkSize :: Lens' CreateDataRepositoryAssociation (Maybe Natural) Source #

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

createDataRepositoryAssociation_s3 :: Lens' CreateDataRepositoryAssociation (Maybe S3DataRepositoryConfiguration) Source #

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

createDataRepositoryAssociation_tags :: Lens' CreateDataRepositoryAssociation (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createDataRepositoryAssociation_fileSystemId :: Lens' CreateDataRepositoryAssociation Text Source #

Undocumented member.

createDataRepositoryAssociation_dataRepositoryPath :: Lens' CreateDataRepositoryAssociation Text Source #

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

createDataRepositoryAssociationResponse_association :: Lens' CreateDataRepositoryAssociationResponse (Maybe DataRepositoryAssociation) Source #

The response object returned after the data repository association is created.

createDataRepositoryAssociationResponse_httpStatus :: Lens' CreateDataRepositoryAssociationResponse Int Source #

The response's http status code.

CreateDataRepositoryTask

createDataRepositoryTask_capacityToRelease :: Lens' CreateDataRepositoryTask (Maybe Natural) Source #

Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

createDataRepositoryTask_clientRequestToken :: Lens' CreateDataRepositoryTask (Maybe Text) Source #

Undocumented member.

createDataRepositoryTask_paths :: Lens' CreateDataRepositoryTask (Maybe [Text]) Source #

A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails.

  • For export tasks, the list contains paths on the Amazon FSx file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.
  • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the Amazon FSx file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

createDataRepositoryTask_tags :: Lens' CreateDataRepositoryTask (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createDataRepositoryTask_type :: Lens' CreateDataRepositoryTask DataRepositoryTaskType Source #

Specifies the type of data repository task to create.

createDataRepositoryTask_fileSystemId :: Lens' CreateDataRepositoryTask Text Source #

Undocumented member.

createDataRepositoryTask_report :: Lens' CreateDataRepositoryTask CompletionReport Source #

Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.

createDataRepositoryTaskResponse_dataRepositoryTask :: Lens' CreateDataRepositoryTaskResponse (Maybe DataRepositoryTask) Source #

The description of the data repository task that you just created.

createDataRepositoryTaskResponse_httpStatus :: Lens' CreateDataRepositoryTaskResponse Int Source #

The response's http status code.

CreateFileCache

createFileCache_clientRequestToken :: Lens' CreateFileCache (Maybe Text) Source #

An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

createFileCache_copyTagsToDataRepositoryAssociations :: Lens' CreateFileCache (Maybe Bool) Source #

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

createFileCache_dataRepositoryAssociations :: Lens' CreateFileCache (Maybe [FileCacheDataRepositoryAssociation]) Source #

A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA configurations must meet the following requirements:

  • All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
  • An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

DRA automatic import and automatic export is not supported.

createFileCache_kmsKeyId :: Lens' CreateFileCache (Maybe Text) Source #

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

createFileCache_lustreConfiguration :: Lens' CreateFileCache (Maybe CreateFileCacheLustreConfiguration) Source #

The configuration for the Amazon File Cache resource being created.

createFileCache_securityGroupIds :: Lens' CreateFileCache (Maybe [Text]) Source #

A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.

createFileCache_tags :: Lens' CreateFileCache (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createFileCache_fileCacheType :: Lens' CreateFileCache FileCacheType Source #

The type of cache that you're creating, which must be LUSTRE.

createFileCache_fileCacheTypeVersion :: Lens' CreateFileCache Text Source #

Sets the Lustre version for the cache that you're creating, which must be 2.12.

createFileCache_storageCapacity :: Lens' CreateFileCache Natural Source #

The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

createFileCache_subnetIds :: Lens' CreateFileCache [Text] Source #

Undocumented member.

createFileCacheResponse_fileCache :: Lens' CreateFileCacheResponse (Maybe FileCacheCreating) Source #

A description of the cache that was created.

createFileCacheResponse_httpStatus :: Lens' CreateFileCacheResponse Int Source #

The response's http status code.

CreateFileSystem

createFileSystem_clientRequestToken :: Lens' CreateFileSystem (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

createFileSystem_fileSystemTypeVersion :: Lens' CreateFileSystem (Maybe Text) Source #

(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10 and 2.12:

  • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
  • 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.

Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.

If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

createFileSystem_kmsKeyId :: Lens' CreateFileSystem (Maybe Text) Source #

Undocumented member.

createFileSystem_lustreConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemLustreConfiguration) Source #

Undocumented member.

createFileSystem_ontapConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemOntapConfiguration) Source #

Undocumented member.

createFileSystem_openZFSConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemOpenZFSConfiguration) Source #

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

createFileSystem_securityGroupIds :: Lens' CreateFileSystem (Maybe [Text]) Source #

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

createFileSystem_storageType :: Lens' CreateFileSystem (Maybe StorageType) Source #

Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
  • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.

Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.

createFileSystem_tags :: Lens' CreateFileSystem (Maybe (NonEmpty Tag)) Source #

The tags to apply to the file system that's being created. The key value of the Name tag appears in the console as the file system name.

createFileSystem_windowsConfiguration :: Lens' CreateFileSystem (Maybe CreateFileSystemWindowsConfiguration) Source #

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

createFileSystem_fileSystemType :: Lens' CreateFileSystem FileSystemType Source #

The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.

createFileSystem_storageCapacity :: Lens' CreateFileSystem Natural Source #

Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).

FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:

  • For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
  • For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
  • For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).

FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:

  • For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
  • For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

createFileSystem_subnetIds :: Lens' CreateFileSystem [Text] Source #

Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.

For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

createFileSystemResponse_fileSystem :: Lens' CreateFileSystemResponse (Maybe FileSystem) Source #

The configuration of the file system that was created.

createFileSystemResponse_httpStatus :: Lens' CreateFileSystemResponse Int Source #

The response's http status code.

CreateFileSystemFromBackup

createFileSystemFromBackup_clientRequestToken :: Lens' CreateFileSystemFromBackup (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

createFileSystemFromBackup_fileSystemTypeVersion :: Lens' CreateFileSystemFromBackup (Maybe Text) Source #

Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10 and 2.12.

You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

createFileSystemFromBackup_kmsKeyId :: Lens' CreateFileSystemFromBackup (Maybe Text) Source #

Undocumented member.

createFileSystemFromBackup_lustreConfiguration :: Lens' CreateFileSystemFromBackup (Maybe CreateFileSystemLustreConfiguration) Source #

Undocumented member.

createFileSystemFromBackup_openZFSConfiguration :: Lens' CreateFileSystemFromBackup (Maybe CreateFileSystemOpenZFSConfiguration) Source #

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

createFileSystemFromBackup_securityGroupIds :: Lens' CreateFileSystemFromBackup (Maybe [Text]) Source #

A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.

createFileSystemFromBackup_storageCapacity :: Lens' CreateFileSystemFromBackup (Maybe Natural) Source #

Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with a 400 Bad Request.

createFileSystemFromBackup_storageType :: Lens' CreateFileSystemFromBackup (Maybe StorageType) Source #

Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
  • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

The default value is SSD.

HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.

createFileSystemFromBackup_tags :: Lens' CreateFileSystemFromBackup (Maybe (NonEmpty Tag)) Source #

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

createFileSystemFromBackup_windowsConfiguration :: Lens' CreateFileSystemFromBackup (Maybe CreateFileSystemWindowsConfiguration) Source #

The configuration for this Microsoft Windows file system.

createFileSystemFromBackup_backupId :: Lens' CreateFileSystemFromBackup Text Source #

Undocumented member.

createFileSystemFromBackup_subnetIds :: Lens' CreateFileSystemFromBackup [Text] Source #

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

createFileSystemFromBackupResponse_fileSystem :: Lens' CreateFileSystemFromBackupResponse (Maybe FileSystem) Source #

A description of the file system.

createFileSystemFromBackupResponse_httpStatus :: Lens' CreateFileSystemFromBackupResponse Int Source #

The response's http status code.

CreateSnapshot

createSnapshot_clientRequestToken :: Lens' CreateSnapshot (Maybe Text) Source #

Undocumented member.

createSnapshot_tags :: Lens' CreateSnapshot (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createSnapshot_name :: Lens' CreateSnapshot Text Source #

The name of the snapshot.

createSnapshot_volumeId :: Lens' CreateSnapshot Text Source #

The ID of the volume that you are taking a snapshot of.

createSnapshotResponse_snapshot :: Lens' CreateSnapshotResponse (Maybe Snapshot) Source #

A description of the snapshot.

createSnapshotResponse_httpStatus :: Lens' CreateSnapshotResponse Int Source #

The response's http status code.

CreateStorageVirtualMachine

createStorageVirtualMachine_activeDirectoryConfiguration :: Lens' CreateStorageVirtualMachine (Maybe CreateSvmActiveDirectoryConfiguration) Source #

Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.

createStorageVirtualMachine_clientRequestToken :: Lens' CreateStorageVirtualMachine (Maybe Text) Source #

Undocumented member.

createStorageVirtualMachine_rootVolumeSecurityStyle :: Lens' CreateStorageVirtualMachine (Maybe StorageVirtualMachineRootVolumeSecurityStyle) Source #

The security style of the root volume of the SVM. Specify one of the following values:

  • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
  • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
  • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

createStorageVirtualMachine_svmAdminPassword :: Lens' CreateStorageVirtualMachine (Maybe Text) Source #

The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.

createStorageVirtualMachine_tags :: Lens' CreateStorageVirtualMachine (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createStorageVirtualMachine_fileSystemId :: Lens' CreateStorageVirtualMachine Text Source #

Undocumented member.

createStorageVirtualMachine_name :: Lens' CreateStorageVirtualMachine Text Source #

The name of the SVM.

createStorageVirtualMachineResponse_storageVirtualMachine :: Lens' CreateStorageVirtualMachineResponse (Maybe StorageVirtualMachine) Source #

Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.

createStorageVirtualMachineResponse_httpStatus :: Lens' CreateStorageVirtualMachineResponse Int Source #

The response's http status code.

CreateVolume

createVolume_clientRequestToken :: Lens' CreateVolume (Maybe Text) Source #

Undocumented member.

createVolume_ontapConfiguration :: Lens' CreateVolume (Maybe CreateOntapVolumeConfiguration) Source #

Specifies the configuration to use when creating the ONTAP volume.

createVolume_openZFSConfiguration :: Lens' CreateVolume (Maybe CreateOpenZFSVolumeConfiguration) Source #

Specifies the configuration to use when creating the OpenZFS volume.

createVolume_tags :: Lens' CreateVolume (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createVolume_volumeType :: Lens' CreateVolume VolumeType Source #

Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume types.

createVolume_name :: Lens' CreateVolume Text Source #

Specifies the name of the volume that you're creating.

createVolumeResponse_volume :: Lens' CreateVolumeResponse (Maybe Volume) Source #

Returned after a successful CreateVolume API operation, describing the volume just created.

createVolumeResponse_httpStatus :: Lens' CreateVolumeResponse Int Source #

The response's http status code.

CreateVolumeFromBackup

createVolumeFromBackup_clientRequestToken :: Lens' CreateVolumeFromBackup (Maybe Text) Source #

Undocumented member.

createVolumeFromBackup_ontapConfiguration :: Lens' CreateVolumeFromBackup (Maybe CreateOntapVolumeConfiguration) Source #

Specifies the configuration of the ONTAP volume that you are creating.

createVolumeFromBackup_tags :: Lens' CreateVolumeFromBackup (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createVolumeFromBackup_backupId :: Lens' CreateVolumeFromBackup Text Source #

Undocumented member.

createVolumeFromBackup_name :: Lens' CreateVolumeFromBackup Text Source #

The name of the new volume you're creating.

createVolumeFromBackupResponse_volume :: Lens' CreateVolumeFromBackupResponse (Maybe Volume) Source #

Returned after a successful CreateVolumeFromBackup API operation, describing the volume just created.

createVolumeFromBackupResponse_httpStatus :: Lens' CreateVolumeFromBackupResponse Int Source #

The response's http status code.

DeleteBackup

deleteBackup_clientRequestToken :: Lens' DeleteBackup (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.

deleteBackup_backupId :: Lens' DeleteBackup Text Source #

The ID of the backup that you want to delete.

deleteBackupResponse_backupId :: Lens' DeleteBackupResponse (Maybe Text) Source #

The ID of the backup that was deleted.

deleteBackupResponse_lifecycle :: Lens' DeleteBackupResponse (Maybe BackupLifecycle) Source #

The lifecycle status of the backup. If the DeleteBackup operation is successful, the status is DELETED.

deleteBackupResponse_httpStatus :: Lens' DeleteBackupResponse Int Source #

The response's http status code.

DeleteDataRepositoryAssociation

deleteDataRepositoryAssociation_clientRequestToken :: Lens' DeleteDataRepositoryAssociation (Maybe Text) Source #

Undocumented member.

deleteDataRepositoryAssociation_deleteDataInFileSystem :: Lens' DeleteDataRepositoryAssociation (Maybe Bool) Source #

Set to true to delete the data in the file system that corresponds to the data repository association.

deleteDataRepositoryAssociation_associationId :: Lens' DeleteDataRepositoryAssociation Text Source #

The ID of the data repository association that you want to delete.

deleteDataRepositoryAssociationResponse_associationId :: Lens' DeleteDataRepositoryAssociationResponse (Maybe Text) Source #

The ID of the data repository association being deleted.

deleteDataRepositoryAssociationResponse_deleteDataInFileSystem :: Lens' DeleteDataRepositoryAssociationResponse (Maybe Bool) Source #

Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is false.

deleteDataRepositoryAssociationResponse_lifecycle :: Lens' DeleteDataRepositoryAssociationResponse (Maybe DataRepositoryLifecycle) Source #

Describes the lifecycle state of the data repository association being deleted.

deleteDataRepositoryAssociationResponse_httpStatus :: Lens' DeleteDataRepositoryAssociationResponse Int Source #

The response's http status code.

DeleteFileCache

deleteFileCache_clientRequestToken :: Lens' DeleteFileCache (Maybe Text) Source #

Undocumented member.

deleteFileCache_fileCacheId :: Lens' DeleteFileCache Text Source #

The ID of the cache that's being deleted.

deleteFileCacheResponse_fileCacheId :: Lens' DeleteFileCacheResponse (Maybe Text) Source #

The ID of the cache that's being deleted.

deleteFileCacheResponse_lifecycle :: Lens' DeleteFileCacheResponse (Maybe FileCacheLifecycle) Source #

The cache lifecycle for the deletion request. If the DeleteFileCache operation is successful, this status is DELETING.

deleteFileCacheResponse_httpStatus :: Lens' DeleteFileCacheResponse Int Source #

The response's http status code.

DeleteFileSystem

deleteFileSystem_clientRequestToken :: Lens' DeleteFileSystem (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.

deleteFileSystem_lustreConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemLustreConfiguration) Source #

Undocumented member.

deleteFileSystem_openZFSConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemOpenZFSConfiguration) Source #

The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.

deleteFileSystem_windowsConfiguration :: Lens' DeleteFileSystem (Maybe DeleteFileSystemWindowsConfiguration) Source #

Undocumented member.

deleteFileSystem_fileSystemId :: Lens' DeleteFileSystem Text Source #

The ID of the file system that you want to delete.

deleteFileSystemResponse_fileSystemId :: Lens' DeleteFileSystemResponse (Maybe Text) Source #

The ID of the file system that's being deleted.

deleteFileSystemResponse_lifecycle :: Lens' DeleteFileSystemResponse (Maybe FileSystemLifecycle) Source #

The file system lifecycle for the deletion request. If the DeleteFileSystem operation is successful, this status is DELETING.

deleteFileSystemResponse_lustreResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemLustreResponse) Source #

Undocumented member.

deleteFileSystemResponse_openZFSResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemOpenZFSResponse) Source #

The response object for the OpenZFS file system that's being deleted in the DeleteFileSystem operation.

deleteFileSystemResponse_windowsResponse :: Lens' DeleteFileSystemResponse (Maybe DeleteFileSystemWindowsResponse) Source #

Undocumented member.

deleteFileSystemResponse_httpStatus :: Lens' DeleteFileSystemResponse Int Source #

The response's http status code.

DeleteSnapshot

deleteSnapshot_clientRequestToken :: Lens' DeleteSnapshot (Maybe Text) Source #

Undocumented member.

deleteSnapshot_snapshotId :: Lens' DeleteSnapshot Text Source #

The ID of the snapshot that you want to delete.

deleteSnapshotResponse_lifecycle :: Lens' DeleteSnapshotResponse (Maybe SnapshotLifecycle) Source #

The lifecycle status of the snapshot. If the DeleteSnapshot operation is successful, this status is DELETING.

deleteSnapshotResponse_snapshotId :: Lens' DeleteSnapshotResponse (Maybe Text) Source #

The ID of the deleted snapshot.

deleteSnapshotResponse_httpStatus :: Lens' DeleteSnapshotResponse Int Source #

The response's http status code.

DeleteStorageVirtualMachine

deleteStorageVirtualMachine_clientRequestToken :: Lens' DeleteStorageVirtualMachine (Maybe Text) Source #

Undocumented member.

deleteStorageVirtualMachine_storageVirtualMachineId :: Lens' DeleteStorageVirtualMachine Text Source #

The ID of the SVM that you want to delete.

deleteStorageVirtualMachineResponse_lifecycle :: Lens' DeleteStorageVirtualMachineResponse (Maybe StorageVirtualMachineLifecycle) Source #

Describes the lifecycle state of the SVM being deleted.

deleteStorageVirtualMachineResponse_storageVirtualMachineId :: Lens' DeleteStorageVirtualMachineResponse (Maybe Text) Source #

The ID of the SVM Amazon FSx is deleting.

deleteStorageVirtualMachineResponse_httpStatus :: Lens' DeleteStorageVirtualMachineResponse Int Source #

The response's http status code.

DeleteVolume

deleteVolume_clientRequestToken :: Lens' DeleteVolume (Maybe Text) Source #

Undocumented member.

deleteVolume_ontapConfiguration :: Lens' DeleteVolume (Maybe DeleteVolumeOntapConfiguration) Source #

For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.

deleteVolume_openZFSConfiguration :: Lens' DeleteVolume (Maybe DeleteVolumeOpenZFSConfiguration) Source #

For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.

deleteVolume_volumeId :: Lens' DeleteVolume Text Source #

The ID of the volume that you are deleting.

deleteVolumeResponse_lifecycle :: Lens' DeleteVolumeResponse (Maybe VolumeLifecycle) Source #

The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.

deleteVolumeResponse_ontapResponse :: Lens' DeleteVolumeResponse (Maybe DeleteVolumeOntapResponse) Source #

Returned after a DeleteVolume request, showing the status of the delete request.

deleteVolumeResponse_volumeId :: Lens' DeleteVolumeResponse (Maybe Text) Source #

The ID of the volume that's being deleted.

deleteVolumeResponse_httpStatus :: Lens' DeleteVolumeResponse Int Source #

The response's http status code.

DescribeBackups

describeBackups_backupIds :: Lens' DescribeBackups (Maybe [Text]) Source #

The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.

describeBackups_filters :: Lens' DescribeBackups (Maybe [Filter]) Source #

The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.

describeBackups_maxResults :: Lens' DescribeBackups (Maybe Natural) Source #

Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text) Source #

An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.

describeBackupsResponse_backups :: Lens' DescribeBackupsResponse (Maybe [Backup]) Source #

An array of backups.

describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (Maybe Text) Source #

A NextToken value is present if there are more backups than returned in the response. You can use the NextToken value in the subsequent request to fetch the backups.

describeBackupsResponse_httpStatus :: Lens' DescribeBackupsResponse Int Source #

The response's http status code.

DescribeDataRepositoryAssociations

describeDataRepositoryAssociations_associationIds :: Lens' DescribeDataRepositoryAssociations (Maybe [Text]) Source #

IDs of the data repository associations whose descriptions you want to retrieve (String).

describeDataRepositoryAssociations_filters :: Lens' DescribeDataRepositoryAssociations (Maybe [Filter]) Source #

Undocumented member.

describeDataRepositoryAssociations_maxResults :: Lens' DescribeDataRepositoryAssociations (Maybe Natural) Source #

The maximum number of resources to return in the response. This value must be an integer greater than zero.

describeDataRepositoryAssociations_nextToken :: Lens' DescribeDataRepositoryAssociations (Maybe Text) Source #

Undocumented member.

describeDataRepositoryAssociationsResponse_associations :: Lens' DescribeDataRepositoryAssociationsResponse (Maybe [DataRepositoryAssociation]) Source #

An array of one or more data repository association descriptions.

describeDataRepositoryAssociationsResponse_nextToken :: Lens' DescribeDataRepositoryAssociationsResponse (Maybe Text) Source #

Undocumented member.

describeDataRepositoryAssociationsResponse_httpStatus :: Lens' DescribeDataRepositoryAssociationsResponse Int Source #

The response's http status code.

DescribeDataRepositoryTasks

describeDataRepositoryTasks_filters :: Lens' DescribeDataRepositoryTasks (Maybe [DataRepositoryTaskFilter]) Source #

(Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.

describeDataRepositoryTasks_maxResults :: Lens' DescribeDataRepositoryTasks (Maybe Natural) Source #

Undocumented member.

describeDataRepositoryTasks_nextToken :: Lens' DescribeDataRepositoryTasks (Maybe Text) Source #

Undocumented member.

describeDataRepositoryTasks_taskIds :: Lens' DescribeDataRepositoryTasks (Maybe [Text]) Source #

(Optional) IDs of the tasks whose descriptions you want to retrieve (String).

describeDataRepositoryTasksResponse_dataRepositoryTasks :: Lens' DescribeDataRepositoryTasksResponse (Maybe [DataRepositoryTask]) Source #

The collection of data repository task descriptions returned.

describeDataRepositoryTasksResponse_nextToken :: Lens' DescribeDataRepositoryTasksResponse (Maybe Text) Source #

Undocumented member.

describeDataRepositoryTasksResponse_httpStatus :: Lens' DescribeDataRepositoryTasksResponse Int Source #

The response's http status code.

DescribeFileCaches

describeFileCaches_fileCacheIds :: Lens' DescribeFileCaches (Maybe [Text]) Source #

IDs of the caches whose descriptions you want to retrieve (String).

describeFileCaches_maxResults :: Lens' DescribeFileCaches (Maybe Natural) Source #

Undocumented member.

describeFileCaches_nextToken :: Lens' DescribeFileCaches (Maybe Text) Source #

Undocumented member.

describeFileCachesResponse_fileCaches :: Lens' DescribeFileCachesResponse (Maybe [FileCache]) Source #

The response object for the DescribeFileCaches operation.

describeFileCachesResponse_nextToken :: Lens' DescribeFileCachesResponse (Maybe Text) Source #

Undocumented member.

describeFileCachesResponse_httpStatus :: Lens' DescribeFileCachesResponse Int Source #

The response's http status code.

DescribeFileSystemAliases

describeFileSystemAliases_clientRequestToken :: Lens' DescribeFileSystemAliases (Maybe Text) Source #

Undocumented member.

describeFileSystemAliases_maxResults :: Lens' DescribeFileSystemAliases (Maybe Natural) Source #

Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

describeFileSystemAliases_nextToken :: Lens' DescribeFileSystemAliases (Maybe Text) Source #

Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.

describeFileSystemAliases_fileSystemId :: Lens' DescribeFileSystemAliases Text Source #

The ID of the file system to return the associated DNS aliases for (String).

describeFileSystemAliasesResponse_aliases :: Lens' DescribeFileSystemAliasesResponse (Maybe [Alias]) Source #

An array of one or more DNS aliases currently associated with the specified file system.

describeFileSystemAliasesResponse_nextToken :: Lens' DescribeFileSystemAliasesResponse (Maybe Text) Source #

Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.

describeFileSystemAliasesResponse_httpStatus :: Lens' DescribeFileSystemAliasesResponse Int Source #

The response's http status code.

DescribeFileSystems

describeFileSystems_fileSystemIds :: Lens' DescribeFileSystems (Maybe [Text]) Source #

IDs of the file systems whose descriptions you want to retrieve (String).

describeFileSystems_maxResults :: Lens' DescribeFileSystems (Maybe Natural) Source #

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

describeFileSystems_nextToken :: Lens' DescribeFileSystems (Maybe Text) Source #

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

describeFileSystemsResponse_fileSystems :: Lens' DescribeFileSystemsResponse (Maybe [FileSystem]) Source #

An array of file system descriptions.

describeFileSystemsResponse_nextToken :: Lens' DescribeFileSystemsResponse (Maybe Text) Source #

Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

describeFileSystemsResponse_httpStatus :: Lens' DescribeFileSystemsResponse Int Source #

The response's http status code.

DescribeSnapshots

describeSnapshots_filters :: Lens' DescribeSnapshots (Maybe [SnapshotFilter]) Source #

The filters structure. The supported names are file-system-id or volume-id.

describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Natural) Source #

Undocumented member.

describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text) Source #

Undocumented member.

describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #

Undocumented member.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #

An array of snapshots.

describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int Source #

The response's http status code.

DescribeStorageVirtualMachines

describeStorageVirtualMachines_filters :: Lens' DescribeStorageVirtualMachines (Maybe [StorageVirtualMachineFilter]) Source #

Enter a filter name:value pair to view a select set of SVMs.

describeStorageVirtualMachines_maxResults :: Lens' DescribeStorageVirtualMachines (Maybe Natural) Source #

Undocumented member.

describeStorageVirtualMachines_nextToken :: Lens' DescribeStorageVirtualMachines (Maybe Text) Source #

Undocumented member.

describeStorageVirtualMachines_storageVirtualMachineIds :: Lens' DescribeStorageVirtualMachines (Maybe [Text]) Source #

Enter the ID of one or more SVMs that you want to view.

describeStorageVirtualMachinesResponse_nextToken :: Lens' DescribeStorageVirtualMachinesResponse (Maybe Text) Source #

Undocumented member.

describeStorageVirtualMachinesResponse_storageVirtualMachines :: Lens' DescribeStorageVirtualMachinesResponse (Maybe [StorageVirtualMachine]) Source #

Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.

describeStorageVirtualMachinesResponse_httpStatus :: Lens' DescribeStorageVirtualMachinesResponse Int Source #

The response's http status code.

DescribeVolumes

describeVolumes_filters :: Lens' DescribeVolumes (Maybe [VolumeFilter]) Source #

Enter a filter Name and Values pair to view a select set of volumes.

describeVolumes_maxResults :: Lens' DescribeVolumes (Maybe Natural) Source #

Undocumented member.

describeVolumes_nextToken :: Lens' DescribeVolumes (Maybe Text) Source #

Undocumented member.

describeVolumes_volumeIds :: Lens' DescribeVolumes (Maybe [Text]) Source #

The IDs of the volumes whose descriptions you want to retrieve.

describeVolumesResponse_nextToken :: Lens' DescribeVolumesResponse (Maybe Text) Source #

Undocumented member.

describeVolumesResponse_volumes :: Lens' DescribeVolumesResponse (Maybe [Volume]) Source #

Returned after a successful DescribeVolumes operation, describing each volume.

describeVolumesResponse_httpStatus :: Lens' DescribeVolumesResponse Int Source #

The response's http status code.

DisassociateFileSystemAliases

disassociateFileSystemAliases_clientRequestToken :: Lens' DisassociateFileSystemAliases (Maybe Text) Source #

Undocumented member.

disassociateFileSystemAliases_fileSystemId :: Lens' DisassociateFileSystemAliases Text Source #

Specifies the file system from which to disassociate the DNS aliases.

disassociateFileSystemAliases_aliases :: Lens' DisassociateFileSystemAliases [Text] Source #

An array of one or more DNS alias names to disassociate, or remove, from the file system.

disassociateFileSystemAliasesResponse_aliases :: Lens' DisassociateFileSystemAliasesResponse (Maybe [Alias]) Source #

An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.

disassociateFileSystemAliasesResponse_httpStatus :: Lens' DisassociateFileSystemAliasesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #

Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The ARN of the Amazon FSx resource that will have its tags listed.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

A list of tags on the resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ReleaseFileSystemNfsV3Locks

releaseFileSystemNfsV3Locks_clientRequestToken :: Lens' ReleaseFileSystemNfsV3Locks (Maybe Text) Source #

Undocumented member.

releaseFileSystemNfsV3Locks_fileSystemId :: Lens' ReleaseFileSystemNfsV3Locks Text Source #

Undocumented member.

releaseFileSystemNfsV3LocksResponse_fileSystem :: Lens' ReleaseFileSystemNfsV3LocksResponse (Maybe FileSystem) Source #

Undocumented member.

releaseFileSystemNfsV3LocksResponse_httpStatus :: Lens' ReleaseFileSystemNfsV3LocksResponse Int Source #

The response's http status code.

RestoreVolumeFromSnapshot

restoreVolumeFromSnapshot_clientRequestToken :: Lens' RestoreVolumeFromSnapshot (Maybe Text) Source #

Undocumented member.

restoreVolumeFromSnapshot_options :: Lens' RestoreVolumeFromSnapshot (Maybe [RestoreOpenZFSVolumeOption]) Source #

The settings used when restoring the specified volume from snapshot.

  • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.
  • DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

restoreVolumeFromSnapshot_volumeId :: Lens' RestoreVolumeFromSnapshot Text Source #

The ID of the volume that you are restoring.

restoreVolumeFromSnapshot_snapshotId :: Lens' RestoreVolumeFromSnapshot Text Source #

The ID of the source snapshot. Specifies the snapshot that you are restoring from.

restoreVolumeFromSnapshotResponse_administrativeActions :: Lens' RestoreVolumeFromSnapshotResponse (Maybe [AdministrativeAction]) Source #

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

restoreVolumeFromSnapshotResponse_lifecycle :: Lens' RestoreVolumeFromSnapshotResponse (Maybe VolumeLifecycle) Source #

The lifecycle state of the volume being restored.

restoreVolumeFromSnapshotResponse_volumeId :: Lens' RestoreVolumeFromSnapshotResponse (Maybe Text) Source #

The ID of the volume that you restored.

restoreVolumeFromSnapshotResponse_httpStatus :: Lens' RestoreVolumeFromSnapshotResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The ARN of the Amazon FSx resource to untag.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateDataRepositoryAssociation

updateDataRepositoryAssociation_clientRequestToken :: Lens' UpdateDataRepositoryAssociation (Maybe Text) Source #

Undocumented member.

updateDataRepositoryAssociation_importedFileChunkSize :: Lens' UpdateDataRepositoryAssociation (Maybe Natural) Source #

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

updateDataRepositoryAssociation_s3 :: Lens' UpdateDataRepositoryAssociation (Maybe S3DataRepositoryConfiguration) Source #

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

updateDataRepositoryAssociation_associationId :: Lens' UpdateDataRepositoryAssociation Text Source #

The ID of the data repository association that you are updating.

updateDataRepositoryAssociationResponse_association :: Lens' UpdateDataRepositoryAssociationResponse (Maybe DataRepositoryAssociation) Source #

The response object returned after the data repository association is updated.

updateDataRepositoryAssociationResponse_httpStatus :: Lens' UpdateDataRepositoryAssociationResponse Int Source #

The response's http status code.

UpdateFileCache

updateFileCache_clientRequestToken :: Lens' UpdateFileCache (Maybe Text) Source #

Undocumented member.

updateFileCache_lustreConfiguration :: Lens' UpdateFileCache (Maybe UpdateFileCacheLustreConfiguration) Source #

The configuration updates for an Amazon File Cache resource.

updateFileCache_fileCacheId :: Lens' UpdateFileCache Text Source #

The ID of the cache that you are updating.

updateFileCacheResponse_fileCache :: Lens' UpdateFileCacheResponse (Maybe FileCache) Source #

A description of the cache that was updated.

updateFileCacheResponse_httpStatus :: Lens' UpdateFileCacheResponse Int Source #

The response's http status code.

UpdateFileSystem

updateFileSystem_clientRequestToken :: Lens' UpdateFileSystem (Maybe Text) Source #

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

updateFileSystem_lustreConfiguration :: Lens' UpdateFileSystem (Maybe UpdateFileSystemLustreConfiguration) Source #

Undocumented member.

updateFileSystem_ontapConfiguration :: Lens' UpdateFileSystem (Maybe UpdateFileSystemOntapConfiguration) Source #

Undocumented member.

updateFileSystem_openZFSConfiguration :: Lens' UpdateFileSystem (Maybe UpdateFileSystemOpenZFSConfiguration) Source #

The configuration updates for an Amazon FSx for OpenZFS file system.

updateFileSystem_storageCapacity :: Lens' UpdateFileSystem (Maybe Natural) Source #

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server, Amazon FSx for Lustre, or Amazon FSx for NetApp ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide.

For Lustre file systems, the storage capacity target value can be the following:

  • For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
  • For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.
  • For SCRATCH_1 file systems, you can't increase the storage capacity.

For more information, see Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

updateFileSystem_windowsConfiguration :: Lens' UpdateFileSystem (Maybe UpdateFileSystemWindowsConfiguration) Source #

The configuration updates for an Amazon FSx for Windows File Server file system.

updateFileSystem_fileSystemId :: Lens' UpdateFileSystem Text Source #

The ID of the file system that you are updating.

updateFileSystemResponse_fileSystem :: Lens' UpdateFileSystemResponse (Maybe FileSystem) Source #

A description of the file system that was updated.

updateFileSystemResponse_httpStatus :: Lens' UpdateFileSystemResponse Int Source #

The response's http status code.

UpdateSnapshot

updateSnapshot_clientRequestToken :: Lens' UpdateSnapshot (Maybe Text) Source #

Undocumented member.

updateSnapshot_name :: Lens' UpdateSnapshot Text Source #

The name of the snapshot to update.

updateSnapshot_snapshotId :: Lens' UpdateSnapshot Text Source #

The ID of the snapshot that you want to update, in the format fsvolsnap-0123456789abcdef0.

updateSnapshotResponse_snapshot :: Lens' UpdateSnapshotResponse (Maybe Snapshot) Source #

Returned after a successful UpdateSnapshot operation, describing the snapshot that you updated.

updateSnapshotResponse_httpStatus :: Lens' UpdateSnapshotResponse Int Source #

The response's http status code.

UpdateStorageVirtualMachine

updateStorageVirtualMachine_activeDirectoryConfiguration :: Lens' UpdateStorageVirtualMachine (Maybe UpdateSvmActiveDirectoryConfiguration) Source #

Updates the Microsoft Active Directory (AD) configuration for an SVM that is joined to an AD.

updateStorageVirtualMachine_clientRequestToken :: Lens' UpdateStorageVirtualMachine (Maybe Text) Source #

Undocumented member.

updateStorageVirtualMachine_svmAdminPassword :: Lens' UpdateStorageVirtualMachine (Maybe Text) Source #

Enter a new SvmAdminPassword if you are updating it.

updateStorageVirtualMachine_storageVirtualMachineId :: Lens' UpdateStorageVirtualMachine Text Source #

The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.

updateStorageVirtualMachineResponse_storageVirtualMachine :: Lens' UpdateStorageVirtualMachineResponse (Maybe StorageVirtualMachine) Source #

Undocumented member.

updateStorageVirtualMachineResponse_httpStatus :: Lens' UpdateStorageVirtualMachineResponse Int Source #

The response's http status code.

UpdateVolume

updateVolume_clientRequestToken :: Lens' UpdateVolume (Maybe Text) Source #

Undocumented member.

updateVolume_name :: Lens' UpdateVolume (Maybe Text) Source #

The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume.

updateVolume_ontapConfiguration :: Lens' UpdateVolume (Maybe UpdateOntapVolumeConfiguration) Source #

The configuration of the ONTAP volume that you are updating.

updateVolume_openZFSConfiguration :: Lens' UpdateVolume (Maybe UpdateOpenZFSVolumeConfiguration) Source #

The configuration of the OpenZFS volume that you are updating.

updateVolume_volumeId :: Lens' UpdateVolume Text Source #

The ID of the volume that you want to update, in the format fsvol-0123456789abcdef0.

updateVolumeResponse_volume :: Lens' UpdateVolumeResponse (Maybe Volume) Source #

A description of the volume just updated. Returned after a successful UpdateVolume API operation.

updateVolumeResponse_httpStatus :: Lens' UpdateVolumeResponse Int Source #

The response's http status code.

Types

ActiveDirectoryBackupAttributes

activeDirectoryBackupAttributes_activeDirectoryId :: Lens' ActiveDirectoryBackupAttributes (Maybe Text) Source #

The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.

activeDirectoryBackupAttributes_domainName :: Lens' ActiveDirectoryBackupAttributes (Maybe Text) Source #

The fully qualified domain name of the self-managed Active Directory directory.

activeDirectoryBackupAttributes_resourceARN :: Lens' ActiveDirectoryBackupAttributes (Maybe Text) Source #

Undocumented member.

AdministrativeAction

administrativeAction_administrativeActionType :: Lens' AdministrativeAction (Maybe AdministrativeActionType) Source #

Undocumented member.

administrativeAction_failureDetails :: Lens' AdministrativeAction (Maybe AdministrativeActionFailureDetails) Source #

Undocumented member.

administrativeAction_progressPercent :: Lens' AdministrativeAction (Maybe Natural) Source #

The percentage-complete status of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.

administrativeAction_requestTime :: Lens' AdministrativeAction (Maybe UTCTime) Source #

The time that the administrative action request was received.

administrativeAction_status :: Lens' AdministrativeAction (Maybe Status) Source #

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.
  • IN_PROGRESS - Amazon FSx is processing the administrative action.
  • PENDING - Amazon FSx is waiting to process the administrative action.
  • COMPLETED - Amazon FSx has finished processing the administrative task.
  • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

administrativeAction_targetFileSystemValues :: Lens' AdministrativeAction (Maybe FileSystem) Source #

Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

administrativeAction_targetSnapshotValues :: Lens' AdministrativeAction (Maybe Snapshot) Source #

Undocumented member.

administrativeAction_targetVolumeValues :: Lens' AdministrativeAction (Maybe Volume) Source #

Undocumented member.

AdministrativeActionFailureDetails

administrativeActionFailureDetails_message :: Lens' AdministrativeActionFailureDetails (Maybe Text) Source #

Error message providing details about the failed administrative action.

Alias

alias_lifecycle :: Lens' Alias (Maybe AliasLifecycle) Source #

Describes the state of the DNS alias.

  • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
  • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
  • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
  • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
  • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

alias_name :: Lens' Alias (Maybe Text) Source #

The name of the DNS alias. The alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.
  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
  • Cannot start or end with a hyphen.
  • Can start with a numeric.

For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

AutoExportPolicy

autoExportPolicy_events :: Lens' AutoExportPolicy (Maybe [EventType]) Source #

The AutoExportPolicy can have the following event values:

  • NEW - New files and directories are automatically exported to the data repository as they are added to the file system.
  • CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.
  • DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.

You can define any combination of event types for your AutoExportPolicy.

AutoImportPolicy

autoImportPolicy_events :: Lens' AutoImportPolicy (Maybe [EventType]) Source #

The AutoImportPolicy can have the following event values:

  • NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.
  • CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.
  • DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.

You can define any combination of event types for your AutoImportPolicy.

Backup

backup_directoryInformation :: Lens' Backup (Maybe ActiveDirectoryBackupAttributes) Source #

The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

backup_failureDetails :: Lens' Backup (Maybe BackupFailureDetails) Source #

Details explaining any failures that occurred when creating a backup.

backup_kmsKeyId :: Lens' Backup (Maybe Text) Source #

The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

backup_ownerId :: Lens' Backup (Maybe Text) Source #

Undocumented member.

backup_progressPercent :: Lens' Backup (Maybe Natural) Source #

Undocumented member.

backup_resourceARN :: Lens' Backup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the backup resource.

backup_resourceType :: Lens' Backup (Maybe ResourceType) Source #

Specifies the resource type that's backed up.

backup_sourceBackupId :: Lens' Backup (Maybe Text) Source #

Undocumented member.

backup_sourceBackupRegion :: Lens' Backup (Maybe Text) Source #

The source Region of the backup. Specifies the Region from where this backup is copied.

backup_tags :: Lens' Backup (Maybe (NonEmpty Tag)) Source #

The tags associated with a particular file system.

backup_volume :: Lens' Backup (Maybe Volume) Source #

Undocumented member.

backup_backupId :: Lens' Backup Text Source #

The ID of the backup.

backup_lifecycle :: Lens' Backup BackupLifecycle Source #

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.
  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
  • CREATING - Amazon FSx is creating the backup.
  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
  • COPYING - Amazon FSx is copying the backup.
  • DELETED - Amazon FSx deleted the backup and it's no longer available.
  • FAILED - Amazon FSx couldn't finish the backup.

backup_type :: Lens' Backup BackupType Source #

The type of the file-system backup.

backup_creationTime :: Lens' Backup UTCTime Source #

The time when a particular backup was created.

backup_fileSystem :: Lens' Backup FileSystem Source #

The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

BackupFailureDetails

backupFailureDetails_message :: Lens' BackupFailureDetails (Maybe Text) Source #

A message describing the backup-creation failure.

CompletionReport

completionReport_format :: Lens' CompletionReport (Maybe ReportFormat) Source #

Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.

completionReport_path :: Lens' CompletionReport (Maybe Text) Source #

Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's ExportPath, see .

completionReport_scope :: Lens' CompletionReport (Maybe ReportScope) Source #

Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

completionReport_enabled :: Lens' CompletionReport Bool Source #

Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.

CreateFileCacheLustreConfiguration

createFileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileCacheLustreConfiguration (Maybe Text) Source #

Undocumented member.

createFileCacheLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileCacheLustreConfiguration Natural Source #

Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.

createFileCacheLustreConfiguration_deploymentType :: Lens' CreateFileCacheLustreConfiguration FileCacheLustreDeploymentType Source #

Specifies the cache deployment type, which must be CACHE_1.

createFileCacheLustreConfiguration_metadataConfiguration :: Lens' CreateFileCacheLustreConfiguration FileCacheLustreMetadataConfiguration Source #

The configuration for a Lustre MDT (Metadata Target) storage volume.

CreateFileSystemLustreConfiguration

createFileSystemLustreConfiguration_autoImportPolicy :: Lens' CreateFileSystemLustreConfiguration (Maybe AutoImportPolicyType) Source #

(Optional) Available with Scratch and Persistent_1 deployment types. When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

For more information, see Automatically import updates from your S3 bucket.

This parameter is not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

createFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #

Undocumented member.

createFileSystemLustreConfiguration_copyTagsToBackups :: Lens' CreateFileSystemLustreConfiguration (Maybe Bool) Source #

(Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup 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.

(Default = false)

For more information, see Working with backups in the Amazon FSx for Lustre User Guide.

createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #

Undocumented member.

createFileSystemLustreConfiguration_dataCompressionType :: Lens' CreateFileSystemLustreConfiguration (Maybe DataCompressionType) Source #

Sets the data compression configuration for the file system. DataCompressionType can have the following values:

  • NONE - (Default) Data compression is turned off when the file system is created.
  • LZ4 - Data compression is turned on with the LZ4 algorithm.

For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.

createFileSystemLustreConfiguration_deploymentType :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreDeploymentType) Source #

(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.

Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.

If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.

Encryption of data in transit is automatically turned on when you access SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.

(Default = SCRATCH_1)

createFileSystemLustreConfiguration_driveCacheType :: Lens' CreateFileSystemLustreConfiguration (Maybe DriveCacheType) Source #

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.

This parameter is required when StorageType is set to HDD.

createFileSystemLustreConfiguration_exportPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #

(Optional) Available with Scratch and Persistent_1 deployment types. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.

The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you specify only a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

This parameter is not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

createFileSystemLustreConfiguration_importPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

This parameter is not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

createFileSystemLustreConfiguration_importedFileChunkSize :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #

(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

This parameter is not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

createFileSystemLustreConfiguration_logConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration) Source #

The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

createFileSystemLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #

Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.

Valid values:

  • For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
  • For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
  • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.

createFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration) Source #

The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

createFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #

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

CreateFileSystemOntapConfiguration

createFileSystemOntapConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemOntapConfiguration (Maybe Natural) Source #

Undocumented member.

createFileSystemOntapConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #

Undocumented member.

createFileSystemOntapConfiguration_diskIopsConfiguration :: Lens' CreateFileSystemOntapConfiguration (Maybe DiskIopsConfiguration) Source #

The SSD IOPS configuration for the FSx for ONTAP file system.

createFileSystemOntapConfiguration_endpointIpAddressRange :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

createFileSystemOntapConfiguration_fsxAdminPassword :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #

The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.

createFileSystemOntapConfiguration_preferredSubnetId :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #

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

createFileSystemOntapConfiguration_routeTableIds :: Lens' CreateFileSystemOntapConfiguration (Maybe [Text]) Source #

(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

createFileSystemOntapConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #

Undocumented member.

createFileSystemOntapConfiguration_deploymentType :: Lens' CreateFileSystemOntapConfiguration OntapDeploymentType Source #

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

  • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
  • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

createFileSystemOntapConfiguration_throughputCapacity :: Lens' CreateFileSystemOntapConfiguration Natural Source #

Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.

CreateFileSystemOpenZFSConfiguration

createFileSystemOpenZFSConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Natural) Source #

Undocumented member.

createFileSystemOpenZFSConfiguration_copyTagsToBackups :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Bool) Source #

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.

createFileSystemOpenZFSConfiguration_copyTagsToVolumes :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Bool) Source #

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.

createFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Text) Source #

Undocumented member.

createFileSystemOpenZFSConfiguration_diskIopsConfiguration :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe DiskIopsConfiguration) Source #

Undocumented member.

createFileSystemOpenZFSConfiguration_rootVolumeConfiguration :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe OpenZFSCreateRootVolumeConfiguration) Source #

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.

createFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Text) Source #

Undocumented member.

createFileSystemOpenZFSConfiguration_deploymentType :: Lens' CreateFileSystemOpenZFSConfiguration OpenZFSDeploymentType Source #

Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:

  • SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available, except US West (Oregon).
  • SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.

For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.

createFileSystemOpenZFSConfiguration_throughputCapacity :: Lens' CreateFileSystemOpenZFSConfiguration Natural Source #

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:

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

You pay for additional throughput capacity that you provision.

CreateFileSystemWindowsConfiguration

createFileSystemWindowsConfiguration_activeDirectoryId :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #

The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

createFileSystemWindowsConfiguration_aliases :: Lens' CreateFileSystemWindowsConfiguration (Maybe [Text]) Source #

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.
  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
  • Cannot start or end with a hyphen.
  • Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

createFileSystemWindowsConfiguration_auditLogConfiguration :: Lens' CreateFileSystemWindowsConfiguration (Maybe WindowsAuditLogCreateConfiguration) Source #

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

createFileSystemWindowsConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemWindowsConfiguration (Maybe Natural) Source #

The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.

createFileSystemWindowsConfiguration_copyTagsToBackups :: Lens' CreateFileSystemWindowsConfiguration (Maybe Bool) Source #

A boolean flag 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.

createFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #

The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

createFileSystemWindowsConfiguration_deploymentType :: Lens' CreateFileSystemWindowsConfiguration (Maybe WindowsDeploymentType) Source #

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type
  • SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
  • SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.

createFileSystemWindowsConfiguration_preferredSubnetId :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

createFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' CreateFileSystemWindowsConfiguration (Maybe SelfManagedActiveDirectoryConfiguration) Source #

Undocumented member.

createFileSystemWindowsConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #

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.

createFileSystemWindowsConfiguration_throughputCapacity :: Lens' CreateFileSystemWindowsConfiguration Natural Source #

Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

CreateOntapVolumeConfiguration

createOntapVolumeConfiguration_copyTagsToBackups :: Lens' CreateOntapVolumeConfiguration (Maybe Bool) Source #

A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.

createOntapVolumeConfiguration_junctionPath :: Lens' CreateOntapVolumeConfiguration (Maybe Text) Source #

Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.

createOntapVolumeConfiguration_ontapVolumeType :: Lens' CreateOntapVolumeConfiguration (Maybe InputOntapVolumeType) Source #

Specifies the type of volume you are creating. Valid values are the following:

  • RW specifies a read/write volume. RW is the default.
  • DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

createOntapVolumeConfiguration_securityStyle :: Lens' CreateOntapVolumeConfiguration (Maybe SecurityStyle) Source #

Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:

  • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
  • NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
  • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

createOntapVolumeConfiguration_snapshotPolicy :: Lens' CreateOntapVolumeConfiguration (Maybe Text) Source #

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

createOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' CreateOntapVolumeConfiguration (Maybe Bool) Source #

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.

createOntapVolumeConfiguration_tieringPolicy :: Lens' CreateOntapVolumeConfiguration (Maybe TieringPolicy) Source #

Undocumented member.

createOntapVolumeConfiguration_sizeInMegabytes :: Lens' CreateOntapVolumeConfiguration Natural Source #

Specifies the size of the volume, in megabytes (MB), that you are creating.

createOntapVolumeConfiguration_storageVirtualMachineId :: Lens' CreateOntapVolumeConfiguration Text Source #

Specifies the ONTAP SVM in which to create the volume.

CreateOpenZFSOriginSnapshotConfiguration

createOpenZFSOriginSnapshotConfiguration_snapshotARN :: Lens' CreateOpenZFSOriginSnapshotConfiguration Text Source #

Undocumented member.

createOpenZFSOriginSnapshotConfiguration_copyStrategy :: Lens' CreateOpenZFSOriginSnapshotConfiguration OpenZFSCopyStrategy Source #

The strategy used when copying data from the snapshot to the new volume.

  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
  • FULL_COPY - Copies all data from the snapshot to the new volume.

CreateOpenZFSVolumeConfiguration

createOpenZFSVolumeConfiguration_copyTagsToSnapshots :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

createOpenZFSVolumeConfiguration_dataCompressionType :: Lens' CreateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the /Amazon FSx for OpenZFS User Guide/.

createOpenZFSVolumeConfiguration_nfsExports :: Lens' CreateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #

The configuration object for mounting a Network File System (NFS) file system.

createOpenZFSVolumeConfiguration_originSnapshot :: Lens' CreateOpenZFSVolumeConfiguration (Maybe CreateOpenZFSOriginSnapshotConfiguration) Source #

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

createOpenZFSVolumeConfiguration_readOnly :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether the volume is read-only.

createOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Natural) Source #

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 ZFS Record size in the Amazon FSx for OpenZFS User Guide.

createOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Int) Source #

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 StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

createOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Int) Source #

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB 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 specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

createOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' CreateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #

An object specifying how much storage users or groups can use on the volume.

createOpenZFSVolumeConfiguration_parentVolumeId :: Lens' CreateOpenZFSVolumeConfiguration Text Source #

The ID of the volume to use as the parent volume of the volume that you are creating.

CreateSvmActiveDirectoryConfiguration

createSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' CreateSvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryConfiguration) Source #

Undocumented member.

createSvmActiveDirectoryConfiguration_netBiosName :: Lens' CreateSvmActiveDirectoryConfiguration Text Source #

The NetBIOS name of the Active Directory computer object that will be created for your SVM.

DataRepositoryAssociation

dataRepositoryAssociation_associationId :: Lens' DataRepositoryAssociation (Maybe Text) Source #

The system-generated, unique ID of the data repository association.

dataRepositoryAssociation_batchImportMetaDataOnCreate :: Lens' DataRepositoryAssociation (Maybe Bool) Source #

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache resource.

dataRepositoryAssociation_creationTime :: Lens' DataRepositoryAssociation (Maybe UTCTime) Source #

Undocumented member.

dataRepositoryAssociation_dataRepositoryPath :: Lens' DataRepositoryAssociation (Maybe Text) Source #

The path to the data repository that will be linked to the cache or file system.

  • For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:

    • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
    • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
  • For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
  • For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

dataRepositoryAssociation_dataRepositorySubdirectories :: Lens' DataRepositoryAssociation (Maybe [Text]) Source #

For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

dataRepositoryAssociation_failureDetails :: Lens' DataRepositoryAssociation (Maybe DataRepositoryFailureDetails) Source #

Undocumented member.

dataRepositoryAssociation_fileCacheId :: Lens' DataRepositoryAssociation (Maybe Text) Source #

The globally unique ID of the Amazon File Cache resource.

dataRepositoryAssociation_fileCachePath :: Lens' DataRepositoryAssociation (Maybe Text) Source #

A path on the Amazon File Cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.

The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

The cache path cannot be set to root (/) for an S3 DRA.

dataRepositoryAssociation_fileSystemId :: Lens' DataRepositoryAssociation (Maybe Text) Source #

Undocumented member.

dataRepositoryAssociation_fileSystemPath :: Lens' DataRepositoryAssociation (Maybe Text) Source #

A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.

dataRepositoryAssociation_importedFileChunkSize :: Lens' DataRepositoryAssociation (Maybe Natural) Source #

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

dataRepositoryAssociation_lifecycle :: Lens' DataRepositoryAssociation (Maybe DataRepositoryLifecycle) Source #

Describes the state of a data repository association. The lifecycle can have the following values:

  • CREATING - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable.
  • AVAILABLE - The data repository association is available for use.
  • MISCONFIGURED - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).
  • UPDATING - The data repository association is undergoing a customer initiated update that might affect its availability.
  • DELETING - The data repository association is undergoing a customer initiated deletion.
  • FAILED - The data repository association is in a terminal state that cannot be recovered.

dataRepositoryAssociation_nfs :: Lens' DataRepositoryAssociation (Maybe NFSDataRepositoryConfiguration) Source #

The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.

dataRepositoryAssociation_resourceARN :: Lens' DataRepositoryAssociation (Maybe Text) Source #

Undocumented member.

dataRepositoryAssociation_s3 :: Lens' DataRepositoryAssociation (Maybe S3DataRepositoryConfiguration) Source #

The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.

dataRepositoryAssociation_tags :: Lens' DataRepositoryAssociation (Maybe (NonEmpty Tag)) Source #

Undocumented member.

DataRepositoryConfiguration

dataRepositoryConfiguration_autoImportPolicy :: Lens' DataRepositoryConfiguration (Maybe AutoImportPolicyType) Source #

Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

dataRepositoryConfiguration_exportPath :: Lens' DataRepositoryConfiguration (Maybe Text) Source #

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

dataRepositoryConfiguration_failureDetails :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryFailureDetails) Source #

Undocumented member.

dataRepositoryConfiguration_importPath :: Lens' DataRepositoryConfiguration (Maybe Text) Source #

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

dataRepositoryConfiguration_importedFileChunkSize :: Lens' DataRepositoryConfiguration (Maybe Natural) Source #

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

dataRepositoryConfiguration_lifecycle :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryLifecycle) Source #

Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

  • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
  • AVAILABLE - The data repository is available for use.
  • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.
  • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
  • FAILED - The data repository is in a terminal state that cannot be recovered.

DataRepositoryFailureDetails

dataRepositoryFailureDetails_message :: Lens' DataRepositoryFailureDetails (Maybe Text) Source #

Undocumented member.

DataRepositoryTask

dataRepositoryTask_capacityToRelease :: Lens' DataRepositoryTask (Maybe Natural) Source #

Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

dataRepositoryTask_endTime :: Lens' DataRepositoryTask (Maybe UTCTime) Source #

The time the system completed processing the task, populated after the task is complete.

dataRepositoryTask_failureDetails :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskFailureDetails) Source #

Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

dataRepositoryTask_fileCacheId :: Lens' DataRepositoryTask (Maybe Text) Source #

The system-generated, unique ID of the cache.

dataRepositoryTask_fileSystemId :: Lens' DataRepositoryTask (Maybe Text) Source #

The globally unique ID of the file system.

dataRepositoryTask_paths :: Lens' DataRepositoryTask (Maybe [Text]) Source #

An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

(Default) If Paths is not specified, Amazon FSx uses the file system root directory.

dataRepositoryTask_report :: Lens' DataRepositoryTask (Maybe CompletionReport) Source #

Undocumented member.

dataRepositoryTask_resourceARN :: Lens' DataRepositoryTask (Maybe Text) Source #

Undocumented member.

dataRepositoryTask_startTime :: Lens' DataRepositoryTask (Maybe UTCTime) Source #

The time the system began processing the task.

dataRepositoryTask_status :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskStatus) Source #

Provides the status of the number of files that the task has processed successfully and failed to process.

dataRepositoryTask_tags :: Lens' DataRepositoryTask (Maybe (NonEmpty Tag)) Source #

Undocumented member.

dataRepositoryTask_taskId :: Lens' DataRepositoryTask Text Source #

The system-generated, unique 17-digit ID of the data repository task.

dataRepositoryTask_lifecycle :: Lens' DataRepositoryTask DataRepositoryTaskLifecycle Source #

The lifecycle status of the data repository task, as follows:

  • PENDING - The task has not started.
  • EXECUTING - The task is in process.
  • FAILED - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
  • SUCCEEDED - The task has completed successfully.
  • CANCELED - The task was canceled and it did not complete.
  • CANCELING - The task is in process of being canceled.

You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

dataRepositoryTask_type :: Lens' DataRepositoryTask DataRepositoryTaskType Source #

The type of data repository task.

  • EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.
  • IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
  • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

dataRepositoryTask_creationTime :: Lens' DataRepositoryTask UTCTime Source #

Undocumented member.

DataRepositoryTaskFailureDetails

dataRepositoryTaskFailureDetails_message :: Lens' DataRepositoryTaskFailureDetails (Maybe Text) Source #

Undocumented member.

DataRepositoryTaskFilter

dataRepositoryTaskFilter_name :: Lens' DataRepositoryTaskFilter (Maybe DataRepositoryTaskFilterName) Source #

Name of the task property to use in filtering the tasks returned in the response.

  • Use file-system-id to retrieve data repository tasks for specific file systems.
  • Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

dataRepositoryTaskFilter_values :: Lens' DataRepositoryTaskFilter (Maybe [Text]) Source #

Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

DataRepositoryTaskStatus

dataRepositoryTaskStatus_failedCount :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #

A running total of the number of files that the task failed to process.

dataRepositoryTaskStatus_lastUpdatedTime :: Lens' DataRepositoryTaskStatus (Maybe UTCTime) Source #

The time at which the task status was last updated.

dataRepositoryTaskStatus_releasedCapacity :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #

The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

dataRepositoryTaskStatus_succeededCount :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #

A running total of the number of files that the task has successfully processed.

dataRepositoryTaskStatus_totalCount :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #

The total number of files that the task will process. While a task is executing, the sum of SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.

DeleteFileSystemLustreConfiguration

deleteFileSystemLustreConfiguration_finalBackupTags :: Lens' DeleteFileSystemLustreConfiguration (Maybe (NonEmpty Tag)) Source #

Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the final backup. If you have set the file system property CopyTagsToBackups to true, and you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.

deleteFileSystemLustreConfiguration_skipFinalBackup :: Lens' DeleteFileSystemLustreConfiguration (Maybe Bool) Source #

Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem operation is invoked. (Default = true)

The fsx:CreateBackup permission is required if you set SkipFinalBackup to false in order to delete the file system and take a final backup.

DeleteFileSystemLustreResponse

deleteFileSystemLustreResponse_finalBackupId :: Lens' DeleteFileSystemLustreResponse (Maybe Text) Source #

The ID of the final backup for this file system.

deleteFileSystemLustreResponse_finalBackupTags :: Lens' DeleteFileSystemLustreResponse (Maybe (NonEmpty Tag)) Source #

The set of tags applied to the final backup.

DeleteFileSystemOpenZFSConfiguration

deleteFileSystemOpenZFSConfiguration_finalBackupTags :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe (NonEmpty Tag)) Source #

A list of tags to apply to the file system's final backup.

deleteFileSystemOpenZFSConfiguration_options :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe [DeleteFileSystemOpenZFSOption]) Source #

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.

deleteFileSystemOpenZFSConfiguration_skipFinalBackup :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe Bool) Source #

By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to true.

DeleteFileSystemOpenZFSResponse

deleteFileSystemOpenZFSResponse_finalBackupId :: Lens' DeleteFileSystemOpenZFSResponse (Maybe Text) Source #

Undocumented member.

deleteFileSystemOpenZFSResponse_finalBackupTags :: Lens' DeleteFileSystemOpenZFSResponse (Maybe (NonEmpty Tag)) Source #

Undocumented member.

DeleteFileSystemWindowsConfiguration

deleteFileSystemWindowsConfiguration_finalBackupTags :: Lens' DeleteFileSystemWindowsConfiguration (Maybe (NonEmpty Tag)) Source #

A set of tags for your final backup.

deleteFileSystemWindowsConfiguration_skipFinalBackup :: Lens' DeleteFileSystemWindowsConfiguration (Maybe Bool) Source #

By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.

DeleteFileSystemWindowsResponse

deleteFileSystemWindowsResponse_finalBackupId :: Lens' DeleteFileSystemWindowsResponse (Maybe Text) Source #

The ID of the final backup for this file system.

deleteFileSystemWindowsResponse_finalBackupTags :: Lens' DeleteFileSystemWindowsResponse (Maybe (NonEmpty Tag)) Source #

The set of tags applied to the final backup.

DeleteVolumeOntapConfiguration

deleteVolumeOntapConfiguration_finalBackupTags :: Lens' DeleteVolumeOntapConfiguration (Maybe (NonEmpty Tag)) Source #

Undocumented member.

deleteVolumeOntapConfiguration_skipFinalBackup :: Lens' DeleteVolumeOntapConfiguration (Maybe Bool) Source #

Set to true if you want to skip taking a final backup of the volume you are deleting.

DeleteVolumeOntapResponse

deleteVolumeOntapResponse_finalBackupId :: Lens' DeleteVolumeOntapResponse (Maybe Text) Source #

Undocumented member.

deleteVolumeOntapResponse_finalBackupTags :: Lens' DeleteVolumeOntapResponse (Maybe (NonEmpty Tag)) Source #

Undocumented member.

DeleteVolumeOpenZFSConfiguration

deleteVolumeOpenZFSConfiguration_options :: Lens' DeleteVolumeOpenZFSConfiguration (Maybe [DeleteOpenZFSVolumeOption]) Source #

To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.

DiskIopsConfiguration

diskIopsConfiguration_iops :: Lens' DiskIopsConfiguration (Maybe Natural) Source #

The total number of SSD IOPS provisioned for the file system.

diskIopsConfiguration_mode :: Lens' DiskIopsConfiguration (Maybe DiskIopsConfigurationMode) Source #

Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC) or was provisioned by the customer (USER_PROVISIONED).

FileCache

fileCache_creationTime :: Lens' FileCache (Maybe UTCTime) Source #

Undocumented member.

fileCache_dNSName :: Lens' FileCache (Maybe Text) Source #

The Domain Name System (DNS) name for the cache.

fileCache_dataRepositoryAssociationIds :: Lens' FileCache (Maybe [Text]) Source #

A list of IDs of data repository associations that are associated with this cache.

fileCache_failureDetails :: Lens' FileCache (Maybe FileCacheFailureDetails) Source #

A structure providing details of any failures that occurred.

fileCache_fileCacheId :: Lens' FileCache (Maybe Text) Source #

The system-generated, unique ID of the cache.

fileCache_fileCacheType :: Lens' FileCache (Maybe FileCacheType) Source #

The type of cache, which must be LUSTRE.

fileCache_fileCacheTypeVersion :: Lens' FileCache (Maybe Text) Source #

The Lustre version of the cache, which must be 2.12.

fileCache_kmsKeyId :: Lens' FileCache (Maybe Text) Source #

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

fileCache_lifecycle :: Lens' FileCache (Maybe FileCacheLifecycle) Source #

The lifecycle status of the cache. The following are the possible values and what they mean:

  • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
  • CREATING - The new cache is being created.
  • DELETING - An existing cache is being deleted.
  • UPDATING - The cache is undergoing a customer-initiated update.
  • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

fileCache_lustreConfiguration :: Lens' FileCache (Maybe FileCacheLustreConfiguration) Source #

The configuration for the Amazon File Cache resource.

fileCache_networkInterfaceIds :: Lens' FileCache (Maybe [Text]) Source #

Undocumented member.

fileCache_ownerId :: Lens' FileCache (Maybe Text) Source #

Undocumented member.

fileCache_resourceARN :: Lens' FileCache (Maybe Text) Source #

Undocumented member.

fileCache_storageCapacity :: Lens' FileCache (Maybe Natural) Source #

The storage capacity of the cache in gibibytes (GiB).

fileCache_subnetIds :: Lens' FileCache (Maybe [Text]) Source #

Undocumented member.

fileCache_vpcId :: Lens' FileCache (Maybe Text) Source #

Undocumented member.

FileCacheCreating

fileCacheCreating_copyTagsToDataRepositoryAssociations :: Lens' FileCacheCreating (Maybe Bool) Source #

A boolean flag indicating whether tags for the cache should be copied to data repository associations.

fileCacheCreating_creationTime :: Lens' FileCacheCreating (Maybe UTCTime) Source #

Undocumented member.

fileCacheCreating_dNSName :: Lens' FileCacheCreating (Maybe Text) Source #

The Domain Name System (DNS) name for the cache.

fileCacheCreating_dataRepositoryAssociationIds :: Lens' FileCacheCreating (Maybe [Text]) Source #

A list of IDs of data repository associations that are associated with this cache.

fileCacheCreating_failureDetails :: Lens' FileCacheCreating (Maybe FileCacheFailureDetails) Source #

A structure providing details of any failures that occurred.

fileCacheCreating_fileCacheId :: Lens' FileCacheCreating (Maybe Text) Source #

The system-generated, unique ID of the cache.

fileCacheCreating_fileCacheType :: Lens' FileCacheCreating (Maybe FileCacheType) Source #

The type of cache, which must be LUSTRE.

fileCacheCreating_fileCacheTypeVersion :: Lens' FileCacheCreating (Maybe Text) Source #

The Lustre version of the cache, which must be 2.12.

fileCacheCreating_kmsKeyId :: Lens' FileCacheCreating (Maybe Text) Source #

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

fileCacheCreating_lifecycle :: Lens' FileCacheCreating (Maybe FileCacheLifecycle) Source #

The lifecycle status of the cache. The following are the possible values and what they mean:

  • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
  • CREATING - The new cache is being created.
  • DELETING - An existing cache is being deleted.
  • UPDATING - The cache is undergoing a customer-initiated update.
  • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

fileCacheCreating_lustreConfiguration :: Lens' FileCacheCreating (Maybe FileCacheLustreConfiguration) Source #

The configuration for the Amazon File Cache resource.

fileCacheCreating_networkInterfaceIds :: Lens' FileCacheCreating (Maybe [Text]) Source #

Undocumented member.

fileCacheCreating_ownerId :: Lens' FileCacheCreating (Maybe Text) Source #

Undocumented member.

fileCacheCreating_resourceARN :: Lens' FileCacheCreating (Maybe Text) Source #

Undocumented member.

fileCacheCreating_storageCapacity :: Lens' FileCacheCreating (Maybe Natural) Source #

The storage capacity of the cache in gibibytes (GiB).

fileCacheCreating_subnetIds :: Lens' FileCacheCreating (Maybe [Text]) Source #

Undocumented member.

fileCacheCreating_tags :: Lens' FileCacheCreating (Maybe (NonEmpty Tag)) Source #

Undocumented member.

fileCacheCreating_vpcId :: Lens' FileCacheCreating (Maybe Text) Source #

Undocumented member.

FileCacheDataRepositoryAssociation

fileCacheDataRepositoryAssociation_dataRepositorySubdirectories :: Lens' FileCacheDataRepositoryAssociation (Maybe [Text]) Source #

A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

fileCacheDataRepositoryAssociation_nfs :: Lens' FileCacheDataRepositoryAssociation (Maybe FileCacheNFSConfiguration) Source #

The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

fileCacheDataRepositoryAssociation_fileCachePath :: Lens' FileCacheDataRepositoryAssociation Text Source #

A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.

The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

The cache path cannot be set to root (/) for an S3 DRA.

fileCacheDataRepositoryAssociation_dataRepositoryPath :: Lens' FileCacheDataRepositoryAssociation Text Source #

The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

  • The path can be an NFS data repository that links to the cache. The path can be in one of two formats:

    • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
    • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
  • The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

FileCacheFailureDetails

fileCacheFailureDetails_message :: Lens' FileCacheFailureDetails (Maybe Text) Source #

A message describing any failures that occurred.

FileCacheLustreConfiguration

fileCacheLustreConfiguration_deploymentType :: Lens' FileCacheLustreConfiguration (Maybe FileCacheLustreDeploymentType) Source #

The deployment type of the Amazon File Cache resource, which must be CACHE_1.

fileCacheLustreConfiguration_logConfiguration :: Lens' FileCacheLustreConfiguration (Maybe LustreLogConfiguration) Source #

The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.

fileCacheLustreConfiguration_metadataConfiguration :: Lens' FileCacheLustreConfiguration (Maybe FileCacheLustreMetadataConfiguration) Source #

The configuration for a Lustre MDT (Metadata Target) storage volume.

fileCacheLustreConfiguration_mountName :: Lens' FileCacheLustreConfiguration (Maybe Text) Source #

You use the MountName value when mounting the cache. If you pass a cache ID to the DescribeFileCaches operation, it returns the the MountName value as part of the cache's description.

fileCacheLustreConfiguration_perUnitStorageThroughput :: Lens' FileCacheLustreConfiguration (Maybe Natural) Source #

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is 1000.

fileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' FileCacheLustreConfiguration (Maybe Text) Source #

Undocumented member.

FileCacheLustreMetadataConfiguration

fileCacheLustreMetadataConfiguration_storageCapacity :: Lens' FileCacheLustreMetadataConfiguration Natural Source #

The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

FileCacheNFSConfiguration

fileCacheNFSConfiguration_dnsIps :: Lens' FileCacheNFSConfiguration (Maybe [Text]) Source #

A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.

fileCacheNFSConfiguration_version :: Lens' FileCacheNFSConfiguration NfsVersion Source #

The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.

FileSystem

fileSystem_administrativeActions :: Lens' FileSystem (Maybe [AdministrativeAction]) Source #

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

fileSystem_creationTime :: Lens' FileSystem (Maybe UTCTime) Source #

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

fileSystem_dNSName :: Lens' FileSystem (Maybe Text) Source #

The Domain Name System (DNS) name for the file system.

fileSystem_failureDetails :: Lens' FileSystem (Maybe FileSystemFailureDetails) Source #

Undocumented member.

fileSystem_fileSystemId :: Lens' FileSystem (Maybe Text) Source #

The system-generated, unique 17-digit ID of the file system.

fileSystem_fileSystemType :: Lens' FileSystem (Maybe FileSystemType) Source #

The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

fileSystem_fileSystemTypeVersion :: Lens' FileSystem (Maybe Text) Source #

The Lustre version of the Amazon FSx for Lustre file system, either 2.10 or 2.12.

fileSystem_kmsKeyId :: Lens' FileSystem (Maybe Text) Source #

The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

  • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

    SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

  • Amazon FSx for NetApp ONTAP
  • Amazon FSx for OpenZFS
  • Amazon FSx for Windows File Server

fileSystem_lifecycle :: Lens' FileSystem (Maybe FileSystemLifecycle) Source #

The lifecycle status of the file system. The following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
  • CREATING - Amazon FSx is creating the new file system.
  • DELETING - Amazon FSx is deleting an existing file system.
  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
  • MISCONFIGURED - The file system is in a failed but recoverable state.
  • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.
  • UPDATING - The file system is undergoing a customer-initiated update.

fileSystem_lustreConfiguration :: Lens' FileSystem (Maybe LustreFileSystemConfiguration) Source #

Undocumented member.

fileSystem_networkInterfaceIds :: Lens' FileSystem (Maybe [Text]) Source #

The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

fileSystem_ontapConfiguration :: Lens' FileSystem (Maybe OntapFileSystemConfiguration) Source #

The configuration for this Amazon FSx for NetApp ONTAP file system.

fileSystem_openZFSConfiguration :: Lens' FileSystem (Maybe OpenZFSFileSystemConfiguration) Source #

The configuration for this Amazon FSx for OpenZFS file system.

fileSystem_ownerId :: Lens' FileSystem (Maybe Text) Source #

The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.

fileSystem_resourceARN :: Lens' FileSystem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the file system resource.

fileSystem_storageCapacity :: Lens' FileSystem (Maybe Natural) Source #

The storage capacity of the file system in gibibytes (GiB).

fileSystem_storageType :: Lens' FileSystem (Maybe StorageType) Source #

The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

fileSystem_subnetIds :: Lens' FileSystem (Maybe [Text]) Source #

Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

fileSystem_tags :: Lens' FileSystem (Maybe (NonEmpty Tag)) Source #

The tags to associate with the file system. For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.

fileSystem_vpcId :: Lens' FileSystem (Maybe Text) Source #

The ID of the primary virtual private cloud (VPC) for the file system.

fileSystem_windowsConfiguration :: Lens' FileSystem (Maybe WindowsFileSystemConfiguration) Source #

The configuration for this Amazon FSx for Windows File Server file system.

FileSystemEndpoint

fileSystemEndpoint_dNSName :: Lens' FileSystemEndpoint (Maybe Text) Source #

Undocumented member.

fileSystemEndpoint_ipAddresses :: Lens' FileSystemEndpoint (Maybe (NonEmpty Text)) Source #

IP addresses of the file system endpoint.

FileSystemEndpoints

fileSystemEndpoints_intercluster :: Lens' FileSystemEndpoints (Maybe FileSystemEndpoint) Source #

An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

fileSystemEndpoints_management :: Lens' FileSystemEndpoints (Maybe FileSystemEndpoint) Source #

An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

FileSystemFailureDetails

fileSystemFailureDetails_message :: Lens' FileSystemFailureDetails (Maybe Text) Source #

A message describing any failures that occurred.

Filter

filter_name :: Lens' Filter (Maybe FilterName) Source #

The name for this filter.

filter_values :: Lens' Filter (Maybe [Text]) Source #

The values of the filter. These are all the values for any of the applied filters.

LifecycleTransitionReason

lifecycleTransitionReason_message :: Lens' LifecycleTransitionReason (Maybe Text) Source #

Undocumented member.

LustreFileSystemConfiguration

lustreFileSystemConfiguration_automaticBackupRetentionDays :: Lens' LustreFileSystemConfiguration (Maybe Natural) Source #

Undocumented member.

lustreFileSystemConfiguration_copyTagsToBackups :: Lens' LustreFileSystemConfiguration (Maybe Bool) Source #

A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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. (Default = false)

lustreFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' LustreFileSystemConfiguration (Maybe Text) Source #

Undocumented member.

lustreFileSystemConfiguration_dataCompressionType :: Lens' LustreFileSystemConfiguration (Maybe DataCompressionType) Source #

The data compression configuration for the file system. DataCompressionType can have the following values:

  • NONE - Data compression is turned off for the file system.
  • LZ4 - Data compression is turned on with the LZ4 algorithm.

For more information, see Lustre data compression.

lustreFileSystemConfiguration_dataRepositoryConfiguration :: Lens' LustreFileSystemConfiguration (Maybe DataRepositoryConfiguration) Source #

Undocumented member.

lustreFileSystemConfiguration_deploymentType :: Lens' LustreFileSystemConfiguration (Maybe LustreDeploymentType) Source #

The deployment type of the FSx for Lustre file system. /Scratch deployment type/ is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 is built on Lustre v2.12 and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

The default is SCRATCH_1.

lustreFileSystemConfiguration_driveCacheType :: Lens' LustreFileSystemConfiguration (Maybe DriveCacheType) Source #

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

This parameter is required when StorageType is set to HDD.

lustreFileSystemConfiguration_logConfiguration :: Lens' LustreFileSystemConfiguration (Maybe LustreLogConfiguration) Source #

The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

lustreFileSystemConfiguration_mountName :: Lens' LustreFileSystemConfiguration (Maybe Text) Source #

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

lustreFileSystemConfiguration_perUnitStorageThroughput :: Lens' LustreFileSystemConfiguration (Maybe Natural) Source #

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

Valid values:

  • For PERSISTENT_1 SSD storage: 50, 100, 200.
  • For PERSISTENT_1 HDD storage: 12, 40.
  • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

lustreFileSystemConfiguration_rootSquashConfiguration :: Lens' LustreFileSystemConfiguration (Maybe LustreRootSquashConfiguration) Source #

The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

lustreFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' LustreFileSystemConfiguration (Maybe Text) Source #

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

LustreLogConfiguration

lustreLogConfiguration_destination :: Lens' LustreLogConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

lustreLogConfiguration_level :: Lens' LustreLogConfiguration LustreAccessAuditLogLevel Source #

The data repository events that are logged by Amazon FSx.

  • WARN_ONLY - only warning events are logged.
  • ERROR_ONLY - only error events are logged.
  • WARN_ERROR - both warning events and error events are logged.
  • DISABLED - logging of data repository events is turned off.

Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

LustreLogCreateConfiguration

lustreLogCreateConfiguration_destination :: Lens' LustreLogCreateConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) that specifies the destination of the logs.

The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:

  • The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
  • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
  • If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).
  • If Destination is provided and the resource does not exist, the request will fail with a BadRequest error.
  • If Level is set to DISABLED, you cannot specify a destination in Destination.

lustreLogCreateConfiguration_level :: Lens' LustreLogCreateConfiguration LustreAccessAuditLogLevel Source #

Sets which data repository events are logged by Amazon FSx.

  • WARN_ONLY - only warning events are logged.
  • ERROR_ONLY - only error events are logged.
  • WARN_ERROR - both warning events and error events are logged.
  • DISABLED - logging of data repository events is turned off.

LustreRootSquashConfiguration

lustreRootSquashConfiguration_noSquashNids :: Lens' LustreRootSquashConfiguration (Maybe [Text]) Source #

When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

  • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).
  • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

lustreRootSquashConfiguration_rootSquash :: Lens' LustreRootSquashConfiguration (Maybe Text) Source #

You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

  • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.
  • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

NFSDataRepositoryConfiguration

nFSDataRepositoryConfiguration_autoExportPolicy :: Lens' NFSDataRepositoryConfiguration (Maybe AutoExportPolicy) Source #

This parameter is not supported for Amazon File Cache.

nFSDataRepositoryConfiguration_dnsIps :: Lens' NFSDataRepositoryConfiguration (Maybe [Text]) Source #

A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.

nFSDataRepositoryConfiguration_version :: Lens' NFSDataRepositoryConfiguration NfsVersion Source #

The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.

OntapFileSystemConfiguration

ontapFileSystemConfiguration_automaticBackupRetentionDays :: Lens' OntapFileSystemConfiguration (Maybe Natural) Source #

Undocumented member.

ontapFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #

Undocumented member.

ontapFileSystemConfiguration_deploymentType :: Lens' OntapFileSystemConfiguration (Maybe OntapDeploymentType) Source #

Specifies the FSx for ONTAP file system deployment type in use in the file system.

  • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
  • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

ontapFileSystemConfiguration_diskIopsConfiguration :: Lens' OntapFileSystemConfiguration (Maybe DiskIopsConfiguration) Source #

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

ontapFileSystemConfiguration_endpointIpAddressRange :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #

(Multi-AZ only) The IP address range in which the endpoints to access your file system are created.

The Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger. If you do not specify this optional parameter, Amazon FSx will automatically select a CIDR block for you.

ontapFileSystemConfiguration_endpoints :: Lens' OntapFileSystemConfiguration (Maybe FileSystemEndpoints) Source #

The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

ontapFileSystemConfiguration_preferredSubnetId :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #

Undocumented member.

ontapFileSystemConfiguration_routeTableIds :: Lens' OntapFileSystemConfiguration (Maybe [Text]) Source #

(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

ontapFileSystemConfiguration_throughputCapacity :: Lens' OntapFileSystemConfiguration (Maybe Natural) Source #

Undocumented member.

ontapFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #

Undocumented member.

OntapVolumeConfiguration

ontapVolumeConfiguration_copyTagsToBackups :: Lens' OntapVolumeConfiguration (Maybe Bool) Source #

A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.

ontapVolumeConfiguration_flexCacheEndpointType :: Lens' OntapVolumeConfiguration (Maybe FlexCacheEndpointType) Source #

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

  • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
  • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
  • CACHE specifies that the volume is a FlexCache volume.

ontapVolumeConfiguration_junctionPath :: Lens' OntapVolumeConfiguration (Maybe Text) Source #

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

ontapVolumeConfiguration_ontapVolumeType :: Lens' OntapVolumeConfiguration (Maybe OntapVolumeType) Source #

Specifies the type of volume. Valid values are the following:

  • RW specifies a read/write volume. RW is the default.
  • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
  • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

ontapVolumeConfiguration_securityStyle :: Lens' OntapVolumeConfiguration (Maybe SecurityStyle) Source #

The security style for the volume, which can be UNIX, NTFS, or MIXED.

ontapVolumeConfiguration_sizeInMegabytes :: Lens' OntapVolumeConfiguration (Maybe Natural) Source #

The configured size of the volume, in megabytes (MBs).

ontapVolumeConfiguration_snapshotPolicy :: Lens' OntapVolumeConfiguration (Maybe Text) Source #

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

ontapVolumeConfiguration_storageEfficiencyEnabled :: Lens' OntapVolumeConfiguration (Maybe Bool) Source #

The volume's storage efficiency setting.

ontapVolumeConfiguration_storageVirtualMachineId :: Lens' OntapVolumeConfiguration (Maybe Text) Source #

The ID of the volume's storage virtual machine.

ontapVolumeConfiguration_storageVirtualMachineRoot :: Lens' OntapVolumeConfiguration (Maybe Bool) Source #

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

ontapVolumeConfiguration_tieringPolicy :: Lens' OntapVolumeConfiguration (Maybe TieringPolicy) Source #

The volume's TieringPolicy setting.

ontapVolumeConfiguration_uuid :: Lens' OntapVolumeConfiguration (Maybe Text) Source #

The volume's universally unique identifier (UUID).

OpenZFSClientConfiguration

openZFSClientConfiguration_clients :: Lens' OpenZFSClientConfiguration Text Source #

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.

openZFSClientConfiguration_options :: Lens' OpenZFSClientConfiguration (NonEmpty Text) Source #

The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

  • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
  • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

OpenZFSCreateRootVolumeConfiguration

openZFSCreateRootVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

openZFSCreateRootVolumeConfiguration_dataCompressionType :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

openZFSCreateRootVolumeConfiguration_nfsExports :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #

The configuration object for mounting a file system.

openZFSCreateRootVolumeConfiguration_readOnly :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

openZFSCreateRootVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Natural) Source #

Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

openZFSCreateRootVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #

An object specifying how much storage users or groups can use on the volume.

OpenZFSFileSystemConfiguration

openZFSFileSystemConfiguration_automaticBackupRetentionDays :: Lens' OpenZFSFileSystemConfiguration (Maybe Natural) Source #

Undocumented member.

openZFSFileSystemConfiguration_copyTagsToBackups :: Lens' OpenZFSFileSystemConfiguration (Maybe Bool) Source #

A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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.

openZFSFileSystemConfiguration_copyTagsToVolumes :: Lens' OpenZFSFileSystemConfiguration (Maybe Bool) Source #

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

openZFSFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' OpenZFSFileSystemConfiguration (Maybe Text) Source #

Undocumented member.

openZFSFileSystemConfiguration_deploymentType :: Lens' OpenZFSFileSystemConfiguration (Maybe OpenZFSDeploymentType) Source #

Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 SINGLE_AZ_1 and SINGLE_AZ_2.

openZFSFileSystemConfiguration_diskIopsConfiguration :: Lens' OpenZFSFileSystemConfiguration (Maybe DiskIopsConfiguration) Source #

Undocumented member.

openZFSFileSystemConfiguration_rootVolumeId :: Lens' OpenZFSFileSystemConfiguration (Maybe Text) Source #

The ID of the root volume of the OpenZFS file system.

openZFSFileSystemConfiguration_throughputCapacity :: Lens' OpenZFSFileSystemConfiguration (Maybe Natural) Source #

The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

openZFSFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' OpenZFSFileSystemConfiguration (Maybe Text) Source #

Undocumented member.

OpenZFSNfsExport

openZFSNfsExport_clientConfigurations :: Lens' OpenZFSNfsExport [OpenZFSClientConfiguration] Source #

A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

OpenZFSOriginSnapshotConfiguration

openZFSOriginSnapshotConfiguration_copyStrategy :: Lens' OpenZFSOriginSnapshotConfiguration (Maybe OpenZFSCopyStrategy) Source #

The strategy used when copying data from the snapshot to the new volume.

  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
  • FULL_COPY - Copies all data from the snapshot to the new volume.

openZFSOriginSnapshotConfiguration_snapshotARN :: Lens' OpenZFSOriginSnapshotConfiguration (Maybe Text) Source #

Undocumented member.

OpenZFSUserOrGroupQuota

openZFSUserOrGroupQuota_type :: Lens' OpenZFSUserOrGroupQuota OpenZFSQuotaType Source #

A value that specifies whether the quota applies to a user or group.

openZFSUserOrGroupQuota_id :: Lens' OpenZFSUserOrGroupQuota Natural Source #

The ID of the user or group.

openZFSUserOrGroupQuota_storageCapacityQuotaGiB :: Lens' OpenZFSUserOrGroupQuota Natural Source #

The amount of storage that the user or group can use in gibibytes (GiB).

OpenZFSVolumeConfiguration

openZFSVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

openZFSVolumeConfiguration_dataCompressionType :: Lens' OpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

openZFSVolumeConfiguration_deleteClonedVolumes :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

openZFSVolumeConfiguration_deleteIntermediateSnaphots :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

openZFSVolumeConfiguration_nfsExports :: Lens' OpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #

The configuration object for mounting a Network File System (NFS) file system.

openZFSVolumeConfiguration_originSnapshot :: Lens' OpenZFSVolumeConfiguration (Maybe OpenZFSOriginSnapshotConfiguration) Source #

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

openZFSVolumeConfiguration_parentVolumeId :: Lens' OpenZFSVolumeConfiguration (Maybe Text) Source #

The ID of the parent volume.

openZFSVolumeConfiguration_readOnly :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether the volume is read-only.

openZFSVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural) Source #

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. Most workloads should use the default record size. For guidance on when to set a custom record size, see the /Amazon FSx for OpenZFS User Guide/.

openZFSVolumeConfiguration_restoreToSnapshot :: Lens' OpenZFSVolumeConfiguration (Maybe Text) Source #

Specifies the ID of the snapshot to which the volume was restored.

openZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural) Source #

The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

openZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural) Source #

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

openZFSVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #

An object specifying how much storage users or groups can use on the volume.

openZFSVolumeConfiguration_volumePath :: Lens' OpenZFSVolumeConfiguration (Maybe Text) Source #

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

S3DataRepositoryConfiguration

s3DataRepositoryConfiguration_autoExportPolicy :: Lens' S3DataRepositoryConfiguration (Maybe AutoExportPolicy) Source #

Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.

s3DataRepositoryConfiguration_autoImportPolicy :: Lens' S3DataRepositoryConfiguration (Maybe AutoImportPolicy) Source #

Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.

SelfManagedActiveDirectoryAttributes

selfManagedActiveDirectoryAttributes_dnsIps :: Lens' SelfManagedActiveDirectoryAttributes (Maybe (NonEmpty Text)) Source #

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

selfManagedActiveDirectoryAttributes_domainName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #

The fully qualified domain name of the self-managed AD directory.

selfManagedActiveDirectoryAttributes_fileSystemAdministratorsGroup :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #

The name of the domain group whose members have administrative privileges for the FSx file system.

selfManagedActiveDirectoryAttributes_organizationalUnitDistinguishedName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #

The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

selfManagedActiveDirectoryAttributes_userName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

SelfManagedActiveDirectoryConfiguration

selfManagedActiveDirectoryConfiguration_fileSystemAdministratorsGroup :: Lens' SelfManagedActiveDirectoryConfiguration (Maybe Text) Source #

(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.

selfManagedActiveDirectoryConfiguration_organizationalUnitDistinguishedName :: Lens' SelfManagedActiveDirectoryConfiguration (Maybe Text) Source #

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

selfManagedActiveDirectoryConfiguration_domainName :: Lens' SelfManagedActiveDirectoryConfiguration Text Source #

The fully qualified domain name of the self-managed AD directory, such as corp.example.com.

selfManagedActiveDirectoryConfiguration_userName :: Lens' SelfManagedActiveDirectoryConfiguration Text Source #

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.

selfManagedActiveDirectoryConfiguration_password :: Lens' SelfManagedActiveDirectoryConfiguration Text Source #

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

selfManagedActiveDirectoryConfiguration_dnsIps :: Lens' SelfManagedActiveDirectoryConfiguration (NonEmpty Text) Source #

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

SelfManagedActiveDirectoryConfigurationUpdates

selfManagedActiveDirectoryConfigurationUpdates_dnsIps :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe (NonEmpty Text)) Source #

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

selfManagedActiveDirectoryConfigurationUpdates_password :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe Text) Source #

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

selfManagedActiveDirectoryConfigurationUpdates_userName :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe Text) Source #

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName.

Snapshot

snapshot_administrativeActions :: Lens' Snapshot (Maybe [AdministrativeAction]) Source #

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

snapshot_creationTime :: Lens' Snapshot (Maybe UTCTime) Source #

Undocumented member.

snapshot_lifecycle :: Lens' Snapshot (Maybe SnapshotLifecycle) Source #

The lifecycle status of the snapshot.

  • PENDING - Amazon FSx hasn't started creating the snapshot.
  • CREATING - Amazon FSx is creating the snapshot.
  • DELETING - Amazon FSx is deleting the snapshot.
  • AVAILABLE - The snapshot is fully available.

snapshot_lifecycleTransitionReason :: Lens' Snapshot (Maybe LifecycleTransitionReason) Source #

Undocumented member.

snapshot_name :: Lens' Snapshot (Maybe Text) Source #

The name of the snapshot.

snapshot_resourceARN :: Lens' Snapshot (Maybe Text) Source #

Undocumented member.

snapshot_snapshotId :: Lens' Snapshot (Maybe Text) Source #

The ID of the snapshot.

snapshot_tags :: Lens' Snapshot (Maybe (NonEmpty Tag)) Source #

Undocumented member.

snapshot_volumeId :: Lens' Snapshot (Maybe Text) Source #

The ID of the volume that the snapshot is of.

SnapshotFilter

snapshotFilter_name :: Lens' SnapshotFilter (Maybe SnapshotFilterName) Source #

The name of the filter to use. You can filter by the file-system-id or by volume-id.

snapshotFilter_values :: Lens' SnapshotFilter (Maybe [Text]) Source #

The file-system-id or volume-id that you are filtering for.

StorageVirtualMachine

storageVirtualMachine_activeDirectoryConfiguration :: Lens' StorageVirtualMachine (Maybe SvmActiveDirectoryConfiguration) Source #

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

storageVirtualMachine_creationTime :: Lens' StorageVirtualMachine (Maybe UTCTime) Source #

Undocumented member.

storageVirtualMachine_endpoints :: Lens' StorageVirtualMachine (Maybe SvmEndpoints) Source #

The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

storageVirtualMachine_fileSystemId :: Lens' StorageVirtualMachine (Maybe Text) Source #

Undocumented member.

storageVirtualMachine_lifecycle :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineLifecycle) Source #

Describes the SVM's lifecycle status.

  • CREATED - The SVM is fully available for use.
  • CREATING - Amazon FSx is creating the new SVM.
  • DELETING - Amazon FSx is deleting an existing SVM.
  • FAILED - Amazon FSx was unable to create the SVM.
  • MISCONFIGURED - The SVM is in a failed but recoverable state.
  • PENDING - Amazon FSx has not started creating the SVM.

storageVirtualMachine_lifecycleTransitionReason :: Lens' StorageVirtualMachine (Maybe LifecycleTransitionReason) Source #

Describes why the SVM lifecycle state changed.

storageVirtualMachine_name :: Lens' StorageVirtualMachine (Maybe Text) Source #

The name of the SVM, if provisioned.

storageVirtualMachine_resourceARN :: Lens' StorageVirtualMachine (Maybe Text) Source #

Undocumented member.

storageVirtualMachine_rootVolumeSecurityStyle :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineRootVolumeSecurityStyle) Source #

The security style of the root volume of the SVM.

storageVirtualMachine_storageVirtualMachineId :: Lens' StorageVirtualMachine (Maybe Text) Source #

The SVM's system generated unique ID.

storageVirtualMachine_subtype :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineSubtype) Source #

Describes the SVM's subtype.

storageVirtualMachine_tags :: Lens' StorageVirtualMachine (Maybe (NonEmpty Tag)) Source #

Undocumented member.

storageVirtualMachine_uuid :: Lens' StorageVirtualMachine (Maybe Text) Source #

The SVM's UUID (universally unique identifier).

StorageVirtualMachineFilter

storageVirtualMachineFilter_name :: Lens' StorageVirtualMachineFilter (Maybe StorageVirtualMachineFilterName) Source #

The name for this filter.

storageVirtualMachineFilter_values :: Lens' StorageVirtualMachineFilter (Maybe [Text]) Source #

The values of the filter. These are all the values for any of the applied filters.

SvmActiveDirectoryConfiguration

svmActiveDirectoryConfiguration_netBiosName :: Lens' SvmActiveDirectoryConfiguration (Maybe Text) Source #

The NetBIOS name of the Active Directory computer object that is joined to your SVM.

svmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' SvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryAttributes) Source #

Undocumented member.

SvmEndpoint

svmEndpoint_dNSName :: Lens' SvmEndpoint (Maybe Text) Source #

Undocumented member.

svmEndpoint_ipAddresses :: Lens' SvmEndpoint (Maybe (NonEmpty Text)) Source #

The SVM endpoint's IP addresses.

SvmEndpoints

svmEndpoints_iscsi :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #

An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.

svmEndpoints_management :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #

An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.

svmEndpoints_nfs :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #

An endpoint for connecting using the Network File System (NFS) protocol.

svmEndpoints_smb :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #

An endpoint for connecting using the Server Message Block (SMB) protocol.

Tag

tag_key :: Lens' Tag Text Source #

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

tag_value :: Lens' Tag Text Source #

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

TieringPolicy

tieringPolicy_coolingPeriod :: Lens' TieringPolicy (Maybe Natural) Source #

Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

tieringPolicy_name :: Lens' TieringPolicy (Maybe TieringPolicyName) Source #

Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

  • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
  • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

UpdateFileCacheLustreConfiguration

updateFileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileCacheLustreConfiguration (Maybe Text) Source #

Undocumented member.

UpdateFileSystemLustreConfiguration

updateFileSystemLustreConfiguration_autoImportPolicy :: Lens' UpdateFileSystemLustreConfiguration (Maybe AutoImportPolicyType) Source #

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.
  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

The AutoImportPolicy parameter is not supported for Lustre file systems with the Persistent_2 deployment type. Instead, use to update a data repository association on your Persistent_2 file system.

updateFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemLustreConfiguration (Maybe Natural) Source #

Undocumented member.

updateFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemLustreConfiguration (Maybe Text) Source #

Undocumented member.

updateFileSystemLustreConfiguration_dataCompressionType :: Lens' UpdateFileSystemLustreConfiguration (Maybe DataCompressionType) Source #

Sets the data compression configuration for the file system. DataCompressionType can have the following values:

  • NONE - Data compression is turned off for the file system.
  • LZ4 - Data compression is turned on with the LZ4 algorithm.

If you don't use DataCompressionType, the file system retains its current data compression configuration.

For more information, see Lustre data compression.

updateFileSystemLustreConfiguration_logConfiguration :: Lens' UpdateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration) Source #

The Lustre logging configuration used when updating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

updateFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' UpdateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration) Source #

The Lustre root squash configuration used when updating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

updateFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemLustreConfiguration (Maybe Text) Source #

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

UpdateFileSystemOntapConfiguration

updateFileSystemOntapConfiguration_addRouteTableIds :: Lens' UpdateFileSystemOntapConfiguration (Maybe [Text]) Source #

(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.

updateFileSystemOntapConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemOntapConfiguration (Maybe Natural) Source #

Undocumented member.

updateFileSystemOntapConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text) Source #

Undocumented member.

updateFileSystemOntapConfiguration_diskIopsConfiguration :: Lens' UpdateFileSystemOntapConfiguration (Maybe DiskIopsConfiguration) Source #

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned.

updateFileSystemOntapConfiguration_fsxAdminPassword :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text) Source #

The ONTAP administrative password for the fsxadmin user.

updateFileSystemOntapConfiguration_removeRouteTableIds :: Lens' UpdateFileSystemOntapConfiguration (Maybe [Text]) Source #

(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.

updateFileSystemOntapConfiguration_throughputCapacity :: Lens' UpdateFileSystemOntapConfiguration (Maybe Natural) Source #

Specifies the throughput of an FSx for NetApp ONTAP file system, measured in megabytes per second (MBps). Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.

updateFileSystemOntapConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text) Source #

Undocumented member.

UpdateFileSystemOpenZFSConfiguration

updateFileSystemOpenZFSConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Natural) Source #

Undocumented member.

updateFileSystemOpenZFSConfiguration_copyTagsToBackups :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Bool) Source #

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.

updateFileSystemOpenZFSConfiguration_copyTagsToVolumes :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Bool) Source #

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

updateFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Text) Source #

Undocumented member.

updateFileSystemOpenZFSConfiguration_diskIopsConfiguration :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe DiskIopsConfiguration) Source #

Undocumented member.

updateFileSystemOpenZFSConfiguration_throughputCapacity :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Natural) Source #

The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second
 (MB/s). Valid values depend on the DeploymentType you choose, as follows:

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

updateFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Text) Source #

Undocumented member.

UpdateFileSystemWindowsConfiguration

updateFileSystemWindowsConfiguration_auditLogConfiguration :: Lens' UpdateFileSystemWindowsConfiguration (Maybe WindowsAuditLogCreateConfiguration) Source #

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system..

updateFileSystemWindowsConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Natural) Source #

The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups.

updateFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Text) Source #

The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00

updateFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' UpdateFileSystemWindowsConfiguration (Maybe SelfManagedActiveDirectoryConfigurationUpdates) Source #

The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.

updateFileSystemWindowsConfiguration_throughputCapacity :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Natural) Source #

Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.

updateFileSystemWindowsConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Text) Source #

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, with 1 = Monday and 7 = Sunday.

UpdateOntapVolumeConfiguration

updateOntapVolumeConfiguration_copyTagsToBackups :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool) Source #

A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume 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 volume, regardless of this value.

updateOntapVolumeConfiguration_junctionPath :: Lens' UpdateOntapVolumeConfiguration (Maybe Text) Source #

Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.

updateOntapVolumeConfiguration_securityStyle :: Lens' UpdateOntapVolumeConfiguration (Maybe SecurityStyle) Source #

The security style for the volume, which can be UNIX. NTFS, or MIXED.

updateOntapVolumeConfiguration_sizeInMegabytes :: Lens' UpdateOntapVolumeConfiguration (Maybe Natural) Source #

Specifies the size of the volume in megabytes.

updateOntapVolumeConfiguration_snapshotPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe Text) Source #

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

updateOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool) Source #

Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.

updateOntapVolumeConfiguration_tieringPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe TieringPolicy) Source #

Update the volume's data tiering policy.

UpdateOpenZFSVolumeConfiguration

updateOpenZFSVolumeConfiguration_dataCompressionType :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

updateOpenZFSVolumeConfiguration_nfsExports :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #

The configuration object for mounting a Network File System (NFS) file system.

updateOpenZFSVolumeConfiguration_readOnly :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Bool) Source #

A Boolean value indicating whether the volume is read-only.

updateOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Natural) Source #

Specifies 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. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

updateOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int) Source #

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

updateOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int) Source #

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of -1 to unset a volume's storage capacity reservation.

updateOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #

An object specifying how much storage users or groups can use on the volume.

UpdateSvmActiveDirectoryConfiguration

updateSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' UpdateSvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryConfigurationUpdates) Source #

Undocumented member.

Volume

volume_administrativeActions :: Lens' Volume (Maybe [AdministrativeAction]) Source #

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

volume_creationTime :: Lens' Volume (Maybe UTCTime) Source #

Undocumented member.

volume_fileSystemId :: Lens' Volume (Maybe Text) Source #

Undocumented member.

volume_lifecycle :: Lens' Volume (Maybe VolumeLifecycle) Source #

The lifecycle status of the volume.

  • AVAILABLE - The volume is fully available for use.
  • CREATED - The volume has been created.
  • CREATING - Amazon FSx is creating the new volume.
  • DELETING - Amazon FSx is deleting an existing volume.
  • FAILED - Amazon FSx was unable to create the volume.
  • MISCONFIGURED - The volume is in a failed but recoverable state.
  • PENDING - Amazon FSx hasn't started creating the volume.

volume_lifecycleTransitionReason :: Lens' Volume (Maybe LifecycleTransitionReason) Source #

The reason why the volume lifecycle status changed.

volume_name :: Lens' Volume (Maybe Text) Source #

The name of the volume.

volume_ontapConfiguration :: Lens' Volume (Maybe OntapVolumeConfiguration) Source #

Undocumented member.

volume_openZFSConfiguration :: Lens' Volume (Maybe OpenZFSVolumeConfiguration) Source #

The configuration of an Amazon FSx for OpenZFS volume.

volume_resourceARN :: Lens' Volume (Maybe Text) Source #

Undocumented member.

volume_tags :: Lens' Volume (Maybe (NonEmpty Tag)) Source #

Undocumented member.

volume_volumeId :: Lens' Volume (Maybe Text) Source #

The system-generated, unique ID of the volume.

volume_volumeType :: Lens' Volume (Maybe VolumeType) Source #

The type of the volume.

VolumeFilter

volumeFilter_name :: Lens' VolumeFilter (Maybe VolumeFilterName) Source #

The name for this filter.

volumeFilter_values :: Lens' VolumeFilter (Maybe [Text]) Source #

The values of the filter. These are all the values for any of the applied filters.

WindowsAuditLogConfiguration

windowsAuditLogConfiguration_auditLogDestination :: Lens' WindowsAuditLogConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.

The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

windowsAuditLogConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogConfiguration WindowsAccessAuditLogLevel Source #

Sets which attempt type is logged by Amazon FSx for file and folder accesses.

  • SUCCESS_ONLY - only successful attempts to access files or folders are logged.
  • FAILURE_ONLY - only failed attempts to access files or folders are logged.
  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
  • DISABLED - access auditing of files and folders is turned off.

windowsAuditLogConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogConfiguration WindowsAccessAuditLogLevel Source #

Sets which attempt type is logged by Amazon FSx for file share accesses.

  • SUCCESS_ONLY - only successful attempts to access file shares are logged.
  • FAILURE_ONLY - only failed attempts to access file shares are logged.
  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
  • DISABLED - access auditing of file shares is turned off.

WindowsAuditLogCreateConfiguration

windowsAuditLogCreateConfiguration_auditLogDestination :: Lens' WindowsAuditLogCreateConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) that specifies the destination of the audit logs.

The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:

  • The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
  • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.
  • If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
  • If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.
  • If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.

windowsAuditLogCreateConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel Source #

Sets which attempt type is logged by Amazon FSx for file and folder accesses.

  • SUCCESS_ONLY - only successful attempts to access files or folders are logged.
  • FAILURE_ONLY - only failed attempts to access files or folders are logged.
  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
  • DISABLED - access auditing of files and folders is turned off.

windowsAuditLogCreateConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel Source #

Sets which attempt type is logged by Amazon FSx for file share accesses.

  • SUCCESS_ONLY - only successful attempts to access file shares are logged.
  • FAILURE_ONLY - only failed attempts to access file shares are logged.
  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
  • DISABLED - access auditing of file shares is turned off.

WindowsFileSystemConfiguration

windowsFileSystemConfiguration_activeDirectoryId :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

windowsFileSystemConfiguration_aliases :: Lens' WindowsFileSystemConfiguration (Maybe [Alias]) Source #

Undocumented member.

windowsFileSystemConfiguration_auditLogConfiguration :: Lens' WindowsFileSystemConfiguration (Maybe WindowsAuditLogConfiguration) Source #

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

windowsFileSystemConfiguration_automaticBackupRetentionDays :: Lens' WindowsFileSystemConfiguration (Maybe Natural) Source #

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

windowsFileSystemConfiguration_copyTagsToBackups :: Lens' WindowsFileSystemConfiguration (Maybe Bool) Source #

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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.

windowsFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #

The preferred time to take daily automatic backups, in the UTC time zone.

windowsFileSystemConfiguration_deploymentType :: Lens' WindowsFileSystemConfiguration (Maybe WindowsDeploymentType) Source #

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
  • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

For more information, see Single-AZ and Multi-AZ File Systems.

windowsFileSystemConfiguration_maintenanceOperationsInProgress :: Lens' WindowsFileSystemConfiguration (Maybe [FileSystemMaintenanceOperation]) Source #

The list of maintenance operations in progress for this file system.

windowsFileSystemConfiguration_preferredFileServerIp :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

windowsFileSystemConfiguration_preferredSubnetId :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

windowsFileSystemConfiguration_remoteAdministrationEndpoint :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

windowsFileSystemConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' WindowsFileSystemConfiguration (Maybe SelfManagedActiveDirectoryAttributes) Source #

Undocumented member.

windowsFileSystemConfiguration_throughputCapacity :: Lens' WindowsFileSystemConfiguration (Maybe Natural) Source #

The throughput of the Amazon FSx file system, measured in megabytes per second.

windowsFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #

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