| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.FSx
Contents
- Service Configuration
- Errors
- ActiveDirectoryError
- BackupBeingCopied
- BackupInProgress
- BackupNotFound
- BackupRestoring
- BadRequest
- DataRepositoryAssociationNotFound
- DataRepositoryTaskEnded
- DataRepositoryTaskExecuting
- DataRepositoryTaskNotFound
- FileCacheNotFound
- FileSystemNotFound
- IncompatibleParameterError
- IncompatibleRegionForMultiAZ
- InternalServerError
- InvalidDataRepositoryType
- InvalidDestinationKmsKey
- InvalidExportPath
- InvalidImportPath
- InvalidNetworkSettings
- InvalidPerUnitStorageThroughput
- InvalidRegion
- InvalidSourceKmsKey
- MissingFileCacheConfiguration
- MissingFileSystemConfiguration
- MissingVolumeConfiguration
- NotServiceResourceError
- ResourceDoesNotSupportTagging
- ResourceNotFound
- ServiceLimitExceeded
- SnapshotNotFound
- SourceBackupUnavailable
- StorageVirtualMachineNotFound
- UnsupportedOperation
- VolumeNotFound
- Waiters
- Operations
- AssociateFileSystemAliases
- CancelDataRepositoryTask
- CopyBackup
- CreateBackup
- CreateDataRepositoryAssociation
- CreateDataRepositoryTask
- CreateFileCache
- CreateFileSystem
- CreateFileSystemFromBackup
- CreateSnapshot
- CreateStorageVirtualMachine
- CreateVolume
- CreateVolumeFromBackup
- DeleteBackup
- DeleteDataRepositoryAssociation
- DeleteFileCache
- DeleteFileSystem
- DeleteSnapshot
- DeleteStorageVirtualMachine
- DeleteVolume
- DescribeBackups (Paginated)
- DescribeDataRepositoryAssociations
- DescribeDataRepositoryTasks
- DescribeFileCaches
- DescribeFileSystemAliases
- DescribeFileSystems (Paginated)
- DescribeSnapshots
- DescribeStorageVirtualMachines (Paginated)
- DescribeVolumes (Paginated)
- DisassociateFileSystemAliases
- ListTagsForResource (Paginated)
- ReleaseFileSystemNfsV3Locks
- RestoreVolumeFromSnapshot
- TagResource
- UntagResource
- UpdateDataRepositoryAssociation
- UpdateFileCache
- UpdateFileSystem
- UpdateSnapshot
- UpdateStorageVirtualMachine
- UpdateVolume
- Types
- AdministrativeActionType
- AliasLifecycle
- AutoImportPolicyType
- BackupLifecycle
- BackupType
- DataCompressionType
- DataRepositoryLifecycle
- DataRepositoryTaskFilterName
- DataRepositoryTaskLifecycle
- DataRepositoryTaskType
- DeleteFileSystemOpenZFSOption
- DeleteOpenZFSVolumeOption
- DiskIopsConfigurationMode
- DriveCacheType
- EventType
- FileCacheLifecycle
- FileCacheLustreDeploymentType
- FileCacheType
- FileSystemLifecycle
- FileSystemMaintenanceOperation
- FileSystemType
- FilterName
- FlexCacheEndpointType
- InputOntapVolumeType
- LustreAccessAuditLogLevel
- LustreDeploymentType
- NfsVersion
- OntapDeploymentType
- OntapVolumeType
- OpenZFSCopyStrategy
- OpenZFSDataCompressionType
- OpenZFSDeploymentType
- OpenZFSQuotaType
- ReportFormat
- ReportScope
- ResourceType
- RestoreOpenZFSVolumeOption
- SecurityStyle
- SnapshotFilterName
- SnapshotLifecycle
- Status
- StorageType
- StorageVirtualMachineFilterName
- StorageVirtualMachineLifecycle
- StorageVirtualMachineRootVolumeSecurityStyle
- StorageVirtualMachineSubtype
- TieringPolicyName
- VolumeFilterName
- VolumeLifecycle
- VolumeType
- WindowsAccessAuditLogLevel
- WindowsDeploymentType
- ActiveDirectoryBackupAttributes
- AdministrativeAction
- AdministrativeActionFailureDetails
- Alias
- AutoExportPolicy
- AutoImportPolicy
- Backup
- BackupFailureDetails
- CompletionReport
- CreateFileCacheLustreConfiguration
- CreateFileSystemLustreConfiguration
- CreateFileSystemOntapConfiguration
- CreateFileSystemOpenZFSConfiguration
- CreateFileSystemWindowsConfiguration
- CreateOntapVolumeConfiguration
- CreateOpenZFSOriginSnapshotConfiguration
- CreateOpenZFSVolumeConfiguration
- CreateSvmActiveDirectoryConfiguration
- DataRepositoryAssociation
- DataRepositoryConfiguration
- DataRepositoryFailureDetails
- DataRepositoryTask
- DataRepositoryTaskFailureDetails
- DataRepositoryTaskFilter
- DataRepositoryTaskStatus
- DeleteFileSystemLustreConfiguration
- DeleteFileSystemLustreResponse
- DeleteFileSystemOpenZFSConfiguration
- DeleteFileSystemOpenZFSResponse
- DeleteFileSystemWindowsConfiguration
- DeleteFileSystemWindowsResponse
- DeleteVolumeOntapConfiguration
- DeleteVolumeOntapResponse
- DeleteVolumeOpenZFSConfiguration
- DiskIopsConfiguration
- FileCache
- FileCacheCreating
- FileCacheDataRepositoryAssociation
- FileCacheFailureDetails
- FileCacheLustreConfiguration
- FileCacheLustreMetadataConfiguration
- FileCacheNFSConfiguration
- FileSystem
- FileSystemEndpoint
- FileSystemEndpoints
- FileSystemFailureDetails
- Filter
- LifecycleTransitionReason
- LustreFileSystemConfiguration
- LustreLogConfiguration
- LustreLogCreateConfiguration
- LustreRootSquashConfiguration
- NFSDataRepositoryConfiguration
- OntapFileSystemConfiguration
- OntapVolumeConfiguration
- OpenZFSClientConfiguration
- OpenZFSCreateRootVolumeConfiguration
- OpenZFSFileSystemConfiguration
- OpenZFSNfsExport
- OpenZFSOriginSnapshotConfiguration
- OpenZFSUserOrGroupQuota
- OpenZFSVolumeConfiguration
- S3DataRepositoryConfiguration
- SelfManagedActiveDirectoryAttributes
- SelfManagedActiveDirectoryConfiguration
- SelfManagedActiveDirectoryConfigurationUpdates
- Snapshot
- SnapshotFilter
- StorageVirtualMachine
- StorageVirtualMachineFilter
- SvmActiveDirectoryConfiguration
- SvmEndpoint
- SvmEndpoints
- Tag
- TieringPolicy
- UpdateFileCacheLustreConfiguration
- UpdateFileSystemLustreConfiguration
- UpdateFileSystemOntapConfiguration
- UpdateFileSystemOpenZFSConfiguration
- UpdateFileSystemWindowsConfiguration
- UpdateOntapVolumeConfiguration
- UpdateOpenZFSVolumeConfiguration
- UpdateSvmActiveDirectoryConfiguration
- Volume
- VolumeFilter
- WindowsAuditLogConfiguration
- WindowsAuditLogCreateConfiguration
- WindowsFileSystemConfiguration
Description
Derived from API version 2018-03-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
Synopsis
- defaultService :: Service
- _ActiveDirectoryError :: AsError a => Fold a ServiceError
- _BackupBeingCopied :: AsError a => Fold a ServiceError
- _BackupInProgress :: AsError a => Fold a ServiceError
- _BackupNotFound :: AsError a => Fold a ServiceError
- _BackupRestoring :: AsError a => Fold a ServiceError
- _BadRequest :: AsError a => Fold a ServiceError
- _DataRepositoryAssociationNotFound :: AsError a => Fold a ServiceError
- _DataRepositoryTaskEnded :: AsError a => Fold a ServiceError
- _DataRepositoryTaskExecuting :: AsError a => Fold a ServiceError
- _DataRepositoryTaskNotFound :: AsError a => Fold a ServiceError
- _FileCacheNotFound :: AsError a => Fold a ServiceError
- _FileSystemNotFound :: AsError a => Fold a ServiceError
- _IncompatibleParameterError :: AsError a => Fold a ServiceError
- _IncompatibleRegionForMultiAZ :: AsError a => Fold a ServiceError
- _InternalServerError :: AsError a => Fold a ServiceError
- _InvalidDataRepositoryType :: AsError a => Fold a ServiceError
- _InvalidDestinationKmsKey :: AsError a => Fold a ServiceError
- _InvalidExportPath :: AsError a => Fold a ServiceError
- _InvalidImportPath :: AsError a => Fold a ServiceError
- _InvalidNetworkSettings :: AsError a => Fold a ServiceError
- _InvalidPerUnitStorageThroughput :: AsError a => Fold a ServiceError
- _InvalidRegion :: AsError a => Fold a ServiceError
- _InvalidSourceKmsKey :: AsError a => Fold a ServiceError
- _MissingFileCacheConfiguration :: AsError a => Fold a ServiceError
- _MissingFileSystemConfiguration :: AsError a => Fold a ServiceError
- _MissingVolumeConfiguration :: AsError a => Fold a ServiceError
- _NotServiceResourceError :: AsError a => Fold a ServiceError
- _ResourceDoesNotSupportTagging :: AsError a => Fold a ServiceError
- _ResourceNotFound :: AsError a => Fold a ServiceError
- _ServiceLimitExceeded :: AsError a => Fold a ServiceError
- _SnapshotNotFound :: AsError a => Fold a ServiceError
- _SourceBackupUnavailable :: AsError a => Fold a ServiceError
- _StorageVirtualMachineNotFound :: AsError a => Fold a ServiceError
- _UnsupportedOperation :: AsError a => Fold a ServiceError
- _VolumeNotFound :: AsError a => Fold a ServiceError
- data AssociateFileSystemAliases = AssociateFileSystemAliases' (Maybe Text) Text [Text]
- newAssociateFileSystemAliases :: Text -> AssociateFileSystemAliases
- data AssociateFileSystemAliasesResponse = AssociateFileSystemAliasesResponse' (Maybe [Alias]) Int
- newAssociateFileSystemAliasesResponse :: Int -> AssociateFileSystemAliasesResponse
- data CancelDataRepositoryTask = CancelDataRepositoryTask' Text
- newCancelDataRepositoryTask :: Text -> CancelDataRepositoryTask
- data CancelDataRepositoryTaskResponse = CancelDataRepositoryTaskResponse' (Maybe DataRepositoryTaskLifecycle) (Maybe Text) Int
- newCancelDataRepositoryTaskResponse :: Int -> CancelDataRepositoryTaskResponse
- data CopyBackup = CopyBackup' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text
- newCopyBackup :: Text -> CopyBackup
- data CopyBackupResponse = CopyBackupResponse' (Maybe Backup) Int
- newCopyBackupResponse :: Int -> CopyBackupResponse
- data CreateBackup = CreateBackup' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text)
- newCreateBackup :: CreateBackup
- data CreateBackupResponse = CreateBackupResponse' (Maybe Backup) Int
- newCreateBackupResponse :: Int -> CreateBackupResponse
- data CreateDataRepositoryAssociation = CreateDataRepositoryAssociation' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe S3DataRepositoryConfiguration) (Maybe (NonEmpty Tag)) Text Text
- newCreateDataRepositoryAssociation :: Text -> Text -> CreateDataRepositoryAssociation
- data CreateDataRepositoryAssociationResponse = CreateDataRepositoryAssociationResponse' (Maybe DataRepositoryAssociation) Int
- newCreateDataRepositoryAssociationResponse :: Int -> CreateDataRepositoryAssociationResponse
- data CreateDataRepositoryTask = CreateDataRepositoryTask' (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty Tag)) DataRepositoryTaskType Text CompletionReport
- newCreateDataRepositoryTask :: DataRepositoryTaskType -> Text -> CompletionReport -> CreateDataRepositoryTask
- data CreateDataRepositoryTaskResponse = CreateDataRepositoryTaskResponse' (Maybe DataRepositoryTask) Int
- newCreateDataRepositoryTaskResponse :: Int -> CreateDataRepositoryTaskResponse
- data CreateFileCache = CreateFileCache' (Maybe Text) (Maybe Bool) (Maybe [FileCacheDataRepositoryAssociation]) (Maybe Text) (Maybe CreateFileCacheLustreConfiguration) (Maybe [Text]) (Maybe (NonEmpty Tag)) FileCacheType Text Natural [Text]
- newCreateFileCache :: FileCacheType -> Text -> Natural -> CreateFileCache
- data CreateFileCacheResponse = CreateFileCacheResponse' (Maybe FileCacheCreating) Int
- newCreateFileCacheResponse :: Int -> CreateFileCacheResponse
- data CreateFileSystem = CreateFileSystem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CreateFileSystemLustreConfiguration) (Maybe CreateFileSystemOntapConfiguration) (Maybe CreateFileSystemOpenZFSConfiguration) (Maybe [Text]) (Maybe StorageType) (Maybe (NonEmpty Tag)) (Maybe CreateFileSystemWindowsConfiguration) FileSystemType Natural [Text]
- newCreateFileSystem :: FileSystemType -> Natural -> CreateFileSystem
- data CreateFileSystemResponse = CreateFileSystemResponse' (Maybe FileSystem) Int
- newCreateFileSystemResponse :: Int -> CreateFileSystemResponse
- data CreateFileSystemFromBackup = CreateFileSystemFromBackup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CreateFileSystemLustreConfiguration) (Maybe CreateFileSystemOpenZFSConfiguration) (Maybe [Text]) (Maybe Natural) (Maybe StorageType) (Maybe (NonEmpty Tag)) (Maybe CreateFileSystemWindowsConfiguration) Text [Text]
- newCreateFileSystemFromBackup :: Text -> CreateFileSystemFromBackup
- data CreateFileSystemFromBackupResponse = CreateFileSystemFromBackupResponse' (Maybe FileSystem) Int
- newCreateFileSystemFromBackupResponse :: Int -> CreateFileSystemFromBackupResponse
- data CreateSnapshot = CreateSnapshot' (Maybe Text) (Maybe (NonEmpty Tag)) Text Text
- newCreateSnapshot :: Text -> Text -> CreateSnapshot
- data CreateSnapshotResponse = CreateSnapshotResponse' (Maybe Snapshot) Int
- newCreateSnapshotResponse :: Int -> CreateSnapshotResponse
- data CreateStorageVirtualMachine = CreateStorageVirtualMachine' (Maybe CreateSvmActiveDirectoryConfiguration) (Maybe Text) (Maybe StorageVirtualMachineRootVolumeSecurityStyle) (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) Text Text
- newCreateStorageVirtualMachine :: Text -> Text -> CreateStorageVirtualMachine
- data CreateStorageVirtualMachineResponse = CreateStorageVirtualMachineResponse' (Maybe StorageVirtualMachine) Int
- newCreateStorageVirtualMachineResponse :: Int -> CreateStorageVirtualMachineResponse
- data CreateVolume = CreateVolume' (Maybe Text) (Maybe CreateOntapVolumeConfiguration) (Maybe CreateOpenZFSVolumeConfiguration) (Maybe (NonEmpty Tag)) VolumeType Text
- newCreateVolume :: VolumeType -> Text -> CreateVolume
- data CreateVolumeResponse = CreateVolumeResponse' (Maybe Volume) Int
- newCreateVolumeResponse :: Int -> CreateVolumeResponse
- data CreateVolumeFromBackup = CreateVolumeFromBackup' (Maybe Text) (Maybe CreateOntapVolumeConfiguration) (Maybe (NonEmpty Tag)) Text Text
- newCreateVolumeFromBackup :: Text -> Text -> CreateVolumeFromBackup
- data CreateVolumeFromBackupResponse = CreateVolumeFromBackupResponse' (Maybe Volume) Int
- newCreateVolumeFromBackupResponse :: Int -> CreateVolumeFromBackupResponse
- data DeleteBackup = DeleteBackup' (Maybe Text) Text
- newDeleteBackup :: Text -> DeleteBackup
- data DeleteBackupResponse = DeleteBackupResponse' (Maybe Text) (Maybe BackupLifecycle) Int
- newDeleteBackupResponse :: Int -> DeleteBackupResponse
- data DeleteDataRepositoryAssociation = DeleteDataRepositoryAssociation' (Maybe Text) (Maybe Bool) Text
- newDeleteDataRepositoryAssociation :: Text -> DeleteDataRepositoryAssociation
- data DeleteDataRepositoryAssociationResponse = DeleteDataRepositoryAssociationResponse' (Maybe Text) (Maybe Bool) (Maybe DataRepositoryLifecycle) Int
- newDeleteDataRepositoryAssociationResponse :: Int -> DeleteDataRepositoryAssociationResponse
- data DeleteFileCache = DeleteFileCache' (Maybe Text) Text
- newDeleteFileCache :: Text -> DeleteFileCache
- data DeleteFileCacheResponse = DeleteFileCacheResponse' (Maybe Text) (Maybe FileCacheLifecycle) Int
- newDeleteFileCacheResponse :: Int -> DeleteFileCacheResponse
- data DeleteFileSystem = DeleteFileSystem' (Maybe Text) (Maybe DeleteFileSystemLustreConfiguration) (Maybe DeleteFileSystemOpenZFSConfiguration) (Maybe DeleteFileSystemWindowsConfiguration) Text
- newDeleteFileSystem :: Text -> DeleteFileSystem
- data DeleteFileSystemResponse = DeleteFileSystemResponse' (Maybe Text) (Maybe FileSystemLifecycle) (Maybe DeleteFileSystemLustreResponse) (Maybe DeleteFileSystemOpenZFSResponse) (Maybe DeleteFileSystemWindowsResponse) Int
- newDeleteFileSystemResponse :: Int -> DeleteFileSystemResponse
- data DeleteSnapshot = DeleteSnapshot' (Maybe Text) Text
- newDeleteSnapshot :: Text -> DeleteSnapshot
- data DeleteSnapshotResponse = DeleteSnapshotResponse' (Maybe SnapshotLifecycle) (Maybe Text) Int
- newDeleteSnapshotResponse :: Int -> DeleteSnapshotResponse
- data DeleteStorageVirtualMachine = DeleteStorageVirtualMachine' (Maybe Text) Text
- newDeleteStorageVirtualMachine :: Text -> DeleteStorageVirtualMachine
- data DeleteStorageVirtualMachineResponse = DeleteStorageVirtualMachineResponse' (Maybe StorageVirtualMachineLifecycle) (Maybe Text) Int
- newDeleteStorageVirtualMachineResponse :: Int -> DeleteStorageVirtualMachineResponse
- data DeleteVolume = DeleteVolume' (Maybe Text) (Maybe DeleteVolumeOntapConfiguration) (Maybe DeleteVolumeOpenZFSConfiguration) Text
- newDeleteVolume :: Text -> DeleteVolume
- data DeleteVolumeResponse = DeleteVolumeResponse' (Maybe VolumeLifecycle) (Maybe DeleteVolumeOntapResponse) (Maybe Text) Int
- newDeleteVolumeResponse :: Int -> DeleteVolumeResponse
- data DescribeBackups = DescribeBackups' (Maybe [Text]) (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newDescribeBackups :: DescribeBackups
- data DescribeBackupsResponse = DescribeBackupsResponse' (Maybe [Backup]) (Maybe Text) Int
- newDescribeBackupsResponse :: Int -> DescribeBackupsResponse
- data DescribeDataRepositoryAssociations = DescribeDataRepositoryAssociations' (Maybe [Text]) (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newDescribeDataRepositoryAssociations :: DescribeDataRepositoryAssociations
- data DescribeDataRepositoryAssociationsResponse = DescribeDataRepositoryAssociationsResponse' (Maybe [DataRepositoryAssociation]) (Maybe Text) Int
- newDescribeDataRepositoryAssociationsResponse :: Int -> DescribeDataRepositoryAssociationsResponse
- data DescribeDataRepositoryTasks = DescribeDataRepositoryTasks' (Maybe [DataRepositoryTaskFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribeDataRepositoryTasks :: DescribeDataRepositoryTasks
- data DescribeDataRepositoryTasksResponse = DescribeDataRepositoryTasksResponse' (Maybe [DataRepositoryTask]) (Maybe Text) Int
- newDescribeDataRepositoryTasksResponse :: Int -> DescribeDataRepositoryTasksResponse
- data DescribeFileCaches = DescribeFileCaches' (Maybe [Text]) (Maybe Natural) (Maybe Text)
- newDescribeFileCaches :: DescribeFileCaches
- data DescribeFileCachesResponse = DescribeFileCachesResponse' (Maybe [FileCache]) (Maybe Text) Int
- newDescribeFileCachesResponse :: Int -> DescribeFileCachesResponse
- data DescribeFileSystemAliases = DescribeFileSystemAliases' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeFileSystemAliases :: Text -> DescribeFileSystemAliases
- data DescribeFileSystemAliasesResponse = DescribeFileSystemAliasesResponse' (Maybe [Alias]) (Maybe Text) Int
- newDescribeFileSystemAliasesResponse :: Int -> DescribeFileSystemAliasesResponse
- data DescribeFileSystems = DescribeFileSystems' (Maybe [Text]) (Maybe Natural) (Maybe Text)
- newDescribeFileSystems :: DescribeFileSystems
- data DescribeFileSystemsResponse = DescribeFileSystemsResponse' (Maybe [FileSystem]) (Maybe Text) Int
- newDescribeFileSystemsResponse :: Int -> DescribeFileSystemsResponse
- data DescribeSnapshots = DescribeSnapshots' (Maybe [SnapshotFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribeSnapshots :: DescribeSnapshots
- data DescribeSnapshotsResponse = DescribeSnapshotsResponse' (Maybe Text) (Maybe [Snapshot]) Int
- newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- data DescribeStorageVirtualMachines = DescribeStorageVirtualMachines' (Maybe [StorageVirtualMachineFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribeStorageVirtualMachines :: DescribeStorageVirtualMachines
- data DescribeStorageVirtualMachinesResponse = DescribeStorageVirtualMachinesResponse' (Maybe Text) (Maybe [StorageVirtualMachine]) Int
- newDescribeStorageVirtualMachinesResponse :: Int -> DescribeStorageVirtualMachinesResponse
- data DescribeVolumes = DescribeVolumes' (Maybe [VolumeFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text])
- newDescribeVolumes :: DescribeVolumes
- data DescribeVolumesResponse = DescribeVolumesResponse' (Maybe Text) (Maybe [Volume]) Int
- newDescribeVolumesResponse :: Int -> DescribeVolumesResponse
- data DisassociateFileSystemAliases = DisassociateFileSystemAliases' (Maybe Text) Text [Text]
- newDisassociateFileSystemAliases :: Text -> DisassociateFileSystemAliases
- data DisassociateFileSystemAliasesResponse = DisassociateFileSystemAliasesResponse' (Maybe [Alias]) Int
- newDisassociateFileSystemAliasesResponse :: Int -> DisassociateFileSystemAliasesResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ReleaseFileSystemNfsV3Locks = ReleaseFileSystemNfsV3Locks' (Maybe Text) Text
- newReleaseFileSystemNfsV3Locks :: Text -> ReleaseFileSystemNfsV3Locks
- data ReleaseFileSystemNfsV3LocksResponse = ReleaseFileSystemNfsV3LocksResponse' (Maybe FileSystem) Int
- newReleaseFileSystemNfsV3LocksResponse :: Int -> ReleaseFileSystemNfsV3LocksResponse
- data RestoreVolumeFromSnapshot = RestoreVolumeFromSnapshot' (Maybe Text) (Maybe [RestoreOpenZFSVolumeOption]) Text Text
- newRestoreVolumeFromSnapshot :: Text -> Text -> RestoreVolumeFromSnapshot
- data RestoreVolumeFromSnapshotResponse = RestoreVolumeFromSnapshotResponse' (Maybe [AdministrativeAction]) (Maybe VolumeLifecycle) (Maybe Text) Int
- newRestoreVolumeFromSnapshotResponse :: Int -> RestoreVolumeFromSnapshotResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDataRepositoryAssociation = UpdateDataRepositoryAssociation' (Maybe Text) (Maybe Natural) (Maybe S3DataRepositoryConfiguration) Text
- newUpdateDataRepositoryAssociation :: Text -> UpdateDataRepositoryAssociation
- data UpdateDataRepositoryAssociationResponse = UpdateDataRepositoryAssociationResponse' (Maybe DataRepositoryAssociation) Int
- newUpdateDataRepositoryAssociationResponse :: Int -> UpdateDataRepositoryAssociationResponse
- data UpdateFileCache = UpdateFileCache' (Maybe Text) (Maybe UpdateFileCacheLustreConfiguration) Text
- newUpdateFileCache :: Text -> UpdateFileCache
- data UpdateFileCacheResponse = UpdateFileCacheResponse' (Maybe FileCache) Int
- newUpdateFileCacheResponse :: Int -> UpdateFileCacheResponse
- data UpdateFileSystem = UpdateFileSystem' (Maybe Text) (Maybe UpdateFileSystemLustreConfiguration) (Maybe UpdateFileSystemOntapConfiguration) (Maybe UpdateFileSystemOpenZFSConfiguration) (Maybe Natural) (Maybe UpdateFileSystemWindowsConfiguration) Text
- newUpdateFileSystem :: Text -> UpdateFileSystem
- data UpdateFileSystemResponse = UpdateFileSystemResponse' (Maybe FileSystem) Int
- newUpdateFileSystemResponse :: Int -> UpdateFileSystemResponse
- data UpdateSnapshot = UpdateSnapshot' (Maybe Text) Text Text
- newUpdateSnapshot :: Text -> Text -> UpdateSnapshot
- data UpdateSnapshotResponse = UpdateSnapshotResponse' (Maybe Snapshot) Int
- newUpdateSnapshotResponse :: Int -> UpdateSnapshotResponse
- data UpdateStorageVirtualMachine = UpdateStorageVirtualMachine' (Maybe UpdateSvmActiveDirectoryConfiguration) (Maybe Text) (Maybe (Sensitive Text)) Text
- newUpdateStorageVirtualMachine :: Text -> UpdateStorageVirtualMachine
- data UpdateStorageVirtualMachineResponse = UpdateStorageVirtualMachineResponse' (Maybe StorageVirtualMachine) Int
- newUpdateStorageVirtualMachineResponse :: Int -> UpdateStorageVirtualMachineResponse
- data UpdateVolume = UpdateVolume' (Maybe Text) (Maybe Text) (Maybe UpdateOntapVolumeConfiguration) (Maybe UpdateOpenZFSVolumeConfiguration) Text
- newUpdateVolume :: Text -> UpdateVolume
- data UpdateVolumeResponse = UpdateVolumeResponse' (Maybe Volume) Int
- newUpdateVolumeResponse :: Int -> UpdateVolumeResponse
- newtype AdministrativeActionType where
- AdministrativeActionType' { }
- pattern AdministrativeActionType_FILE_SYSTEM_ALIAS_ASSOCIATION :: AdministrativeActionType
- pattern AdministrativeActionType_FILE_SYSTEM_ALIAS_DISASSOCIATION :: AdministrativeActionType
- pattern AdministrativeActionType_FILE_SYSTEM_UPDATE :: AdministrativeActionType
- pattern AdministrativeActionType_RELEASE_NFS_V3_LOCKS :: AdministrativeActionType
- pattern AdministrativeActionType_SNAPSHOT_UPDATE :: AdministrativeActionType
- pattern AdministrativeActionType_STORAGE_OPTIMIZATION :: AdministrativeActionType
- pattern AdministrativeActionType_VOLUME_RESTORE :: AdministrativeActionType
- pattern AdministrativeActionType_VOLUME_UPDATE :: AdministrativeActionType
- newtype AliasLifecycle where
- AliasLifecycle' { }
- pattern AliasLifecycle_AVAILABLE :: AliasLifecycle
- pattern AliasLifecycle_CREATE_FAILED :: AliasLifecycle
- pattern AliasLifecycle_CREATING :: AliasLifecycle
- pattern AliasLifecycle_DELETE_FAILED :: AliasLifecycle
- pattern AliasLifecycle_DELETING :: AliasLifecycle
- newtype AutoImportPolicyType where
- newtype BackupLifecycle where
- BackupLifecycle' { }
- pattern BackupLifecycle_AVAILABLE :: BackupLifecycle
- pattern BackupLifecycle_COPYING :: BackupLifecycle
- pattern BackupLifecycle_CREATING :: BackupLifecycle
- pattern BackupLifecycle_DELETED :: BackupLifecycle
- pattern BackupLifecycle_FAILED :: BackupLifecycle
- pattern BackupLifecycle_PENDING :: BackupLifecycle
- pattern BackupLifecycle_TRANSFERRING :: BackupLifecycle
- newtype BackupType where
- BackupType' { }
- pattern BackupType_AUTOMATIC :: BackupType
- pattern BackupType_AWS_BACKUP :: BackupType
- pattern BackupType_USER_INITIATED :: BackupType
- newtype DataCompressionType where
- DataCompressionType' { }
- pattern DataCompressionType_LZ4 :: DataCompressionType
- pattern DataCompressionType_NONE :: DataCompressionType
- newtype DataRepositoryLifecycle where
- DataRepositoryLifecycle' { }
- pattern DataRepositoryLifecycle_AVAILABLE :: DataRepositoryLifecycle
- pattern DataRepositoryLifecycle_CREATING :: DataRepositoryLifecycle
- pattern DataRepositoryLifecycle_DELETING :: DataRepositoryLifecycle
- pattern DataRepositoryLifecycle_FAILED :: DataRepositoryLifecycle
- pattern DataRepositoryLifecycle_MISCONFIGURED :: DataRepositoryLifecycle
- pattern DataRepositoryLifecycle_UPDATING :: DataRepositoryLifecycle
- newtype DataRepositoryTaskFilterName where
- DataRepositoryTaskFilterName' { }
- pattern DataRepositoryTaskFilterName_Data_repository_association_id :: DataRepositoryTaskFilterName
- pattern DataRepositoryTaskFilterName_File_cache_id :: DataRepositoryTaskFilterName
- pattern DataRepositoryTaskFilterName_File_system_id :: DataRepositoryTaskFilterName
- pattern DataRepositoryTaskFilterName_Task_lifecycle :: DataRepositoryTaskFilterName
- newtype DataRepositoryTaskLifecycle where
- DataRepositoryTaskLifecycle' { }
- pattern DataRepositoryTaskLifecycle_CANCELED :: DataRepositoryTaskLifecycle
- pattern DataRepositoryTaskLifecycle_CANCELING :: DataRepositoryTaskLifecycle
- pattern DataRepositoryTaskLifecycle_EXECUTING :: DataRepositoryTaskLifecycle
- pattern DataRepositoryTaskLifecycle_FAILED :: DataRepositoryTaskLifecycle
- pattern DataRepositoryTaskLifecycle_PENDING :: DataRepositoryTaskLifecycle
- pattern DataRepositoryTaskLifecycle_SUCCEEDED :: DataRepositoryTaskLifecycle
- newtype DataRepositoryTaskType where
- DataRepositoryTaskType' { }
- pattern DataRepositoryTaskType_AUTO_RELEASE_DATA :: DataRepositoryTaskType
- pattern DataRepositoryTaskType_EXPORT_TO_REPOSITORY :: DataRepositoryTaskType
- pattern DataRepositoryTaskType_IMPORT_METADATA_FROM_REPOSITORY :: DataRepositoryTaskType
- pattern DataRepositoryTaskType_RELEASE_DATA_FROM_FILESYSTEM :: DataRepositoryTaskType
- newtype DeleteFileSystemOpenZFSOption where
- newtype DeleteOpenZFSVolumeOption where
- newtype DiskIopsConfigurationMode where
- newtype DriveCacheType where
- DriveCacheType' { }
- pattern DriveCacheType_NONE :: DriveCacheType
- pattern DriveCacheType_READ :: DriveCacheType
- newtype EventType where
- EventType' { }
- pattern EventType_CHANGED :: EventType
- pattern EventType_DELETED :: EventType
- pattern EventType_NEW :: EventType
- newtype FileCacheLifecycle where
- FileCacheLifecycle' { }
- pattern FileCacheLifecycle_AVAILABLE :: FileCacheLifecycle
- pattern FileCacheLifecycle_CREATING :: FileCacheLifecycle
- pattern FileCacheLifecycle_DELETING :: FileCacheLifecycle
- pattern FileCacheLifecycle_FAILED :: FileCacheLifecycle
- pattern FileCacheLifecycle_UPDATING :: FileCacheLifecycle
- newtype FileCacheLustreDeploymentType where
- newtype FileCacheType where
- FileCacheType' { }
- pattern FileCacheType_LUSTRE :: FileCacheType
- newtype FileSystemLifecycle where
- FileSystemLifecycle' { }
- pattern FileSystemLifecycle_AVAILABLE :: FileSystemLifecycle
- pattern FileSystemLifecycle_CREATING :: FileSystemLifecycle
- pattern FileSystemLifecycle_DELETING :: FileSystemLifecycle
- pattern FileSystemLifecycle_FAILED :: FileSystemLifecycle
- pattern FileSystemLifecycle_MISCONFIGURED :: FileSystemLifecycle
- pattern FileSystemLifecycle_MISCONFIGURED_UNAVAILABLE :: FileSystemLifecycle
- pattern FileSystemLifecycle_UPDATING :: FileSystemLifecycle
- newtype FileSystemMaintenanceOperation where
- newtype FileSystemType where
- FileSystemType' { }
- pattern FileSystemType_LUSTRE :: FileSystemType
- pattern FileSystemType_ONTAP :: FileSystemType
- pattern FileSystemType_OPENZFS :: FileSystemType
- pattern FileSystemType_WINDOWS :: FileSystemType
- newtype FilterName where
- FilterName' { }
- pattern FilterName_Backup_type :: FilterName
- pattern FilterName_Data_repository_type :: FilterName
- pattern FilterName_File_cache_id :: FilterName
- pattern FilterName_File_cache_type :: FilterName
- pattern FilterName_File_system_id :: FilterName
- pattern FilterName_File_system_type :: FilterName
- pattern FilterName_Volume_id :: FilterName
- newtype FlexCacheEndpointType where
- newtype InputOntapVolumeType where
- newtype LustreAccessAuditLogLevel where
- LustreAccessAuditLogLevel' { }
- pattern LustreAccessAuditLogLevel_DISABLED :: LustreAccessAuditLogLevel
- pattern LustreAccessAuditLogLevel_ERROR_ONLY :: LustreAccessAuditLogLevel
- pattern LustreAccessAuditLogLevel_WARN_ERROR :: LustreAccessAuditLogLevel
- pattern LustreAccessAuditLogLevel_WARN_ONLY :: LustreAccessAuditLogLevel
- newtype LustreDeploymentType where
- newtype NfsVersion where
- NfsVersion' { }
- pattern NfsVersion_NFS3 :: NfsVersion
- newtype OntapDeploymentType where
- newtype OntapVolumeType where
- OntapVolumeType' { }
- pattern OntapVolumeType_DP :: OntapVolumeType
- pattern OntapVolumeType_LS :: OntapVolumeType
- pattern OntapVolumeType_RW :: OntapVolumeType
- newtype OpenZFSCopyStrategy where
- newtype OpenZFSDataCompressionType where
- newtype OpenZFSDeploymentType where
- newtype OpenZFSQuotaType where
- OpenZFSQuotaType' { }
- pattern OpenZFSQuotaType_GROUP :: OpenZFSQuotaType
- pattern OpenZFSQuotaType_USER :: OpenZFSQuotaType
- newtype ReportFormat where
- ReportFormat' { }
- pattern ReportFormat_REPORT_CSV_20191124 :: ReportFormat
- newtype ReportScope where
- ReportScope' { }
- pattern ReportScope_FAILED_FILES_ONLY :: ReportScope
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_FILE_SYSTEM :: ResourceType
- pattern ResourceType_VOLUME :: ResourceType
- newtype RestoreOpenZFSVolumeOption where
- newtype SecurityStyle where
- SecurityStyle' { }
- pattern SecurityStyle_MIXED :: SecurityStyle
- pattern SecurityStyle_NTFS :: SecurityStyle
- pattern SecurityStyle_UNIX :: SecurityStyle
- newtype SnapshotFilterName where
- newtype SnapshotLifecycle where
- SnapshotLifecycle' { }
- pattern SnapshotLifecycle_AVAILABLE :: SnapshotLifecycle
- pattern SnapshotLifecycle_CREATING :: SnapshotLifecycle
- pattern SnapshotLifecycle_DELETING :: SnapshotLifecycle
- pattern SnapshotLifecycle_PENDING :: SnapshotLifecycle
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_COMPLETED :: Status
- pattern Status_FAILED :: Status
- pattern Status_IN_PROGRESS :: Status
- pattern Status_PENDING :: Status
- pattern Status_UPDATED_OPTIMIZING :: Status
- Status' {
- newtype StorageType where
- StorageType' { }
- pattern StorageType_HDD :: StorageType
- pattern StorageType_SSD :: StorageType
- newtype StorageVirtualMachineFilterName where
- newtype StorageVirtualMachineLifecycle where
- StorageVirtualMachineLifecycle' { }
- pattern StorageVirtualMachineLifecycle_CREATED :: StorageVirtualMachineLifecycle
- pattern StorageVirtualMachineLifecycle_CREATING :: StorageVirtualMachineLifecycle
- pattern StorageVirtualMachineLifecycle_DELETING :: StorageVirtualMachineLifecycle
- pattern StorageVirtualMachineLifecycle_FAILED :: StorageVirtualMachineLifecycle
- pattern StorageVirtualMachineLifecycle_MISCONFIGURED :: StorageVirtualMachineLifecycle
- pattern StorageVirtualMachineLifecycle_PENDING :: StorageVirtualMachineLifecycle
- newtype StorageVirtualMachineRootVolumeSecurityStyle where
- StorageVirtualMachineRootVolumeSecurityStyle' { }
- pattern StorageVirtualMachineRootVolumeSecurityStyle_MIXED :: StorageVirtualMachineRootVolumeSecurityStyle
- pattern StorageVirtualMachineRootVolumeSecurityStyle_NTFS :: StorageVirtualMachineRootVolumeSecurityStyle
- pattern StorageVirtualMachineRootVolumeSecurityStyle_UNIX :: StorageVirtualMachineRootVolumeSecurityStyle
- newtype StorageVirtualMachineSubtype where
- StorageVirtualMachineSubtype' { }
- pattern StorageVirtualMachineSubtype_DEFAULT :: StorageVirtualMachineSubtype
- pattern StorageVirtualMachineSubtype_DP_DESTINATION :: StorageVirtualMachineSubtype
- pattern StorageVirtualMachineSubtype_SYNC_DESTINATION :: StorageVirtualMachineSubtype
- pattern StorageVirtualMachineSubtype_SYNC_SOURCE :: StorageVirtualMachineSubtype
- newtype TieringPolicyName where
- TieringPolicyName' { }
- pattern TieringPolicyName_ALL :: TieringPolicyName
- pattern TieringPolicyName_AUTO :: TieringPolicyName
- pattern TieringPolicyName_NONE :: TieringPolicyName
- pattern TieringPolicyName_SNAPSHOT_ONLY :: TieringPolicyName
- newtype VolumeFilterName where
- newtype VolumeLifecycle where
- VolumeLifecycle' { }
- pattern VolumeLifecycle_AVAILABLE :: VolumeLifecycle
- pattern VolumeLifecycle_CREATED :: VolumeLifecycle
- pattern VolumeLifecycle_CREATING :: VolumeLifecycle
- pattern VolumeLifecycle_DELETING :: VolumeLifecycle
- pattern VolumeLifecycle_FAILED :: VolumeLifecycle
- pattern VolumeLifecycle_MISCONFIGURED :: VolumeLifecycle
- pattern VolumeLifecycle_PENDING :: VolumeLifecycle
- newtype VolumeType where
- VolumeType' { }
- pattern VolumeType_ONTAP :: VolumeType
- pattern VolumeType_OPENZFS :: VolumeType
- newtype WindowsAccessAuditLogLevel where
- WindowsAccessAuditLogLevel' { }
- pattern WindowsAccessAuditLogLevel_DISABLED :: WindowsAccessAuditLogLevel
- pattern WindowsAccessAuditLogLevel_FAILURE_ONLY :: WindowsAccessAuditLogLevel
- pattern WindowsAccessAuditLogLevel_SUCCESS_AND_FAILURE :: WindowsAccessAuditLogLevel
- pattern WindowsAccessAuditLogLevel_SUCCESS_ONLY :: WindowsAccessAuditLogLevel
- newtype WindowsDeploymentType where
- data ActiveDirectoryBackupAttributes = ActiveDirectoryBackupAttributes' (Maybe Text) (Maybe Text) (Maybe Text)
- newActiveDirectoryBackupAttributes :: ActiveDirectoryBackupAttributes
- data AdministrativeAction = AdministrativeAction' (Maybe AdministrativeActionType) (Maybe AdministrativeActionFailureDetails) (Maybe Natural) (Maybe POSIX) (Maybe Status) (Maybe FileSystem) (Maybe Snapshot) (Maybe Volume)
- newAdministrativeAction :: AdministrativeAction
- data AdministrativeActionFailureDetails = AdministrativeActionFailureDetails' (Maybe Text)
- newAdministrativeActionFailureDetails :: AdministrativeActionFailureDetails
- data Alias = Alias' (Maybe AliasLifecycle) (Maybe Text)
- newAlias :: Alias
- data AutoExportPolicy = AutoExportPolicy' (Maybe [EventType])
- newAutoExportPolicy :: AutoExportPolicy
- data AutoImportPolicy = AutoImportPolicy' (Maybe [EventType])
- newAutoImportPolicy :: AutoImportPolicy
- data Backup = Backup' (Maybe ActiveDirectoryBackupAttributes) (Maybe BackupFailureDetails) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ResourceType) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Volume) Text BackupLifecycle BackupType POSIX FileSystem
- newBackup :: Text -> BackupLifecycle -> BackupType -> UTCTime -> FileSystem -> Backup
- data BackupFailureDetails = BackupFailureDetails' (Maybe Text)
- newBackupFailureDetails :: BackupFailureDetails
- data CompletionReport = CompletionReport' (Maybe ReportFormat) (Maybe Text) (Maybe ReportScope) Bool
- newCompletionReport :: Bool -> CompletionReport
- data CreateFileCacheLustreConfiguration = CreateFileCacheLustreConfiguration' (Maybe Text) Natural FileCacheLustreDeploymentType FileCacheLustreMetadataConfiguration
- newCreateFileCacheLustreConfiguration :: Natural -> FileCacheLustreDeploymentType -> FileCacheLustreMetadataConfiguration -> CreateFileCacheLustreConfiguration
- data CreateFileSystemLustreConfiguration = CreateFileSystemLustreConfiguration' (Maybe AutoImportPolicyType) (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe DataCompressionType) (Maybe LustreDeploymentType) (Maybe DriveCacheType) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe LustreLogCreateConfiguration) (Maybe Natural) (Maybe LustreRootSquashConfiguration) (Maybe Text)
- newCreateFileSystemLustreConfiguration :: CreateFileSystemLustreConfiguration
- data CreateFileSystemOntapConfiguration = CreateFileSystemOntapConfiguration' (Maybe Natural) (Maybe Text) (Maybe DiskIopsConfiguration) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [Text]) (Maybe Text) OntapDeploymentType Natural
- newCreateFileSystemOntapConfiguration :: OntapDeploymentType -> Natural -> CreateFileSystemOntapConfiguration
- data CreateFileSystemOpenZFSConfiguration = CreateFileSystemOpenZFSConfiguration' (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe DiskIopsConfiguration) (Maybe OpenZFSCreateRootVolumeConfiguration) (Maybe Text) OpenZFSDeploymentType Natural
- newCreateFileSystemOpenZFSConfiguration :: OpenZFSDeploymentType -> Natural -> CreateFileSystemOpenZFSConfiguration
- data CreateFileSystemWindowsConfiguration = CreateFileSystemWindowsConfiguration' (Maybe Text) (Maybe [Text]) (Maybe WindowsAuditLogCreateConfiguration) (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe WindowsDeploymentType) (Maybe Text) (Maybe SelfManagedActiveDirectoryConfiguration) (Maybe Text) Natural
- newCreateFileSystemWindowsConfiguration :: Natural -> CreateFileSystemWindowsConfiguration
- data CreateOntapVolumeConfiguration = CreateOntapVolumeConfiguration' (Maybe Bool) (Maybe Text) (Maybe InputOntapVolumeType) (Maybe SecurityStyle) (Maybe Text) (Maybe Bool) (Maybe TieringPolicy) Natural Text
- newCreateOntapVolumeConfiguration :: Natural -> Text -> CreateOntapVolumeConfiguration
- data CreateOpenZFSOriginSnapshotConfiguration = CreateOpenZFSOriginSnapshotConfiguration' Text OpenZFSCopyStrategy
- newCreateOpenZFSOriginSnapshotConfiguration :: Text -> OpenZFSCopyStrategy -> CreateOpenZFSOriginSnapshotConfiguration
- data CreateOpenZFSVolumeConfiguration = CreateOpenZFSVolumeConfiguration' (Maybe Bool) (Maybe OpenZFSDataCompressionType) (Maybe [OpenZFSNfsExport]) (Maybe CreateOpenZFSOriginSnapshotConfiguration) (Maybe Bool) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe [OpenZFSUserOrGroupQuota]) Text
- newCreateOpenZFSVolumeConfiguration :: Text -> CreateOpenZFSVolumeConfiguration
- data CreateSvmActiveDirectoryConfiguration = CreateSvmActiveDirectoryConfiguration' (Maybe SelfManagedActiveDirectoryConfiguration) Text
- newCreateSvmActiveDirectoryConfiguration :: Text -> CreateSvmActiveDirectoryConfiguration
- data DataRepositoryAssociation = DataRepositoryAssociation' (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe DataRepositoryFailureDetails) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe DataRepositoryLifecycle) (Maybe NFSDataRepositoryConfiguration) (Maybe Text) (Maybe S3DataRepositoryConfiguration) (Maybe (NonEmpty Tag))
- newDataRepositoryAssociation :: DataRepositoryAssociation
- data DataRepositoryConfiguration = DataRepositoryConfiguration' (Maybe AutoImportPolicyType) (Maybe Text) (Maybe DataRepositoryFailureDetails) (Maybe Text) (Maybe Natural) (Maybe DataRepositoryLifecycle)
- newDataRepositoryConfiguration :: DataRepositoryConfiguration
- data DataRepositoryFailureDetails = DataRepositoryFailureDetails' (Maybe Text)
- newDataRepositoryFailureDetails :: DataRepositoryFailureDetails
- data DataRepositoryTask = DataRepositoryTask' (Maybe Natural) (Maybe POSIX) (Maybe DataRepositoryTaskFailureDetails) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe CompletionReport) (Maybe Text) (Maybe POSIX) (Maybe DataRepositoryTaskStatus) (Maybe (NonEmpty Tag)) Text DataRepositoryTaskLifecycle DataRepositoryTaskType POSIX
- newDataRepositoryTask :: Text -> DataRepositoryTaskLifecycle -> DataRepositoryTaskType -> UTCTime -> DataRepositoryTask
- data DataRepositoryTaskFailureDetails = DataRepositoryTaskFailureDetails' (Maybe Text)
- newDataRepositoryTaskFailureDetails :: DataRepositoryTaskFailureDetails
- data DataRepositoryTaskFilter = DataRepositoryTaskFilter' (Maybe DataRepositoryTaskFilterName) (Maybe [Text])
- newDataRepositoryTaskFilter :: DataRepositoryTaskFilter
- data DataRepositoryTaskStatus = DataRepositoryTaskStatus' (Maybe Integer) (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newDataRepositoryTaskStatus :: DataRepositoryTaskStatus
- data DeleteFileSystemLustreConfiguration = DeleteFileSystemLustreConfiguration' (Maybe (NonEmpty Tag)) (Maybe Bool)
- newDeleteFileSystemLustreConfiguration :: DeleteFileSystemLustreConfiguration
- data DeleteFileSystemLustreResponse = DeleteFileSystemLustreResponse' (Maybe Text) (Maybe (NonEmpty Tag))
- newDeleteFileSystemLustreResponse :: DeleteFileSystemLustreResponse
- data DeleteFileSystemOpenZFSConfiguration = DeleteFileSystemOpenZFSConfiguration' (Maybe (NonEmpty Tag)) (Maybe [DeleteFileSystemOpenZFSOption]) (Maybe Bool)
- newDeleteFileSystemOpenZFSConfiguration :: DeleteFileSystemOpenZFSConfiguration
- data DeleteFileSystemOpenZFSResponse = DeleteFileSystemOpenZFSResponse' (Maybe Text) (Maybe (NonEmpty Tag))
- newDeleteFileSystemOpenZFSResponse :: DeleteFileSystemOpenZFSResponse
- data DeleteFileSystemWindowsConfiguration = DeleteFileSystemWindowsConfiguration' (Maybe (NonEmpty Tag)) (Maybe Bool)
- newDeleteFileSystemWindowsConfiguration :: DeleteFileSystemWindowsConfiguration
- data DeleteFileSystemWindowsResponse = DeleteFileSystemWindowsResponse' (Maybe Text) (Maybe (NonEmpty Tag))
- newDeleteFileSystemWindowsResponse :: DeleteFileSystemWindowsResponse
- data DeleteVolumeOntapConfiguration = DeleteVolumeOntapConfiguration' (Maybe (NonEmpty Tag)) (Maybe Bool)
- newDeleteVolumeOntapConfiguration :: DeleteVolumeOntapConfiguration
- data DeleteVolumeOntapResponse = DeleteVolumeOntapResponse' (Maybe Text) (Maybe (NonEmpty Tag))
- newDeleteVolumeOntapResponse :: DeleteVolumeOntapResponse
- data DeleteVolumeOpenZFSConfiguration = DeleteVolumeOpenZFSConfiguration' (Maybe [DeleteOpenZFSVolumeOption])
- newDeleteVolumeOpenZFSConfiguration :: DeleteVolumeOpenZFSConfiguration
- data DiskIopsConfiguration = DiskIopsConfiguration' (Maybe Natural) (Maybe DiskIopsConfigurationMode)
- newDiskIopsConfiguration :: DiskIopsConfiguration
- data FileCache = FileCache' (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe FileCacheFailureDetails) (Maybe Text) (Maybe FileCacheType) (Maybe Text) (Maybe Text) (Maybe FileCacheLifecycle) (Maybe FileCacheLustreConfiguration) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe [Text]) (Maybe Text)
- newFileCache :: FileCache
- data FileCacheCreating = FileCacheCreating' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe FileCacheFailureDetails) (Maybe Text) (Maybe FileCacheType) (Maybe Text) (Maybe Text) (Maybe FileCacheLifecycle) (Maybe FileCacheLustreConfiguration) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe [Text]) (Maybe (NonEmpty Tag)) (Maybe Text)
- newFileCacheCreating :: FileCacheCreating
- data FileCacheDataRepositoryAssociation = FileCacheDataRepositoryAssociation' (Maybe [Text]) (Maybe FileCacheNFSConfiguration) Text Text
- newFileCacheDataRepositoryAssociation :: Text -> Text -> FileCacheDataRepositoryAssociation
- data FileCacheFailureDetails = FileCacheFailureDetails' (Maybe Text)
- newFileCacheFailureDetails :: FileCacheFailureDetails
- data FileCacheLustreConfiguration = FileCacheLustreConfiguration' (Maybe FileCacheLustreDeploymentType) (Maybe LustreLogConfiguration) (Maybe FileCacheLustreMetadataConfiguration) (Maybe Text) (Maybe Natural) (Maybe Text)
- newFileCacheLustreConfiguration :: FileCacheLustreConfiguration
- data FileCacheLustreMetadataConfiguration = FileCacheLustreMetadataConfiguration' Natural
- newFileCacheLustreMetadataConfiguration :: Natural -> FileCacheLustreMetadataConfiguration
- data FileCacheNFSConfiguration = FileCacheNFSConfiguration' (Maybe [Text]) NfsVersion
- newFileCacheNFSConfiguration :: NfsVersion -> FileCacheNFSConfiguration
- data FileSystem = FileSystem' (Maybe [AdministrativeAction]) (Maybe POSIX) (Maybe Text) (Maybe FileSystemFailureDetails) (Maybe Text) (Maybe FileSystemType) (Maybe Text) (Maybe Text) (Maybe FileSystemLifecycle) (Maybe LustreFileSystemConfiguration) (Maybe [Text]) (Maybe OntapFileSystemConfiguration) (Maybe OpenZFSFileSystemConfiguration) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe StorageType) (Maybe [Text]) (Maybe (NonEmpty Tag)) (Maybe Text) (Maybe WindowsFileSystemConfiguration)
- newFileSystem :: FileSystem
- data FileSystemEndpoint = FileSystemEndpoint' (Maybe Text) (Maybe (NonEmpty Text))
- newFileSystemEndpoint :: FileSystemEndpoint
- data FileSystemEndpoints = FileSystemEndpoints' (Maybe FileSystemEndpoint) (Maybe FileSystemEndpoint)
- newFileSystemEndpoints :: FileSystemEndpoints
- data FileSystemFailureDetails = FileSystemFailureDetails' (Maybe Text)
- newFileSystemFailureDetails :: FileSystemFailureDetails
- data Filter = Filter' (Maybe FilterName) (Maybe [Text])
- newFilter :: Filter
- data LifecycleTransitionReason = LifecycleTransitionReason' (Maybe Text)
- newLifecycleTransitionReason :: LifecycleTransitionReason
- data LustreFileSystemConfiguration = LustreFileSystemConfiguration' (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe DataCompressionType) (Maybe DataRepositoryConfiguration) (Maybe LustreDeploymentType) (Maybe DriveCacheType) (Maybe LustreLogConfiguration) (Maybe Text) (Maybe Natural) (Maybe LustreRootSquashConfiguration) (Maybe Text)
- newLustreFileSystemConfiguration :: LustreFileSystemConfiguration
- data LustreLogConfiguration = LustreLogConfiguration' (Maybe Text) LustreAccessAuditLogLevel
- newLustreLogConfiguration :: LustreAccessAuditLogLevel -> LustreLogConfiguration
- data LustreLogCreateConfiguration = LustreLogCreateConfiguration' (Maybe Text) LustreAccessAuditLogLevel
- newLustreLogCreateConfiguration :: LustreAccessAuditLogLevel -> LustreLogCreateConfiguration
- data LustreRootSquashConfiguration = LustreRootSquashConfiguration' (Maybe [Text]) (Maybe Text)
- newLustreRootSquashConfiguration :: LustreRootSquashConfiguration
- data NFSDataRepositoryConfiguration = NFSDataRepositoryConfiguration' (Maybe AutoExportPolicy) (Maybe [Text]) NfsVersion
- newNFSDataRepositoryConfiguration :: NfsVersion -> NFSDataRepositoryConfiguration
- data OntapFileSystemConfiguration = OntapFileSystemConfiguration' (Maybe Natural) (Maybe Text) (Maybe OntapDeploymentType) (Maybe DiskIopsConfiguration) (Maybe Text) (Maybe FileSystemEndpoints) (Maybe Text) (Maybe [Text]) (Maybe Natural) (Maybe Text)
- newOntapFileSystemConfiguration :: OntapFileSystemConfiguration
- data OntapVolumeConfiguration = OntapVolumeConfiguration' (Maybe Bool) (Maybe FlexCacheEndpointType) (Maybe Text) (Maybe OntapVolumeType) (Maybe SecurityStyle) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe TieringPolicy) (Maybe Text)
- newOntapVolumeConfiguration :: OntapVolumeConfiguration
- data OpenZFSClientConfiguration = OpenZFSClientConfiguration' Text (NonEmpty Text)
- newOpenZFSClientConfiguration :: Text -> NonEmpty Text -> OpenZFSClientConfiguration
- data OpenZFSCreateRootVolumeConfiguration = OpenZFSCreateRootVolumeConfiguration' (Maybe Bool) (Maybe OpenZFSDataCompressionType) (Maybe [OpenZFSNfsExport]) (Maybe Bool) (Maybe Natural) (Maybe [OpenZFSUserOrGroupQuota])
- newOpenZFSCreateRootVolumeConfiguration :: OpenZFSCreateRootVolumeConfiguration
- data OpenZFSFileSystemConfiguration = OpenZFSFileSystemConfiguration' (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe OpenZFSDeploymentType) (Maybe DiskIopsConfiguration) (Maybe Text) (Maybe Natural) (Maybe Text)
- newOpenZFSFileSystemConfiguration :: OpenZFSFileSystemConfiguration
- data OpenZFSNfsExport = OpenZFSNfsExport' [OpenZFSClientConfiguration]
- newOpenZFSNfsExport :: OpenZFSNfsExport
- data OpenZFSOriginSnapshotConfiguration = OpenZFSOriginSnapshotConfiguration' (Maybe OpenZFSCopyStrategy) (Maybe Text)
- newOpenZFSOriginSnapshotConfiguration :: OpenZFSOriginSnapshotConfiguration
- data OpenZFSUserOrGroupQuota = OpenZFSUserOrGroupQuota' OpenZFSQuotaType Natural Natural
- newOpenZFSUserOrGroupQuota :: OpenZFSQuotaType -> Natural -> Natural -> OpenZFSUserOrGroupQuota
- data OpenZFSVolumeConfiguration = OpenZFSVolumeConfiguration' (Maybe Bool) (Maybe OpenZFSDataCompressionType) (Maybe Bool) (Maybe Bool) (Maybe [OpenZFSNfsExport]) (Maybe OpenZFSOriginSnapshotConfiguration) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe [OpenZFSUserOrGroupQuota]) (Maybe Text)
- newOpenZFSVolumeConfiguration :: OpenZFSVolumeConfiguration
- data S3DataRepositoryConfiguration = S3DataRepositoryConfiguration' (Maybe AutoExportPolicy) (Maybe AutoImportPolicy)
- newS3DataRepositoryConfiguration :: S3DataRepositoryConfiguration
- data SelfManagedActiveDirectoryAttributes = SelfManagedActiveDirectoryAttributes' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSelfManagedActiveDirectoryAttributes :: SelfManagedActiveDirectoryAttributes
- data SelfManagedActiveDirectoryConfiguration = SelfManagedActiveDirectoryConfiguration' (Maybe Text) (Maybe Text) Text Text (Sensitive Text) (NonEmpty Text)
- newSelfManagedActiveDirectoryConfiguration :: Text -> Text -> Text -> NonEmpty Text -> SelfManagedActiveDirectoryConfiguration
- data SelfManagedActiveDirectoryConfigurationUpdates = SelfManagedActiveDirectoryConfigurationUpdates' (Maybe (NonEmpty Text)) (Maybe (Sensitive Text)) (Maybe Text)
- newSelfManagedActiveDirectoryConfigurationUpdates :: SelfManagedActiveDirectoryConfigurationUpdates
- data Snapshot = Snapshot' (Maybe [AdministrativeAction]) (Maybe POSIX) (Maybe SnapshotLifecycle) (Maybe LifecycleTransitionReason) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text)
- newSnapshot :: Snapshot
- data SnapshotFilter = SnapshotFilter' (Maybe SnapshotFilterName) (Maybe [Text])
- newSnapshotFilter :: SnapshotFilter
- data StorageVirtualMachine = StorageVirtualMachine' (Maybe SvmActiveDirectoryConfiguration) (Maybe POSIX) (Maybe SvmEndpoints) (Maybe Text) (Maybe StorageVirtualMachineLifecycle) (Maybe LifecycleTransitionReason) (Maybe Text) (Maybe Text) (Maybe StorageVirtualMachineRootVolumeSecurityStyle) (Maybe Text) (Maybe StorageVirtualMachineSubtype) (Maybe (NonEmpty Tag)) (Maybe Text)
- newStorageVirtualMachine :: StorageVirtualMachine
- data StorageVirtualMachineFilter = StorageVirtualMachineFilter' (Maybe StorageVirtualMachineFilterName) (Maybe [Text])
- newStorageVirtualMachineFilter :: StorageVirtualMachineFilter
- data SvmActiveDirectoryConfiguration = SvmActiveDirectoryConfiguration' (Maybe Text) (Maybe SelfManagedActiveDirectoryAttributes)
- newSvmActiveDirectoryConfiguration :: SvmActiveDirectoryConfiguration
- data SvmEndpoint = SvmEndpoint' (Maybe Text) (Maybe (NonEmpty Text))
- newSvmEndpoint :: SvmEndpoint
- data SvmEndpoints = SvmEndpoints' (Maybe SvmEndpoint) (Maybe SvmEndpoint) (Maybe SvmEndpoint) (Maybe SvmEndpoint)
- newSvmEndpoints :: SvmEndpoints
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TieringPolicy = TieringPolicy' (Maybe Natural) (Maybe TieringPolicyName)
- newTieringPolicy :: TieringPolicy
- data UpdateFileCacheLustreConfiguration = UpdateFileCacheLustreConfiguration' (Maybe Text)
- newUpdateFileCacheLustreConfiguration :: UpdateFileCacheLustreConfiguration
- data UpdateFileSystemLustreConfiguration = UpdateFileSystemLustreConfiguration' (Maybe AutoImportPolicyType) (Maybe Natural) (Maybe Text) (Maybe DataCompressionType) (Maybe LustreLogCreateConfiguration) (Maybe LustreRootSquashConfiguration) (Maybe Text)
- newUpdateFileSystemLustreConfiguration :: UpdateFileSystemLustreConfiguration
- data UpdateFileSystemOntapConfiguration = UpdateFileSystemOntapConfiguration' (Maybe [Text]) (Maybe Natural) (Maybe Text) (Maybe DiskIopsConfiguration) (Maybe (Sensitive Text)) (Maybe [Text]) (Maybe Natural) (Maybe Text)
- newUpdateFileSystemOntapConfiguration :: UpdateFileSystemOntapConfiguration
- data UpdateFileSystemOpenZFSConfiguration = UpdateFileSystemOpenZFSConfiguration' (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe DiskIopsConfiguration) (Maybe Natural) (Maybe Text)
- newUpdateFileSystemOpenZFSConfiguration :: UpdateFileSystemOpenZFSConfiguration
- data UpdateFileSystemWindowsConfiguration = UpdateFileSystemWindowsConfiguration' (Maybe WindowsAuditLogCreateConfiguration) (Maybe Natural) (Maybe Text) (Maybe SelfManagedActiveDirectoryConfigurationUpdates) (Maybe Natural) (Maybe Text)
- newUpdateFileSystemWindowsConfiguration :: UpdateFileSystemWindowsConfiguration
- data UpdateOntapVolumeConfiguration = UpdateOntapVolumeConfiguration' (Maybe Bool) (Maybe Text) (Maybe SecurityStyle) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe TieringPolicy)
- newUpdateOntapVolumeConfiguration :: UpdateOntapVolumeConfiguration
- data UpdateOpenZFSVolumeConfiguration = UpdateOpenZFSVolumeConfiguration' (Maybe OpenZFSDataCompressionType) (Maybe [OpenZFSNfsExport]) (Maybe Bool) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe [OpenZFSUserOrGroupQuota])
- newUpdateOpenZFSVolumeConfiguration :: UpdateOpenZFSVolumeConfiguration
- data UpdateSvmActiveDirectoryConfiguration = UpdateSvmActiveDirectoryConfiguration' (Maybe SelfManagedActiveDirectoryConfigurationUpdates)
- newUpdateSvmActiveDirectoryConfiguration :: UpdateSvmActiveDirectoryConfiguration
- data Volume = Volume' (Maybe [AdministrativeAction]) (Maybe POSIX) (Maybe Text) (Maybe VolumeLifecycle) (Maybe LifecycleTransitionReason) (Maybe Text) (Maybe OntapVolumeConfiguration) (Maybe OpenZFSVolumeConfiguration) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) (Maybe VolumeType)
- newVolume :: Volume
- data VolumeFilter = VolumeFilter' (Maybe VolumeFilterName) (Maybe [Text])
- newVolumeFilter :: VolumeFilter
- data WindowsAuditLogConfiguration = WindowsAuditLogConfiguration' (Maybe Text) WindowsAccessAuditLogLevel WindowsAccessAuditLogLevel
- newWindowsAuditLogConfiguration :: WindowsAccessAuditLogLevel -> WindowsAccessAuditLogLevel -> WindowsAuditLogConfiguration
- data WindowsAuditLogCreateConfiguration = WindowsAuditLogCreateConfiguration' (Maybe Text) WindowsAccessAuditLogLevel WindowsAccessAuditLogLevel
- newWindowsAuditLogCreateConfiguration :: WindowsAccessAuditLogLevel -> WindowsAccessAuditLogLevel -> WindowsAuditLogCreateConfiguration
- data WindowsFileSystemConfiguration = WindowsFileSystemConfiguration' (Maybe Text) (Maybe [Alias]) (Maybe WindowsAuditLogConfiguration) (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe WindowsDeploymentType) (Maybe [FileSystemMaintenanceOperation]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SelfManagedActiveDirectoryAttributes) (Maybe Natural) (Maybe Text)
- newWindowsFileSystemConfiguration :: WindowsFileSystemConfiguration
Service Configuration
defaultService :: Service Source #
API version 2018-03-01 of the Amazon FSx SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by FSx.
ActiveDirectoryError
_ActiveDirectoryError :: AsError a => Fold a ServiceError Source #
An Active Directory error.
BackupBeingCopied
_BackupBeingCopied :: AsError a => Fold a ServiceError Source #
You can't delete a backup while it's being copied.
BackupInProgress
_BackupInProgress :: AsError a => Fold a ServiceError Source #
Another backup is already under way. Wait for completion before initiating additional backups of this file system.
BackupNotFound
_BackupNotFound :: AsError a => Fold a ServiceError Source #
No Amazon FSx backups were found based upon the supplied parameters.
BackupRestoring
_BackupRestoring :: AsError a => Fold a ServiceError Source #
You can't delete a backup while it's being used to restore a file system.
BadRequest
_BadRequest :: AsError a => Fold a ServiceError Source #
A generic error indicating a failure with a client request.
DataRepositoryAssociationNotFound
_DataRepositoryAssociationNotFound :: AsError a => Fold a ServiceError Source #
No data repository associations were found based upon the supplied parameters.
DataRepositoryTaskEnded
_DataRepositoryTaskEnded :: AsError a => Fold a ServiceError Source #
The data repository task could not be canceled because the task has already ended.
DataRepositoryTaskExecuting
_DataRepositoryTaskExecuting :: AsError a => Fold a ServiceError Source #
An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.
DataRepositoryTaskNotFound
_DataRepositoryTaskNotFound :: AsError a => Fold a ServiceError Source #
The data repository task or tasks you specified could not be found.
FileCacheNotFound
_FileCacheNotFound :: AsError a => Fold a ServiceError Source #
No caches were found based upon supplied parameters.
FileSystemNotFound
_FileSystemNotFound :: AsError a => Fold a ServiceError Source #
No Amazon FSx file systems were found based upon supplied parameters.
IncompatibleParameterError
_IncompatibleParameterError :: AsError a => Fold a ServiceError Source #
The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.
IncompatibleRegionForMultiAZ
_IncompatibleRegionForMultiAZ :: AsError a => Fold a ServiceError Source #
Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.
InternalServerError
_InternalServerError :: AsError a => Fold a ServiceError Source #
A generic error indicating a server-side failure.
InvalidDataRepositoryType
_InvalidDataRepositoryType :: AsError a => Fold a ServiceError Source #
You have filtered the response to a data repository type that is not supported.
InvalidDestinationKmsKey
_InvalidDestinationKmsKey :: AsError a => Fold a ServiceError Source #
The Key Management Service (KMS) key of the destination backup is not valid.
InvalidExportPath
_InvalidExportPath :: AsError a => Fold a ServiceError Source #
The path provided for data repository export isn't valid.
InvalidImportPath
_InvalidImportPath :: AsError a => Fold a ServiceError Source #
The path provided for data repository import isn't valid.
InvalidNetworkSettings
_InvalidNetworkSettings :: AsError a => Fold a ServiceError Source #
One or more network settings specified in the request are invalid.
InvalidPerUnitStorageThroughput
_InvalidPerUnitStorageThroughput :: AsError a => Fold a ServiceError Source #
An invalid value for PerUnitStorageThroughput was provided. Please
create your file system again, using a valid value.
InvalidRegion
_InvalidRegion :: AsError a => Fold a ServiceError Source #
The Region provided for SourceRegion is not valid or is in a different
Amazon Web Services partition.
InvalidSourceKmsKey
_InvalidSourceKmsKey :: AsError a => Fold a ServiceError Source #
The Key Management Service (KMS) key of the source backup is not valid.
MissingFileCacheConfiguration
_MissingFileCacheConfiguration :: AsError a => Fold a ServiceError Source #
A cache configuration is required for this operation.
MissingFileSystemConfiguration
_MissingFileSystemConfiguration :: AsError a => Fold a ServiceError Source #
A file system configuration is required for this operation.
MissingVolumeConfiguration
_MissingVolumeConfiguration :: AsError a => Fold a ServiceError Source #
A volume configuration is required for this operation.
NotServiceResourceError
_NotServiceResourceError :: AsError a => Fold a ServiceError Source #
The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
ResourceDoesNotSupportTagging
_ResourceDoesNotSupportTagging :: AsError a => Fold a ServiceError Source #
The resource specified does not support tagging.
ResourceNotFound
_ResourceNotFound :: AsError a => Fold a ServiceError Source #
The resource specified by the Amazon Resource Name (ARN) can't be found.
ServiceLimitExceeded
_ServiceLimitExceeded :: AsError a => Fold a ServiceError Source #
An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
SnapshotNotFound
_SnapshotNotFound :: AsError a => Fold a ServiceError Source #
No Amazon FSx snapshots were found based on the supplied parameters.
SourceBackupUnavailable
_SourceBackupUnavailable :: AsError a => Fold a ServiceError Source #
The request was rejected because the lifecycle status of the source
backup isn't AVAILABLE.
StorageVirtualMachineNotFound
_StorageVirtualMachineNotFound :: AsError a => Fold a ServiceError Source #
No FSx for ONTAP SVMs were found based upon the supplied parameters.
UnsupportedOperation
_UnsupportedOperation :: AsError a => Fold a ServiceError Source #
The requested operation is not supported for this resource or API.
VolumeNotFound
_VolumeNotFound :: AsError a => Fold a ServiceError Source #
No Amazon FSx volumes were found based upon the supplied parameters.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateFileSystemAliases
data AssociateFileSystemAliases Source #
The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
See: newAssociateFileSystemAliases smart constructor.
Constructors
| AssociateFileSystemAliases' (Maybe Text) Text [Text] |
Instances
newAssociateFileSystemAliases Source #
Arguments
| :: Text | |
| -> AssociateFileSystemAliases |
Create a value of AssociateFileSystemAliases with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:AssociateFileSystemAliases', associateFileSystemAliases_clientRequestToken - Undocumented member.
AssociateFileSystemAliases, associateFileSystemAliases_fileSystemId - Specifies the file system with which you want to associate one or more
DNS aliases.
AssociateFileSystemAliases, associateFileSystemAliases_aliases - 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.
data AssociateFileSystemAliasesResponse Source #
The system generated response showing the DNS aliases that Amazon FSx is
attempting to associate with the file system. Use the API operation to
monitor the status of the aliases Amazon FSx is associating with the
file system. It can take up to 2.5 minutes for the alias status to
change from CREATING to AVAILABLE.
See: newAssociateFileSystemAliasesResponse smart constructor.
Constructors
| AssociateFileSystemAliasesResponse' (Maybe [Alias]) Int |
Instances
newAssociateFileSystemAliasesResponse Source #
Arguments
| :: Int | |
| -> AssociateFileSystemAliasesResponse |
Create a value of AssociateFileSystemAliasesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateFileSystemAliases, associateFileSystemAliasesResponse_aliases - An array of the DNS aliases that Amazon FSx is associating with the file
system.
$sel:httpStatus:AssociateFileSystemAliasesResponse', associateFileSystemAliasesResponse_httpStatus - The response's http status code.
CancelDataRepositoryTask
data CancelDataRepositoryTask Source #
Cancels a data repository task.
See: newCancelDataRepositoryTask smart constructor.
Constructors
| CancelDataRepositoryTask' Text |
Instances
newCancelDataRepositoryTask Source #
Arguments
| :: Text | |
| -> CancelDataRepositoryTask |
Create a value of CancelDataRepositoryTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelDataRepositoryTask, cancelDataRepositoryTask_taskId - Specifies the data repository task to cancel.
data CancelDataRepositoryTaskResponse Source #
See: newCancelDataRepositoryTaskResponse smart constructor.
Constructors
| CancelDataRepositoryTaskResponse' (Maybe DataRepositoryTaskLifecycle) (Maybe Text) Int |
Instances
newCancelDataRepositoryTaskResponse Source #
Create a value of CancelDataRepositoryTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelDataRepositoryTaskResponse, cancelDataRepositoryTaskResponse_lifecycle - 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.
CancelDataRepositoryTask, cancelDataRepositoryTaskResponse_taskId - The ID of the task being canceled.
$sel:httpStatus:CancelDataRepositoryTaskResponse', cancelDataRepositoryTaskResponse_httpStatus - The response's http status code.
CopyBackup
data CopyBackup Source #
See: newCopyBackup smart constructor.
Constructors
| CopyBackup' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) Text |
Instances
Arguments
| :: Text | |
| -> CopyBackup |
Create a value of CopyBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CopyBackup', copyBackup_clientRequestToken - Undocumented member.
$sel:copyTags:CopyBackup', copyBackup_copyTags - 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, copyBackup_kmsKeyId - Undocumented member.
$sel:sourceRegion:CopyBackup', copyBackup_sourceRegion - 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, copyBackup_tags - Undocumented member.
CopyBackup, copyBackup_sourceBackupId - The ID of the source backup. Specifies the ID of the backup that's
being copied.
data CopyBackupResponse Source #
See: newCopyBackupResponse smart constructor.
Constructors
| CopyBackupResponse' (Maybe Backup) Int |
Instances
newCopyBackupResponse Source #
Arguments
| :: Int | |
| -> CopyBackupResponse |
Create a value of CopyBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backup:CopyBackupResponse', copyBackupResponse_backup - Undocumented member.
$sel:httpStatus:CopyBackupResponse', copyBackupResponse_httpStatus - The response's http status code.
CreateBackup
data CreateBackup Source #
The request object for the CreateBackup operation.
See: newCreateBackup smart constructor.
Instances
newCreateBackup :: CreateBackup Source #
Create a value of CreateBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateBackup', createBackup_clientRequestToken - (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, createBackup_fileSystemId - The ID of the file system to back up.
CreateBackup, createBackup_tags - (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, createBackup_volumeId - (Optional) The ID of the FSx for ONTAP volume to back up.
data CreateBackupResponse Source #
The response object for the CreateBackup operation.
See: newCreateBackupResponse smart constructor.
Constructors
| CreateBackupResponse' (Maybe Backup) Int |
Instances
newCreateBackupResponse Source #
Arguments
| :: Int | |
| -> CreateBackupResponse |
Create a value of CreateBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backup:CreateBackupResponse', createBackupResponse_backup - A description of the backup.
$sel:httpStatus:CreateBackupResponse', createBackupResponse_httpStatus - The response's http status code.
CreateDataRepositoryAssociation
data CreateDataRepositoryAssociation Source #
See: newCreateDataRepositoryAssociation smart constructor.
Constructors
| CreateDataRepositoryAssociation' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe S3DataRepositoryConfiguration) (Maybe (NonEmpty Tag)) Text Text |
Instances
newCreateDataRepositoryAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateDataRepositoryAssociation |
Create a value of CreateDataRepositoryAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataRepositoryAssociation, createDataRepositoryAssociation_batchImportMetaDataOnCreate - 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.
$sel:clientRequestToken:CreateDataRepositoryAssociation', createDataRepositoryAssociation_clientRequestToken - Undocumented member.
CreateDataRepositoryAssociation, createDataRepositoryAssociation_fileSystemPath - 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, createDataRepositoryAssociation_importedFileChunkSize - 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, createDataRepositoryAssociation_s3 - 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, createDataRepositoryAssociation_tags - Undocumented member.
CreateDataRepositoryAssociation, createDataRepositoryAssociation_fileSystemId - Undocumented member.
CreateDataRepositoryAssociation, createDataRepositoryAssociation_dataRepositoryPath - 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.
data CreateDataRepositoryAssociationResponse Source #
See: newCreateDataRepositoryAssociationResponse smart constructor.
Instances
newCreateDataRepositoryAssociationResponse Source #
Arguments
| :: Int | |
| -> CreateDataRepositoryAssociationResponse |
Create a value of CreateDataRepositoryAssociationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:association:CreateDataRepositoryAssociationResponse', createDataRepositoryAssociationResponse_association - The response object returned after the data repository association is
created.
$sel:httpStatus:CreateDataRepositoryAssociationResponse', createDataRepositoryAssociationResponse_httpStatus - The response's http status code.
CreateDataRepositoryTask
data CreateDataRepositoryTask Source #
See: newCreateDataRepositoryTask smart constructor.
Constructors
| CreateDataRepositoryTask' (Maybe Natural) (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty Tag)) DataRepositoryTaskType Text CompletionReport |
Instances
newCreateDataRepositoryTask Source #
Arguments
| :: DataRepositoryTaskType | |
| -> Text | |
| -> CompletionReport | |
| -> CreateDataRepositoryTask |
Create a value of CreateDataRepositoryTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataRepositoryTask, createDataRepositoryTask_capacityToRelease - 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.
$sel:clientRequestToken:CreateDataRepositoryTask', createDataRepositoryTask_clientRequestToken - Undocumented member.
CreateDataRepositoryTask, createDataRepositoryTask_paths - 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/fsxand/mnt/fsx/path1is a directory or file on the file system you want to export, then the path to provide ispath1. - 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(wheremyPrefixis optional).
CreateDataRepositoryTask, createDataRepositoryTask_tags - Undocumented member.
CreateDataRepositoryTask, createDataRepositoryTask_type - Specifies the type of data repository task to create.
CreateDataRepositoryTask, createDataRepositoryTask_fileSystemId - Undocumented member.
CreateDataRepositoryTask, createDataRepositoryTask_report - 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.
data CreateDataRepositoryTaskResponse Source #
See: newCreateDataRepositoryTaskResponse smart constructor.
Constructors
| CreateDataRepositoryTaskResponse' (Maybe DataRepositoryTask) Int |
Instances
newCreateDataRepositoryTaskResponse Source #
Create a value of CreateDataRepositoryTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataRepositoryTask:CreateDataRepositoryTaskResponse', createDataRepositoryTaskResponse_dataRepositoryTask - The description of the data repository task that you just created.
$sel:httpStatus:CreateDataRepositoryTaskResponse', createDataRepositoryTaskResponse_httpStatus - The response's http status code.
CreateFileCache
data CreateFileCache Source #
See: newCreateFileCache smart constructor.
Constructors
Instances
Arguments
| :: FileCacheType | |
| -> Text | |
| -> Natural | |
| -> CreateFileCache |
Create a value of CreateFileCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateFileCache', createFileCache_clientRequestToken - 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, createFileCache_copyTagsToDataRepositoryAssociations - A boolean flag indicating whether tags for the cache should be copied to
data repository associations. This value defaults to false.
$sel:dataRepositoryAssociations:CreateFileCache', createFileCache_dataRepositoryAssociations - 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, createFileCache_kmsKeyId - 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, createFileCache_lustreConfiguration - The configuration for the Amazon File Cache resource being created.
$sel:securityGroupIds:CreateFileCache', createFileCache_securityGroupIds - 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, createFileCache_tags - Undocumented member.
CreateFileCache, createFileCache_fileCacheType - The type of cache that you're creating, which must be LUSTRE.
CreateFileCache, createFileCache_fileCacheTypeVersion - Sets the Lustre version for the cache that you're creating, which must
be 2.12.
CreateFileCache, createFileCache_storageCapacity - The storage capacity of the cache in gibibytes (GiB). Valid values are
1200 GiB, 2400 GiB, and increments of 2400 GiB.
CreateFileCache, createFileCache_subnetIds - Undocumented member.
data CreateFileCacheResponse Source #
See: newCreateFileCacheResponse smart constructor.
Constructors
| CreateFileCacheResponse' (Maybe FileCacheCreating) Int |
Instances
newCreateFileCacheResponse Source #
Create a value of CreateFileCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileCache:CreateFileCacheResponse', createFileCacheResponse_fileCache - A description of the cache that was created.
$sel:httpStatus:CreateFileCacheResponse', createFileCacheResponse_httpStatus - The response's http status code.
CreateFileSystem
data CreateFileSystem Source #
The request object used to create a new Amazon FSx file system.
See: newCreateFileSystem smart constructor.
Constructors
Instances
Arguments
| :: FileSystemType | |
| -> Natural | |
| -> CreateFileSystem |
Create a value of CreateFileSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateFileSystem', createFileSystem_clientRequestToken - 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, createFileSystem_fileSystemTypeVersion - (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.12is required when setting FSx for LustreDeploymentTypetoPERSISTENT_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, createFileSystem_kmsKeyId - Undocumented member.
CreateFileSystem, createFileSystem_lustreConfiguration - Undocumented member.
CreateFileSystem, createFileSystem_ontapConfiguration - Undocumented member.
CreateFileSystem, createFileSystem_openZFSConfiguration - The OpenZFS configuration for the file system that's being created.
$sel:securityGroupIds:CreateFileSystem', createFileSystem_securityGroupIds - 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, createFileSystem_storageType - Sets the storage type for the file system that you're creating. Valid
values are SSD and HDD.
- Set to
SSDto use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set to
HDDto use hard disk drive storage. HDD is supported onSINGLE_AZ_2andMULTI_AZ_1Windows file system deployment types, and onPERSISTENT_1Lustre 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, createFileSystem_tags - 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, createFileSystem_windowsConfiguration - The Microsoft Windows configuration for the file system that's being
created.
CreateFileSystem, createFileSystem_fileSystemType - The type of Amazon FSx file system to create. Valid values are
WINDOWS, LUSTRE, ONTAP, and OPENZFS.
CreateFileSystem, createFileSystem_storageCapacity - 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_2andPERSISTENT_1deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - For
PERSISTENT_1HDD 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_1deployment 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, createFileSystem_subnetIds - 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.
data CreateFileSystemResponse Source #
The response object returned after the file system is created.
See: newCreateFileSystemResponse smart constructor.
Constructors
| CreateFileSystemResponse' (Maybe FileSystem) Int |
Instances
newCreateFileSystemResponse Source #
Create a value of CreateFileSystemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFileSystemResponse, createFileSystemResponse_fileSystem - The configuration of the file system that was created.
$sel:httpStatus:CreateFileSystemResponse', createFileSystemResponse_httpStatus - The response's http status code.
CreateFileSystemFromBackup
data CreateFileSystemFromBackup Source #
The request object for the CreateFileSystemFromBackup operation.
See: newCreateFileSystemFromBackup smart constructor.
Constructors
Instances
newCreateFileSystemFromBackup Source #
Arguments
| :: Text | |
| -> CreateFileSystemFromBackup |
Create a value of CreateFileSystemFromBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateFileSystemFromBackup', createFileSystemFromBackup_clientRequestToken - 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, createFileSystemFromBackup_fileSystemTypeVersion - 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, createFileSystemFromBackup_kmsKeyId - Undocumented member.
CreateFileSystemFromBackup, createFileSystemFromBackup_lustreConfiguration - Undocumented member.
CreateFileSystemFromBackup, createFileSystemFromBackup_openZFSConfiguration - The OpenZFS configuration for the file system that's being created.
$sel:securityGroupIds:CreateFileSystemFromBackup', createFileSystemFromBackup_securityGroupIds - 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, createFileSystemFromBackup_storageCapacity - 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, createFileSystemFromBackup_storageType - 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
SSDto use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types. - Set to
HDDto use hard disk drive storage. HDD is supported onSINGLE_AZ_2andMULTI_AZ_1FSx 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, createFileSystemFromBackup_tags - 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, createFileSystemFromBackup_windowsConfiguration - The configuration for this Microsoft Windows file system.
CreateFileSystemFromBackup, createFileSystemFromBackup_backupId - Undocumented member.
CreateFileSystemFromBackup, createFileSystemFromBackup_subnetIds - 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.
data CreateFileSystemFromBackupResponse Source #
The response object for the CreateFileSystemFromBackup operation.
See: newCreateFileSystemFromBackupResponse smart constructor.
Constructors
| CreateFileSystemFromBackupResponse' (Maybe FileSystem) Int |
Instances
newCreateFileSystemFromBackupResponse Source #
Arguments
| :: Int | |
| -> CreateFileSystemFromBackupResponse |
Create a value of CreateFileSystemFromBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFileSystemFromBackupResponse, createFileSystemFromBackupResponse_fileSystem - A description of the file system.
$sel:httpStatus:CreateFileSystemFromBackupResponse', createFileSystemFromBackupResponse_httpStatus - The response's http status code.
CreateSnapshot
data CreateSnapshot Source #
See: newCreateSnapshot smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSnapshot |
Create a value of CreateSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateSnapshot', createSnapshot_clientRequestToken - Undocumented member.
CreateSnapshot, createSnapshot_tags - Undocumented member.
CreateSnapshot, createSnapshot_name - The name of the snapshot.
CreateSnapshot, createSnapshot_volumeId - The ID of the volume that you are taking a snapshot of.
data CreateSnapshotResponse Source #
See: newCreateSnapshotResponse smart constructor.
Constructors
| CreateSnapshotResponse' (Maybe Snapshot) Int |
Instances
newCreateSnapshotResponse Source #
Create a value of CreateSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:CreateSnapshotResponse', createSnapshotResponse_snapshot - A description of the snapshot.
$sel:httpStatus:CreateSnapshotResponse', createSnapshotResponse_httpStatus - The response's http status code.
CreateStorageVirtualMachine
data CreateStorageVirtualMachine Source #
See: newCreateStorageVirtualMachine smart constructor.
Constructors
| CreateStorageVirtualMachine' (Maybe CreateSvmActiveDirectoryConfiguration) (Maybe Text) (Maybe StorageVirtualMachineRootVolumeSecurityStyle) (Maybe (Sensitive Text)) (Maybe (NonEmpty Tag)) Text Text |
Instances
newCreateStorageVirtualMachine Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateStorageVirtualMachine |
Create a value of CreateStorageVirtualMachine with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStorageVirtualMachine, createStorageVirtualMachine_activeDirectoryConfiguration - 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.
$sel:clientRequestToken:CreateStorageVirtualMachine', createStorageVirtualMachine_clientRequestToken - Undocumented member.
CreateStorageVirtualMachine, createStorageVirtualMachine_rootVolumeSecurityStyle - The security style of the root volume of the SVM. Specify one of the
following values:
UNIXif 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.NTFSif 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.MIXEDif the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
$sel:svmAdminPassword:CreateStorageVirtualMachine', createStorageVirtualMachine_svmAdminPassword - 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, createStorageVirtualMachine_tags - Undocumented member.
CreateStorageVirtualMachine, createStorageVirtualMachine_fileSystemId - Undocumented member.
CreateStorageVirtualMachine, createStorageVirtualMachine_name - The name of the SVM.
data CreateStorageVirtualMachineResponse Source #
See: newCreateStorageVirtualMachineResponse smart constructor.
Constructors
| CreateStorageVirtualMachineResponse' (Maybe StorageVirtualMachine) Int |
Instances
newCreateStorageVirtualMachineResponse Source #
Arguments
| :: Int | |
| -> CreateStorageVirtualMachineResponse |
Create a value of CreateStorageVirtualMachineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageVirtualMachine:CreateStorageVirtualMachineResponse', createStorageVirtualMachineResponse_storageVirtualMachine - Returned after a successful CreateStorageVirtualMachine operation;
describes the SVM just created.
$sel:httpStatus:CreateStorageVirtualMachineResponse', createStorageVirtualMachineResponse_httpStatus - The response's http status code.
CreateVolume
data CreateVolume Source #
See: newCreateVolume smart constructor.
Constructors
| CreateVolume' (Maybe Text) (Maybe CreateOntapVolumeConfiguration) (Maybe CreateOpenZFSVolumeConfiguration) (Maybe (NonEmpty Tag)) VolumeType Text |
Instances
Arguments
| :: VolumeType | |
| -> Text | |
| -> CreateVolume |
Create a value of CreateVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateVolume', createVolume_clientRequestToken - Undocumented member.
CreateVolume, createVolume_ontapConfiguration - Specifies the configuration to use when creating the ONTAP volume.
CreateVolume, createVolume_openZFSConfiguration - Specifies the configuration to use when creating the OpenZFS volume.
CreateVolume, createVolume_tags - Undocumented member.
CreateVolume, createVolume_volumeType - Specifies the type of volume to create; ONTAP and OPENZFS are the
only valid volume types.
CreateVolume, createVolume_name - Specifies the name of the volume that you're creating.
data CreateVolumeResponse Source #
See: newCreateVolumeResponse smart constructor.
Constructors
| CreateVolumeResponse' (Maybe Volume) Int |
Instances
newCreateVolumeResponse Source #
Arguments
| :: Int | |
| -> CreateVolumeResponse |
Create a value of CreateVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateVolumeResponse, createVolumeResponse_volume - Returned after a successful CreateVolume API operation, describing the
volume just created.
$sel:httpStatus:CreateVolumeResponse', createVolumeResponse_httpStatus - The response's http status code.
CreateVolumeFromBackup
data CreateVolumeFromBackup Source #
See: newCreateVolumeFromBackup smart constructor.
Constructors
| CreateVolumeFromBackup' (Maybe Text) (Maybe CreateOntapVolumeConfiguration) (Maybe (NonEmpty Tag)) Text Text |
Instances
newCreateVolumeFromBackup Source #
Create a value of CreateVolumeFromBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:CreateVolumeFromBackup', createVolumeFromBackup_clientRequestToken - Undocumented member.
CreateVolumeFromBackup, createVolumeFromBackup_ontapConfiguration - Specifies the configuration of the ONTAP volume that you are creating.
CreateVolumeFromBackup, createVolumeFromBackup_tags - Undocumented member.
CreateVolumeFromBackup, createVolumeFromBackup_backupId - Undocumented member.
CreateVolumeFromBackup, createVolumeFromBackup_name - The name of the new volume you're creating.
data CreateVolumeFromBackupResponse Source #
See: newCreateVolumeFromBackupResponse smart constructor.
Constructors
| CreateVolumeFromBackupResponse' (Maybe Volume) Int |
Instances
newCreateVolumeFromBackupResponse Source #
Create a value of CreateVolumeFromBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateVolumeFromBackupResponse, createVolumeFromBackupResponse_volume - Returned after a successful CreateVolumeFromBackup API operation,
describing the volume just created.
$sel:httpStatus:CreateVolumeFromBackupResponse', createVolumeFromBackupResponse_httpStatus - The response's http status code.
DeleteBackup
data DeleteBackup Source #
The request object for the DeleteBackup operation.
See: newDeleteBackup smart constructor.
Constructors
| DeleteBackup' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteBackup |
Create a value of DeleteBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteBackup', deleteBackup_clientRequestToken - 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, deleteBackup_backupId - The ID of the backup that you want to delete.
data DeleteBackupResponse Source #
The response object for the DeleteBackup operation.
See: newDeleteBackupResponse smart constructor.
Constructors
| DeleteBackupResponse' (Maybe Text) (Maybe BackupLifecycle) Int |
Instances
newDeleteBackupResponse Source #
Arguments
| :: Int | |
| -> DeleteBackupResponse |
Create a value of DeleteBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackup, deleteBackupResponse_backupId - The ID of the backup that was deleted.
DeleteBackupResponse, deleteBackupResponse_lifecycle - The lifecycle status of the backup. If the DeleteBackup operation is
successful, the status is DELETED.
$sel:httpStatus:DeleteBackupResponse', deleteBackupResponse_httpStatus - The response's http status code.
DeleteDataRepositoryAssociation
data DeleteDataRepositoryAssociation Source #
See: newDeleteDataRepositoryAssociation smart constructor.
Instances
newDeleteDataRepositoryAssociation Source #
Create a value of DeleteDataRepositoryAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteDataRepositoryAssociation', deleteDataRepositoryAssociation_clientRequestToken - Undocumented member.
DeleteDataRepositoryAssociation, deleteDataRepositoryAssociation_deleteDataInFileSystem - Set to true to delete the data in the file system that corresponds to
the data repository association.
DeleteDataRepositoryAssociation, deleteDataRepositoryAssociation_associationId - The ID of the data repository association that you want to delete.
data DeleteDataRepositoryAssociationResponse Source #
See: newDeleteDataRepositoryAssociationResponse smart constructor.
Constructors
| DeleteDataRepositoryAssociationResponse' (Maybe Text) (Maybe Bool) (Maybe DataRepositoryLifecycle) Int |
Instances
newDeleteDataRepositoryAssociationResponse Source #
Arguments
| :: Int | |
| -> DeleteDataRepositoryAssociationResponse |
Create a value of DeleteDataRepositoryAssociationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDataRepositoryAssociation, deleteDataRepositoryAssociationResponse_associationId - The ID of the data repository association being deleted.
DeleteDataRepositoryAssociation, deleteDataRepositoryAssociationResponse_deleteDataInFileSystem - Indicates whether data in the file system that corresponds to the data
repository association is being deleted. Default is false.
DeleteDataRepositoryAssociationResponse, deleteDataRepositoryAssociationResponse_lifecycle - Describes the lifecycle state of the data repository association being
deleted.
$sel:httpStatus:DeleteDataRepositoryAssociationResponse', deleteDataRepositoryAssociationResponse_httpStatus - The response's http status code.
DeleteFileCache
data DeleteFileCache Source #
See: newDeleteFileCache smart constructor.
Constructors
| DeleteFileCache' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteFileCache |
Create a value of DeleteFileCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteFileCache', deleteFileCache_clientRequestToken - Undocumented member.
DeleteFileCache, deleteFileCache_fileCacheId - The ID of the cache that's being deleted.
data DeleteFileCacheResponse Source #
See: newDeleteFileCacheResponse smart constructor.
Constructors
| DeleteFileCacheResponse' (Maybe Text) (Maybe FileCacheLifecycle) Int |
Instances
newDeleteFileCacheResponse Source #
Create a value of DeleteFileCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteFileCache, deleteFileCacheResponse_fileCacheId - The ID of the cache that's being deleted.
DeleteFileCacheResponse, deleteFileCacheResponse_lifecycle - The cache lifecycle for the deletion request. If the DeleteFileCache
operation is successful, this status is DELETING.
$sel:httpStatus:DeleteFileCacheResponse', deleteFileCacheResponse_httpStatus - The response's http status code.
DeleteFileSystem
data DeleteFileSystem Source #
The request object for DeleteFileSystem operation.
See: newDeleteFileSystem smart constructor.
Constructors
| DeleteFileSystem' (Maybe Text) (Maybe DeleteFileSystemLustreConfiguration) (Maybe DeleteFileSystemOpenZFSConfiguration) (Maybe DeleteFileSystemWindowsConfiguration) Text |
Instances
Arguments
| :: Text | |
| -> DeleteFileSystem |
Create a value of DeleteFileSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteFileSystem', deleteFileSystem_clientRequestToken - 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, deleteFileSystem_lustreConfiguration - Undocumented member.
DeleteFileSystem, deleteFileSystem_openZFSConfiguration - The configuration object for the OpenZFS file system used in the
DeleteFileSystem operation.
DeleteFileSystem, deleteFileSystem_windowsConfiguration - Undocumented member.
DeleteFileSystem, deleteFileSystem_fileSystemId - The ID of the file system that you want to delete.
data DeleteFileSystemResponse Source #
The response object for the DeleteFileSystem operation.
See: newDeleteFileSystemResponse smart constructor.
Constructors
| DeleteFileSystemResponse' (Maybe Text) (Maybe FileSystemLifecycle) (Maybe DeleteFileSystemLustreResponse) (Maybe DeleteFileSystemOpenZFSResponse) (Maybe DeleteFileSystemWindowsResponse) Int |
Instances
newDeleteFileSystemResponse Source #
Create a value of DeleteFileSystemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteFileSystem, deleteFileSystemResponse_fileSystemId - The ID of the file system that's being deleted.
DeleteFileSystemResponse, deleteFileSystemResponse_lifecycle - The file system lifecycle for the deletion request. If the
DeleteFileSystem operation is successful, this status is DELETING.
$sel:lustreResponse:DeleteFileSystemResponse', deleteFileSystemResponse_lustreResponse - Undocumented member.
$sel:openZFSResponse:DeleteFileSystemResponse', deleteFileSystemResponse_openZFSResponse - The response object for the OpenZFS file system that's being deleted in
the DeleteFileSystem operation.
$sel:windowsResponse:DeleteFileSystemResponse', deleteFileSystemResponse_windowsResponse - Undocumented member.
$sel:httpStatus:DeleteFileSystemResponse', deleteFileSystemResponse_httpStatus - The response's http status code.
DeleteSnapshot
data DeleteSnapshot Source #
See: newDeleteSnapshot smart constructor.
Constructors
| DeleteSnapshot' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteSnapshot |
Create a value of DeleteSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteSnapshot', deleteSnapshot_clientRequestToken - Undocumented member.
DeleteSnapshot, deleteSnapshot_snapshotId - The ID of the snapshot that you want to delete.
data DeleteSnapshotResponse Source #
See: newDeleteSnapshotResponse smart constructor.
Constructors
| DeleteSnapshotResponse' (Maybe SnapshotLifecycle) (Maybe Text) Int |
Instances
newDeleteSnapshotResponse Source #
Create a value of DeleteSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteSnapshotResponse, deleteSnapshotResponse_lifecycle - The lifecycle status of the snapshot. If the DeleteSnapshot operation
is successful, this status is DELETING.
DeleteSnapshot, deleteSnapshotResponse_snapshotId - The ID of the deleted snapshot.
$sel:httpStatus:DeleteSnapshotResponse', deleteSnapshotResponse_httpStatus - The response's http status code.
DeleteStorageVirtualMachine
data DeleteStorageVirtualMachine Source #
See: newDeleteStorageVirtualMachine smart constructor.
Constructors
| DeleteStorageVirtualMachine' (Maybe Text) Text |
Instances
newDeleteStorageVirtualMachine Source #
Arguments
| :: Text | |
| -> DeleteStorageVirtualMachine |
Create a value of DeleteStorageVirtualMachine with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteStorageVirtualMachine', deleteStorageVirtualMachine_clientRequestToken - Undocumented member.
DeleteStorageVirtualMachine, deleteStorageVirtualMachine_storageVirtualMachineId - The ID of the SVM that you want to delete.
data DeleteStorageVirtualMachineResponse Source #
See: newDeleteStorageVirtualMachineResponse smart constructor.
Constructors
| DeleteStorageVirtualMachineResponse' (Maybe StorageVirtualMachineLifecycle) (Maybe Text) Int |
Instances
newDeleteStorageVirtualMachineResponse Source #
Arguments
| :: Int | |
| -> DeleteStorageVirtualMachineResponse |
Create a value of DeleteStorageVirtualMachineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStorageVirtualMachineResponse, deleteStorageVirtualMachineResponse_lifecycle - Describes the lifecycle state of the SVM being deleted.
DeleteStorageVirtualMachine, deleteStorageVirtualMachineResponse_storageVirtualMachineId - The ID of the SVM Amazon FSx is deleting.
$sel:httpStatus:DeleteStorageVirtualMachineResponse', deleteStorageVirtualMachineResponse_httpStatus - The response's http status code.
DeleteVolume
data DeleteVolume Source #
See: newDeleteVolume smart constructor.
Constructors
| DeleteVolume' (Maybe Text) (Maybe DeleteVolumeOntapConfiguration) (Maybe DeleteVolumeOpenZFSConfiguration) Text |
Instances
Arguments
| :: Text | |
| -> DeleteVolume |
Create a value of DeleteVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DeleteVolume', deleteVolume_clientRequestToken - Undocumented member.
DeleteVolume, deleteVolume_ontapConfiguration - 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, deleteVolume_openZFSConfiguration - For Amazon FSx for OpenZFS volumes, specify whether to delete all child
volumes and snapshots.
DeleteVolume, deleteVolume_volumeId - The ID of the volume that you are deleting.
data DeleteVolumeResponse Source #
See: newDeleteVolumeResponse smart constructor.
Constructors
| DeleteVolumeResponse' (Maybe VolumeLifecycle) (Maybe DeleteVolumeOntapResponse) (Maybe Text) Int |
Instances
newDeleteVolumeResponse Source #
Arguments
| :: Int | |
| -> DeleteVolumeResponse |
Create a value of DeleteVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteVolumeResponse, deleteVolumeResponse_lifecycle - The lifecycle state of the volume being deleted. If the DeleteVolume
operation is successful, this value is DELETING.
$sel:ontapResponse:DeleteVolumeResponse', deleteVolumeResponse_ontapResponse - Returned after a DeleteVolume request, showing the status of the
delete request.
DeleteVolume, deleteVolumeResponse_volumeId - The ID of the volume that's being deleted.
$sel:httpStatus:DeleteVolumeResponse', deleteVolumeResponse_httpStatus - The response's http status code.
DescribeBackups (Paginated)
data DescribeBackups Source #
The request object for the DescribeBackups operation.
See: newDescribeBackups smart constructor.
Instances
newDescribeBackups :: DescribeBackups Source #
Create a value of DescribeBackups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupIds:DescribeBackups', describeBackups_backupIds - 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.
$sel:filters:DescribeBackups', describeBackups_filters - The filters structure. The supported names are file-system-id,
backup-type, file-system-type, and volume-id.
$sel:maxResults:DescribeBackups', describeBackups_maxResults - 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, describeBackups_nextToken - 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.
data DescribeBackupsResponse Source #
Response object for the DescribeBackups operation.
See: newDescribeBackupsResponse smart constructor.
Instances
newDescribeBackupsResponse Source #
Create a value of DescribeBackupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backups:DescribeBackupsResponse', describeBackupsResponse_backups - An array of backups.
DescribeBackups, describeBackupsResponse_nextToken - 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.
$sel:httpStatus:DescribeBackupsResponse', describeBackupsResponse_httpStatus - The response's http status code.
DescribeDataRepositoryAssociations
data DescribeDataRepositoryAssociations Source #
See: newDescribeDataRepositoryAssociations smart constructor.
Constructors
| DescribeDataRepositoryAssociations' (Maybe [Text]) (Maybe [Filter]) (Maybe Natural) (Maybe Text) |
Instances
newDescribeDataRepositoryAssociations :: DescribeDataRepositoryAssociations Source #
Create a value of DescribeDataRepositoryAssociations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associationIds:DescribeDataRepositoryAssociations', describeDataRepositoryAssociations_associationIds - IDs of the data repository associations whose descriptions you want to
retrieve (String).
$sel:filters:DescribeDataRepositoryAssociations', describeDataRepositoryAssociations_filters - Undocumented member.
$sel:maxResults:DescribeDataRepositoryAssociations', describeDataRepositoryAssociations_maxResults - The maximum number of resources to return in the response. This value
must be an integer greater than zero.
DescribeDataRepositoryAssociations, describeDataRepositoryAssociations_nextToken - Undocumented member.
data DescribeDataRepositoryAssociationsResponse Source #
See: newDescribeDataRepositoryAssociationsResponse smart constructor.
Constructors
| DescribeDataRepositoryAssociationsResponse' (Maybe [DataRepositoryAssociation]) (Maybe Text) Int |
Instances
newDescribeDataRepositoryAssociationsResponse Source #
Arguments
| :: Int | |
| -> DescribeDataRepositoryAssociationsResponse |
Create a value of DescribeDataRepositoryAssociationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associations:DescribeDataRepositoryAssociationsResponse', describeDataRepositoryAssociationsResponse_associations - An array of one or more data repository association descriptions.
DescribeDataRepositoryAssociations, describeDataRepositoryAssociationsResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeDataRepositoryAssociationsResponse', describeDataRepositoryAssociationsResponse_httpStatus - The response's http status code.
DescribeDataRepositoryTasks
data DescribeDataRepositoryTasks Source #
See: newDescribeDataRepositoryTasks smart constructor.
Constructors
| DescribeDataRepositoryTasks' (Maybe [DataRepositoryTaskFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) |
Instances
newDescribeDataRepositoryTasks :: DescribeDataRepositoryTasks Source #
Create a value of DescribeDataRepositoryTasks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeDataRepositoryTasks', describeDataRepositoryTasks_filters - (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.
$sel:maxResults:DescribeDataRepositoryTasks', describeDataRepositoryTasks_maxResults - Undocumented member.
DescribeDataRepositoryTasks, describeDataRepositoryTasks_nextToken - Undocumented member.
$sel:taskIds:DescribeDataRepositoryTasks', describeDataRepositoryTasks_taskIds - (Optional) IDs of the tasks whose descriptions you want to retrieve
(String).
data DescribeDataRepositoryTasksResponse Source #
See: newDescribeDataRepositoryTasksResponse smart constructor.
Constructors
| DescribeDataRepositoryTasksResponse' (Maybe [DataRepositoryTask]) (Maybe Text) Int |
Instances
newDescribeDataRepositoryTasksResponse Source #
Arguments
| :: Int | |
| -> DescribeDataRepositoryTasksResponse |
Create a value of DescribeDataRepositoryTasksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataRepositoryTasks:DescribeDataRepositoryTasksResponse', describeDataRepositoryTasksResponse_dataRepositoryTasks - The collection of data repository task descriptions returned.
DescribeDataRepositoryTasks, describeDataRepositoryTasksResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeDataRepositoryTasksResponse', describeDataRepositoryTasksResponse_httpStatus - The response's http status code.
DescribeFileCaches
data DescribeFileCaches Source #
See: newDescribeFileCaches smart constructor.
Instances
newDescribeFileCaches :: DescribeFileCaches Source #
Create a value of DescribeFileCaches with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileCacheIds:DescribeFileCaches', describeFileCaches_fileCacheIds - IDs of the caches whose descriptions you want to retrieve (String).
$sel:maxResults:DescribeFileCaches', describeFileCaches_maxResults - Undocumented member.
DescribeFileCaches, describeFileCaches_nextToken - Undocumented member.
data DescribeFileCachesResponse Source #
See: newDescribeFileCachesResponse smart constructor.
Instances
newDescribeFileCachesResponse Source #
Create a value of DescribeFileCachesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileCaches:DescribeFileCachesResponse', describeFileCachesResponse_fileCaches - The response object for the DescribeFileCaches operation.
DescribeFileCaches, describeFileCachesResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeFileCachesResponse', describeFileCachesResponse_httpStatus - The response's http status code.
DescribeFileSystemAliases
data DescribeFileSystemAliases Source #
The request object for DescribeFileSystemAliases operation.
See: newDescribeFileSystemAliases smart constructor.
Instances
newDescribeFileSystemAliases Source #
Arguments
| :: Text | |
| -> DescribeFileSystemAliases |
Create a value of DescribeFileSystemAliases with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DescribeFileSystemAliases', describeFileSystemAliases_clientRequestToken - Undocumented member.
$sel:maxResults:DescribeFileSystemAliases', describeFileSystemAliases_maxResults - 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, describeFileSystemAliases_nextToken - 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, describeFileSystemAliases_fileSystemId - The ID of the file system to return the associated DNS aliases for
(String).
data DescribeFileSystemAliasesResponse Source #
The response object for DescribeFileSystemAliases operation.
See: newDescribeFileSystemAliasesResponse smart constructor.
Instances
newDescribeFileSystemAliasesResponse Source #
Arguments
| :: Int | |
| -> DescribeFileSystemAliasesResponse |
Create a value of DescribeFileSystemAliasesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeFileSystemAliasesResponse, describeFileSystemAliasesResponse_aliases - An array of one or more DNS aliases currently associated with the
specified file system.
DescribeFileSystemAliases, describeFileSystemAliasesResponse_nextToken - 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.
$sel:httpStatus:DescribeFileSystemAliasesResponse', describeFileSystemAliasesResponse_httpStatus - The response's http status code.
DescribeFileSystems (Paginated)
data DescribeFileSystems Source #
The request object for DescribeFileSystems operation.
See: newDescribeFileSystems smart constructor.
Instances
newDescribeFileSystems :: DescribeFileSystems Source #
Create a value of DescribeFileSystems with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemIds:DescribeFileSystems', describeFileSystems_fileSystemIds - IDs of the file systems whose descriptions you want to retrieve
(String).
$sel:maxResults:DescribeFileSystems', describeFileSystems_maxResults - 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, describeFileSystems_nextToken - 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.
data DescribeFileSystemsResponse Source #
The response object for DescribeFileSystems operation.
See: newDescribeFileSystemsResponse smart constructor.
Constructors
| DescribeFileSystemsResponse' (Maybe [FileSystem]) (Maybe Text) Int |
Instances
newDescribeFileSystemsResponse Source #
Create a value of DescribeFileSystemsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystems:DescribeFileSystemsResponse', describeFileSystemsResponse_fileSystems - An array of file system descriptions.
DescribeFileSystems, describeFileSystemsResponse_nextToken - 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.
$sel:httpStatus:DescribeFileSystemsResponse', describeFileSystemsResponse_httpStatus - The response's http status code.
DescribeSnapshots
data DescribeSnapshots Source #
See: newDescribeSnapshots smart constructor.
Constructors
| DescribeSnapshots' (Maybe [SnapshotFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) |
Instances
newDescribeSnapshots :: DescribeSnapshots Source #
Create a value of DescribeSnapshots with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeSnapshots', describeSnapshots_filters - The filters structure. The supported names are file-system-id or
volume-id.
$sel:maxResults:DescribeSnapshots', describeSnapshots_maxResults - Undocumented member.
DescribeSnapshots, describeSnapshots_nextToken - Undocumented member.
$sel:snapshotIds:DescribeSnapshots', describeSnapshots_snapshotIds - 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.
data DescribeSnapshotsResponse Source #
See: newDescribeSnapshotsResponse smart constructor.
Instances
newDescribeSnapshotsResponse Source #
Create a value of DescribeSnapshotsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSnapshots, describeSnapshotsResponse_nextToken - Undocumented member.
$sel:snapshots:DescribeSnapshotsResponse', describeSnapshotsResponse_snapshots - An array of snapshots.
$sel:httpStatus:DescribeSnapshotsResponse', describeSnapshotsResponse_httpStatus - The response's http status code.
DescribeStorageVirtualMachines (Paginated)
data DescribeStorageVirtualMachines Source #
See: newDescribeStorageVirtualMachines smart constructor.
Constructors
| DescribeStorageVirtualMachines' (Maybe [StorageVirtualMachineFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) |
Instances
newDescribeStorageVirtualMachines :: DescribeStorageVirtualMachines Source #
Create a value of DescribeStorageVirtualMachines with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeStorageVirtualMachines', describeStorageVirtualMachines_filters - Enter a filter name:value pair to view a select set of SVMs.
$sel:maxResults:DescribeStorageVirtualMachines', describeStorageVirtualMachines_maxResults - Undocumented member.
DescribeStorageVirtualMachines, describeStorageVirtualMachines_nextToken - Undocumented member.
$sel:storageVirtualMachineIds:DescribeStorageVirtualMachines', describeStorageVirtualMachines_storageVirtualMachineIds - Enter the ID of one or more SVMs that you want to view.
data DescribeStorageVirtualMachinesResponse Source #
See: newDescribeStorageVirtualMachinesResponse smart constructor.
Constructors
| DescribeStorageVirtualMachinesResponse' (Maybe Text) (Maybe [StorageVirtualMachine]) Int |
Instances
newDescribeStorageVirtualMachinesResponse Source #
Arguments
| :: Int | |
| -> DescribeStorageVirtualMachinesResponse |
Create a value of DescribeStorageVirtualMachinesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStorageVirtualMachines, describeStorageVirtualMachinesResponse_nextToken - Undocumented member.
$sel:storageVirtualMachines:DescribeStorageVirtualMachinesResponse', describeStorageVirtualMachinesResponse_storageVirtualMachines - Returned after a successful DescribeStorageVirtualMachines operation,
describing each SVM.
$sel:httpStatus:DescribeStorageVirtualMachinesResponse', describeStorageVirtualMachinesResponse_httpStatus - The response's http status code.
DescribeVolumes (Paginated)
data DescribeVolumes Source #
See: newDescribeVolumes smart constructor.
Constructors
| DescribeVolumes' (Maybe [VolumeFilter]) (Maybe Natural) (Maybe Text) (Maybe [Text]) |
Instances
newDescribeVolumes :: DescribeVolumes Source #
Create a value of DescribeVolumes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeVolumes', describeVolumes_filters - Enter a filter Name and Values pair to view a select set of volumes.
$sel:maxResults:DescribeVolumes', describeVolumes_maxResults - Undocumented member.
DescribeVolumes, describeVolumes_nextToken - Undocumented member.
$sel:volumeIds:DescribeVolumes', describeVolumes_volumeIds - The IDs of the volumes whose descriptions you want to retrieve.
data DescribeVolumesResponse Source #
See: newDescribeVolumesResponse smart constructor.
Instances
newDescribeVolumesResponse Source #
Create a value of DescribeVolumesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeVolumes, describeVolumesResponse_nextToken - Undocumented member.
$sel:volumes:DescribeVolumesResponse', describeVolumesResponse_volumes - Returned after a successful DescribeVolumes operation, describing each
volume.
$sel:httpStatus:DescribeVolumesResponse', describeVolumesResponse_httpStatus - The response's http status code.
DisassociateFileSystemAliases
data DisassociateFileSystemAliases Source #
The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
See: newDisassociateFileSystemAliases smart constructor.
Constructors
| DisassociateFileSystemAliases' (Maybe Text) Text [Text] |
Instances
newDisassociateFileSystemAliases Source #
Create a value of DisassociateFileSystemAliases with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:DisassociateFileSystemAliases', disassociateFileSystemAliases_clientRequestToken - Undocumented member.
DisassociateFileSystemAliases, disassociateFileSystemAliases_fileSystemId - Specifies the file system from which to disassociate the DNS aliases.
DisassociateFileSystemAliases, disassociateFileSystemAliases_aliases - An array of one or more DNS alias names to disassociate, or remove, from
the file system.
data DisassociateFileSystemAliasesResponse Source #
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.
See: newDisassociateFileSystemAliasesResponse smart constructor.
Constructors
| DisassociateFileSystemAliasesResponse' (Maybe [Alias]) Int |
Instances
newDisassociateFileSystemAliasesResponse Source #
Arguments
| :: Int | |
| -> DisassociateFileSystemAliasesResponse |
Create a value of DisassociateFileSystemAliasesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateFileSystemAliases, disassociateFileSystemAliasesResponse_aliases - An array of one or more DNS aliases that Amazon FSx is attempting to
disassociate from the file system.
$sel:httpStatus:DisassociateFileSystemAliasesResponse', disassociateFileSystemAliasesResponse_httpStatus - The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
The request object for ListTagsForResource operation.
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForResource', listTagsForResource_maxResults - 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, listTagsForResource_nextToken - 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, listTagsForResource_resourceARN - The ARN of the Amazon FSx resource that will have its tags listed.
data ListTagsForResourceResponse Source #
The response object for ListTagsForResource operation.
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResourceResponse_nextToken - 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, listTagsForResourceResponse_tags - A list of tags on the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ReleaseFileSystemNfsV3Locks
data ReleaseFileSystemNfsV3Locks Source #
See: newReleaseFileSystemNfsV3Locks smart constructor.
Constructors
| ReleaseFileSystemNfsV3Locks' (Maybe Text) Text |
Instances
newReleaseFileSystemNfsV3Locks Source #
Arguments
| :: Text | |
| -> ReleaseFileSystemNfsV3Locks |
Create a value of ReleaseFileSystemNfsV3Locks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:ReleaseFileSystemNfsV3Locks', releaseFileSystemNfsV3Locks_clientRequestToken - Undocumented member.
ReleaseFileSystemNfsV3Locks, releaseFileSystemNfsV3Locks_fileSystemId - Undocumented member.
data ReleaseFileSystemNfsV3LocksResponse Source #
See: newReleaseFileSystemNfsV3LocksResponse smart constructor.
Constructors
| ReleaseFileSystemNfsV3LocksResponse' (Maybe FileSystem) Int |
Instances
newReleaseFileSystemNfsV3LocksResponse Source #
Arguments
| :: Int | |
| -> ReleaseFileSystemNfsV3LocksResponse |
Create a value of ReleaseFileSystemNfsV3LocksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ReleaseFileSystemNfsV3LocksResponse, releaseFileSystemNfsV3LocksResponse_fileSystem - Undocumented member.
$sel:httpStatus:ReleaseFileSystemNfsV3LocksResponse', releaseFileSystemNfsV3LocksResponse_httpStatus - The response's http status code.
RestoreVolumeFromSnapshot
data RestoreVolumeFromSnapshot Source #
See: newRestoreVolumeFromSnapshot smart constructor.
Constructors
| RestoreVolumeFromSnapshot' (Maybe Text) (Maybe [RestoreOpenZFSVolumeOption]) Text Text |
Instances
newRestoreVolumeFromSnapshot Source #
Arguments
| :: Text | |
| -> Text | |
| -> RestoreVolumeFromSnapshot |
Create a value of RestoreVolumeFromSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:RestoreVolumeFromSnapshot', restoreVolumeFromSnapshot_clientRequestToken - Undocumented member.
RestoreVolumeFromSnapshot, restoreVolumeFromSnapshot_options - 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,RestoreVolumeFromSnapshotfails.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,RestoreVolumeFromSnapshotfails.
RestoreVolumeFromSnapshot, restoreVolumeFromSnapshot_volumeId - The ID of the volume that you are restoring.
RestoreVolumeFromSnapshot, restoreVolumeFromSnapshot_snapshotId - The ID of the source snapshot. Specifies the snapshot that you are
restoring from.
data RestoreVolumeFromSnapshotResponse Source #
See: newRestoreVolumeFromSnapshotResponse smart constructor.
Constructors
| RestoreVolumeFromSnapshotResponse' (Maybe [AdministrativeAction]) (Maybe VolumeLifecycle) (Maybe Text) Int |
Instances
newRestoreVolumeFromSnapshotResponse Source #
Arguments
| :: Int | |
| -> RestoreVolumeFromSnapshotResponse |
Create a value of RestoreVolumeFromSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreVolumeFromSnapshotResponse, restoreVolumeFromSnapshotResponse_administrativeActions - 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, restoreVolumeFromSnapshotResponse_lifecycle - The lifecycle state of the volume being restored.
RestoreVolumeFromSnapshot, restoreVolumeFromSnapshotResponse_volumeId - The ID of the volume that you restored.
$sel:httpStatus:RestoreVolumeFromSnapshotResponse', restoreVolumeFromSnapshotResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
The request object for the TagResource operation.
See: newTagResource smart constructor.
Constructors
| TagResource' Text (NonEmpty Tag) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Tag | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource, tagResource_resourceARN - The Amazon Resource Name (ARN) of the Amazon FSx resource that you want
to tag.
TagResource, tagResource_tags - 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.
data TagResourceResponse Source #
The response object for the TagResource operation.
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
The request object for UntagResource action.
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource, untagResource_resourceARN - The ARN of the Amazon FSx resource to untag.
$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.
data UntagResourceResponse Source #
The response object for UntagResource action.
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateDataRepositoryAssociation
data UpdateDataRepositoryAssociation Source #
See: newUpdateDataRepositoryAssociation smart constructor.
Constructors
| UpdateDataRepositoryAssociation' (Maybe Text) (Maybe Natural) (Maybe S3DataRepositoryConfiguration) Text |
Instances
newUpdateDataRepositoryAssociation Source #
Create a value of UpdateDataRepositoryAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateDataRepositoryAssociation', updateDataRepositoryAssociation_clientRequestToken - Undocumented member.
UpdateDataRepositoryAssociation, updateDataRepositoryAssociation_importedFileChunkSize - 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, updateDataRepositoryAssociation_s3 - 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, updateDataRepositoryAssociation_associationId - The ID of the data repository association that you are updating.
data UpdateDataRepositoryAssociationResponse Source #
See: newUpdateDataRepositoryAssociationResponse smart constructor.
Instances
newUpdateDataRepositoryAssociationResponse Source #
Arguments
| :: Int | |
| -> UpdateDataRepositoryAssociationResponse |
Create a value of UpdateDataRepositoryAssociationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:association:UpdateDataRepositoryAssociationResponse', updateDataRepositoryAssociationResponse_association - The response object returned after the data repository association is
updated.
$sel:httpStatus:UpdateDataRepositoryAssociationResponse', updateDataRepositoryAssociationResponse_httpStatus - The response's http status code.
UpdateFileCache
data UpdateFileCache Source #
See: newUpdateFileCache smart constructor.
Constructors
| UpdateFileCache' (Maybe Text) (Maybe UpdateFileCacheLustreConfiguration) Text |
Instances
Arguments
| :: Text | |
| -> UpdateFileCache |
Create a value of UpdateFileCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateFileCache', updateFileCache_clientRequestToken - Undocumented member.
UpdateFileCache, updateFileCache_lustreConfiguration - The configuration updates for an Amazon File Cache resource.
UpdateFileCache, updateFileCache_fileCacheId - The ID of the cache that you are updating.
data UpdateFileCacheResponse Source #
See: newUpdateFileCacheResponse smart constructor.
Constructors
| UpdateFileCacheResponse' (Maybe FileCache) Int |
Instances
newUpdateFileCacheResponse Source #
Create a value of UpdateFileCacheResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileCache:UpdateFileCacheResponse', updateFileCacheResponse_fileCache - A description of the cache that was updated.
$sel:httpStatus:UpdateFileCacheResponse', updateFileCacheResponse_httpStatus - The response's http status code.
UpdateFileSystem
data UpdateFileSystem Source #
The request object for the UpdateFileSystem operation.
See: newUpdateFileSystem smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> UpdateFileSystem |
Create a value of UpdateFileSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateFileSystem', updateFileSystem_clientRequestToken - 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, updateFileSystem_lustreConfiguration - Undocumented member.
UpdateFileSystem, updateFileSystem_ontapConfiguration - Undocumented member.
UpdateFileSystem, updateFileSystem_openZFSConfiguration - The configuration updates for an Amazon FSx for OpenZFS file system.
UpdateFileSystem, updateFileSystem_storageCapacity - 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, andPERSISTENT_2 SSDdeployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity. - For
PERSISTENT HDDfile 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_1file 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, updateFileSystem_windowsConfiguration - The configuration updates for an Amazon FSx for Windows File Server file
system.
UpdateFileSystem, updateFileSystem_fileSystemId - The ID of the file system that you are updating.
data UpdateFileSystemResponse Source #
The response object for the UpdateFileSystem operation.
See: newUpdateFileSystemResponse smart constructor.
Constructors
| UpdateFileSystemResponse' (Maybe FileSystem) Int |
Instances
newUpdateFileSystemResponse Source #
Create a value of UpdateFileSystemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateFileSystemResponse, updateFileSystemResponse_fileSystem - A description of the file system that was updated.
$sel:httpStatus:UpdateFileSystemResponse', updateFileSystemResponse_httpStatus - The response's http status code.
UpdateSnapshot
data UpdateSnapshot Source #
See: newUpdateSnapshot smart constructor.
Constructors
| UpdateSnapshot' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSnapshot |
Create a value of UpdateSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateSnapshot', updateSnapshot_clientRequestToken - Undocumented member.
UpdateSnapshot, updateSnapshot_name - The name of the snapshot to update.
UpdateSnapshot, updateSnapshot_snapshotId - The ID of the snapshot that you want to update, in the format
fsvolsnap-0123456789abcdef0.
data UpdateSnapshotResponse Source #
See: newUpdateSnapshotResponse smart constructor.
Constructors
| UpdateSnapshotResponse' (Maybe Snapshot) Int |
Instances
newUpdateSnapshotResponse Source #
Create a value of UpdateSnapshotResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshot:UpdateSnapshotResponse', updateSnapshotResponse_snapshot - Returned after a successful UpdateSnapshot operation, describing the
snapshot that you updated.
$sel:httpStatus:UpdateSnapshotResponse', updateSnapshotResponse_httpStatus - The response's http status code.
UpdateStorageVirtualMachine
data UpdateStorageVirtualMachine Source #
See: newUpdateStorageVirtualMachine smart constructor.
Constructors
| UpdateStorageVirtualMachine' (Maybe UpdateSvmActiveDirectoryConfiguration) (Maybe Text) (Maybe (Sensitive Text)) Text |
Instances
newUpdateStorageVirtualMachine Source #
Arguments
| :: Text | |
| -> UpdateStorageVirtualMachine |
Create a value of UpdateStorageVirtualMachine with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStorageVirtualMachine, updateStorageVirtualMachine_activeDirectoryConfiguration - Updates the Microsoft Active Directory (AD) configuration for an SVM
that is joined to an AD.
$sel:clientRequestToken:UpdateStorageVirtualMachine', updateStorageVirtualMachine_clientRequestToken - Undocumented member.
$sel:svmAdminPassword:UpdateStorageVirtualMachine', updateStorageVirtualMachine_svmAdminPassword - Enter a new SvmAdminPassword if you are updating it.
UpdateStorageVirtualMachine, updateStorageVirtualMachine_storageVirtualMachineId - The ID of the SVM that you want to update, in the format
svm-0123456789abcdef0.
data UpdateStorageVirtualMachineResponse Source #
See: newUpdateStorageVirtualMachineResponse smart constructor.
Constructors
| UpdateStorageVirtualMachineResponse' (Maybe StorageVirtualMachine) Int |
Instances
newUpdateStorageVirtualMachineResponse Source #
Arguments
| :: Int | |
| -> UpdateStorageVirtualMachineResponse |
Create a value of UpdateStorageVirtualMachineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageVirtualMachine:UpdateStorageVirtualMachineResponse', updateStorageVirtualMachineResponse_storageVirtualMachine - Undocumented member.
$sel:httpStatus:UpdateStorageVirtualMachineResponse', updateStorageVirtualMachineResponse_httpStatus - The response's http status code.
UpdateVolume
data UpdateVolume Source #
See: newUpdateVolume smart constructor.
Constructors
| UpdateVolume' (Maybe Text) (Maybe Text) (Maybe UpdateOntapVolumeConfiguration) (Maybe UpdateOpenZFSVolumeConfiguration) Text |
Instances
Arguments
| :: Text | |
| -> UpdateVolume |
Create a value of UpdateVolume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:UpdateVolume', updateVolume_clientRequestToken - Undocumented member.
UpdateVolume, updateVolume_name - 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, updateVolume_ontapConfiguration - The configuration of the ONTAP volume that you are updating.
UpdateVolume, updateVolume_openZFSConfiguration - The configuration of the OpenZFS volume that you are updating.
UpdateVolume, updateVolume_volumeId - The ID of the volume that you want to update, in the format
fsvol-0123456789abcdef0.
data UpdateVolumeResponse Source #
See: newUpdateVolumeResponse smart constructor.
Constructors
| UpdateVolumeResponse' (Maybe Volume) Int |
Instances
newUpdateVolumeResponse Source #
Arguments
| :: Int | |
| -> UpdateVolumeResponse |
Create a value of UpdateVolumeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateVolumeResponse, updateVolumeResponse_volume - A description of the volume just updated. Returned after a successful
UpdateVolume API operation.
$sel:httpStatus:UpdateVolumeResponse', updateVolumeResponse_httpStatus - The response's http status code.
Types
AdministrativeActionType
newtype AdministrativeActionType Source #
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE- A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).STORAGE_OPTIMIZATION- After theFILE_SYSTEM_UPDATEtask to increase a file system's storage capacity has been completed successfully, aSTORAGE_OPTIMIZATIONtask starts.- For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.
- For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage-optimization progress using the
ProgressPercentproperty. WhenSTORAGE_OPTIMIZATIONhas been completed successfully, the parentFILE_SYSTEM_UPDATEaction status changes toCOMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.FILE_SYSTEM_ALIAS_ASSOCIATION- A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.FILE_SYSTEM_ALIAS_DISASSOCIATION- A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.VOLUME_UPDATE- A volume update to an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).VOLUME_RESTORE- An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).SNAPSHOT_UPDATE- A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).RELEASE_NFS_V3_LOCKS- Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
Constructors
| AdministrativeActionType' | |
Fields | |
Bundled Patterns
Instances
AliasLifecycle
newtype AliasLifecycle Source #
Constructors
| AliasLifecycle' | |
Fields | |
Bundled Patterns
| pattern AliasLifecycle_AVAILABLE :: AliasLifecycle | |
| pattern AliasLifecycle_CREATE_FAILED :: AliasLifecycle | |
| pattern AliasLifecycle_CREATING :: AliasLifecycle | |
| pattern AliasLifecycle_DELETE_FAILED :: AliasLifecycle | |
| pattern AliasLifecycle_DELETING :: AliasLifecycle |
Instances
AutoImportPolicyType
newtype AutoImportPolicyType Source #
Constructors
| AutoImportPolicyType' | |
Fields | |
Bundled Patterns
| pattern AutoImportPolicyType_NEW :: AutoImportPolicyType | |
| pattern AutoImportPolicyType_NEW_CHANGED :: AutoImportPolicyType | |
| pattern AutoImportPolicyType_NEW_CHANGED_DELETED :: AutoImportPolicyType | |
| pattern AutoImportPolicyType_NONE :: AutoImportPolicyType |
Instances
BackupLifecycle
newtype 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 new user-initiated backup.TRANSFERRING- For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file system.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.
Constructors
| BackupLifecycle' | |
Fields | |
Bundled Patterns
| pattern BackupLifecycle_AVAILABLE :: BackupLifecycle | |
| pattern BackupLifecycle_COPYING :: BackupLifecycle | |
| pattern BackupLifecycle_CREATING :: BackupLifecycle | |
| pattern BackupLifecycle_DELETED :: BackupLifecycle | |
| pattern BackupLifecycle_FAILED :: BackupLifecycle | |
| pattern BackupLifecycle_PENDING :: BackupLifecycle | |
| pattern BackupLifecycle_TRANSFERRING :: BackupLifecycle |
Instances
BackupType
newtype BackupType Source #
The type of the backup.
Constructors
| BackupType' | |
Fields | |
Bundled Patterns
| pattern BackupType_AUTOMATIC :: BackupType | |
| pattern BackupType_AWS_BACKUP :: BackupType | |
| pattern BackupType_USER_INITIATED :: BackupType |
Instances
DataCompressionType
newtype DataCompressionType Source #
Constructors
| DataCompressionType' | |
Fields | |
Bundled Patterns
| pattern DataCompressionType_LZ4 :: DataCompressionType | |
| pattern DataCompressionType_NONE :: DataCompressionType |
Instances
DataRepositoryLifecycle
newtype DataRepositoryLifecycle Source #
Constructors
| DataRepositoryLifecycle' | |
Fields | |
Bundled Patterns
Instances
DataRepositoryTaskFilterName
newtype DataRepositoryTaskFilterName Source #
Constructors
| DataRepositoryTaskFilterName' | |
Fields | |
Bundled Patterns
Instances
DataRepositoryTaskLifecycle
newtype DataRepositoryTaskLifecycle Source #
Constructors
| DataRepositoryTaskLifecycle' | |
Fields | |
Bundled Patterns
Instances
DataRepositoryTaskType
newtype DataRepositoryTaskType Source #
Constructors
| DataRepositoryTaskType' | |
Fields | |
Bundled Patterns
Instances
DeleteFileSystemOpenZFSOption
newtype DeleteFileSystemOpenZFSOption Source #
Constructors
| DeleteFileSystemOpenZFSOption' | |
Fields | |
Bundled Patterns
| pattern DeleteFileSystemOpenZFSOption_DELETE_CHILD_VOLUMES_AND_SNAPSHOTS :: DeleteFileSystemOpenZFSOption |
Instances
DeleteOpenZFSVolumeOption
newtype DeleteOpenZFSVolumeOption Source #
Constructors
| DeleteOpenZFSVolumeOption' | |
Fields | |
Bundled Patterns
| pattern DeleteOpenZFSVolumeOption_DELETE_CHILD_VOLUMES_AND_SNAPSHOTS :: DeleteOpenZFSVolumeOption |
Instances
DiskIopsConfigurationMode
newtype DiskIopsConfigurationMode Source #
Constructors
| DiskIopsConfigurationMode' | |
Fields | |
Bundled Patterns
| pattern DiskIopsConfigurationMode_AUTOMATIC :: DiskIopsConfigurationMode | |
| pattern DiskIopsConfigurationMode_USER_PROVISIONED :: DiskIopsConfigurationMode |
Instances
DriveCacheType
newtype DriveCacheType Source #
Constructors
| DriveCacheType' | |
Fields | |
Bundled Patterns
| pattern DriveCacheType_NONE :: DriveCacheType | |
| pattern DriveCacheType_READ :: DriveCacheType |
Instances
EventType
Constructors
| EventType' | |
Fields | |
Bundled Patterns
| pattern EventType_CHANGED :: EventType | |
| pattern EventType_DELETED :: EventType | |
| pattern EventType_NEW :: EventType |
Instances
FileCacheLifecycle
newtype FileCacheLifecycle Source #
Constructors
| FileCacheLifecycle' | |
Fields | |
Bundled Patterns
| pattern FileCacheLifecycle_AVAILABLE :: FileCacheLifecycle | |
| pattern FileCacheLifecycle_CREATING :: FileCacheLifecycle | |
| pattern FileCacheLifecycle_DELETING :: FileCacheLifecycle | |
| pattern FileCacheLifecycle_FAILED :: FileCacheLifecycle | |
| pattern FileCacheLifecycle_UPDATING :: FileCacheLifecycle |
Instances
FileCacheLustreDeploymentType
newtype FileCacheLustreDeploymentType Source #
Constructors
| FileCacheLustreDeploymentType' | |
Fields | |
Bundled Patterns
| pattern FileCacheLustreDeploymentType_CACHE_1 :: FileCacheLustreDeploymentType |
Instances
FileCacheType
newtype FileCacheType Source #
Constructors
| FileCacheType' | |
Fields | |
Bundled Patterns
| pattern FileCacheType_LUSTRE :: FileCacheType |
Instances
FileSystemLifecycle
newtype FileSystemLifecycle Source #
The lifecycle status of the file system.
Constructors
| FileSystemLifecycle' | |
Fields | |
Bundled Patterns
| pattern FileSystemLifecycle_AVAILABLE :: FileSystemLifecycle | |
| pattern FileSystemLifecycle_CREATING :: FileSystemLifecycle | |
| pattern FileSystemLifecycle_DELETING :: FileSystemLifecycle | |
| pattern FileSystemLifecycle_FAILED :: FileSystemLifecycle | |
| pattern FileSystemLifecycle_MISCONFIGURED :: FileSystemLifecycle | |
| pattern FileSystemLifecycle_MISCONFIGURED_UNAVAILABLE :: FileSystemLifecycle | |
| pattern FileSystemLifecycle_UPDATING :: FileSystemLifecycle |
Instances
FileSystemMaintenanceOperation
newtype FileSystemMaintenanceOperation Source #
An enumeration specifying the currently ongoing maintenance operation.
Constructors
| FileSystemMaintenanceOperation' | |
Fields | |
Bundled Patterns
| pattern FileSystemMaintenanceOperation_BACKING_UP :: FileSystemMaintenanceOperation | |
| pattern FileSystemMaintenanceOperation_PATCHING :: FileSystemMaintenanceOperation |
Instances
FileSystemType
newtype FileSystemType Source #
The type of file system.
Constructors
| FileSystemType' | |
Fields | |
Bundled Patterns
| pattern FileSystemType_LUSTRE :: FileSystemType | |
| pattern FileSystemType_ONTAP :: FileSystemType | |
| pattern FileSystemType_OPENZFS :: FileSystemType | |
| pattern FileSystemType_WINDOWS :: FileSystemType |
Instances
FilterName
newtype FilterName Source #
The name for a filter.
Constructors
| FilterName' | |
Fields | |
Bundled Patterns
| pattern FilterName_Backup_type :: FilterName | |
| pattern FilterName_Data_repository_type :: FilterName | |
| pattern FilterName_File_cache_id :: FilterName | |
| pattern FilterName_File_cache_type :: FilterName | |
| pattern FilterName_File_system_id :: FilterName | |
| pattern FilterName_File_system_type :: FilterName | |
| pattern FilterName_Volume_id :: FilterName |
Instances
FlexCacheEndpointType
newtype FlexCacheEndpointType Source #
Constructors
| FlexCacheEndpointType' | |
Fields | |
Bundled Patterns
| pattern FlexCacheEndpointType_CACHE :: FlexCacheEndpointType | |
| pattern FlexCacheEndpointType_NONE :: FlexCacheEndpointType | |
| pattern FlexCacheEndpointType_ORIGIN :: FlexCacheEndpointType |
Instances
InputOntapVolumeType
newtype InputOntapVolumeType Source #
Constructors
| InputOntapVolumeType' | |
Fields | |
Bundled Patterns
| pattern InputOntapVolumeType_DP :: InputOntapVolumeType | |
| pattern InputOntapVolumeType_RW :: InputOntapVolumeType |
Instances
LustreAccessAuditLogLevel
newtype LustreAccessAuditLogLevel Source #
Constructors
| LustreAccessAuditLogLevel' | |
Fields | |
Bundled Patterns
Instances
LustreDeploymentType
newtype LustreDeploymentType Source #
Constructors
| LustreDeploymentType' | |
Fields | |
Bundled Patterns
Instances
NfsVersion
newtype NfsVersion Source #
Constructors
| NfsVersion' | |
Fields | |
Bundled Patterns
| pattern NfsVersion_NFS3 :: NfsVersion |
Instances
OntapDeploymentType
newtype OntapDeploymentType Source #
Constructors
| OntapDeploymentType' | |
Fields | |
Bundled Patterns
| pattern OntapDeploymentType_MULTI_AZ_1 :: OntapDeploymentType | |
| pattern OntapDeploymentType_SINGLE_AZ_1 :: OntapDeploymentType |
Instances
OntapVolumeType
newtype OntapVolumeType Source #
Constructors
| OntapVolumeType' | |
Fields | |
Bundled Patterns
| pattern OntapVolumeType_DP :: OntapVolumeType | |
| pattern OntapVolumeType_LS :: OntapVolumeType | |
| pattern OntapVolumeType_RW :: OntapVolumeType |
Instances
OpenZFSCopyStrategy
newtype OpenZFSCopyStrategy Source #
Constructors
| OpenZFSCopyStrategy' | |
Fields | |
Bundled Patterns
| pattern OpenZFSCopyStrategy_CLONE :: OpenZFSCopyStrategy | |
| pattern OpenZFSCopyStrategy_FULL_COPY :: OpenZFSCopyStrategy |
Instances
OpenZFSDataCompressionType
newtype OpenZFSDataCompressionType Source #
Constructors
| OpenZFSDataCompressionType' | |
Fields | |
Bundled Patterns
Instances
OpenZFSDeploymentType
newtype OpenZFSDeploymentType Source #
Constructors
| OpenZFSDeploymentType' | |
Fields | |
Bundled Patterns
| pattern OpenZFSDeploymentType_SINGLE_AZ_1 :: OpenZFSDeploymentType | |
| pattern OpenZFSDeploymentType_SINGLE_AZ_2 :: OpenZFSDeploymentType |
Instances
OpenZFSQuotaType
newtype OpenZFSQuotaType Source #
Constructors
| OpenZFSQuotaType' | |
Fields | |
Bundled Patterns
| pattern OpenZFSQuotaType_GROUP :: OpenZFSQuotaType | |
| pattern OpenZFSQuotaType_USER :: OpenZFSQuotaType |
Instances
ReportFormat
newtype ReportFormat Source #
Constructors
| ReportFormat' | |
Fields | |
Bundled Patterns
| pattern ReportFormat_REPORT_CSV_20191124 :: ReportFormat |
Instances
ReportScope
newtype ReportScope Source #
Constructors
| ReportScope' | |
Fields | |
Bundled Patterns
| pattern ReportScope_FAILED_FILES_ONLY :: ReportScope |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_FILE_SYSTEM :: ResourceType | |
| pattern ResourceType_VOLUME :: ResourceType |
Instances
RestoreOpenZFSVolumeOption
newtype RestoreOpenZFSVolumeOption Source #
Constructors
| RestoreOpenZFSVolumeOption' | |
Fields | |
Bundled Patterns
| pattern RestoreOpenZFSVolumeOption_DELETE_CLONED_VOLUMES :: RestoreOpenZFSVolumeOption | |
| pattern RestoreOpenZFSVolumeOption_DELETE_INTERMEDIATE_SNAPSHOTS :: RestoreOpenZFSVolumeOption |
Instances
SecurityStyle
newtype SecurityStyle Source #
Constructors
| SecurityStyle' | |
Fields | |
Bundled Patterns
| pattern SecurityStyle_MIXED :: SecurityStyle | |
| pattern SecurityStyle_NTFS :: SecurityStyle | |
| pattern SecurityStyle_UNIX :: SecurityStyle |
Instances
SnapshotFilterName
newtype SnapshotFilterName Source #
Constructors
| SnapshotFilterName' | |
Fields | |
Bundled Patterns
| pattern SnapshotFilterName_File_system_id :: SnapshotFilterName | |
| pattern SnapshotFilterName_Volume_id :: SnapshotFilterName |
Instances
SnapshotLifecycle
newtype SnapshotLifecycle Source #
Constructors
| SnapshotLifecycle' | |
Fields | |
Bundled Patterns
| pattern SnapshotLifecycle_AVAILABLE :: SnapshotLifecycle | |
| pattern SnapshotLifecycle_CREATING :: SnapshotLifecycle | |
| pattern SnapshotLifecycle_DELETING :: SnapshotLifecycle | |
| pattern SnapshotLifecycle_PENDING :: SnapshotLifecycle |
Instances
Status
Constructors
| Status' | |
Fields
| |
Bundled Patterns
| pattern Status_COMPLETED :: Status | |
| pattern Status_FAILED :: Status | |
| pattern Status_IN_PROGRESS :: Status | |
| pattern Status_PENDING :: Status | |
| pattern Status_UPDATED_OPTIMIZING :: Status |
Instances
StorageType
newtype StorageType Source #
The storage type for your Amazon FSx file system.
Constructors
| StorageType' | |
Fields | |
Bundled Patterns
| pattern StorageType_HDD :: StorageType | |
| pattern StorageType_SSD :: StorageType |
Instances
StorageVirtualMachineFilterName
newtype StorageVirtualMachineFilterName Source #
Constructors
| StorageVirtualMachineFilterName' | |
Fields | |
Bundled Patterns
| pattern StorageVirtualMachineFilterName_File_system_id :: StorageVirtualMachineFilterName |
Instances
StorageVirtualMachineLifecycle
newtype StorageVirtualMachineLifecycle Source #
Constructors
| StorageVirtualMachineLifecycle' | |
Fields | |
Bundled Patterns
Instances
StorageVirtualMachineRootVolumeSecurityStyle
newtype StorageVirtualMachineRootVolumeSecurityStyle Source #
Constructors
| StorageVirtualMachineRootVolumeSecurityStyle' | |
Bundled Patterns
Instances
StorageVirtualMachineSubtype
newtype StorageVirtualMachineSubtype Source #
Constructors
| StorageVirtualMachineSubtype' | |
Fields | |
Bundled Patterns
Instances
TieringPolicyName
newtype TieringPolicyName Source #
Constructors
| TieringPolicyName' | |
Fields | |
Bundled Patterns
| pattern TieringPolicyName_ALL :: TieringPolicyName | |
| pattern TieringPolicyName_AUTO :: TieringPolicyName | |
| pattern TieringPolicyName_NONE :: TieringPolicyName | |
| pattern TieringPolicyName_SNAPSHOT_ONLY :: TieringPolicyName |
Instances
VolumeFilterName
newtype VolumeFilterName Source #
Constructors
| VolumeFilterName' | |
Fields | |
Bundled Patterns
| pattern VolumeFilterName_File_system_id :: VolumeFilterName | |
| pattern VolumeFilterName_Storage_virtual_machine_id :: VolumeFilterName |
Instances
VolumeLifecycle
newtype VolumeLifecycle Source #
Constructors
| VolumeLifecycle' | |
Fields | |
Bundled Patterns
| pattern VolumeLifecycle_AVAILABLE :: VolumeLifecycle | |
| pattern VolumeLifecycle_CREATED :: VolumeLifecycle | |
| pattern VolumeLifecycle_CREATING :: VolumeLifecycle | |
| pattern VolumeLifecycle_DELETING :: VolumeLifecycle | |
| pattern VolumeLifecycle_FAILED :: VolumeLifecycle | |
| pattern VolumeLifecycle_MISCONFIGURED :: VolumeLifecycle | |
| pattern VolumeLifecycle_PENDING :: VolumeLifecycle |
Instances
VolumeType
newtype VolumeType Source #
Constructors
| VolumeType' | |
Fields | |
Bundled Patterns
| pattern VolumeType_ONTAP :: VolumeType | |
| pattern VolumeType_OPENZFS :: VolumeType |
Instances
WindowsAccessAuditLogLevel
newtype WindowsAccessAuditLogLevel Source #
Constructors
| WindowsAccessAuditLogLevel' | |
Fields | |
Bundled Patterns
Instances
WindowsDeploymentType
newtype WindowsDeploymentType Source #
Constructors
| WindowsDeploymentType' | |
Fields | |
Bundled Patterns
| pattern WindowsDeploymentType_MULTI_AZ_1 :: WindowsDeploymentType | |
| pattern WindowsDeploymentType_SINGLE_AZ_1 :: WindowsDeploymentType | |
| pattern WindowsDeploymentType_SINGLE_AZ_2 :: WindowsDeploymentType |
Instances
ActiveDirectoryBackupAttributes
data ActiveDirectoryBackupAttributes Source #
The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.
See: newActiveDirectoryBackupAttributes smart constructor.
Instances
newActiveDirectoryBackupAttributes :: ActiveDirectoryBackupAttributes Source #
Create a value of ActiveDirectoryBackupAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeDirectoryId:ActiveDirectoryBackupAttributes', activeDirectoryBackupAttributes_activeDirectoryId - The ID of the Amazon Web Services Managed Microsoft Active Directory
instance to which the file system is joined.
$sel:domainName:ActiveDirectoryBackupAttributes', activeDirectoryBackupAttributes_domainName - The fully qualified domain name of the self-managed Active Directory
directory.
$sel:resourceARN:ActiveDirectoryBackupAttributes', activeDirectoryBackupAttributes_resourceARN - Undocumented member.
AdministrativeAction
data AdministrativeAction Source #
Describes a specific Amazon FSx administrative action for the current Windows, Lustre, or OpenZFS file system.
See: newAdministrativeAction smart constructor.
Constructors
| AdministrativeAction' (Maybe AdministrativeActionType) (Maybe AdministrativeActionFailureDetails) (Maybe Natural) (Maybe POSIX) (Maybe Status) (Maybe FileSystem) (Maybe Snapshot) (Maybe Volume) |
Instances
newAdministrativeAction :: AdministrativeAction Source #
Create a value of AdministrativeAction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:administrativeActionType:AdministrativeAction', administrativeAction_administrativeActionType - Undocumented member.
$sel:failureDetails:AdministrativeAction', administrativeAction_failureDetails - Undocumented member.
$sel:progressPercent:AdministrativeAction', administrativeAction_progressPercent - The percentage-complete status of a STORAGE_OPTIMIZATION
administrative action. Does not apply to any other administrative action
type.
$sel:requestTime:AdministrativeAction', administrativeAction_requestTime - The time that the administrative action request was received.
$sel:status:AdministrativeAction', administrativeAction_status - 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.
$sel:targetFileSystemValues:AdministrativeAction', administrativeAction_targetFileSystemValues - Describes the target value for the administration action, provided in
the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE
administrative actions.
$sel:targetSnapshotValues:AdministrativeAction', administrativeAction_targetSnapshotValues - Undocumented member.
$sel:targetVolumeValues:AdministrativeAction', administrativeAction_targetVolumeValues - Undocumented member.
AdministrativeActionFailureDetails
data AdministrativeActionFailureDetails Source #
Provides information about a failed administrative action.
See: newAdministrativeActionFailureDetails smart constructor.
Constructors
| AdministrativeActionFailureDetails' (Maybe Text) |
Instances
newAdministrativeActionFailureDetails :: AdministrativeActionFailureDetails Source #
Create a value of AdministrativeActionFailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:AdministrativeActionFailureDetails', administrativeActionFailureDetails_message - Error message providing details about the failed administrative action.
Alias
A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.
See: newAlias smart constructor.
Constructors
| Alias' (Maybe AliasLifecycle) (Maybe Text) |
Instances
| FromJSON Alias Source # | |
| Generic Alias Source # | |
| Read Alias Source # | |
| Show Alias Source # | |
| NFData Alias Source # | |
Defined in Amazonka.FSx.Types.Alias | |
| Eq Alias Source # | |
| Hashable Alias Source # | |
Defined in Amazonka.FSx.Types.Alias | |
| type Rep Alias Source # | |
Defined in Amazonka.FSx.Types.Alias type Rep Alias = D1 ('MetaData "Alias" "Amazonka.FSx.Types.Alias" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "Alias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AliasLifecycle)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Alias with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lifecycle:Alias', alias_lifecycle - 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.
$sel:name:Alias', alias_name - 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
data AutoExportPolicy Source #
Describes a data repository association's automatic export policy. The
AutoExportPolicy defines the types of updated objects on the file
system that will be automatically exported to the data repository. As
you create, modify, or delete files, Amazon FSx for Lustre automatically
exports the defined changes asynchronously once your application
finishes modifying the file.
This AutoExportPolicy is supported only for Amazon FSx for Lustre file
systems with the Persistent_2 deployment type.
See: newAutoExportPolicy smart constructor.
Constructors
| AutoExportPolicy' (Maybe [EventType]) |
Instances
newAutoExportPolicy :: AutoExportPolicy Source #
Create a value of AutoExportPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:AutoExportPolicy', autoExportPolicy_events - 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
data AutoImportPolicy Source #
Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.
The AutoImportPolicy is supported only for Amazon FSx for Lustre file
systems with the Persistent_2 deployment type.
See: newAutoImportPolicy smart constructor.
Constructors
| AutoImportPolicy' (Maybe [EventType]) |
Instances
newAutoImportPolicy :: AutoImportPolicy Source #
Create a value of AutoImportPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:AutoImportPolicy', autoImportPolicy_events - 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
A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.
See: newBackup smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> BackupLifecycle | |
| -> BackupType | |
| -> UTCTime | |
| -> FileSystem | |
| -> Backup |
Create a value of Backup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:directoryInformation:Backup', backup_directoryInformation - The configuration of the self-managed Microsoft Active Directory
directory to which the Windows File Server instance is joined.
Backup, backup_failureDetails - Details explaining any failures that occurred when creating a backup.
Backup, backup_kmsKeyId - 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, backup_ownerId - Undocumented member.
$sel:progressPercent:Backup', backup_progressPercent - Undocumented member.
Backup, backup_resourceARN - The Amazon Resource Name (ARN) for the backup resource.
$sel:resourceType:Backup', backup_resourceType - Specifies the resource type that's backed up.
$sel:sourceBackupId:Backup', backup_sourceBackupId - Undocumented member.
$sel:sourceBackupRegion:Backup', backup_sourceBackupRegion - The source Region of the backup. Specifies the Region from where this
backup is copied.
Backup, backup_tags - The tags associated with a particular file system.
$sel:volume:Backup', backup_volume - Undocumented member.
$sel:backupId:Backup', backup_backupId - The ID of the backup.
Backup, backup_lifecycle - 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.
$sel:type':Backup', backup_type - The type of the file-system backup.
Backup, backup_creationTime - The time when a particular backup was created.
$sel:fileSystem:Backup', backup_fileSystem - The metadata of the file system associated with the backup. This
metadata is persisted even if the file system is deleted.
BackupFailureDetails
data BackupFailureDetails Source #
If backup creation fails, this structure contains the details of that failure.
See: newBackupFailureDetails smart constructor.
Constructors
| BackupFailureDetails' (Maybe Text) |
Instances
newBackupFailureDetails :: BackupFailureDetails Source #
Create a value of BackupFailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:BackupFailureDetails', backupFailureDetails_message - A message describing the backup-creation failure.
CompletionReport
data CompletionReport Source #
Provides a report detailing the data repository task results of the
files processed that match the criteria specified in the report Scope
parameter. FSx delivers the report to the file system's linked data
repository in Amazon S3, using the path specified in the report Path
parameter. You can specify whether or not a report gets generated for a
task using the Enabled parameter.
See: newCompletionReport smart constructor.
Constructors
| CompletionReport' (Maybe ReportFormat) (Maybe Text) (Maybe ReportScope) Bool |
Instances
Arguments
| :: Bool | |
| -> CompletionReport |
Create a value of CompletionReport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:format:CompletionReport', completionReport_format - 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.
$sel:path:CompletionReport', completionReport_path - 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 .
$sel:scope:CompletionReport', completionReport_scope - 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.
$sel:enabled:CompletionReport', completionReport_enabled - 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
data CreateFileCacheLustreConfiguration Source #
The Amazon File Cache configuration for the cache that you are creating.
See: newCreateFileCacheLustreConfiguration smart constructor.
Constructors
| CreateFileCacheLustreConfiguration' (Maybe Text) Natural FileCacheLustreDeploymentType FileCacheLustreMetadataConfiguration |
Instances
newCreateFileCacheLustreConfiguration Source #
Arguments
Create a value of CreateFileCacheLustreConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:weeklyMaintenanceStartTime:CreateFileCacheLustreConfiguration', createFileCacheLustreConfiguration_weeklyMaintenanceStartTime - Undocumented member.
$sel:perUnitStorageThroughput:CreateFileCacheLustreConfiguration', createFileCacheLustreConfiguration_perUnitStorageThroughput - 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.
$sel:deploymentType:CreateFileCacheLustreConfiguration', createFileCacheLustreConfiguration_deploymentType - Specifies the cache deployment type, which must be CACHE_1.
$sel:metadataConfiguration:CreateFileCacheLustreConfiguration', createFileCacheLustreConfiguration_metadataConfiguration - The configuration for a Lustre MDT (Metadata Target) storage volume.
CreateFileSystemLustreConfiguration
data CreateFileSystemLustreConfiguration Source #
The Lustre configuration for the file system being created.
The following parameters are 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.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
See: newCreateFileSystemLustreConfiguration smart constructor.
Constructors
Instances
newCreateFileSystemLustreConfiguration :: CreateFileSystemLustreConfiguration Source #
Create a value of CreateFileSystemLustreConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoImportPolicy:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_autoImportPolicy - (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.
$sel:automaticBackupRetentionDays:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:copyTagsToBackups:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_copyTagsToBackups - (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.
$sel:dailyAutomaticBackupStartTime:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:dataCompressionType:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_dataCompressionType - 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.
$sel:deploymentType:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_deploymentType - (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)
$sel:driveCacheType:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_driveCacheType - 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.
$sel:exportPath:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_exportPath - (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.
$sel:importPath:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_importPath - (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.
$sel:importedFileChunkSize:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_importedFileChunkSize - (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.
$sel:logConfiguration:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_logConfiguration - 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.
$sel:perUnitStorageThroughput:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_perUnitStorageThroughput - 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_1SSD storage: 50, 100, 200 MB/s/TiB. - For
PERSISTENT_1HDD storage: 12, 40 MB/s/TiB. - For
PERSISTENT_2SSD storage: 125, 250, 500, 1000 MB/s/TiB.
$sel:rootSquashConfiguration:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_rootSquashConfiguration - 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.
$sel:weeklyMaintenanceStartTime:CreateFileSystemLustreConfiguration', createFileSystemLustreConfiguration_weeklyMaintenanceStartTime - (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
data CreateFileSystemOntapConfiguration Source #
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
See: newCreateFileSystemOntapConfiguration smart constructor.
Constructors
Instances
newCreateFileSystemOntapConfiguration Source #
Arguments
| :: OntapDeploymentType | |
| -> Natural | |
| -> CreateFileSystemOntapConfiguration |
Create a value of CreateFileSystemOntapConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticBackupRetentionDays:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:dailyAutomaticBackupStartTime:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:diskIopsConfiguration:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_diskIopsConfiguration - The SSD IOPS configuration for the FSx for ONTAP file system.
$sel:endpointIpAddressRange:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_endpointIpAddressRange - (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.
$sel:fsxAdminPassword:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_fsxAdminPassword - The ONTAP administrative password for the fsxadmin user with which you
administer your file system using the NetApp ONTAP CLI and REST API.
$sel:preferredSubnetId:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1. This specifies
the subnet in which you want the preferred file server to be located.
$sel:routeTableIds:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_routeTableIds - (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.
$sel:weeklyMaintenanceStartTime:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_weeklyMaintenanceStartTime - Undocumented member.
$sel:deploymentType:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_deploymentType - 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.
$sel:throughputCapacity:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_throughputCapacity - Sets the throughput capacity for the file system that you're creating.
Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
CreateFileSystemOpenZFSConfiguration
data CreateFileSystemOpenZFSConfiguration Source #
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
See: newCreateFileSystemOpenZFSConfiguration smart constructor.
Constructors
Instances
newCreateFileSystemOpenZFSConfiguration Source #
Arguments
| :: OpenZFSDeploymentType | |
| -> Natural |
|
| -> CreateFileSystemOpenZFSConfiguration |
Create a value of CreateFileSystemOpenZFSConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticBackupRetentionDays:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:copyTagsToBackups:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_copyTagsToBackups - 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.
$sel:copyTagsToVolumes:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_copyTagsToVolumes - 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.
$sel:dailyAutomaticBackupStartTime:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:diskIopsConfiguration:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_diskIopsConfiguration - Undocumented member.
$sel:rootVolumeConfiguration:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_rootVolumeConfiguration - 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.
$sel:weeklyMaintenanceStartTime:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime - Undocumented member.
$sel:deploymentType:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_deploymentType - 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_1is 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_2is 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.
$sel:throughputCapacity:CreateFileSystemOpenZFSConfiguration', createFileSystemOpenZFSConfiguration_throughputCapacity - 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
data CreateFileSystemWindowsConfiguration Source #
The configuration object for the Microsoft Windows file system used in
CreateFileSystem and CreateFileSystemFromBackup operations.
See: newCreateFileSystemWindowsConfiguration smart constructor.
Constructors
Instances
newCreateFileSystemWindowsConfiguration Source #
Arguments
| :: Natural |
|
| -> CreateFileSystemWindowsConfiguration |
Create a value of CreateFileSystemWindowsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeDirectoryId:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_activeDirectoryId - The ID for an existing Amazon Web Services Managed Microsoft Active
Directory (AD) instance that the file system should join when it's
created.
$sel:aliases:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_aliases - 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.
$sel:auditLogConfiguration:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_auditLogConfiguration - 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.
$sel:automaticBackupRetentionDays:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_automaticBackupRetentionDays - 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.
$sel:copyTagsToBackups:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_copyTagsToBackups - 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.
$sel:dailyAutomaticBackupStartTime:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime - The preferred time to take daily automatic backups, formatted HH:MM in
the UTC time zone.
$sel:deploymentType:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_deploymentType - 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 typeSINGLE_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.
$sel:preferredSubnetId:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_preferredSubnetId - 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.
$sel:selfManagedActiveDirectoryConfiguration:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration - Undocumented member.
$sel:weeklyMaintenanceStartTime:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_weeklyMaintenanceStartTime - 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.
$sel:throughputCapacity:CreateFileSystemWindowsConfiguration', createFileSystemWindowsConfiguration_throughputCapacity - 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
data CreateOntapVolumeConfiguration Source #
Specifies the configuration of the ONTAP volume that you are creating.
See: newCreateOntapVolumeConfiguration smart constructor.
Constructors
| CreateOntapVolumeConfiguration' (Maybe Bool) (Maybe Text) (Maybe InputOntapVolumeType) (Maybe SecurityStyle) (Maybe Text) (Maybe Bool) (Maybe TieringPolicy) Natural Text |
Instances
newCreateOntapVolumeConfiguration Source #
Arguments
| :: Natural | |
| -> Text |
|
| -> CreateOntapVolumeConfiguration |
Create a value of CreateOntapVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToBackups:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_copyTagsToBackups - 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.
$sel:junctionPath:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_junctionPath - Specifies the location in the SVM's namespace where the volume is
mounted. The JunctionPath must have a leading forward slash, such as
/vol3.
$sel:ontapVolumeType:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_ontapVolumeType - Specifies the type of volume you are creating. Valid values are the
following:
RWspecifies a read/write volume.RWis the default.DPspecifies a data-protection volume. ADPvolume 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.
$sel:securityStyle:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_securityStyle - 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:
UNIXif 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.NTFSif 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.MIXEDif the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
$sel:snapshotPolicy:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_snapshotPolicy - 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 thedefaultpolicy 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.
$sel:storageEfficiencyEnabled:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_storageEfficiencyEnabled - Set to true to enable deduplication, compression, and compaction storage
efficiency features on the volume.
$sel:tieringPolicy:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_tieringPolicy - Undocumented member.
$sel:sizeInMegabytes:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_sizeInMegabytes - Specifies the size of the volume, in megabytes (MB), that you are
creating.
$sel:storageVirtualMachineId:CreateOntapVolumeConfiguration', createOntapVolumeConfiguration_storageVirtualMachineId - Specifies the ONTAP SVM in which to create the volume.
CreateOpenZFSOriginSnapshotConfiguration
data CreateOpenZFSOriginSnapshotConfiguration Source #
The snapshot configuration to use when creating an OpenZFS volume from a snapshot.
See: newCreateOpenZFSOriginSnapshotConfiguration smart constructor.
Instances
newCreateOpenZFSOriginSnapshotConfiguration Source #
Arguments
| :: Text | |
| -> OpenZFSCopyStrategy | |
| -> CreateOpenZFSOriginSnapshotConfiguration |
Create a value of CreateOpenZFSOriginSnapshotConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:snapshotARN:CreateOpenZFSOriginSnapshotConfiguration', createOpenZFSOriginSnapshotConfiguration_snapshotARN - Undocumented member.
$sel:copyStrategy:CreateOpenZFSOriginSnapshotConfiguration', createOpenZFSOriginSnapshotConfiguration_copyStrategy - 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
data CreateOpenZFSVolumeConfiguration Source #
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
See: newCreateOpenZFSVolumeConfiguration smart constructor.
Constructors
Instances
newCreateOpenZFSVolumeConfiguration Source #
Arguments
| :: Text | |
| -> CreateOpenZFSVolumeConfiguration |
Create a value of CreateOpenZFSVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToSnapshots:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_copyTagsToSnapshots - 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.
$sel:dataCompressionType:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_dataCompressionType - 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.NONEis 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/.
$sel:nfsExports:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_nfsExports - The configuration object for mounting a Network File System (NFS) file
system.
$sel:originSnapshot:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_originSnapshot - The configuration object that specifies the snapshot to use as the
origin of the data for the volume.
$sel:readOnly:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_readOnly - A Boolean value indicating whether the volume is read-only.
$sel:recordSizeKiB:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_recordSizeKiB - 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, createOpenZFSVolumeConfiguration_storageCapacityQuotaGiB - 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.
$sel:storageCapacityReservationGiB:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_storageCapacityReservationGiB - 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.
$sel:userAndGroupQuotas:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_userAndGroupQuotas - An object specifying how much storage users or groups can use on the
volume.
$sel:parentVolumeId:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_parentVolumeId - The ID of the volume to use as the parent volume of the volume that you
are creating.
CreateSvmActiveDirectoryConfiguration
data CreateSvmActiveDirectoryConfiguration Source #
The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
See: newCreateSvmActiveDirectoryConfiguration smart constructor.
Constructors
| CreateSvmActiveDirectoryConfiguration' (Maybe SelfManagedActiveDirectoryConfiguration) Text |
Instances
newCreateSvmActiveDirectoryConfiguration Source #
Arguments
| :: Text | |
| -> CreateSvmActiveDirectoryConfiguration |
Create a value of CreateSvmActiveDirectoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:selfManagedActiveDirectoryConfiguration:CreateSvmActiveDirectoryConfiguration', createSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration - Undocumented member.
$sel:netBiosName:CreateSvmActiveDirectoryConfiguration', createSvmActiveDirectoryConfiguration_netBiosName - The NetBIOS name of the Active Directory computer object that will be
created for your SVM.
DataRepositoryAssociation
data DataRepositoryAssociation Source #
The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:
CreateDataRepositoryAssociation
UpdateDataRepositoryAssociation
DescribeDataRepositoryAssociations
Data repository associations are supported only for an Amazon FSx for
Lustre file system with the Persistent_2 deployment type and for an
Amazon File Cache resource.
See: newDataRepositoryAssociation smart constructor.
Constructors
| DataRepositoryAssociation' (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe DataRepositoryFailureDetails) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe DataRepositoryLifecycle) (Maybe NFSDataRepositoryConfiguration) (Maybe Text) (Maybe S3DataRepositoryConfiguration) (Maybe (NonEmpty Tag)) |
Instances
newDataRepositoryAssociation :: DataRepositoryAssociation Source #
Create a value of DataRepositoryAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associationId:DataRepositoryAssociation', dataRepositoryAssociation_associationId - The system-generated, unique ID of the data repository association.
$sel:batchImportMetaDataOnCreate:DataRepositoryAssociation', dataRepositoryAssociation_batchImportMetaDataOnCreate - 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.
$sel:creationTime:DataRepositoryAssociation', dataRepositoryAssociation_creationTime - Undocumented member.
$sel:dataRepositoryPath:DataRepositoryAssociation', dataRepositoryAssociation_dataRepositoryPath - 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
DataRepositorySubdirectoriesparameter, the path is to an NFS Export directory (or one of its subdirectories) in the formatnsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association. - If you are using the
DataRepositorySubdirectoriesparameter, the path is the domain name of the NFS file system in the formatnfs://filer-domain-name, which indicates the root of the subdirectories specified with theDataRepositorySubdirectoriesparameter.
- If you are not using the
- 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/.
$sel:dataRepositorySubdirectories:DataRepositoryAssociation', dataRepositoryAssociation_dataRepositorySubdirectories - 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.
$sel:failureDetails:DataRepositoryAssociation', dataRepositoryAssociation_failureDetails - Undocumented member.
$sel:fileCacheId:DataRepositoryAssociation', dataRepositoryAssociation_fileCacheId - The globally unique ID of the Amazon File Cache resource.
$sel:fileCachePath:DataRepositoryAssociation', dataRepositoryAssociation_fileCachePath - 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.
$sel:fileSystemId:DataRepositoryAssociation', dataRepositoryAssociation_fileSystemId - Undocumented member.
$sel:fileSystemPath:DataRepositoryAssociation', dataRepositoryAssociation_fileSystemPath - 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.
$sel:importedFileChunkSize:DataRepositoryAssociation', dataRepositoryAssociation_importedFileChunkSize - 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.
$sel:lifecycle:DataRepositoryAssociation', dataRepositoryAssociation_lifecycle - 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.
$sel:nfs:DataRepositoryAssociation', dataRepositoryAssociation_nfs - The configuration for an NFS data repository linked to an Amazon File
Cache resource with a data repository association.
$sel:resourceARN:DataRepositoryAssociation', dataRepositoryAssociation_resourceARN - Undocumented member.
$sel:s3:DataRepositoryAssociation', dataRepositoryAssociation_s3 - The configuration for an Amazon S3 data repository linked to an Amazon
FSx for Lustre file system with a data repository association.
$sel:tags:DataRepositoryAssociation', dataRepositoryAssociation_tags - Undocumented member.
DataRepositoryConfiguration
data DataRepositoryConfiguration Source #
The data repository configuration object for Lustre file systems
returned in the response of the CreateFileSystem operation.
This data type is not supported for file systems with the Persistent_2
deployment type. Instead, use .
See: newDataRepositoryConfiguration smart constructor.
Constructors
| DataRepositoryConfiguration' (Maybe AutoImportPolicyType) (Maybe Text) (Maybe DataRepositoryFailureDetails) (Maybe Text) (Maybe Natural) (Maybe DataRepositoryLifecycle) |
Instances
newDataRepositoryConfiguration :: DataRepositoryConfiguration Source #
Create a value of DataRepositoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoImportPolicy:DataRepositoryConfiguration', dataRepositoryConfiguration_autoImportPolicy - 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.
$sel:exportPath:DataRepositoryConfiguration', dataRepositoryConfiguration_exportPath - 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.
$sel:failureDetails:DataRepositoryConfiguration', dataRepositoryConfiguration_failureDetails - Undocumented member.
$sel:importPath:DataRepositoryConfiguration', dataRepositoryConfiguration_importPath - 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.
$sel:importedFileChunkSize:DataRepositoryConfiguration', dataRepositoryConfiguration_importedFileChunkSize - 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.
$sel:lifecycle:DataRepositoryConfiguration', dataRepositoryConfiguration_lifecycle - 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
data DataRepositoryFailureDetails Source #
Provides detailed information about the data repository if its
Lifecycle is set to MISCONFIGURED or FAILED.
See: newDataRepositoryFailureDetails smart constructor.
Constructors
| DataRepositoryFailureDetails' (Maybe Text) |
Instances
newDataRepositoryFailureDetails :: DataRepositoryFailureDetails Source #
Create a value of DataRepositoryFailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:DataRepositoryFailureDetails', dataRepositoryFailureDetails_message - Undocumented member.
DataRepositoryTask
data DataRepositoryTask Source #
A description of the data repository task. You use data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository. An Amazon File Cache resource uses a task to automatically release files from the cache.
See: newDataRepositoryTask smart constructor.
Constructors
Instances
newDataRepositoryTask Source #
Arguments
| :: Text | |
| -> DataRepositoryTaskLifecycle | |
| -> DataRepositoryTaskType | |
| -> UTCTime | |
| -> DataRepositoryTask |
Create a value of DataRepositoryTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityToRelease:DataRepositoryTask', dataRepositoryTask_capacityToRelease - 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.
$sel:endTime:DataRepositoryTask', dataRepositoryTask_endTime - The time the system completed processing the task, populated after the
task is complete.
$sel:failureDetails:DataRepositoryTask', dataRepositoryTask_failureDetails - Failure message describing why the task failed, it is populated only
when Lifecycle is set to FAILED.
$sel:fileCacheId:DataRepositoryTask', dataRepositoryTask_fileCacheId - The system-generated, unique ID of the cache.
$sel:fileSystemId:DataRepositoryTask', dataRepositoryTask_fileSystemId - The globally unique ID of the file system.
$sel:paths:DataRepositoryTask', dataRepositoryTask_paths - 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.
$sel:report:DataRepositoryTask', dataRepositoryTask_report - Undocumented member.
$sel:resourceARN:DataRepositoryTask', dataRepositoryTask_resourceARN - Undocumented member.
$sel:startTime:DataRepositoryTask', dataRepositoryTask_startTime - The time the system began processing the task.
$sel:status:DataRepositoryTask', dataRepositoryTask_status - Provides the status of the number of files that the task has processed
successfully and failed to process.
$sel:tags:DataRepositoryTask', dataRepositoryTask_tags - Undocumented member.
$sel:taskId:DataRepositoryTask', dataRepositoryTask_taskId - The system-generated, unique 17-digit ID of the data repository task.
$sel:lifecycle:DataRepositoryTask', dataRepositoryTask_lifecycle - 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.
$sel:type':DataRepositoryTask', dataRepositoryTask_type - The type of data repository task.
EXPORT_TO_REPOSITORYtasks export from your Amazon FSx for Lustre file system to a linked data repository.IMPORT_METADATA_FROM_REPOSITORYtasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.AUTO_RELEASE_DATAtasks automatically release files from an Amazon File Cache resource.
$sel:creationTime:DataRepositoryTask', dataRepositoryTask_creationTime - Undocumented member.
DataRepositoryTaskFailureDetails
data DataRepositoryTaskFailureDetails Source #
Provides information about why a data repository task failed. Only
populated when the task Lifecycle is set to FAILED.
See: newDataRepositoryTaskFailureDetails smart constructor.
Constructors
| DataRepositoryTaskFailureDetails' (Maybe Text) |
Instances
newDataRepositoryTaskFailureDetails :: DataRepositoryTaskFailureDetails Source #
Create a value of DataRepositoryTaskFailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:DataRepositoryTaskFailureDetails', dataRepositoryTaskFailureDetails_message - Undocumented member.
DataRepositoryTaskFilter
data DataRepositoryTaskFilter Source #
(Optional) An array of filter objects you can use to filter the response
of data repository tasks you will see in the the response. You can
filter the tasks returned in the response by one or more file system
IDs, task lifecycles, and by task type. A filter object consists of a
filter Name, and one or more Values for the filter.
See: newDataRepositoryTaskFilter smart constructor.
Constructors
| DataRepositoryTaskFilter' (Maybe DataRepositoryTaskFilterName) (Maybe [Text]) |
Instances
newDataRepositoryTaskFilter :: DataRepositoryTaskFilter Source #
Create a value of DataRepositoryTaskFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:DataRepositoryTaskFilter', dataRepositoryTaskFilter_name - Name of the task property to use in filtering the tasks returned in the
response.
- Use
file-system-idto retrieve data repository tasks for specific file systems. - Use
task-lifecycleto retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.
$sel:values:DataRepositoryTaskFilter', dataRepositoryTaskFilter_values - Use Values to include the specific file system IDs and task lifecycle
states for the filters you are using.
DataRepositoryTaskStatus
data DataRepositoryTaskStatus Source #
Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.
See: newDataRepositoryTaskStatus smart constructor.
Constructors
| DataRepositoryTaskStatus' (Maybe Integer) (Maybe POSIX) (Maybe Integer) (Maybe Integer) (Maybe Integer) |
Instances
newDataRepositoryTaskStatus :: DataRepositoryTaskStatus Source #
Create a value of DataRepositoryTaskStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failedCount:DataRepositoryTaskStatus', dataRepositoryTaskStatus_failedCount - A running total of the number of files that the task failed to process.
$sel:lastUpdatedTime:DataRepositoryTaskStatus', dataRepositoryTaskStatus_lastUpdatedTime - The time at which the task status was last updated.
$sel:releasedCapacity:DataRepositoryTaskStatus', dataRepositoryTaskStatus_releasedCapacity - The total amount of data, in GiB, released by an Amazon File Cache
AUTO_RELEASE_DATA task that automatically releases files from the cache.
$sel:succeededCount:DataRepositoryTaskStatus', dataRepositoryTaskStatus_succeededCount - A running total of the number of files that the task has successfully
processed.
$sel:totalCount:DataRepositoryTaskStatus', dataRepositoryTaskStatus_totalCount - 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
data DeleteFileSystemLustreConfiguration Source #
The configuration object for the Amazon FSx for Lustre file system being
deleted in the DeleteFileSystem operation.
See: newDeleteFileSystemLustreConfiguration smart constructor.
Instances
newDeleteFileSystemLustreConfiguration :: DeleteFileSystemLustreConfiguration Source #
Create a value of DeleteFileSystemLustreConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupTags:DeleteFileSystemLustreConfiguration', deleteFileSystemLustreConfiguration_finalBackupTags - 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.
$sel:skipFinalBackup:DeleteFileSystemLustreConfiguration', deleteFileSystemLustreConfiguration_skipFinalBackup - 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
data DeleteFileSystemLustreResponse Source #
The response object for the Amazon FSx for Lustre file system being
deleted in the DeleteFileSystem operation.
See: newDeleteFileSystemLustreResponse smart constructor.
Instances
newDeleteFileSystemLustreResponse :: DeleteFileSystemLustreResponse Source #
Create a value of DeleteFileSystemLustreResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupId:DeleteFileSystemLustreResponse', deleteFileSystemLustreResponse_finalBackupId - The ID of the final backup for this file system.
$sel:finalBackupTags:DeleteFileSystemLustreResponse', deleteFileSystemLustreResponse_finalBackupTags - The set of tags applied to the final backup.
DeleteFileSystemOpenZFSConfiguration
data DeleteFileSystemOpenZFSConfiguration Source #
The configuration object for the Amazon FSx for OpenZFS file system used
in the DeleteFileSystem operation.
See: newDeleteFileSystemOpenZFSConfiguration smart constructor.
Constructors
| DeleteFileSystemOpenZFSConfiguration' (Maybe (NonEmpty Tag)) (Maybe [DeleteFileSystemOpenZFSOption]) (Maybe Bool) |
Instances
newDeleteFileSystemOpenZFSConfiguration :: DeleteFileSystemOpenZFSConfiguration Source #
Create a value of DeleteFileSystemOpenZFSConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupTags:DeleteFileSystemOpenZFSConfiguration', deleteFileSystemOpenZFSConfiguration_finalBackupTags - A list of tags to apply to the file system's final backup.
$sel:options:DeleteFileSystemOpenZFSConfiguration', deleteFileSystemOpenZFSConfiguration_options - 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.
$sel:skipFinalBackup:DeleteFileSystemOpenZFSConfiguration', deleteFileSystemOpenZFSConfiguration_skipFinalBackup - 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
data DeleteFileSystemOpenZFSResponse Source #
The response object for the Amazon FSx for OpenZFS file system that's
being deleted in the DeleteFileSystem operation.
See: newDeleteFileSystemOpenZFSResponse smart constructor.
Instances
newDeleteFileSystemOpenZFSResponse :: DeleteFileSystemOpenZFSResponse Source #
Create a value of DeleteFileSystemOpenZFSResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupId:DeleteFileSystemOpenZFSResponse', deleteFileSystemOpenZFSResponse_finalBackupId - Undocumented member.
$sel:finalBackupTags:DeleteFileSystemOpenZFSResponse', deleteFileSystemOpenZFSResponse_finalBackupTags - Undocumented member.
DeleteFileSystemWindowsConfiguration
data DeleteFileSystemWindowsConfiguration Source #
The configuration object for the Microsoft Windows file system used in
the DeleteFileSystem operation.
See: newDeleteFileSystemWindowsConfiguration smart constructor.
Instances
newDeleteFileSystemWindowsConfiguration :: DeleteFileSystemWindowsConfiguration Source #
Create a value of DeleteFileSystemWindowsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupTags:DeleteFileSystemWindowsConfiguration', deleteFileSystemWindowsConfiguration_finalBackupTags - A set of tags for your final backup.
$sel:skipFinalBackup:DeleteFileSystemWindowsConfiguration', deleteFileSystemWindowsConfiguration_skipFinalBackup - 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
data DeleteFileSystemWindowsResponse Source #
The response object for the Microsoft Windows file system used in the
DeleteFileSystem operation.
See: newDeleteFileSystemWindowsResponse smart constructor.
Instances
newDeleteFileSystemWindowsResponse :: DeleteFileSystemWindowsResponse Source #
Create a value of DeleteFileSystemWindowsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupId:DeleteFileSystemWindowsResponse', deleteFileSystemWindowsResponse_finalBackupId - The ID of the final backup for this file system.
$sel:finalBackupTags:DeleteFileSystemWindowsResponse', deleteFileSystemWindowsResponse_finalBackupTags - The set of tags applied to the final backup.
DeleteVolumeOntapConfiguration
data DeleteVolumeOntapConfiguration Source #
Use to specify skipping a final backup, or to add tags to a final backup.
See: newDeleteVolumeOntapConfiguration smart constructor.
Instances
newDeleteVolumeOntapConfiguration :: DeleteVolumeOntapConfiguration Source #
Create a value of DeleteVolumeOntapConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupTags:DeleteVolumeOntapConfiguration', deleteVolumeOntapConfiguration_finalBackupTags - Undocumented member.
$sel:skipFinalBackup:DeleteVolumeOntapConfiguration', deleteVolumeOntapConfiguration_skipFinalBackup - Set to true if you want to skip taking a final backup of the volume you
are deleting.
DeleteVolumeOntapResponse
data DeleteVolumeOntapResponse Source #
The response object for the Amazon FSx for NetApp ONTAP volume being
deleted in the DeleteVolume operation.
See: newDeleteVolumeOntapResponse smart constructor.
Instances
newDeleteVolumeOntapResponse :: DeleteVolumeOntapResponse Source #
Create a value of DeleteVolumeOntapResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:finalBackupId:DeleteVolumeOntapResponse', deleteVolumeOntapResponse_finalBackupId - Undocumented member.
$sel:finalBackupTags:DeleteVolumeOntapResponse', deleteVolumeOntapResponse_finalBackupTags - Undocumented member.
DeleteVolumeOpenZFSConfiguration
data DeleteVolumeOpenZFSConfiguration Source #
A value that specifies whether to delete all child volumes and snapshots.
See: newDeleteVolumeOpenZFSConfiguration smart constructor.
Constructors
| DeleteVolumeOpenZFSConfiguration' (Maybe [DeleteOpenZFSVolumeOption]) |
Instances
newDeleteVolumeOpenZFSConfiguration :: DeleteVolumeOpenZFSConfiguration Source #
Create a value of DeleteVolumeOpenZFSConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:DeleteVolumeOpenZFSConfiguration', deleteVolumeOpenZFSConfiguration_options - To delete the volume's child volumes, snapshots, and clones, use the
string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.
DiskIopsConfiguration
data DiskIopsConfiguration Source #
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS 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 the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).
See: newDiskIopsConfiguration smart constructor.
Constructors
| DiskIopsConfiguration' (Maybe Natural) (Maybe DiskIopsConfigurationMode) |
Instances
newDiskIopsConfiguration :: DiskIopsConfiguration Source #
Create a value of DiskIopsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iops:DiskIopsConfiguration', diskIopsConfiguration_iops - The total number of SSD IOPS provisioned for the file system.
$sel:mode:DiskIopsConfiguration', diskIopsConfiguration_mode - 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
A description of a specific Amazon File Cache resource, which is a
response object from the DescribeFileCaches operation.
See: newFileCache smart constructor.
Constructors
| FileCache' (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe FileCacheFailureDetails) (Maybe Text) (Maybe FileCacheType) (Maybe Text) (Maybe Text) (Maybe FileCacheLifecycle) (Maybe FileCacheLustreConfiguration) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe [Text]) (Maybe Text) |
Instances
newFileCache :: FileCache Source #
Create a value of FileCache with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:FileCache', fileCache_creationTime - Undocumented member.
$sel:dNSName:FileCache', fileCache_dNSName - The Domain Name System (DNS) name for the cache.
$sel:dataRepositoryAssociationIds:FileCache', fileCache_dataRepositoryAssociationIds - A list of IDs of data repository associations that are associated with
this cache.
$sel:failureDetails:FileCache', fileCache_failureDetails - A structure providing details of any failures that occurred.
$sel:fileCacheId:FileCache', fileCache_fileCacheId - The system-generated, unique ID of the cache.
$sel:fileCacheType:FileCache', fileCache_fileCacheType - The type of cache, which must be LUSTRE.
$sel:fileCacheTypeVersion:FileCache', fileCache_fileCacheTypeVersion - The Lustre version of the cache, which must be 2.12.
$sel:kmsKeyId:FileCache', fileCache_kmsKeyId - 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.
$sel:lifecycle:FileCache', fileCache_lifecycle - 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.
$sel:lustreConfiguration:FileCache', fileCache_lustreConfiguration - The configuration for the Amazon File Cache resource.
$sel:networkInterfaceIds:FileCache', fileCache_networkInterfaceIds - Undocumented member.
$sel:ownerId:FileCache', fileCache_ownerId - Undocumented member.
$sel:resourceARN:FileCache', fileCache_resourceARN - Undocumented member.
$sel:storageCapacity:FileCache', fileCache_storageCapacity - The storage capacity of the cache in gibibytes (GiB).
$sel:subnetIds:FileCache', fileCache_subnetIds - Undocumented member.
$sel:vpcId:FileCache', fileCache_vpcId - Undocumented member.
FileCacheCreating
data FileCacheCreating Source #
The response object for the Amazon File Cache resource being created in
the CreateFileCache operation.
See: newFileCacheCreating smart constructor.
Constructors
| FileCacheCreating' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe FileCacheFailureDetails) (Maybe Text) (Maybe FileCacheType) (Maybe Text) (Maybe Text) (Maybe FileCacheLifecycle) (Maybe FileCacheLustreConfiguration) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe [Text]) (Maybe (NonEmpty Tag)) (Maybe Text) |
Instances
newFileCacheCreating :: FileCacheCreating Source #
Create a value of FileCacheCreating with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToDataRepositoryAssociations:FileCacheCreating', fileCacheCreating_copyTagsToDataRepositoryAssociations - A boolean flag indicating whether tags for the cache should be copied to
data repository associations.
$sel:creationTime:FileCacheCreating', fileCacheCreating_creationTime - Undocumented member.
$sel:dNSName:FileCacheCreating', fileCacheCreating_dNSName - The Domain Name System (DNS) name for the cache.
$sel:dataRepositoryAssociationIds:FileCacheCreating', fileCacheCreating_dataRepositoryAssociationIds - A list of IDs of data repository associations that are associated with
this cache.
$sel:failureDetails:FileCacheCreating', fileCacheCreating_failureDetails - A structure providing details of any failures that occurred.
$sel:fileCacheId:FileCacheCreating', fileCacheCreating_fileCacheId - The system-generated, unique ID of the cache.
$sel:fileCacheType:FileCacheCreating', fileCacheCreating_fileCacheType - The type of cache, which must be LUSTRE.
$sel:fileCacheTypeVersion:FileCacheCreating', fileCacheCreating_fileCacheTypeVersion - The Lustre version of the cache, which must be 2.12.
$sel:kmsKeyId:FileCacheCreating', fileCacheCreating_kmsKeyId - 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.
$sel:lifecycle:FileCacheCreating', fileCacheCreating_lifecycle - 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.
$sel:lustreConfiguration:FileCacheCreating', fileCacheCreating_lustreConfiguration - The configuration for the Amazon File Cache resource.
$sel:networkInterfaceIds:FileCacheCreating', fileCacheCreating_networkInterfaceIds - Undocumented member.
$sel:ownerId:FileCacheCreating', fileCacheCreating_ownerId - Undocumented member.
$sel:resourceARN:FileCacheCreating', fileCacheCreating_resourceARN - Undocumented member.
$sel:storageCapacity:FileCacheCreating', fileCacheCreating_storageCapacity - The storage capacity of the cache in gibibytes (GiB).
$sel:subnetIds:FileCacheCreating', fileCacheCreating_subnetIds - Undocumented member.
$sel:tags:FileCacheCreating', fileCacheCreating_tags - Undocumented member.
$sel:vpcId:FileCacheCreating', fileCacheCreating_vpcId - Undocumented member.
FileCacheDataRepositoryAssociation
data FileCacheDataRepositoryAssociation Source #
The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA does not support automatic import or automatic export.
See: newFileCacheDataRepositoryAssociation smart constructor.
Constructors
| FileCacheDataRepositoryAssociation' (Maybe [Text]) (Maybe FileCacheNFSConfiguration) Text Text |
Instances
newFileCacheDataRepositoryAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> FileCacheDataRepositoryAssociation |
Create a value of FileCacheDataRepositoryAssociation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataRepositorySubdirectories:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_dataRepositorySubdirectories - 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.
$sel:nfs:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_nfs - The configuration for a data repository association that links an Amazon
File Cache resource to an NFS data repository.
$sel:fileCachePath:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_fileCachePath - 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.
$sel:dataRepositoryPath:FileCacheDataRepositoryAssociation', fileCacheDataRepositoryAssociation_dataRepositoryPath - 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
DataRepositorySubdirectoriesparameter, the path is to an NFS Export directory (or one of its subdirectories) in the formatnsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association. - If you are using the
DataRepositorySubdirectoriesparameter, the path is the domain name of the NFS file system in the formatnfs://filer-domain-name, which indicates the root of the subdirectories specified with theDataRepositorySubdirectoriesparameter.
- If you are not using the
- The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix/.
FileCacheFailureDetails
data FileCacheFailureDetails Source #
A structure providing details of any failures that occurred.
See: newFileCacheFailureDetails smart constructor.
Constructors
| FileCacheFailureDetails' (Maybe Text) |
Instances
newFileCacheFailureDetails :: FileCacheFailureDetails Source #
Create a value of FileCacheFailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:FileCacheFailureDetails', fileCacheFailureDetails_message - A message describing any failures that occurred.
FileCacheLustreConfiguration
data FileCacheLustreConfiguration Source #
The configuration for the Amazon File Cache resource.
See: newFileCacheLustreConfiguration smart constructor.
Constructors
| FileCacheLustreConfiguration' (Maybe FileCacheLustreDeploymentType) (Maybe LustreLogConfiguration) (Maybe FileCacheLustreMetadataConfiguration) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newFileCacheLustreConfiguration :: FileCacheLustreConfiguration Source #
Create a value of FileCacheLustreConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deploymentType:FileCacheLustreConfiguration', fileCacheLustreConfiguration_deploymentType - The deployment type of the Amazon File Cache resource, which must be
CACHE_1.
$sel:logConfiguration:FileCacheLustreConfiguration', fileCacheLustreConfiguration_logConfiguration - The configuration for Lustre logging used to write the enabled logging
events for your Amazon File Cache resource to Amazon CloudWatch Logs.
$sel:metadataConfiguration:FileCacheLustreConfiguration', fileCacheLustreConfiguration_metadataConfiguration - The configuration for a Lustre MDT (Metadata Target) storage volume.
$sel:mountName:FileCacheLustreConfiguration', fileCacheLustreConfiguration_mountName - 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.
$sel:perUnitStorageThroughput:FileCacheLustreConfiguration', fileCacheLustreConfiguration_perUnitStorageThroughput - 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.
$sel:weeklyMaintenanceStartTime:FileCacheLustreConfiguration', fileCacheLustreConfiguration_weeklyMaintenanceStartTime - Undocumented member.
FileCacheLustreMetadataConfiguration
data FileCacheLustreMetadataConfiguration Source #
The configuration for a Lustre MDT (Metadata Target) storage volume. The metadata on Amazon File Cache is managed by a Lustre Metadata Server (MDS) while the actual metadata is persisted on an MDT.
See: newFileCacheLustreMetadataConfiguration smart constructor.
Constructors
| FileCacheLustreMetadataConfiguration' Natural |
Instances
newFileCacheLustreMetadataConfiguration Source #
Arguments
| :: Natural | |
| -> FileCacheLustreMetadataConfiguration |
Create a value of FileCacheLustreMetadataConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageCapacity:FileCacheLustreMetadataConfiguration', fileCacheLustreMetadataConfiguration_storageCapacity - The storage capacity of the Lustre MDT (Metadata Target) storage volume
in gibibytes (GiB). The only supported value is 2400 GiB.
FileCacheNFSConfiguration
data FileCacheNFSConfiguration Source #
The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache resource.
See: newFileCacheNFSConfiguration smart constructor.
Constructors
| FileCacheNFSConfiguration' (Maybe [Text]) NfsVersion |
Instances
newFileCacheNFSConfiguration Source #
Create a value of FileCacheNFSConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dnsIps:FileCacheNFSConfiguration', fileCacheNFSConfiguration_dnsIps - 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.
$sel:version:FileCacheNFSConfiguration', fileCacheNFSConfiguration_version - 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
data FileSystem Source #
A description of a specific Amazon FSx file system.
See: newFileSystem smart constructor.
Constructors
Instances
newFileSystem :: FileSystem Source #
Create a value of FileSystem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:administrativeActions:FileSystem', fileSystem_administrativeActions - 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.
$sel:creationTime:FileSystem', fileSystem_creationTime - The time that the file system was created, in seconds (since
1970-01-01T00:00:00Z), also known as Unix time.
$sel:dNSName:FileSystem', fileSystem_dNSName - The Domain Name System (DNS) name for the file system.
FileSystem, fileSystem_failureDetails - Undocumented member.
$sel:fileSystemId:FileSystem', fileSystem_fileSystemId - The system-generated, unique 17-digit ID of the file system.
$sel:fileSystemType:FileSystem', fileSystem_fileSystemType - The type of Amazon FSx file system, which can be LUSTRE, WINDOWS,
ONTAP, or OPENZFS.
$sel:fileSystemTypeVersion:FileSystem', fileSystem_fileSystemTypeVersion - The Lustre version of the Amazon FSx for Lustre file system, either
2.10 or 2.12.
$sel:kmsKeyId:FileSystem', fileSystem_kmsKeyId - 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_1andPERSISTENT_2deployment types only.SCRATCH_1andSCRATCH_2types 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
$sel:lifecycle:FileSystem', fileSystem_lifecycle - 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.
$sel:lustreConfiguration:FileSystem', fileSystem_lustreConfiguration - Undocumented member.
$sel:networkInterfaceIds:FileSystem', fileSystem_networkInterfaceIds - 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.
$sel:ontapConfiguration:FileSystem', fileSystem_ontapConfiguration - The configuration for this Amazon FSx for NetApp ONTAP file system.
$sel:openZFSConfiguration:FileSystem', fileSystem_openZFSConfiguration - The configuration for this Amazon FSx for OpenZFS file system.
$sel:ownerId:FileSystem', fileSystem_ownerId - 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.
$sel:resourceARN:FileSystem', fileSystem_resourceARN - The Amazon Resource Name (ARN) of the file system resource.
$sel:storageCapacity:FileSystem', fileSystem_storageCapacity - The storage capacity of the file system in gibibytes (GiB).
$sel:storageType:FileSystem', fileSystem_storageType - 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.
$sel:subnetIds:FileSystem', fileSystem_subnetIds - 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.
$sel:tags:FileSystem', fileSystem_tags - The tags to associate with the file system. For more information, see
Tagging your Amazon EC2 resources
in the Amazon EC2 User Guide.
$sel:vpcId:FileSystem', fileSystem_vpcId - The ID of the primary virtual private cloud (VPC) for the file system.
$sel:windowsConfiguration:FileSystem', fileSystem_windowsConfiguration - The configuration for this Amazon FSx for Windows File Server file
system.
FileSystemEndpoint
data FileSystemEndpoint Source #
An Amazon FSx for NetApp ONTAP file system has two endpoints that are
used to access data or to manage the file system using the NetApp ONTAP
CLI, REST API, or NetApp SnapMirror. They are the Management and
Intercluster endpoints.
See: newFileSystemEndpoint smart constructor.
Instances
newFileSystemEndpoint :: FileSystemEndpoint Source #
Create a value of FileSystemEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dNSName:FileSystemEndpoint', fileSystemEndpoint_dNSName - Undocumented member.
$sel:ipAddresses:FileSystemEndpoint', fileSystemEndpoint_ipAddresses - IP addresses of the file system endpoint.
FileSystemEndpoints
data FileSystemEndpoints Source #
An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
See: newFileSystemEndpoints smart constructor.
Constructors
| FileSystemEndpoints' (Maybe FileSystemEndpoint) (Maybe FileSystemEndpoint) |
Instances
newFileSystemEndpoints :: FileSystemEndpoints Source #
Create a value of FileSystemEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:intercluster:FileSystemEndpoints', fileSystemEndpoints_intercluster - An endpoint for managing your file system by setting up NetApp
SnapMirror with other ONTAP systems.
$sel:management:FileSystemEndpoints', fileSystemEndpoints_management - An endpoint for managing your file system using the NetApp ONTAP CLI and
NetApp ONTAP API.
FileSystemFailureDetails
data FileSystemFailureDetails Source #
A structure providing details of any failures that occurred.
See: newFileSystemFailureDetails smart constructor.
Constructors
| FileSystemFailureDetails' (Maybe Text) |
Instances
newFileSystemFailureDetails :: FileSystemFailureDetails Source #
Create a value of FileSystemFailureDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:FileSystemFailureDetails', fileSystemFailureDetails_message - A message describing any failures that occurred.
Filter
A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.
See: newFilter smart constructor.
Constructors
| Filter' (Maybe FilterName) (Maybe [Text]) |
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.FSx.Types.Filter | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.FSx.Types.Filter | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
Defined in Amazonka.FSx.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.FSx.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.FSx.Types.Filter" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterName)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Filter', filter_name - The name for this filter.
$sel:values:Filter', filter_values - The values of the filter. These are all the values for any of the
applied filters.
LifecycleTransitionReason
data LifecycleTransitionReason Source #
Describes why a resource lifecycle state changed.
See: newLifecycleTransitionReason smart constructor.
Constructors
| LifecycleTransitionReason' (Maybe Text) |
Instances
newLifecycleTransitionReason :: LifecycleTransitionReason Source #
Create a value of LifecycleTransitionReason with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:LifecycleTransitionReason', lifecycleTransitionReason_message - Undocumented member.
LustreFileSystemConfiguration
data LustreFileSystemConfiguration Source #
The configuration for the Amazon FSx for Lustre file system.
See: newLustreFileSystemConfiguration smart constructor.
Constructors
Instances
newLustreFileSystemConfiguration :: LustreFileSystemConfiguration Source #
Create a value of LustreFileSystemConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticBackupRetentionDays:LustreFileSystemConfiguration', lustreFileSystemConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:copyTagsToBackups:LustreFileSystemConfiguration', lustreFileSystemConfiguration_copyTagsToBackups - 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)
$sel:dailyAutomaticBackupStartTime:LustreFileSystemConfiguration', lustreFileSystemConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:dataCompressionType:LustreFileSystemConfiguration', lustreFileSystemConfiguration_dataCompressionType - 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.
$sel:dataRepositoryConfiguration:LustreFileSystemConfiguration', lustreFileSystemConfiguration_dataRepositoryConfiguration - Undocumented member.
$sel:deploymentType:LustreFileSystemConfiguration', lustreFileSystemConfiguration_deploymentType - 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.
$sel:driveCacheType:LustreFileSystemConfiguration', lustreFileSystemConfiguration_driveCacheType - 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.
$sel:logConfiguration:LustreFileSystemConfiguration', lustreFileSystemConfiguration_logConfiguration - The Lustre logging configuration. Lustre logging writes the enabled log
events for your file system to Amazon CloudWatch Logs.
$sel:mountName:LustreFileSystemConfiguration', lustreFileSystemConfiguration_mountName - 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.
$sel:perUnitStorageThroughput:LustreFileSystemConfiguration', lustreFileSystemConfiguration_perUnitStorageThroughput - 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_1SSD storage: 50, 100, 200. - For
PERSISTENT_1HDD storage: 12, 40. - For
PERSISTENT_2SSD storage: 125, 250, 500, 1000.
$sel:rootSquashConfiguration:LustreFileSystemConfiguration', lustreFileSystemConfiguration_rootSquashConfiguration - 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.
$sel:weeklyMaintenanceStartTime:LustreFileSystemConfiguration', lustreFileSystemConfiguration_weeklyMaintenanceStartTime - 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
data LustreLogConfiguration Source #
The configuration for Lustre logging used to write the enabled logging events for your Amazon FSx for Lustre file system or Amazon File Cache resource to Amazon CloudWatch Logs.
See: newLustreLogConfiguration smart constructor.
Constructors
| LustreLogConfiguration' (Maybe Text) LustreAccessAuditLogLevel |
Instances
newLustreLogConfiguration Source #
Create a value of LustreLogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:LustreLogConfiguration', lustreLogConfiguration_destination - 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.
$sel:level:LustreLogConfiguration', lustreLogConfiguration_level - 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
data LustreLogCreateConfiguration Source #
The Lustre logging configuration used when creating or updating an
Amazon FSx for Lustre file system. An Amazon File Cache is created with
Lustre logging enabled by default, with a setting of WARN_ERROR for
the logging events. which can't be changed.
Lustre logging writes the enabled logging events for your file system or cache to Amazon CloudWatch Logs.
See: newLustreLogCreateConfiguration smart constructor.
Constructors
| LustreLogCreateConfiguration' (Maybe Text) LustreAccessAuditLogLevel |
Instances
newLustreLogCreateConfiguration Source #
Arguments
| :: LustreAccessAuditLogLevel | |
| -> LustreLogCreateConfiguration |
Create a value of LustreLogCreateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destination:LustreLogCreateConfiguration', lustreLogCreateConfiguration_destination - 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/fsxprefix. - If you do not provide a destination, Amazon FSx will create and use
a log stream in the CloudWatch Logs
/aws/fsx/lustrelog group (for Amazon FSx for Lustre) or/aws/fsx/filecache(for Amazon File Cache). - If
Destinationis provided and the resource does not exist, the request will fail with aBadRequesterror. - If
Levelis set toDISABLED, you cannot specify a destination inDestination.
$sel:level:LustreLogCreateConfiguration', lustreLogCreateConfiguration_level - 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
data LustreRootSquashConfiguration Source #
The configuration for Lustre root squash used to restrict root-level
access from clients that try to access your FSx for Lustre file system
as root. Use the RootSquash parameter to enable root squash. To learn
more about Lustre root squash, see
Lustre root squash.
You can also use the NoSquashNids parameter to provide an array of
clients who are not affected by the root squash setting. These clients
will access the file system as root, with unrestricted privileges.
See: newLustreRootSquashConfiguration smart constructor.
Constructors
| LustreRootSquashConfiguration' (Maybe [Text]) (Maybe Text) |
Instances
newLustreRootSquashConfiguration :: LustreRootSquashConfiguration Source #
Create a value of LustreRootSquashConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:noSquashNids:LustreRootSquashConfiguration', lustreRootSquashConfiguration_noSquashNids - 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).
$sel:rootSquash:LustreRootSquashConfiguration', lustreRootSquashConfiguration_rootSquash - 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
data NFSDataRepositoryConfiguration Source #
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
See: newNFSDataRepositoryConfiguration smart constructor.
Constructors
| NFSDataRepositoryConfiguration' (Maybe AutoExportPolicy) (Maybe [Text]) NfsVersion |
Instances
newNFSDataRepositoryConfiguration Source #
Create a value of NFSDataRepositoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoExportPolicy:NFSDataRepositoryConfiguration', nFSDataRepositoryConfiguration_autoExportPolicy - This parameter is not supported for Amazon File Cache.
$sel:dnsIps:NFSDataRepositoryConfiguration', nFSDataRepositoryConfiguration_dnsIps - 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.
$sel:version:NFSDataRepositoryConfiguration', nFSDataRepositoryConfiguration_version - 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
data OntapFileSystemConfiguration Source #
Configuration for the FSx for NetApp ONTAP file system.
See: newOntapFileSystemConfiguration smart constructor.
Constructors
Instances
newOntapFileSystemConfiguration :: OntapFileSystemConfiguration Source #
Create a value of OntapFileSystemConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticBackupRetentionDays:OntapFileSystemConfiguration', ontapFileSystemConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:dailyAutomaticBackupStartTime:OntapFileSystemConfiguration', ontapFileSystemConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:deploymentType:OntapFileSystemConfiguration', ontapFileSystemConfiguration_deploymentType - 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.
$sel:diskIopsConfiguration:OntapFileSystemConfiguration', ontapFileSystemConfiguration_diskIopsConfiguration - The SSD IOPS configuration for the ONTAP file system, specifying the
number of provisioned IOPS and the provision mode.
$sel:endpointIpAddressRange:OntapFileSystemConfiguration', ontapFileSystemConfiguration_endpointIpAddressRange - (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.
$sel:endpoints:OntapFileSystemConfiguration', ontapFileSystemConfiguration_endpoints - 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.
$sel:preferredSubnetId:OntapFileSystemConfiguration', ontapFileSystemConfiguration_preferredSubnetId - Undocumented member.
$sel:routeTableIds:OntapFileSystemConfiguration', ontapFileSystemConfiguration_routeTableIds - (Multi-AZ only) The VPC route tables in which your file system's
endpoints are created.
$sel:throughputCapacity:OntapFileSystemConfiguration', ontapFileSystemConfiguration_throughputCapacity - Undocumented member.
$sel:weeklyMaintenanceStartTime:OntapFileSystemConfiguration', ontapFileSystemConfiguration_weeklyMaintenanceStartTime - Undocumented member.
OntapVolumeConfiguration
data OntapVolumeConfiguration Source #
The configuration of an Amazon FSx for NetApp ONTAP volume.
See: newOntapVolumeConfiguration smart constructor.
Constructors
| OntapVolumeConfiguration' (Maybe Bool) (Maybe FlexCacheEndpointType) (Maybe Text) (Maybe OntapVolumeType) (Maybe SecurityStyle) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe TieringPolicy) (Maybe Text) |
Instances
newOntapVolumeConfiguration :: OntapVolumeConfiguration Source #
Create a value of OntapVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToBackups:OntapVolumeConfiguration', ontapVolumeConfiguration_copyTagsToBackups - 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.
$sel:flexCacheEndpointType:OntapVolumeConfiguration', ontapVolumeConfiguration_flexCacheEndpointType - Specifies the FlexCache endpoint type of the volume. Valid values are
the following:
NONEspecifies that the volume doesn't have a FlexCache configuration.NONEis the default.ORIGINspecifies that the volume is the origin volume for a FlexCache volume.CACHEspecifies that the volume is a FlexCache volume.
$sel:junctionPath:OntapVolumeConfiguration', ontapVolumeConfiguration_junctionPath - 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.
$sel:ontapVolumeType:OntapVolumeConfiguration', ontapVolumeConfiguration_ontapVolumeType - Specifies the type of volume. Valid values are the following:
RWspecifies a read/write volume.RWis the default.DPspecifies 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.LSspecifies 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.
$sel:securityStyle:OntapVolumeConfiguration', ontapVolumeConfiguration_securityStyle - The security style for the volume, which can be UNIX, NTFS, or
MIXED.
$sel:sizeInMegabytes:OntapVolumeConfiguration', ontapVolumeConfiguration_sizeInMegabytes - The configured size of the volume, in megabytes (MBs).
$sel:snapshotPolicy:OntapVolumeConfiguration', ontapVolumeConfiguration_snapshotPolicy - 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 thedefaultpolicy 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.
$sel:storageEfficiencyEnabled:OntapVolumeConfiguration', ontapVolumeConfiguration_storageEfficiencyEnabled - The volume's storage efficiency setting.
$sel:storageVirtualMachineId:OntapVolumeConfiguration', ontapVolumeConfiguration_storageVirtualMachineId - The ID of the volume's storage virtual machine.
$sel:storageVirtualMachineRoot:OntapVolumeConfiguration', ontapVolumeConfiguration_storageVirtualMachineRoot - 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.
$sel:tieringPolicy:OntapVolumeConfiguration', ontapVolumeConfiguration_tieringPolicy - The volume's TieringPolicy setting.
$sel:uuid:OntapVolumeConfiguration', ontapVolumeConfiguration_uuid - The volume's universally unique identifier (UUID).
OpenZFSClientConfiguration
data OpenZFSClientConfiguration Source #
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
See: newOpenZFSClientConfiguration smart constructor.
Constructors
| OpenZFSClientConfiguration' Text (NonEmpty Text) |
Instances
newOpenZFSClientConfiguration Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> OpenZFSClientConfiguration |
Create a value of OpenZFSClientConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clients:OpenZFSClientConfiguration', openZFSClientConfiguration_clients - 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.
$sel:options:OpenZFSClientConfiguration', openZFSClientConfiguration_options - 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:
crossmntis used by default. If you don't specifycrossmntwhen changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.syncis used by default. If you instead specifyasync, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
OpenZFSCreateRootVolumeConfiguration
data OpenZFSCreateRootVolumeConfiguration Source #
The configuration of an Amazon FSx for OpenZFS root volume.
See: newOpenZFSCreateRootVolumeConfiguration smart constructor.
Constructors
| OpenZFSCreateRootVolumeConfiguration' (Maybe Bool) (Maybe OpenZFSDataCompressionType) (Maybe [OpenZFSNfsExport]) (Maybe Bool) (Maybe Natural) (Maybe [OpenZFSUserOrGroupQuota]) |
Instances
newOpenZFSCreateRootVolumeConfiguration :: OpenZFSCreateRootVolumeConfiguration Source #
Create a value of OpenZFSCreateRootVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToSnapshots:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_copyTagsToSnapshots - 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.
$sel:dataCompressionType:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_dataCompressionType - 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.NONEis 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.
$sel:nfsExports:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_nfsExports - The configuration object for mounting a file system.
$sel:readOnly:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_readOnly - 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.
$sel:recordSizeKiB:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_recordSizeKiB - 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.
$sel:userAndGroupQuotas:OpenZFSCreateRootVolumeConfiguration', openZFSCreateRootVolumeConfiguration_userAndGroupQuotas - An object specifying how much storage users or groups can use on the
volume.
OpenZFSFileSystemConfiguration
data OpenZFSFileSystemConfiguration Source #
The configuration for the Amazon FSx for OpenZFS file system.
See: newOpenZFSFileSystemConfiguration smart constructor.
Constructors
| OpenZFSFileSystemConfiguration' (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe OpenZFSDeploymentType) (Maybe DiskIopsConfiguration) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newOpenZFSFileSystemConfiguration :: OpenZFSFileSystemConfiguration Source #
Create a value of OpenZFSFileSystemConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticBackupRetentionDays:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:copyTagsToBackups:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_copyTagsToBackups - 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.
$sel:copyTagsToVolumes:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_copyTagsToVolumes - 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.
$sel:dailyAutomaticBackupStartTime:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:deploymentType:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_deploymentType - Specifies the file-system deployment type. Amazon FSx for OpenZFS
supports
SINGLE_AZ_1 and SINGLE_AZ_2.
$sel:diskIopsConfiguration:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_diskIopsConfiguration - Undocumented member.
$sel:rootVolumeId:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_rootVolumeId - The ID of the root volume of the OpenZFS file system.
$sel:throughputCapacity:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_throughputCapacity - The throughput of an Amazon FSx file system, measured in megabytes per
second (MBps).
$sel:weeklyMaintenanceStartTime:OpenZFSFileSystemConfiguration', openZFSFileSystemConfiguration_weeklyMaintenanceStartTime - Undocumented member.
OpenZFSNfsExport
data OpenZFSNfsExport Source #
The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.
See: newOpenZFSNfsExport smart constructor.
Constructors
| OpenZFSNfsExport' [OpenZFSClientConfiguration] |
Instances
newOpenZFSNfsExport :: OpenZFSNfsExport Source #
Create a value of OpenZFSNfsExport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientConfigurations:OpenZFSNfsExport', openZFSNfsExport_clientConfigurations - A list of configuration objects that contain the client and options for
mounting the OpenZFS file system.
OpenZFSOriginSnapshotConfiguration
data OpenZFSOriginSnapshotConfiguration Source #
The snapshot configuration to use when creating an OpenZFS volume from a snapshot.
See: newOpenZFSOriginSnapshotConfiguration smart constructor.
Constructors
| OpenZFSOriginSnapshotConfiguration' (Maybe OpenZFSCopyStrategy) (Maybe Text) |
Instances
newOpenZFSOriginSnapshotConfiguration :: OpenZFSOriginSnapshotConfiguration Source #
Create a value of OpenZFSOriginSnapshotConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyStrategy:OpenZFSOriginSnapshotConfiguration', openZFSOriginSnapshotConfiguration_copyStrategy - 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.
$sel:snapshotARN:OpenZFSOriginSnapshotConfiguration', openZFSOriginSnapshotConfiguration_snapshotARN - Undocumented member.
OpenZFSUserOrGroupQuota
data OpenZFSUserOrGroupQuota Source #
The configuration for how much storage a user or group can use on the volume.
See: newOpenZFSUserOrGroupQuota smart constructor.
Constructors
| OpenZFSUserOrGroupQuota' OpenZFSQuotaType Natural Natural |
Instances
newOpenZFSUserOrGroupQuota Source #
Arguments
| :: OpenZFSQuotaType | |
| -> Natural | |
| -> Natural | |
| -> OpenZFSUserOrGroupQuota |
Create a value of OpenZFSUserOrGroupQuota with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':OpenZFSUserOrGroupQuota', openZFSUserOrGroupQuota_type - A value that specifies whether the quota applies to a user or group.
$sel:id:OpenZFSUserOrGroupQuota', openZFSUserOrGroupQuota_id - The ID of the user or group.
$sel:storageCapacityQuotaGiB:OpenZFSUserOrGroupQuota', openZFSUserOrGroupQuota_storageCapacityQuotaGiB - The amount of storage that the user or group can use in gibibytes (GiB).
OpenZFSVolumeConfiguration
data OpenZFSVolumeConfiguration Source #
The configuration of an Amazon FSx for OpenZFS volume.
See: newOpenZFSVolumeConfiguration smart constructor.
Constructors
Instances
newOpenZFSVolumeConfiguration :: OpenZFSVolumeConfiguration Source #
Create a value of OpenZFSVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToSnapshots:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_copyTagsToSnapshots - 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.
$sel:dataCompressionType:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_dataCompressionType - 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.NONEis 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.
$sel:deleteClonedVolumes:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_deleteClonedVolumes - A Boolean value indicating whether dependent clone volumes created from
intermediate snapshots should be deleted when a volume is restored from
snapshot.
$sel:deleteIntermediateSnaphots:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_deleteIntermediateSnaphots - A Boolean value indicating whether snapshots between the current state
and the specified snapshot should be deleted when a volume is restored
from snapshot.
$sel:nfsExports:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_nfsExports - The configuration object for mounting a Network File System (NFS) file
system.
$sel:originSnapshot:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_originSnapshot - The configuration object that specifies the snapshot to use as the
origin of the data for the volume.
$sel:parentVolumeId:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_parentVolumeId - The ID of the parent volume.
$sel:readOnly:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_readOnly - A Boolean value indicating whether the volume is read-only.
$sel:recordSizeKiB:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_recordSizeKiB - 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/.
$sel:restoreToSnapshot:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_restoreToSnapshot - Specifies the ID of the snapshot to which the volume was restored.
OpenZFSVolumeConfiguration, openZFSVolumeConfiguration_storageCapacityQuotaGiB - 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.
$sel:storageCapacityReservationGiB:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_storageCapacityReservationGiB - 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.
$sel:userAndGroupQuotas:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_userAndGroupQuotas - An object specifying how much storage users or groups can use on the
volume.
$sel:volumePath:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_volumePath - The path to the volume from the root volume. For example,
fsx/parentVolume/volume1.
S3DataRepositoryConfiguration
data S3DataRepositoryConfiguration Source #
The configuration for an Amazon S3 data repository linked to an Amazon
FSx for Lustre file system with a data repository association. The
configuration consists of an AutoImportPolicy that defines which file
events on the data repository are automatically imported to the file
system and an AutoExportPolicy that defines which file events on the
file system are automatically exported to the data repository. File
events are when files or directories are added, changed, or deleted on
the file system or the data repository.
Data repository associations on Amazon File Cache don't use
S3DataRepositoryConfiguration because they don't support automatic
import or automatic export.
See: newS3DataRepositoryConfiguration smart constructor.
Constructors
| S3DataRepositoryConfiguration' (Maybe AutoExportPolicy) (Maybe AutoImportPolicy) |
Instances
newS3DataRepositoryConfiguration :: S3DataRepositoryConfiguration Source #
Create a value of S3DataRepositoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoExportPolicy:S3DataRepositoryConfiguration', s3DataRepositoryConfiguration_autoExportPolicy - Specifies the type of updated objects (new, changed, deleted) that will
be automatically exported from your file system to the linked S3 bucket.
$sel:autoImportPolicy:S3DataRepositoryConfiguration', s3DataRepositoryConfiguration_autoImportPolicy - Specifies the type of updated objects (new, changed, deleted) that will
be automatically imported from the linked S3 bucket to your file system.
SelfManagedActiveDirectoryAttributes
data SelfManagedActiveDirectoryAttributes Source #
The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
See: newSelfManagedActiveDirectoryAttributes smart constructor.
Constructors
| SelfManagedActiveDirectoryAttributes' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newSelfManagedActiveDirectoryAttributes :: SelfManagedActiveDirectoryAttributes Source #
Create a value of SelfManagedActiveDirectoryAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dnsIps:SelfManagedActiveDirectoryAttributes', selfManagedActiveDirectoryAttributes_dnsIps - A list of up to three IP addresses of DNS servers or domain controllers
in the self-managed AD directory.
$sel:domainName:SelfManagedActiveDirectoryAttributes', selfManagedActiveDirectoryAttributes_domainName - The fully qualified domain name of the self-managed AD directory.
$sel:fileSystemAdministratorsGroup:SelfManagedActiveDirectoryAttributes', selfManagedActiveDirectoryAttributes_fileSystemAdministratorsGroup - The name of the domain group whose members have administrative
privileges for the FSx file system.
$sel:organizationalUnitDistinguishedName:SelfManagedActiveDirectoryAttributes', selfManagedActiveDirectoryAttributes_organizationalUnitDistinguishedName - 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.
$sel:userName:SelfManagedActiveDirectoryAttributes', selfManagedActiveDirectoryAttributes_userName - The user name for the service account on your self-managed AD domain
that FSx uses to join to your AD domain.
SelfManagedActiveDirectoryConfiguration
data SelfManagedActiveDirectoryConfiguration Source #
The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory or Managing SVMs.
See: newSelfManagedActiveDirectoryConfiguration smart constructor.
Constructors
| SelfManagedActiveDirectoryConfiguration' (Maybe Text) (Maybe Text) Text Text (Sensitive Text) (NonEmpty Text) |
Instances
newSelfManagedActiveDirectoryConfiguration Source #
Create a value of SelfManagedActiveDirectoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileSystemAdministratorsGroup:SelfManagedActiveDirectoryConfiguration', selfManagedActiveDirectoryConfiguration_fileSystemAdministratorsGroup - (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.
$sel:organizationalUnitDistinguishedName:SelfManagedActiveDirectoryConfiguration', selfManagedActiveDirectoryConfiguration_organizationalUnitDistinguishedName - (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.
$sel:domainName:SelfManagedActiveDirectoryConfiguration', selfManagedActiveDirectoryConfiguration_domainName - The fully qualified domain name of the self-managed AD directory, such
as corp.example.com.
$sel:userName:SelfManagedActiveDirectoryConfiguration', selfManagedActiveDirectoryConfiguration_userName - 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.
$sel:password:SelfManagedActiveDirectoryConfiguration', selfManagedActiveDirectoryConfiguration_password - The password for the service account on your self-managed AD domain that
Amazon FSx will use to join to your AD domain.
$sel:dnsIps:SelfManagedActiveDirectoryConfiguration', selfManagedActiveDirectoryConfiguration_dnsIps - A list of up to three IP addresses of DNS servers or domain controllers
in the self-managed AD directory.
SelfManagedActiveDirectoryConfigurationUpdates
data SelfManagedActiveDirectoryConfigurationUpdates Source #
The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.
See: newSelfManagedActiveDirectoryConfigurationUpdates smart constructor.
Constructors
| SelfManagedActiveDirectoryConfigurationUpdates' (Maybe (NonEmpty Text)) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newSelfManagedActiveDirectoryConfigurationUpdates :: SelfManagedActiveDirectoryConfigurationUpdates Source #
Create a value of SelfManagedActiveDirectoryConfigurationUpdates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dnsIps:SelfManagedActiveDirectoryConfigurationUpdates', selfManagedActiveDirectoryConfigurationUpdates_dnsIps - A list of up to three IP addresses of DNS servers or domain controllers
in the self-managed AD directory.
$sel:password:SelfManagedActiveDirectoryConfigurationUpdates', selfManagedActiveDirectoryConfigurationUpdates_password - The password for the service account on your self-managed AD domain that
Amazon FSx will use to join to your AD domain.
$sel:userName:SelfManagedActiveDirectoryConfigurationUpdates', selfManagedActiveDirectoryConfigurationUpdates_userName - 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
A snapshot of an Amazon FSx for OpenZFS volume.
See: newSnapshot smart constructor.
Constructors
| Snapshot' (Maybe [AdministrativeAction]) (Maybe POSIX) (Maybe SnapshotLifecycle) (Maybe LifecycleTransitionReason) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) |
Instances
newSnapshot :: Snapshot Source #
Create a value of Snapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:administrativeActions:Snapshot', snapshot_administrativeActions - 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.
$sel:creationTime:Snapshot', snapshot_creationTime - Undocumented member.
$sel:lifecycle:Snapshot', snapshot_lifecycle - 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.
$sel:lifecycleTransitionReason:Snapshot', snapshot_lifecycleTransitionReason - Undocumented member.
$sel:name:Snapshot', snapshot_name - The name of the snapshot.
$sel:resourceARN:Snapshot', snapshot_resourceARN - Undocumented member.
$sel:snapshotId:Snapshot', snapshot_snapshotId - The ID of the snapshot.
$sel:tags:Snapshot', snapshot_tags - Undocumented member.
$sel:volumeId:Snapshot', snapshot_volumeId - The ID of the volume that the snapshot is of.
SnapshotFilter
data SnapshotFilter Source #
A filter used to restrict the results of DescribeSnapshots calls. You
can use multiple filters to return results that meet all applied filter
requirements.
See: newSnapshotFilter smart constructor.
Constructors
| SnapshotFilter' (Maybe SnapshotFilterName) (Maybe [Text]) |
Instances
newSnapshotFilter :: SnapshotFilter Source #
Create a value of SnapshotFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SnapshotFilter', snapshotFilter_name - The name of the filter to use. You can filter by the file-system-id or
by volume-id.
$sel:values:SnapshotFilter', snapshotFilter_values - The file-system-id or volume-id that you are filtering for.
StorageVirtualMachine
data StorageVirtualMachine Source #
Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.
See: newStorageVirtualMachine smart constructor.
Constructors
Instances
newStorageVirtualMachine :: StorageVirtualMachine Source #
Create a value of StorageVirtualMachine with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeDirectoryConfiguration:StorageVirtualMachine', storageVirtualMachine_activeDirectoryConfiguration - Describes the Microsoft Active Directory configuration to which the SVM
is joined, if applicable.
$sel:creationTime:StorageVirtualMachine', storageVirtualMachine_creationTime - Undocumented member.
$sel:endpoints:StorageVirtualMachine', storageVirtualMachine_endpoints - 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.
$sel:fileSystemId:StorageVirtualMachine', storageVirtualMachine_fileSystemId - Undocumented member.
$sel:lifecycle:StorageVirtualMachine', storageVirtualMachine_lifecycle - 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.
$sel:lifecycleTransitionReason:StorageVirtualMachine', storageVirtualMachine_lifecycleTransitionReason - Describes why the SVM lifecycle state changed.
$sel:name:StorageVirtualMachine', storageVirtualMachine_name - The name of the SVM, if provisioned.
$sel:resourceARN:StorageVirtualMachine', storageVirtualMachine_resourceARN - Undocumented member.
$sel:rootVolumeSecurityStyle:StorageVirtualMachine', storageVirtualMachine_rootVolumeSecurityStyle - The security style of the root volume of the SVM.
$sel:storageVirtualMachineId:StorageVirtualMachine', storageVirtualMachine_storageVirtualMachineId - The SVM's system generated unique ID.
$sel:subtype:StorageVirtualMachine', storageVirtualMachine_subtype - Describes the SVM's subtype.
$sel:tags:StorageVirtualMachine', storageVirtualMachine_tags - Undocumented member.
$sel:uuid:StorageVirtualMachine', storageVirtualMachine_uuid - The SVM's UUID (universally unique identifier).
StorageVirtualMachineFilter
data StorageVirtualMachineFilter Source #
A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.
See: newStorageVirtualMachineFilter smart constructor.
Constructors
| StorageVirtualMachineFilter' (Maybe StorageVirtualMachineFilterName) (Maybe [Text]) |
Instances
newStorageVirtualMachineFilter :: StorageVirtualMachineFilter Source #
Create a value of StorageVirtualMachineFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:StorageVirtualMachineFilter', storageVirtualMachineFilter_name - The name for this filter.
$sel:values:StorageVirtualMachineFilter', storageVirtualMachineFilter_values - The values of the filter. These are all the values for any of the
applied filters.
SvmActiveDirectoryConfiguration
data SvmActiveDirectoryConfiguration Source #
Describes the configuration of the Microsoft Active Directory (AD) directory to which the Amazon FSx for ONTAP storage virtual machine (SVM) is joined. Pleae note, account credentials are not returned in the response payload.
See: newSvmActiveDirectoryConfiguration smart constructor.
Constructors
| SvmActiveDirectoryConfiguration' (Maybe Text) (Maybe SelfManagedActiveDirectoryAttributes) |
Instances
newSvmActiveDirectoryConfiguration :: SvmActiveDirectoryConfiguration Source #
Create a value of SvmActiveDirectoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:netBiosName:SvmActiveDirectoryConfiguration', svmActiveDirectoryConfiguration_netBiosName - The NetBIOS name of the Active Directory computer object that is joined
to your SVM.
$sel:selfManagedActiveDirectoryConfiguration:SvmActiveDirectoryConfiguration', svmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration - Undocumented member.
SvmEndpoint
data SvmEndpoint Source #
An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four
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.
See: newSvmEndpoint smart constructor.
Instances
newSvmEndpoint :: SvmEndpoint Source #
Create a value of SvmEndpoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dNSName:SvmEndpoint', svmEndpoint_dNSName - Undocumented member.
$sel:ipAddresses:SvmEndpoint', svmEndpoint_ipAddresses - The SVM endpoint's IP addresses.
SvmEndpoints
data SvmEndpoints Source #
An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
See: newSvmEndpoints smart constructor.
Constructors
| SvmEndpoints' (Maybe SvmEndpoint) (Maybe SvmEndpoint) (Maybe SvmEndpoint) (Maybe SvmEndpoint) |
Instances
newSvmEndpoints :: SvmEndpoints Source #
Create a value of SvmEndpoints with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iscsi:SvmEndpoints', svmEndpoints_iscsi - An endpoint for connecting using the Internet Small Computer Systems
Interface (iSCSI) protocol.
$sel:management:SvmEndpoints', svmEndpoints_management - An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP
API, or NetApp CloudManager.
$sel:nfs:SvmEndpoints', svmEndpoints_nfs - An endpoint for connecting using the Network File System (NFS) protocol.
$sel:smb:SvmEndpoints', svmEndpoints_smb - An endpoint for connecting using the Server Message Block (SMB)
protocol.
Tag
Specifies a key-value pair for a resource tag.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.FSx.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.FSx.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.FSx.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.FSx.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.FSx.Types.Tag" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - A value that specifies the TagKey, the name of the tag. Tag keys must
be unique for the resource to which they are attached.
$sel:value:Tag', tag_value - 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
data TieringPolicy Source #
Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.
Valid tiering policies are the following:
SNAPSHOT_ONLY- (Default value) 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.
See: newTieringPolicy smart constructor.
Constructors
| TieringPolicy' (Maybe Natural) (Maybe TieringPolicyName) |
Instances
newTieringPolicy :: TieringPolicy Source #
Create a value of TieringPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:coolingPeriod:TieringPolicy', tieringPolicy_coolingPeriod - 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.
$sel:name:TieringPolicy', tieringPolicy_name - 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
data UpdateFileCacheLustreConfiguration Source #
The configuration update for an Amazon File Cache resource.
See: newUpdateFileCacheLustreConfiguration smart constructor.
Constructors
| UpdateFileCacheLustreConfiguration' (Maybe Text) |
Instances
newUpdateFileCacheLustreConfiguration :: UpdateFileCacheLustreConfiguration Source #
Create a value of UpdateFileCacheLustreConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:weeklyMaintenanceStartTime:UpdateFileCacheLustreConfiguration', updateFileCacheLustreConfiguration_weeklyMaintenanceStartTime - Undocumented member.
UpdateFileSystemLustreConfiguration
data UpdateFileSystemLustreConfiguration Source #
The configuration object for Amazon FSx for Lustre file systems used in
the UpdateFileSystem operation.
See: newUpdateFileSystemLustreConfiguration smart constructor.
Constructors
Instances
newUpdateFileSystemLustreConfiguration :: UpdateFileSystemLustreConfiguration Source #
Create a value of UpdateFileSystemLustreConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoImportPolicy:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_autoImportPolicy - (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.
$sel:automaticBackupRetentionDays:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:dailyAutomaticBackupStartTime:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:dataCompressionType:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_dataCompressionType - 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.
$sel:logConfiguration:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_logConfiguration - 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.
$sel:rootSquashConfiguration:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_rootSquashConfiguration - 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.
$sel:weeklyMaintenanceStartTime:UpdateFileSystemLustreConfiguration', updateFileSystemLustreConfiguration_weeklyMaintenanceStartTime - (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
data UpdateFileSystemOntapConfiguration Source #
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
See: newUpdateFileSystemOntapConfiguration smart constructor.
Constructors
| UpdateFileSystemOntapConfiguration' (Maybe [Text]) (Maybe Natural) (Maybe Text) (Maybe DiskIopsConfiguration) (Maybe (Sensitive Text)) (Maybe [Text]) (Maybe Natural) (Maybe Text) |
Instances
newUpdateFileSystemOntapConfiguration :: UpdateFileSystemOntapConfiguration Source #
Create a value of UpdateFileSystemOntapConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:addRouteTableIds:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_addRouteTableIds - (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.
$sel:automaticBackupRetentionDays:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:dailyAutomaticBackupStartTime:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:diskIopsConfiguration:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_diskIopsConfiguration - 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.
$sel:fsxAdminPassword:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_fsxAdminPassword - The ONTAP administrative password for the fsxadmin user.
$sel:removeRouteTableIds:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_removeRouteTableIds - (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.
$sel:throughputCapacity:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_throughputCapacity - 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.
$sel:weeklyMaintenanceStartTime:UpdateFileSystemOntapConfiguration', updateFileSystemOntapConfiguration_weeklyMaintenanceStartTime - Undocumented member.
UpdateFileSystemOpenZFSConfiguration
data UpdateFileSystemOpenZFSConfiguration Source #
The configuration updates for an Amazon FSx for OpenZFS file system.
See: newUpdateFileSystemOpenZFSConfiguration smart constructor.
Constructors
| UpdateFileSystemOpenZFSConfiguration' (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe DiskIopsConfiguration) (Maybe Natural) (Maybe Text) |
Instances
newUpdateFileSystemOpenZFSConfiguration :: UpdateFileSystemOpenZFSConfiguration Source #
Create a value of UpdateFileSystemOpenZFSConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automaticBackupRetentionDays:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_automaticBackupRetentionDays - Undocumented member.
$sel:copyTagsToBackups:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_copyTagsToBackups - 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.
$sel:copyTagsToVolumes:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_copyTagsToVolumes - 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.
$sel:dailyAutomaticBackupStartTime:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime - Undocumented member.
$sel:diskIopsConfiguration:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_diskIopsConfiguration - Undocumented member.
$sel:throughputCapacity:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_throughputCapacity - 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.
$sel:weeklyMaintenanceStartTime:UpdateFileSystemOpenZFSConfiguration', updateFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime - Undocumented member.
UpdateFileSystemWindowsConfiguration
data UpdateFileSystemWindowsConfiguration Source #
Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.
See: newUpdateFileSystemWindowsConfiguration smart constructor.
Constructors
| UpdateFileSystemWindowsConfiguration' (Maybe WindowsAuditLogCreateConfiguration) (Maybe Natural) (Maybe Text) (Maybe SelfManagedActiveDirectoryConfigurationUpdates) (Maybe Natural) (Maybe Text) |
Instances
newUpdateFileSystemWindowsConfiguration :: UpdateFileSystemWindowsConfiguration Source #
Create a value of UpdateFileSystemWindowsConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auditLogConfiguration:UpdateFileSystemWindowsConfiguration', updateFileSystemWindowsConfiguration_auditLogConfiguration - 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..
$sel:automaticBackupRetentionDays:UpdateFileSystemWindowsConfiguration', updateFileSystemWindowsConfiguration_automaticBackupRetentionDays - 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.
$sel:dailyAutomaticBackupStartTime:UpdateFileSystemWindowsConfiguration', updateFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime - The preferred time to start the daily automatic backup, in the UTC time
zone, for example, 02:00
$sel:selfManagedActiveDirectoryConfiguration:UpdateFileSystemWindowsConfiguration', updateFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration - 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.
$sel:throughputCapacity:UpdateFileSystemWindowsConfiguration', updateFileSystemWindowsConfiguration_throughputCapacity - 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.
$sel:weeklyMaintenanceStartTime:UpdateFileSystemWindowsConfiguration', updateFileSystemWindowsConfiguration_weeklyMaintenanceStartTime - 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
data UpdateOntapVolumeConfiguration Source #
Used to specify changes to the ONTAP configuration for the volume you are updating.
See: newUpdateOntapVolumeConfiguration smart constructor.
Constructors
| UpdateOntapVolumeConfiguration' (Maybe Bool) (Maybe Text) (Maybe SecurityStyle) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe TieringPolicy) |
Instances
newUpdateOntapVolumeConfiguration :: UpdateOntapVolumeConfiguration Source #
Create a value of UpdateOntapVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyTagsToBackups:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_copyTagsToBackups - 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.
$sel:junctionPath:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_junctionPath - Specifies the location in the SVM's namespace where the volume is
mounted. The JunctionPath must have a leading forward slash, such as
/vol3.
$sel:securityStyle:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_securityStyle - The security style for the volume, which can be UNIX. NTFS, or
MIXED.
$sel:sizeInMegabytes:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_sizeInMegabytes - Specifies the size of the volume in megabytes.
$sel:snapshotPolicy:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_snapshotPolicy - 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 thedefaultpolicy 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.
$sel:storageEfficiencyEnabled:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_storageEfficiencyEnabled - Default is false. Set to true to enable the deduplication,
compression, and compaction storage efficiency features on the volume.
$sel:tieringPolicy:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_tieringPolicy - Update the volume's data tiering policy.
UpdateOpenZFSVolumeConfiguration
data UpdateOpenZFSVolumeConfiguration Source #
Used to specify changes to the OpenZFS configuration for the volume that you are updating.
See: newUpdateOpenZFSVolumeConfiguration smart constructor.
Constructors
| UpdateOpenZFSVolumeConfiguration' (Maybe OpenZFSDataCompressionType) (Maybe [OpenZFSNfsExport]) (Maybe Bool) (Maybe Natural) (Maybe Int) (Maybe Int) (Maybe [OpenZFSUserOrGroupQuota]) |
Instances
newUpdateOpenZFSVolumeConfiguration :: UpdateOpenZFSVolumeConfiguration Source #
Create a value of UpdateOpenZFSVolumeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataCompressionType:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_dataCompressionType - 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.NONEis 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.
$sel:nfsExports:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_nfsExports - The configuration object for mounting a Network File System (NFS) file
system.
$sel:readOnly:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_readOnly - A Boolean value indicating whether the volume is read-only.
$sel:recordSizeKiB:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_recordSizeKiB - 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, updateOpenZFSVolumeConfiguration_storageCapacityQuotaGiB - 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.
$sel:storageCapacityReservationGiB:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_storageCapacityReservationGiB - 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.
$sel:userAndGroupQuotas:UpdateOpenZFSVolumeConfiguration', updateOpenZFSVolumeConfiguration_userAndGroupQuotas - An object specifying how much storage users or groups can use on the
volume.
UpdateSvmActiveDirectoryConfiguration
data UpdateSvmActiveDirectoryConfiguration Source #
Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. Please note, account credentials are not returned in the response payload.
See: newUpdateSvmActiveDirectoryConfiguration smart constructor.
Constructors
| UpdateSvmActiveDirectoryConfiguration' (Maybe SelfManagedActiveDirectoryConfigurationUpdates) |
Instances
newUpdateSvmActiveDirectoryConfiguration :: UpdateSvmActiveDirectoryConfiguration Source #
Create a value of UpdateSvmActiveDirectoryConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:selfManagedActiveDirectoryConfiguration:UpdateSvmActiveDirectoryConfiguration', updateSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration - Undocumented member.
Volume
Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
See: newVolume smart constructor.
Constructors
Instances
Create a value of Volume with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:administrativeActions:Volume', volume_administrativeActions - 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.
$sel:creationTime:Volume', volume_creationTime - Undocumented member.
$sel:fileSystemId:Volume', volume_fileSystemId - Undocumented member.
$sel:lifecycle:Volume', volume_lifecycle - 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.
$sel:lifecycleTransitionReason:Volume', volume_lifecycleTransitionReason - The reason why the volume lifecycle status changed.
$sel:name:Volume', volume_name - The name of the volume.
$sel:ontapConfiguration:Volume', volume_ontapConfiguration - Undocumented member.
$sel:openZFSConfiguration:Volume', volume_openZFSConfiguration - The configuration of an Amazon FSx for OpenZFS volume.
$sel:resourceARN:Volume', volume_resourceARN - Undocumented member.
$sel:tags:Volume', volume_tags - Undocumented member.
$sel:volumeId:Volume', volume_volumeId - The system-generated, unique ID of the volume.
$sel:volumeType:Volume', volume_volumeType - The type of the volume.
VolumeFilter
data VolumeFilter Source #
A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to return results that meet all applied filter requirements.
See: newVolumeFilter smart constructor.
Constructors
| VolumeFilter' (Maybe VolumeFilterName) (Maybe [Text]) |
Instances
newVolumeFilter :: VolumeFilter Source #
Create a value of VolumeFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:VolumeFilter', volumeFilter_name - The name for this filter.
$sel:values:VolumeFilter', volumeFilter_values - The values of the filter. These are all the values for any of the
applied filters.
WindowsAuditLogConfiguration
data 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. For more information, see File access auditing.
See: newWindowsAuditLogConfiguration smart constructor.
Constructors
| WindowsAuditLogConfiguration' (Maybe Text) WindowsAccessAuditLogLevel WindowsAccessAuditLogLevel |
Instances
newWindowsAuditLogConfiguration Source #
Arguments
| :: WindowsAccessAuditLogLevel | |
| -> WindowsAccessAuditLogLevel |
|
| -> WindowsAuditLogConfiguration |
Create a value of WindowsAuditLogConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auditLogDestination:WindowsAuditLogConfiguration', windowsAuditLogConfiguration_auditLogDestination - 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.
$sel:fileAccessAuditLogLevel:WindowsAuditLogConfiguration', windowsAuditLogConfiguration_fileAccessAuditLogLevel - 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.
$sel:fileShareAccessAuditLogLevel:WindowsAuditLogConfiguration', windowsAuditLogConfiguration_fileShareAccessAuditLogLevel - 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
data WindowsAuditLogCreateConfiguration Source #
The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.
See: newWindowsAuditLogCreateConfiguration smart constructor.
Constructors
| WindowsAuditLogCreateConfiguration' (Maybe Text) WindowsAccessAuditLogLevel WindowsAccessAuditLogLevel |
Instances
newWindowsAuditLogCreateConfiguration Source #
Arguments
Create a value of WindowsAuditLogCreateConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auditLogDestination:WindowsAuditLogCreateConfiguration', windowsAuditLogCreateConfiguration_auditLogDestination - 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/fsxprefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with theaws-fsxprefix. - If you do not provide a destination in
AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs/aws/fsx/windowslog group. - If
AuditLogDestinationis provided and the resource does not exist, the request will fail with aBadRequesterror. - If
FileAccessAuditLogLevelandFileShareAccessAuditLogLevelare both set toDISABLED, you cannot specify a destination inAuditLogDestination.
$sel:fileAccessAuditLogLevel:WindowsAuditLogCreateConfiguration', windowsAuditLogCreateConfiguration_fileAccessAuditLogLevel - 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.
$sel:fileShareAccessAuditLogLevel:WindowsAuditLogCreateConfiguration', windowsAuditLogCreateConfiguration_fileShareAccessAuditLogLevel - 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
data WindowsFileSystemConfiguration Source #
The configuration for this Microsoft Windows file system.
See: newWindowsFileSystemConfiguration smart constructor.
Constructors
Instances
newWindowsFileSystemConfiguration :: WindowsFileSystemConfiguration Source #
Create a value of WindowsFileSystemConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeDirectoryId:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_activeDirectoryId - The ID for an existing Amazon Web Services Managed Microsoft Active
Directory instance that the file system is joined to.
$sel:aliases:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_aliases - Undocumented member.
$sel:auditLogConfiguration:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_auditLogConfiguration - 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.
$sel:automaticBackupRetentionDays:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_automaticBackupRetentionDays - 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.
$sel:copyTagsToBackups:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_copyTagsToBackups - 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.
$sel:dailyAutomaticBackupStartTime:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_dailyAutomaticBackupStartTime - The preferred time to take daily automatic backups, in the UTC time
zone.
$sel:deploymentType:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_deploymentType - 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.
$sel:maintenanceOperationsInProgress:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_maintenanceOperationsInProgress - The list of maintenance operations in progress for this file system.
$sel:preferredFileServerIp:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_preferredFileServerIp - 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.
$sel:preferredSubnetId:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_preferredSubnetId - 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.
$sel:remoteAdministrationEndpoint:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_remoteAdministrationEndpoint - 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.
$sel:selfManagedActiveDirectoryConfiguration:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_selfManagedActiveDirectoryConfiguration - Undocumented member.
$sel:throughputCapacity:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_throughputCapacity - The throughput of the Amazon FSx file system, measured in megabytes per
second.
$sel:weeklyMaintenanceStartTime:WindowsFileSystemConfiguration', windowsFileSystemConfiguration_weeklyMaintenanceStartTime - 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.