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 |
- Service Configuration
- Errors
- 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
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
- 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' {}
- newActiveDirectoryBackupAttributes :: ActiveDirectoryBackupAttributes
- activeDirectoryBackupAttributes_activeDirectoryId :: Lens' ActiveDirectoryBackupAttributes (Maybe Text)
- activeDirectoryBackupAttributes_domainName :: Lens' ActiveDirectoryBackupAttributes (Maybe Text)
- activeDirectoryBackupAttributes_resourceARN :: Lens' ActiveDirectoryBackupAttributes (Maybe Text)
- data AdministrativeAction = AdministrativeAction' {
- administrativeActionType :: Maybe AdministrativeActionType
- failureDetails :: Maybe AdministrativeActionFailureDetails
- progressPercent :: Maybe Natural
- requestTime :: Maybe POSIX
- status :: Maybe Status
- targetFileSystemValues :: Maybe FileSystem
- targetSnapshotValues :: Maybe Snapshot
- targetVolumeValues :: Maybe Volume
- newAdministrativeAction :: AdministrativeAction
- administrativeAction_administrativeActionType :: Lens' AdministrativeAction (Maybe AdministrativeActionType)
- administrativeAction_failureDetails :: Lens' AdministrativeAction (Maybe AdministrativeActionFailureDetails)
- administrativeAction_progressPercent :: Lens' AdministrativeAction (Maybe Natural)
- administrativeAction_requestTime :: Lens' AdministrativeAction (Maybe UTCTime)
- administrativeAction_status :: Lens' AdministrativeAction (Maybe Status)
- administrativeAction_targetFileSystemValues :: Lens' AdministrativeAction (Maybe FileSystem)
- administrativeAction_targetSnapshotValues :: Lens' AdministrativeAction (Maybe Snapshot)
- administrativeAction_targetVolumeValues :: Lens' AdministrativeAction (Maybe Volume)
- data AdministrativeActionFailureDetails = AdministrativeActionFailureDetails' {}
- newAdministrativeActionFailureDetails :: AdministrativeActionFailureDetails
- administrativeActionFailureDetails_message :: Lens' AdministrativeActionFailureDetails (Maybe Text)
- data Alias = Alias' {}
- newAlias :: Alias
- alias_lifecycle :: Lens' Alias (Maybe AliasLifecycle)
- alias_name :: Lens' Alias (Maybe Text)
- data AutoExportPolicy = AutoExportPolicy' {}
- newAutoExportPolicy :: AutoExportPolicy
- autoExportPolicy_events :: Lens' AutoExportPolicy (Maybe [EventType])
- data AutoImportPolicy = AutoImportPolicy' {}
- newAutoImportPolicy :: AutoImportPolicy
- autoImportPolicy_events :: Lens' AutoImportPolicy (Maybe [EventType])
- data Backup = Backup' {
- directoryInformation :: Maybe ActiveDirectoryBackupAttributes
- failureDetails :: Maybe BackupFailureDetails
- kmsKeyId :: Maybe Text
- ownerId :: Maybe Text
- progressPercent :: Maybe Natural
- resourceARN :: Maybe Text
- resourceType :: Maybe ResourceType
- sourceBackupId :: Maybe Text
- sourceBackupRegion :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- volume :: Maybe Volume
- backupId :: Text
- lifecycle :: BackupLifecycle
- type' :: BackupType
- creationTime :: POSIX
- fileSystem :: FileSystem
- newBackup :: Text -> BackupLifecycle -> BackupType -> UTCTime -> FileSystem -> Backup
- backup_directoryInformation :: Lens' Backup (Maybe ActiveDirectoryBackupAttributes)
- backup_failureDetails :: Lens' Backup (Maybe BackupFailureDetails)
- backup_kmsKeyId :: Lens' Backup (Maybe Text)
- backup_ownerId :: Lens' Backup (Maybe Text)
- backup_progressPercent :: Lens' Backup (Maybe Natural)
- backup_resourceARN :: Lens' Backup (Maybe Text)
- backup_resourceType :: Lens' Backup (Maybe ResourceType)
- backup_sourceBackupId :: Lens' Backup (Maybe Text)
- backup_sourceBackupRegion :: Lens' Backup (Maybe Text)
- backup_tags :: Lens' Backup (Maybe (NonEmpty Tag))
- backup_volume :: Lens' Backup (Maybe Volume)
- backup_backupId :: Lens' Backup Text
- backup_lifecycle :: Lens' Backup BackupLifecycle
- backup_type :: Lens' Backup BackupType
- backup_creationTime :: Lens' Backup UTCTime
- backup_fileSystem :: Lens' Backup FileSystem
- data BackupFailureDetails = BackupFailureDetails' {}
- newBackupFailureDetails :: BackupFailureDetails
- backupFailureDetails_message :: Lens' BackupFailureDetails (Maybe Text)
- data CompletionReport = CompletionReport' {}
- newCompletionReport :: Bool -> CompletionReport
- completionReport_format :: Lens' CompletionReport (Maybe ReportFormat)
- completionReport_path :: Lens' CompletionReport (Maybe Text)
- completionReport_scope :: Lens' CompletionReport (Maybe ReportScope)
- completionReport_enabled :: Lens' CompletionReport Bool
- data CreateFileCacheLustreConfiguration = CreateFileCacheLustreConfiguration' {}
- newCreateFileCacheLustreConfiguration :: Natural -> FileCacheLustreDeploymentType -> FileCacheLustreMetadataConfiguration -> CreateFileCacheLustreConfiguration
- createFileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileCacheLustreConfiguration (Maybe Text)
- createFileCacheLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileCacheLustreConfiguration Natural
- createFileCacheLustreConfiguration_deploymentType :: Lens' CreateFileCacheLustreConfiguration FileCacheLustreDeploymentType
- createFileCacheLustreConfiguration_metadataConfiguration :: Lens' CreateFileCacheLustreConfiguration FileCacheLustreMetadataConfiguration
- data CreateFileSystemLustreConfiguration = CreateFileSystemLustreConfiguration' {
- autoImportPolicy :: Maybe AutoImportPolicyType
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- dataCompressionType :: Maybe DataCompressionType
- deploymentType :: Maybe LustreDeploymentType
- driveCacheType :: Maybe DriveCacheType
- exportPath :: Maybe Text
- importPath :: Maybe Text
- importedFileChunkSize :: Maybe Natural
- logConfiguration :: Maybe LustreLogCreateConfiguration
- perUnitStorageThroughput :: Maybe Natural
- rootSquashConfiguration :: Maybe LustreRootSquashConfiguration
- weeklyMaintenanceStartTime :: Maybe Text
- newCreateFileSystemLustreConfiguration :: CreateFileSystemLustreConfiguration
- createFileSystemLustreConfiguration_autoImportPolicy :: Lens' CreateFileSystemLustreConfiguration (Maybe AutoImportPolicyType)
- createFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural)
- createFileSystemLustreConfiguration_copyTagsToBackups :: Lens' CreateFileSystemLustreConfiguration (Maybe Bool)
- createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- createFileSystemLustreConfiguration_dataCompressionType :: Lens' CreateFileSystemLustreConfiguration (Maybe DataCompressionType)
- createFileSystemLustreConfiguration_deploymentType :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreDeploymentType)
- createFileSystemLustreConfiguration_driveCacheType :: Lens' CreateFileSystemLustreConfiguration (Maybe DriveCacheType)
- createFileSystemLustreConfiguration_exportPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- createFileSystemLustreConfiguration_importPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- createFileSystemLustreConfiguration_importedFileChunkSize :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural)
- createFileSystemLustreConfiguration_logConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration)
- createFileSystemLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural)
- createFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration)
- createFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text)
- data CreateFileSystemOntapConfiguration = CreateFileSystemOntapConfiguration' {
- automaticBackupRetentionDays :: Maybe Natural
- dailyAutomaticBackupStartTime :: Maybe Text
- diskIopsConfiguration :: Maybe DiskIopsConfiguration
- endpointIpAddressRange :: Maybe Text
- fsxAdminPassword :: Maybe (Sensitive Text)
- preferredSubnetId :: Maybe Text
- routeTableIds :: Maybe [Text]
- weeklyMaintenanceStartTime :: Maybe Text
- deploymentType :: OntapDeploymentType
- throughputCapacity :: Natural
- newCreateFileSystemOntapConfiguration :: OntapDeploymentType -> Natural -> CreateFileSystemOntapConfiguration
- createFileSystemOntapConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemOntapConfiguration (Maybe Natural)
- createFileSystemOntapConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemOntapConfiguration (Maybe Text)
- createFileSystemOntapConfiguration_diskIopsConfiguration :: Lens' CreateFileSystemOntapConfiguration (Maybe DiskIopsConfiguration)
- createFileSystemOntapConfiguration_endpointIpAddressRange :: Lens' CreateFileSystemOntapConfiguration (Maybe Text)
- createFileSystemOntapConfiguration_fsxAdminPassword :: Lens' CreateFileSystemOntapConfiguration (Maybe Text)
- createFileSystemOntapConfiguration_preferredSubnetId :: Lens' CreateFileSystemOntapConfiguration (Maybe Text)
- createFileSystemOntapConfiguration_routeTableIds :: Lens' CreateFileSystemOntapConfiguration (Maybe [Text])
- createFileSystemOntapConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemOntapConfiguration (Maybe Text)
- createFileSystemOntapConfiguration_deploymentType :: Lens' CreateFileSystemOntapConfiguration OntapDeploymentType
- createFileSystemOntapConfiguration_throughputCapacity :: Lens' CreateFileSystemOntapConfiguration Natural
- data CreateFileSystemOpenZFSConfiguration = CreateFileSystemOpenZFSConfiguration' {
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- copyTagsToVolumes :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- diskIopsConfiguration :: Maybe DiskIopsConfiguration
- rootVolumeConfiguration :: Maybe OpenZFSCreateRootVolumeConfiguration
- weeklyMaintenanceStartTime :: Maybe Text
- deploymentType :: OpenZFSDeploymentType
- throughputCapacity :: Natural
- newCreateFileSystemOpenZFSConfiguration :: OpenZFSDeploymentType -> Natural -> CreateFileSystemOpenZFSConfiguration
- createFileSystemOpenZFSConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Natural)
- createFileSystemOpenZFSConfiguration_copyTagsToBackups :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Bool)
- createFileSystemOpenZFSConfiguration_copyTagsToVolumes :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Bool)
- createFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Text)
- createFileSystemOpenZFSConfiguration_diskIopsConfiguration :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe DiskIopsConfiguration)
- createFileSystemOpenZFSConfiguration_rootVolumeConfiguration :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe OpenZFSCreateRootVolumeConfiguration)
- createFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Text)
- createFileSystemOpenZFSConfiguration_deploymentType :: Lens' CreateFileSystemOpenZFSConfiguration OpenZFSDeploymentType
- createFileSystemOpenZFSConfiguration_throughputCapacity :: Lens' CreateFileSystemOpenZFSConfiguration Natural
- data CreateFileSystemWindowsConfiguration = CreateFileSystemWindowsConfiguration' {
- activeDirectoryId :: Maybe Text
- aliases :: Maybe [Text]
- auditLogConfiguration :: Maybe WindowsAuditLogCreateConfiguration
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- deploymentType :: Maybe WindowsDeploymentType
- preferredSubnetId :: Maybe Text
- selfManagedActiveDirectoryConfiguration :: Maybe SelfManagedActiveDirectoryConfiguration
- weeklyMaintenanceStartTime :: Maybe Text
- throughputCapacity :: Natural
- newCreateFileSystemWindowsConfiguration :: Natural -> CreateFileSystemWindowsConfiguration
- createFileSystemWindowsConfiguration_activeDirectoryId :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text)
- createFileSystemWindowsConfiguration_aliases :: Lens' CreateFileSystemWindowsConfiguration (Maybe [Text])
- createFileSystemWindowsConfiguration_auditLogConfiguration :: Lens' CreateFileSystemWindowsConfiguration (Maybe WindowsAuditLogCreateConfiguration)
- createFileSystemWindowsConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemWindowsConfiguration (Maybe Natural)
- createFileSystemWindowsConfiguration_copyTagsToBackups :: Lens' CreateFileSystemWindowsConfiguration (Maybe Bool)
- createFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text)
- createFileSystemWindowsConfiguration_deploymentType :: Lens' CreateFileSystemWindowsConfiguration (Maybe WindowsDeploymentType)
- createFileSystemWindowsConfiguration_preferredSubnetId :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text)
- createFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' CreateFileSystemWindowsConfiguration (Maybe SelfManagedActiveDirectoryConfiguration)
- createFileSystemWindowsConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text)
- createFileSystemWindowsConfiguration_throughputCapacity :: Lens' CreateFileSystemWindowsConfiguration Natural
- data CreateOntapVolumeConfiguration = CreateOntapVolumeConfiguration' {}
- newCreateOntapVolumeConfiguration :: Natural -> Text -> CreateOntapVolumeConfiguration
- createOntapVolumeConfiguration_copyTagsToBackups :: Lens' CreateOntapVolumeConfiguration (Maybe Bool)
- createOntapVolumeConfiguration_junctionPath :: Lens' CreateOntapVolumeConfiguration (Maybe Text)
- createOntapVolumeConfiguration_ontapVolumeType :: Lens' CreateOntapVolumeConfiguration (Maybe InputOntapVolumeType)
- createOntapVolumeConfiguration_securityStyle :: Lens' CreateOntapVolumeConfiguration (Maybe SecurityStyle)
- createOntapVolumeConfiguration_snapshotPolicy :: Lens' CreateOntapVolumeConfiguration (Maybe Text)
- createOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' CreateOntapVolumeConfiguration (Maybe Bool)
- createOntapVolumeConfiguration_tieringPolicy :: Lens' CreateOntapVolumeConfiguration (Maybe TieringPolicy)
- createOntapVolumeConfiguration_sizeInMegabytes :: Lens' CreateOntapVolumeConfiguration Natural
- createOntapVolumeConfiguration_storageVirtualMachineId :: Lens' CreateOntapVolumeConfiguration Text
- data CreateOpenZFSOriginSnapshotConfiguration = CreateOpenZFSOriginSnapshotConfiguration' {}
- newCreateOpenZFSOriginSnapshotConfiguration :: Text -> OpenZFSCopyStrategy -> CreateOpenZFSOriginSnapshotConfiguration
- createOpenZFSOriginSnapshotConfiguration_snapshotARN :: Lens' CreateOpenZFSOriginSnapshotConfiguration Text
- createOpenZFSOriginSnapshotConfiguration_copyStrategy :: Lens' CreateOpenZFSOriginSnapshotConfiguration OpenZFSCopyStrategy
- data CreateOpenZFSVolumeConfiguration = CreateOpenZFSVolumeConfiguration' {
- copyTagsToSnapshots :: Maybe Bool
- dataCompressionType :: Maybe OpenZFSDataCompressionType
- nfsExports :: Maybe [OpenZFSNfsExport]
- originSnapshot :: Maybe CreateOpenZFSOriginSnapshotConfiguration
- readOnly :: Maybe Bool
- recordSizeKiB :: Maybe Natural
- storageCapacityQuotaGiB :: Maybe Int
- storageCapacityReservationGiB :: Maybe Int
- userAndGroupQuotas :: Maybe [OpenZFSUserOrGroupQuota]
- parentVolumeId :: Text
- newCreateOpenZFSVolumeConfiguration :: Text -> CreateOpenZFSVolumeConfiguration
- createOpenZFSVolumeConfiguration_copyTagsToSnapshots :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Bool)
- createOpenZFSVolumeConfiguration_dataCompressionType :: Lens' CreateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType)
- createOpenZFSVolumeConfiguration_nfsExports :: Lens' CreateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport])
- createOpenZFSVolumeConfiguration_originSnapshot :: Lens' CreateOpenZFSVolumeConfiguration (Maybe CreateOpenZFSOriginSnapshotConfiguration)
- createOpenZFSVolumeConfiguration_readOnly :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Bool)
- createOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Natural)
- createOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Int)
- createOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Int)
- createOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' CreateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota])
- createOpenZFSVolumeConfiguration_parentVolumeId :: Lens' CreateOpenZFSVolumeConfiguration Text
- data CreateSvmActiveDirectoryConfiguration = CreateSvmActiveDirectoryConfiguration' {}
- newCreateSvmActiveDirectoryConfiguration :: Text -> CreateSvmActiveDirectoryConfiguration
- createSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' CreateSvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryConfiguration)
- createSvmActiveDirectoryConfiguration_netBiosName :: Lens' CreateSvmActiveDirectoryConfiguration Text
- data DataRepositoryAssociation = DataRepositoryAssociation' {
- associationId :: Maybe Text
- batchImportMetaDataOnCreate :: Maybe Bool
- creationTime :: Maybe POSIX
- dataRepositoryPath :: Maybe Text
- dataRepositorySubdirectories :: Maybe [Text]
- failureDetails :: Maybe DataRepositoryFailureDetails
- fileCacheId :: Maybe Text
- fileCachePath :: Maybe Text
- fileSystemId :: Maybe Text
- fileSystemPath :: Maybe Text
- importedFileChunkSize :: Maybe Natural
- lifecycle :: Maybe DataRepositoryLifecycle
- nfs :: Maybe NFSDataRepositoryConfiguration
- resourceARN :: Maybe Text
- s3 :: Maybe S3DataRepositoryConfiguration
- tags :: Maybe (NonEmpty Tag)
- newDataRepositoryAssociation :: DataRepositoryAssociation
- dataRepositoryAssociation_associationId :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_batchImportMetaDataOnCreate :: Lens' DataRepositoryAssociation (Maybe Bool)
- dataRepositoryAssociation_creationTime :: Lens' DataRepositoryAssociation (Maybe UTCTime)
- dataRepositoryAssociation_dataRepositoryPath :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_dataRepositorySubdirectories :: Lens' DataRepositoryAssociation (Maybe [Text])
- dataRepositoryAssociation_failureDetails :: Lens' DataRepositoryAssociation (Maybe DataRepositoryFailureDetails)
- dataRepositoryAssociation_fileCacheId :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_fileCachePath :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_fileSystemId :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_fileSystemPath :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_importedFileChunkSize :: Lens' DataRepositoryAssociation (Maybe Natural)
- dataRepositoryAssociation_lifecycle :: Lens' DataRepositoryAssociation (Maybe DataRepositoryLifecycle)
- dataRepositoryAssociation_nfs :: Lens' DataRepositoryAssociation (Maybe NFSDataRepositoryConfiguration)
- dataRepositoryAssociation_resourceARN :: Lens' DataRepositoryAssociation (Maybe Text)
- dataRepositoryAssociation_s3 :: Lens' DataRepositoryAssociation (Maybe S3DataRepositoryConfiguration)
- dataRepositoryAssociation_tags :: Lens' DataRepositoryAssociation (Maybe (NonEmpty Tag))
- data DataRepositoryConfiguration = DataRepositoryConfiguration' {}
- newDataRepositoryConfiguration :: DataRepositoryConfiguration
- dataRepositoryConfiguration_autoImportPolicy :: Lens' DataRepositoryConfiguration (Maybe AutoImportPolicyType)
- dataRepositoryConfiguration_exportPath :: Lens' DataRepositoryConfiguration (Maybe Text)
- dataRepositoryConfiguration_failureDetails :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryFailureDetails)
- dataRepositoryConfiguration_importPath :: Lens' DataRepositoryConfiguration (Maybe Text)
- dataRepositoryConfiguration_importedFileChunkSize :: Lens' DataRepositoryConfiguration (Maybe Natural)
- dataRepositoryConfiguration_lifecycle :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryLifecycle)
- data DataRepositoryFailureDetails = DataRepositoryFailureDetails' {}
- newDataRepositoryFailureDetails :: DataRepositoryFailureDetails
- dataRepositoryFailureDetails_message :: Lens' DataRepositoryFailureDetails (Maybe Text)
- data DataRepositoryTask = DataRepositoryTask' {
- capacityToRelease :: Maybe Natural
- endTime :: Maybe POSIX
- failureDetails :: Maybe DataRepositoryTaskFailureDetails
- fileCacheId :: Maybe Text
- fileSystemId :: Maybe Text
- paths :: Maybe [Text]
- report :: Maybe CompletionReport
- resourceARN :: Maybe Text
- startTime :: Maybe POSIX
- status :: Maybe DataRepositoryTaskStatus
- tags :: Maybe (NonEmpty Tag)
- taskId :: Text
- lifecycle :: DataRepositoryTaskLifecycle
- type' :: DataRepositoryTaskType
- creationTime :: POSIX
- newDataRepositoryTask :: Text -> DataRepositoryTaskLifecycle -> DataRepositoryTaskType -> UTCTime -> DataRepositoryTask
- dataRepositoryTask_capacityToRelease :: Lens' DataRepositoryTask (Maybe Natural)
- dataRepositoryTask_endTime :: Lens' DataRepositoryTask (Maybe UTCTime)
- dataRepositoryTask_failureDetails :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskFailureDetails)
- dataRepositoryTask_fileCacheId :: Lens' DataRepositoryTask (Maybe Text)
- dataRepositoryTask_fileSystemId :: Lens' DataRepositoryTask (Maybe Text)
- dataRepositoryTask_paths :: Lens' DataRepositoryTask (Maybe [Text])
- dataRepositoryTask_report :: Lens' DataRepositoryTask (Maybe CompletionReport)
- dataRepositoryTask_resourceARN :: Lens' DataRepositoryTask (Maybe Text)
- dataRepositoryTask_startTime :: Lens' DataRepositoryTask (Maybe UTCTime)
- dataRepositoryTask_status :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskStatus)
- dataRepositoryTask_tags :: Lens' DataRepositoryTask (Maybe (NonEmpty Tag))
- dataRepositoryTask_taskId :: Lens' DataRepositoryTask Text
- dataRepositoryTask_lifecycle :: Lens' DataRepositoryTask DataRepositoryTaskLifecycle
- dataRepositoryTask_type :: Lens' DataRepositoryTask DataRepositoryTaskType
- dataRepositoryTask_creationTime :: Lens' DataRepositoryTask UTCTime
- data DataRepositoryTaskFailureDetails = DataRepositoryTaskFailureDetails' {}
- newDataRepositoryTaskFailureDetails :: DataRepositoryTaskFailureDetails
- dataRepositoryTaskFailureDetails_message :: Lens' DataRepositoryTaskFailureDetails (Maybe Text)
- data DataRepositoryTaskFilter = DataRepositoryTaskFilter' {}
- newDataRepositoryTaskFilter :: DataRepositoryTaskFilter
- dataRepositoryTaskFilter_name :: Lens' DataRepositoryTaskFilter (Maybe DataRepositoryTaskFilterName)
- dataRepositoryTaskFilter_values :: Lens' DataRepositoryTaskFilter (Maybe [Text])
- data DataRepositoryTaskStatus = DataRepositoryTaskStatus' {}
- newDataRepositoryTaskStatus :: DataRepositoryTaskStatus
- dataRepositoryTaskStatus_failedCount :: Lens' DataRepositoryTaskStatus (Maybe Integer)
- dataRepositoryTaskStatus_lastUpdatedTime :: Lens' DataRepositoryTaskStatus (Maybe UTCTime)
- dataRepositoryTaskStatus_releasedCapacity :: Lens' DataRepositoryTaskStatus (Maybe Integer)
- dataRepositoryTaskStatus_succeededCount :: Lens' DataRepositoryTaskStatus (Maybe Integer)
- dataRepositoryTaskStatus_totalCount :: Lens' DataRepositoryTaskStatus (Maybe Integer)
- data DeleteFileSystemLustreConfiguration = DeleteFileSystemLustreConfiguration' {}
- newDeleteFileSystemLustreConfiguration :: DeleteFileSystemLustreConfiguration
- deleteFileSystemLustreConfiguration_finalBackupTags :: Lens' DeleteFileSystemLustreConfiguration (Maybe (NonEmpty Tag))
- deleteFileSystemLustreConfiguration_skipFinalBackup :: Lens' DeleteFileSystemLustreConfiguration (Maybe Bool)
- data DeleteFileSystemLustreResponse = DeleteFileSystemLustreResponse' {}
- newDeleteFileSystemLustreResponse :: DeleteFileSystemLustreResponse
- deleteFileSystemLustreResponse_finalBackupId :: Lens' DeleteFileSystemLustreResponse (Maybe Text)
- deleteFileSystemLustreResponse_finalBackupTags :: Lens' DeleteFileSystemLustreResponse (Maybe (NonEmpty Tag))
- data DeleteFileSystemOpenZFSConfiguration = DeleteFileSystemOpenZFSConfiguration' {}
- newDeleteFileSystemOpenZFSConfiguration :: DeleteFileSystemOpenZFSConfiguration
- deleteFileSystemOpenZFSConfiguration_finalBackupTags :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe (NonEmpty Tag))
- deleteFileSystemOpenZFSConfiguration_options :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe [DeleteFileSystemOpenZFSOption])
- deleteFileSystemOpenZFSConfiguration_skipFinalBackup :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe Bool)
- data DeleteFileSystemOpenZFSResponse = DeleteFileSystemOpenZFSResponse' {}
- newDeleteFileSystemOpenZFSResponse :: DeleteFileSystemOpenZFSResponse
- deleteFileSystemOpenZFSResponse_finalBackupId :: Lens' DeleteFileSystemOpenZFSResponse (Maybe Text)
- deleteFileSystemOpenZFSResponse_finalBackupTags :: Lens' DeleteFileSystemOpenZFSResponse (Maybe (NonEmpty Tag))
- data DeleteFileSystemWindowsConfiguration = DeleteFileSystemWindowsConfiguration' {}
- newDeleteFileSystemWindowsConfiguration :: DeleteFileSystemWindowsConfiguration
- deleteFileSystemWindowsConfiguration_finalBackupTags :: Lens' DeleteFileSystemWindowsConfiguration (Maybe (NonEmpty Tag))
- deleteFileSystemWindowsConfiguration_skipFinalBackup :: Lens' DeleteFileSystemWindowsConfiguration (Maybe Bool)
- data DeleteFileSystemWindowsResponse = DeleteFileSystemWindowsResponse' {}
- newDeleteFileSystemWindowsResponse :: DeleteFileSystemWindowsResponse
- deleteFileSystemWindowsResponse_finalBackupId :: Lens' DeleteFileSystemWindowsResponse (Maybe Text)
- deleteFileSystemWindowsResponse_finalBackupTags :: Lens' DeleteFileSystemWindowsResponse (Maybe (NonEmpty Tag))
- data DeleteVolumeOntapConfiguration = DeleteVolumeOntapConfiguration' {}
- newDeleteVolumeOntapConfiguration :: DeleteVolumeOntapConfiguration
- deleteVolumeOntapConfiguration_finalBackupTags :: Lens' DeleteVolumeOntapConfiguration (Maybe (NonEmpty Tag))
- deleteVolumeOntapConfiguration_skipFinalBackup :: Lens' DeleteVolumeOntapConfiguration (Maybe Bool)
- data DeleteVolumeOntapResponse = DeleteVolumeOntapResponse' {}
- newDeleteVolumeOntapResponse :: DeleteVolumeOntapResponse
- deleteVolumeOntapResponse_finalBackupId :: Lens' DeleteVolumeOntapResponse (Maybe Text)
- deleteVolumeOntapResponse_finalBackupTags :: Lens' DeleteVolumeOntapResponse (Maybe (NonEmpty Tag))
- data DeleteVolumeOpenZFSConfiguration = DeleteVolumeOpenZFSConfiguration' {}
- newDeleteVolumeOpenZFSConfiguration :: DeleteVolumeOpenZFSConfiguration
- deleteVolumeOpenZFSConfiguration_options :: Lens' DeleteVolumeOpenZFSConfiguration (Maybe [DeleteOpenZFSVolumeOption])
- data DiskIopsConfiguration = DiskIopsConfiguration' {}
- newDiskIopsConfiguration :: DiskIopsConfiguration
- diskIopsConfiguration_iops :: Lens' DiskIopsConfiguration (Maybe Natural)
- diskIopsConfiguration_mode :: Lens' DiskIopsConfiguration (Maybe DiskIopsConfigurationMode)
- data FileCache = FileCache' {
- creationTime :: Maybe POSIX
- dNSName :: Maybe Text
- dataRepositoryAssociationIds :: Maybe [Text]
- failureDetails :: Maybe FileCacheFailureDetails
- fileCacheId :: Maybe Text
- fileCacheType :: Maybe FileCacheType
- fileCacheTypeVersion :: Maybe Text
- kmsKeyId :: Maybe Text
- lifecycle :: Maybe FileCacheLifecycle
- lustreConfiguration :: Maybe FileCacheLustreConfiguration
- networkInterfaceIds :: Maybe [Text]
- ownerId :: Maybe Text
- resourceARN :: Maybe Text
- storageCapacity :: Maybe Natural
- subnetIds :: Maybe [Text]
- vpcId :: Maybe Text
- newFileCache :: FileCache
- fileCache_creationTime :: Lens' FileCache (Maybe UTCTime)
- fileCache_dNSName :: Lens' FileCache (Maybe Text)
- fileCache_dataRepositoryAssociationIds :: Lens' FileCache (Maybe [Text])
- fileCache_failureDetails :: Lens' FileCache (Maybe FileCacheFailureDetails)
- fileCache_fileCacheId :: Lens' FileCache (Maybe Text)
- fileCache_fileCacheType :: Lens' FileCache (Maybe FileCacheType)
- fileCache_fileCacheTypeVersion :: Lens' FileCache (Maybe Text)
- fileCache_kmsKeyId :: Lens' FileCache (Maybe Text)
- fileCache_lifecycle :: Lens' FileCache (Maybe FileCacheLifecycle)
- fileCache_lustreConfiguration :: Lens' FileCache (Maybe FileCacheLustreConfiguration)
- fileCache_networkInterfaceIds :: Lens' FileCache (Maybe [Text])
- fileCache_ownerId :: Lens' FileCache (Maybe Text)
- fileCache_resourceARN :: Lens' FileCache (Maybe Text)
- fileCache_storageCapacity :: Lens' FileCache (Maybe Natural)
- fileCache_subnetIds :: Lens' FileCache (Maybe [Text])
- fileCache_vpcId :: Lens' FileCache (Maybe Text)
- data FileCacheCreating = FileCacheCreating' {
- copyTagsToDataRepositoryAssociations :: Maybe Bool
- creationTime :: Maybe POSIX
- dNSName :: Maybe Text
- dataRepositoryAssociationIds :: Maybe [Text]
- failureDetails :: Maybe FileCacheFailureDetails
- fileCacheId :: Maybe Text
- fileCacheType :: Maybe FileCacheType
- fileCacheTypeVersion :: Maybe Text
- kmsKeyId :: Maybe Text
- lifecycle :: Maybe FileCacheLifecycle
- lustreConfiguration :: Maybe FileCacheLustreConfiguration
- networkInterfaceIds :: Maybe [Text]
- ownerId :: Maybe Text
- resourceARN :: Maybe Text
- storageCapacity :: Maybe Natural
- subnetIds :: Maybe [Text]
- tags :: Maybe (NonEmpty Tag)
- vpcId :: Maybe Text
- newFileCacheCreating :: FileCacheCreating
- fileCacheCreating_copyTagsToDataRepositoryAssociations :: Lens' FileCacheCreating (Maybe Bool)
- fileCacheCreating_creationTime :: Lens' FileCacheCreating (Maybe UTCTime)
- fileCacheCreating_dNSName :: Lens' FileCacheCreating (Maybe Text)
- fileCacheCreating_dataRepositoryAssociationIds :: Lens' FileCacheCreating (Maybe [Text])
- fileCacheCreating_failureDetails :: Lens' FileCacheCreating (Maybe FileCacheFailureDetails)
- fileCacheCreating_fileCacheId :: Lens' FileCacheCreating (Maybe Text)
- fileCacheCreating_fileCacheType :: Lens' FileCacheCreating (Maybe FileCacheType)
- fileCacheCreating_fileCacheTypeVersion :: Lens' FileCacheCreating (Maybe Text)
- fileCacheCreating_kmsKeyId :: Lens' FileCacheCreating (Maybe Text)
- fileCacheCreating_lifecycle :: Lens' FileCacheCreating (Maybe FileCacheLifecycle)
- fileCacheCreating_lustreConfiguration :: Lens' FileCacheCreating (Maybe FileCacheLustreConfiguration)
- fileCacheCreating_networkInterfaceIds :: Lens' FileCacheCreating (Maybe [Text])
- fileCacheCreating_ownerId :: Lens' FileCacheCreating (Maybe Text)
- fileCacheCreating_resourceARN :: Lens' FileCacheCreating (Maybe Text)
- fileCacheCreating_storageCapacity :: Lens' FileCacheCreating (Maybe Natural)
- fileCacheCreating_subnetIds :: Lens' FileCacheCreating (Maybe [Text])
- fileCacheCreating_tags :: Lens' FileCacheCreating (Maybe (NonEmpty Tag))
- fileCacheCreating_vpcId :: Lens' FileCacheCreating (Maybe Text)
- data FileCacheDataRepositoryAssociation = FileCacheDataRepositoryAssociation' {}
- newFileCacheDataRepositoryAssociation :: Text -> Text -> FileCacheDataRepositoryAssociation
- fileCacheDataRepositoryAssociation_dataRepositorySubdirectories :: Lens' FileCacheDataRepositoryAssociation (Maybe [Text])
- fileCacheDataRepositoryAssociation_nfs :: Lens' FileCacheDataRepositoryAssociation (Maybe FileCacheNFSConfiguration)
- fileCacheDataRepositoryAssociation_fileCachePath :: Lens' FileCacheDataRepositoryAssociation Text
- fileCacheDataRepositoryAssociation_dataRepositoryPath :: Lens' FileCacheDataRepositoryAssociation Text
- data FileCacheFailureDetails = FileCacheFailureDetails' {}
- newFileCacheFailureDetails :: FileCacheFailureDetails
- fileCacheFailureDetails_message :: Lens' FileCacheFailureDetails (Maybe Text)
- data FileCacheLustreConfiguration = FileCacheLustreConfiguration' {}
- newFileCacheLustreConfiguration :: FileCacheLustreConfiguration
- fileCacheLustreConfiguration_deploymentType :: Lens' FileCacheLustreConfiguration (Maybe FileCacheLustreDeploymentType)
- fileCacheLustreConfiguration_logConfiguration :: Lens' FileCacheLustreConfiguration (Maybe LustreLogConfiguration)
- fileCacheLustreConfiguration_metadataConfiguration :: Lens' FileCacheLustreConfiguration (Maybe FileCacheLustreMetadataConfiguration)
- fileCacheLustreConfiguration_mountName :: Lens' FileCacheLustreConfiguration (Maybe Text)
- fileCacheLustreConfiguration_perUnitStorageThroughput :: Lens' FileCacheLustreConfiguration (Maybe Natural)
- fileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' FileCacheLustreConfiguration (Maybe Text)
- data FileCacheLustreMetadataConfiguration = FileCacheLustreMetadataConfiguration' {}
- newFileCacheLustreMetadataConfiguration :: Natural -> FileCacheLustreMetadataConfiguration
- fileCacheLustreMetadataConfiguration_storageCapacity :: Lens' FileCacheLustreMetadataConfiguration Natural
- data FileCacheNFSConfiguration = FileCacheNFSConfiguration' {
- dnsIps :: Maybe [Text]
- version :: NfsVersion
- newFileCacheNFSConfiguration :: NfsVersion -> FileCacheNFSConfiguration
- fileCacheNFSConfiguration_dnsIps :: Lens' FileCacheNFSConfiguration (Maybe [Text])
- fileCacheNFSConfiguration_version :: Lens' FileCacheNFSConfiguration NfsVersion
- data FileSystem = FileSystem' {
- administrativeActions :: Maybe [AdministrativeAction]
- creationTime :: Maybe POSIX
- dNSName :: Maybe Text
- failureDetails :: Maybe FileSystemFailureDetails
- fileSystemId :: Maybe Text
- fileSystemType :: Maybe FileSystemType
- fileSystemTypeVersion :: Maybe Text
- kmsKeyId :: Maybe Text
- lifecycle :: Maybe FileSystemLifecycle
- lustreConfiguration :: Maybe LustreFileSystemConfiguration
- networkInterfaceIds :: Maybe [Text]
- ontapConfiguration :: Maybe OntapFileSystemConfiguration
- openZFSConfiguration :: Maybe OpenZFSFileSystemConfiguration
- ownerId :: Maybe Text
- resourceARN :: Maybe Text
- storageCapacity :: Maybe Natural
- storageType :: Maybe StorageType
- subnetIds :: Maybe [Text]
- tags :: Maybe (NonEmpty Tag)
- vpcId :: Maybe Text
- windowsConfiguration :: Maybe WindowsFileSystemConfiguration
- newFileSystem :: FileSystem
- fileSystem_administrativeActions :: Lens' FileSystem (Maybe [AdministrativeAction])
- fileSystem_creationTime :: Lens' FileSystem (Maybe UTCTime)
- fileSystem_dNSName :: Lens' FileSystem (Maybe Text)
- fileSystem_failureDetails :: Lens' FileSystem (Maybe FileSystemFailureDetails)
- fileSystem_fileSystemId :: Lens' FileSystem (Maybe Text)
- fileSystem_fileSystemType :: Lens' FileSystem (Maybe FileSystemType)
- fileSystem_fileSystemTypeVersion :: Lens' FileSystem (Maybe Text)
- fileSystem_kmsKeyId :: Lens' FileSystem (Maybe Text)
- fileSystem_lifecycle :: Lens' FileSystem (Maybe FileSystemLifecycle)
- fileSystem_lustreConfiguration :: Lens' FileSystem (Maybe LustreFileSystemConfiguration)
- fileSystem_networkInterfaceIds :: Lens' FileSystem (Maybe [Text])
- fileSystem_ontapConfiguration :: Lens' FileSystem (Maybe OntapFileSystemConfiguration)
- fileSystem_openZFSConfiguration :: Lens' FileSystem (Maybe OpenZFSFileSystemConfiguration)
- fileSystem_ownerId :: Lens' FileSystem (Maybe Text)
- fileSystem_resourceARN :: Lens' FileSystem (Maybe Text)
- fileSystem_storageCapacity :: Lens' FileSystem (Maybe Natural)
- fileSystem_storageType :: Lens' FileSystem (Maybe StorageType)
- fileSystem_subnetIds :: Lens' FileSystem (Maybe [Text])
- fileSystem_tags :: Lens' FileSystem (Maybe (NonEmpty Tag))
- fileSystem_vpcId :: Lens' FileSystem (Maybe Text)
- fileSystem_windowsConfiguration :: Lens' FileSystem (Maybe WindowsFileSystemConfiguration)
- data FileSystemEndpoint = FileSystemEndpoint' {}
- newFileSystemEndpoint :: FileSystemEndpoint
- fileSystemEndpoint_dNSName :: Lens' FileSystemEndpoint (Maybe Text)
- fileSystemEndpoint_ipAddresses :: Lens' FileSystemEndpoint (Maybe (NonEmpty Text))
- data FileSystemEndpoints = FileSystemEndpoints' {}
- newFileSystemEndpoints :: FileSystemEndpoints
- fileSystemEndpoints_intercluster :: Lens' FileSystemEndpoints (Maybe FileSystemEndpoint)
- fileSystemEndpoints_management :: Lens' FileSystemEndpoints (Maybe FileSystemEndpoint)
- data FileSystemFailureDetails = FileSystemFailureDetails' {}
- newFileSystemFailureDetails :: FileSystemFailureDetails
- fileSystemFailureDetails_message :: Lens' FileSystemFailureDetails (Maybe Text)
- data Filter = Filter' {}
- newFilter :: Filter
- filter_name :: Lens' Filter (Maybe FilterName)
- filter_values :: Lens' Filter (Maybe [Text])
- data LifecycleTransitionReason = LifecycleTransitionReason' {}
- newLifecycleTransitionReason :: LifecycleTransitionReason
- lifecycleTransitionReason_message :: Lens' LifecycleTransitionReason (Maybe Text)
- data LustreFileSystemConfiguration = LustreFileSystemConfiguration' {
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- dataCompressionType :: Maybe DataCompressionType
- dataRepositoryConfiguration :: Maybe DataRepositoryConfiguration
- deploymentType :: Maybe LustreDeploymentType
- driveCacheType :: Maybe DriveCacheType
- logConfiguration :: Maybe LustreLogConfiguration
- mountName :: Maybe Text
- perUnitStorageThroughput :: Maybe Natural
- rootSquashConfiguration :: Maybe LustreRootSquashConfiguration
- weeklyMaintenanceStartTime :: Maybe Text
- newLustreFileSystemConfiguration :: LustreFileSystemConfiguration
- lustreFileSystemConfiguration_automaticBackupRetentionDays :: Lens' LustreFileSystemConfiguration (Maybe Natural)
- lustreFileSystemConfiguration_copyTagsToBackups :: Lens' LustreFileSystemConfiguration (Maybe Bool)
- lustreFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' LustreFileSystemConfiguration (Maybe Text)
- lustreFileSystemConfiguration_dataCompressionType :: Lens' LustreFileSystemConfiguration (Maybe DataCompressionType)
- lustreFileSystemConfiguration_dataRepositoryConfiguration :: Lens' LustreFileSystemConfiguration (Maybe DataRepositoryConfiguration)
- lustreFileSystemConfiguration_deploymentType :: Lens' LustreFileSystemConfiguration (Maybe LustreDeploymentType)
- lustreFileSystemConfiguration_driveCacheType :: Lens' LustreFileSystemConfiguration (Maybe DriveCacheType)
- lustreFileSystemConfiguration_logConfiguration :: Lens' LustreFileSystemConfiguration (Maybe LustreLogConfiguration)
- lustreFileSystemConfiguration_mountName :: Lens' LustreFileSystemConfiguration (Maybe Text)
- lustreFileSystemConfiguration_perUnitStorageThroughput :: Lens' LustreFileSystemConfiguration (Maybe Natural)
- lustreFileSystemConfiguration_rootSquashConfiguration :: Lens' LustreFileSystemConfiguration (Maybe LustreRootSquashConfiguration)
- lustreFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' LustreFileSystemConfiguration (Maybe Text)
- data LustreLogConfiguration = LustreLogConfiguration' {}
- newLustreLogConfiguration :: LustreAccessAuditLogLevel -> LustreLogConfiguration
- lustreLogConfiguration_destination :: Lens' LustreLogConfiguration (Maybe Text)
- lustreLogConfiguration_level :: Lens' LustreLogConfiguration LustreAccessAuditLogLevel
- data LustreLogCreateConfiguration = LustreLogCreateConfiguration' {}
- newLustreLogCreateConfiguration :: LustreAccessAuditLogLevel -> LustreLogCreateConfiguration
- lustreLogCreateConfiguration_destination :: Lens' LustreLogCreateConfiguration (Maybe Text)
- lustreLogCreateConfiguration_level :: Lens' LustreLogCreateConfiguration LustreAccessAuditLogLevel
- data LustreRootSquashConfiguration = LustreRootSquashConfiguration' {
- noSquashNids :: Maybe [Text]
- rootSquash :: Maybe Text
- newLustreRootSquashConfiguration :: LustreRootSquashConfiguration
- lustreRootSquashConfiguration_noSquashNids :: Lens' LustreRootSquashConfiguration (Maybe [Text])
- lustreRootSquashConfiguration_rootSquash :: Lens' LustreRootSquashConfiguration (Maybe Text)
- data NFSDataRepositoryConfiguration = NFSDataRepositoryConfiguration' {}
- newNFSDataRepositoryConfiguration :: NfsVersion -> NFSDataRepositoryConfiguration
- nFSDataRepositoryConfiguration_autoExportPolicy :: Lens' NFSDataRepositoryConfiguration (Maybe AutoExportPolicy)
- nFSDataRepositoryConfiguration_dnsIps :: Lens' NFSDataRepositoryConfiguration (Maybe [Text])
- nFSDataRepositoryConfiguration_version :: Lens' NFSDataRepositoryConfiguration NfsVersion
- data OntapFileSystemConfiguration = OntapFileSystemConfiguration' {
- automaticBackupRetentionDays :: Maybe Natural
- dailyAutomaticBackupStartTime :: Maybe Text
- deploymentType :: Maybe OntapDeploymentType
- diskIopsConfiguration :: Maybe DiskIopsConfiguration
- endpointIpAddressRange :: Maybe Text
- endpoints :: Maybe FileSystemEndpoints
- preferredSubnetId :: Maybe Text
- routeTableIds :: Maybe [Text]
- throughputCapacity :: Maybe Natural
- weeklyMaintenanceStartTime :: Maybe Text
- newOntapFileSystemConfiguration :: OntapFileSystemConfiguration
- ontapFileSystemConfiguration_automaticBackupRetentionDays :: Lens' OntapFileSystemConfiguration (Maybe Natural)
- ontapFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' OntapFileSystemConfiguration (Maybe Text)
- ontapFileSystemConfiguration_deploymentType :: Lens' OntapFileSystemConfiguration (Maybe OntapDeploymentType)
- ontapFileSystemConfiguration_diskIopsConfiguration :: Lens' OntapFileSystemConfiguration (Maybe DiskIopsConfiguration)
- ontapFileSystemConfiguration_endpointIpAddressRange :: Lens' OntapFileSystemConfiguration (Maybe Text)
- ontapFileSystemConfiguration_endpoints :: Lens' OntapFileSystemConfiguration (Maybe FileSystemEndpoints)
- ontapFileSystemConfiguration_preferredSubnetId :: Lens' OntapFileSystemConfiguration (Maybe Text)
- ontapFileSystemConfiguration_routeTableIds :: Lens' OntapFileSystemConfiguration (Maybe [Text])
- ontapFileSystemConfiguration_throughputCapacity :: Lens' OntapFileSystemConfiguration (Maybe Natural)
- ontapFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' OntapFileSystemConfiguration (Maybe Text)
- data OntapVolumeConfiguration = OntapVolumeConfiguration' {
- copyTagsToBackups :: Maybe Bool
- flexCacheEndpointType :: Maybe FlexCacheEndpointType
- junctionPath :: Maybe Text
- ontapVolumeType :: Maybe OntapVolumeType
- securityStyle :: Maybe SecurityStyle
- sizeInMegabytes :: Maybe Natural
- snapshotPolicy :: Maybe Text
- storageEfficiencyEnabled :: Maybe Bool
- storageVirtualMachineId :: Maybe Text
- storageVirtualMachineRoot :: Maybe Bool
- tieringPolicy :: Maybe TieringPolicy
- uuid :: Maybe Text
- newOntapVolumeConfiguration :: OntapVolumeConfiguration
- ontapVolumeConfiguration_copyTagsToBackups :: Lens' OntapVolumeConfiguration (Maybe Bool)
- ontapVolumeConfiguration_flexCacheEndpointType :: Lens' OntapVolumeConfiguration (Maybe FlexCacheEndpointType)
- ontapVolumeConfiguration_junctionPath :: Lens' OntapVolumeConfiguration (Maybe Text)
- ontapVolumeConfiguration_ontapVolumeType :: Lens' OntapVolumeConfiguration (Maybe OntapVolumeType)
- ontapVolumeConfiguration_securityStyle :: Lens' OntapVolumeConfiguration (Maybe SecurityStyle)
- ontapVolumeConfiguration_sizeInMegabytes :: Lens' OntapVolumeConfiguration (Maybe Natural)
- ontapVolumeConfiguration_snapshotPolicy :: Lens' OntapVolumeConfiguration (Maybe Text)
- ontapVolumeConfiguration_storageEfficiencyEnabled :: Lens' OntapVolumeConfiguration (Maybe Bool)
- ontapVolumeConfiguration_storageVirtualMachineId :: Lens' OntapVolumeConfiguration (Maybe Text)
- ontapVolumeConfiguration_storageVirtualMachineRoot :: Lens' OntapVolumeConfiguration (Maybe Bool)
- ontapVolumeConfiguration_tieringPolicy :: Lens' OntapVolumeConfiguration (Maybe TieringPolicy)
- ontapVolumeConfiguration_uuid :: Lens' OntapVolumeConfiguration (Maybe Text)
- data OpenZFSClientConfiguration = OpenZFSClientConfiguration' {}
- newOpenZFSClientConfiguration :: Text -> NonEmpty Text -> OpenZFSClientConfiguration
- openZFSClientConfiguration_clients :: Lens' OpenZFSClientConfiguration Text
- openZFSClientConfiguration_options :: Lens' OpenZFSClientConfiguration (NonEmpty Text)
- data OpenZFSCreateRootVolumeConfiguration = OpenZFSCreateRootVolumeConfiguration' {}
- newOpenZFSCreateRootVolumeConfiguration :: OpenZFSCreateRootVolumeConfiguration
- openZFSCreateRootVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool)
- openZFSCreateRootVolumeConfiguration_dataCompressionType :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe OpenZFSDataCompressionType)
- openZFSCreateRootVolumeConfiguration_nfsExports :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSNfsExport])
- openZFSCreateRootVolumeConfiguration_readOnly :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool)
- openZFSCreateRootVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Natural)
- openZFSCreateRootVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota])
- data OpenZFSFileSystemConfiguration = OpenZFSFileSystemConfiguration' {
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- copyTagsToVolumes :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- deploymentType :: Maybe OpenZFSDeploymentType
- diskIopsConfiguration :: Maybe DiskIopsConfiguration
- rootVolumeId :: Maybe Text
- throughputCapacity :: Maybe Natural
- weeklyMaintenanceStartTime :: Maybe Text
- newOpenZFSFileSystemConfiguration :: OpenZFSFileSystemConfiguration
- openZFSFileSystemConfiguration_automaticBackupRetentionDays :: Lens' OpenZFSFileSystemConfiguration (Maybe Natural)
- openZFSFileSystemConfiguration_copyTagsToBackups :: Lens' OpenZFSFileSystemConfiguration (Maybe Bool)
- openZFSFileSystemConfiguration_copyTagsToVolumes :: Lens' OpenZFSFileSystemConfiguration (Maybe Bool)
- openZFSFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' OpenZFSFileSystemConfiguration (Maybe Text)
- openZFSFileSystemConfiguration_deploymentType :: Lens' OpenZFSFileSystemConfiguration (Maybe OpenZFSDeploymentType)
- openZFSFileSystemConfiguration_diskIopsConfiguration :: Lens' OpenZFSFileSystemConfiguration (Maybe DiskIopsConfiguration)
- openZFSFileSystemConfiguration_rootVolumeId :: Lens' OpenZFSFileSystemConfiguration (Maybe Text)
- openZFSFileSystemConfiguration_throughputCapacity :: Lens' OpenZFSFileSystemConfiguration (Maybe Natural)
- openZFSFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' OpenZFSFileSystemConfiguration (Maybe Text)
- data OpenZFSNfsExport = OpenZFSNfsExport' {}
- newOpenZFSNfsExport :: OpenZFSNfsExport
- openZFSNfsExport_clientConfigurations :: Lens' OpenZFSNfsExport [OpenZFSClientConfiguration]
- data OpenZFSOriginSnapshotConfiguration = OpenZFSOriginSnapshotConfiguration' {}
- newOpenZFSOriginSnapshotConfiguration :: OpenZFSOriginSnapshotConfiguration
- openZFSOriginSnapshotConfiguration_copyStrategy :: Lens' OpenZFSOriginSnapshotConfiguration (Maybe OpenZFSCopyStrategy)
- openZFSOriginSnapshotConfiguration_snapshotARN :: Lens' OpenZFSOriginSnapshotConfiguration (Maybe Text)
- data OpenZFSUserOrGroupQuota = OpenZFSUserOrGroupQuota' {}
- newOpenZFSUserOrGroupQuota :: OpenZFSQuotaType -> Natural -> Natural -> OpenZFSUserOrGroupQuota
- openZFSUserOrGroupQuota_type :: Lens' OpenZFSUserOrGroupQuota OpenZFSQuotaType
- openZFSUserOrGroupQuota_id :: Lens' OpenZFSUserOrGroupQuota Natural
- openZFSUserOrGroupQuota_storageCapacityQuotaGiB :: Lens' OpenZFSUserOrGroupQuota Natural
- data OpenZFSVolumeConfiguration = OpenZFSVolumeConfiguration' {
- copyTagsToSnapshots :: Maybe Bool
- dataCompressionType :: Maybe OpenZFSDataCompressionType
- deleteClonedVolumes :: Maybe Bool
- deleteIntermediateSnaphots :: Maybe Bool
- nfsExports :: Maybe [OpenZFSNfsExport]
- originSnapshot :: Maybe OpenZFSOriginSnapshotConfiguration
- parentVolumeId :: Maybe Text
- readOnly :: Maybe Bool
- recordSizeKiB :: Maybe Natural
- restoreToSnapshot :: Maybe Text
- storageCapacityQuotaGiB :: Maybe Natural
- storageCapacityReservationGiB :: Maybe Natural
- userAndGroupQuotas :: Maybe [OpenZFSUserOrGroupQuota]
- volumePath :: Maybe Text
- newOpenZFSVolumeConfiguration :: OpenZFSVolumeConfiguration
- openZFSVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSVolumeConfiguration (Maybe Bool)
- openZFSVolumeConfiguration_dataCompressionType :: Lens' OpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType)
- openZFSVolumeConfiguration_deleteClonedVolumes :: Lens' OpenZFSVolumeConfiguration (Maybe Bool)
- openZFSVolumeConfiguration_deleteIntermediateSnaphots :: Lens' OpenZFSVolumeConfiguration (Maybe Bool)
- openZFSVolumeConfiguration_nfsExports :: Lens' OpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport])
- openZFSVolumeConfiguration_originSnapshot :: Lens' OpenZFSVolumeConfiguration (Maybe OpenZFSOriginSnapshotConfiguration)
- openZFSVolumeConfiguration_parentVolumeId :: Lens' OpenZFSVolumeConfiguration (Maybe Text)
- openZFSVolumeConfiguration_readOnly :: Lens' OpenZFSVolumeConfiguration (Maybe Bool)
- openZFSVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural)
- openZFSVolumeConfiguration_restoreToSnapshot :: Lens' OpenZFSVolumeConfiguration (Maybe Text)
- openZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural)
- openZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural)
- openZFSVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota])
- openZFSVolumeConfiguration_volumePath :: Lens' OpenZFSVolumeConfiguration (Maybe Text)
- data S3DataRepositoryConfiguration = S3DataRepositoryConfiguration' {}
- newS3DataRepositoryConfiguration :: S3DataRepositoryConfiguration
- s3DataRepositoryConfiguration_autoExportPolicy :: Lens' S3DataRepositoryConfiguration (Maybe AutoExportPolicy)
- s3DataRepositoryConfiguration_autoImportPolicy :: Lens' S3DataRepositoryConfiguration (Maybe AutoImportPolicy)
- data SelfManagedActiveDirectoryAttributes = SelfManagedActiveDirectoryAttributes' {}
- newSelfManagedActiveDirectoryAttributes :: SelfManagedActiveDirectoryAttributes
- selfManagedActiveDirectoryAttributes_dnsIps :: Lens' SelfManagedActiveDirectoryAttributes (Maybe (NonEmpty Text))
- selfManagedActiveDirectoryAttributes_domainName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text)
- selfManagedActiveDirectoryAttributes_fileSystemAdministratorsGroup :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text)
- selfManagedActiveDirectoryAttributes_organizationalUnitDistinguishedName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text)
- selfManagedActiveDirectoryAttributes_userName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text)
- data SelfManagedActiveDirectoryConfiguration = SelfManagedActiveDirectoryConfiguration' {}
- newSelfManagedActiveDirectoryConfiguration :: Text -> Text -> Text -> NonEmpty Text -> SelfManagedActiveDirectoryConfiguration
- selfManagedActiveDirectoryConfiguration_fileSystemAdministratorsGroup :: Lens' SelfManagedActiveDirectoryConfiguration (Maybe Text)
- selfManagedActiveDirectoryConfiguration_organizationalUnitDistinguishedName :: Lens' SelfManagedActiveDirectoryConfiguration (Maybe Text)
- selfManagedActiveDirectoryConfiguration_domainName :: Lens' SelfManagedActiveDirectoryConfiguration Text
- selfManagedActiveDirectoryConfiguration_userName :: Lens' SelfManagedActiveDirectoryConfiguration Text
- selfManagedActiveDirectoryConfiguration_password :: Lens' SelfManagedActiveDirectoryConfiguration Text
- selfManagedActiveDirectoryConfiguration_dnsIps :: Lens' SelfManagedActiveDirectoryConfiguration (NonEmpty Text)
- data SelfManagedActiveDirectoryConfigurationUpdates = SelfManagedActiveDirectoryConfigurationUpdates' {}
- newSelfManagedActiveDirectoryConfigurationUpdates :: SelfManagedActiveDirectoryConfigurationUpdates
- selfManagedActiveDirectoryConfigurationUpdates_dnsIps :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe (NonEmpty Text))
- selfManagedActiveDirectoryConfigurationUpdates_password :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe Text)
- selfManagedActiveDirectoryConfigurationUpdates_userName :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe Text)
- data Snapshot = Snapshot' {}
- newSnapshot :: Snapshot
- snapshot_administrativeActions :: Lens' Snapshot (Maybe [AdministrativeAction])
- snapshot_creationTime :: Lens' Snapshot (Maybe UTCTime)
- snapshot_lifecycle :: Lens' Snapshot (Maybe SnapshotLifecycle)
- snapshot_lifecycleTransitionReason :: Lens' Snapshot (Maybe LifecycleTransitionReason)
- snapshot_name :: Lens' Snapshot (Maybe Text)
- snapshot_resourceARN :: Lens' Snapshot (Maybe Text)
- snapshot_snapshotId :: Lens' Snapshot (Maybe Text)
- snapshot_tags :: Lens' Snapshot (Maybe (NonEmpty Tag))
- snapshot_volumeId :: Lens' Snapshot (Maybe Text)
- data SnapshotFilter = SnapshotFilter' {}
- newSnapshotFilter :: SnapshotFilter
- snapshotFilter_name :: Lens' SnapshotFilter (Maybe SnapshotFilterName)
- snapshotFilter_values :: Lens' SnapshotFilter (Maybe [Text])
- data StorageVirtualMachine = StorageVirtualMachine' {
- activeDirectoryConfiguration :: Maybe SvmActiveDirectoryConfiguration
- creationTime :: Maybe POSIX
- endpoints :: Maybe SvmEndpoints
- fileSystemId :: Maybe Text
- lifecycle :: Maybe StorageVirtualMachineLifecycle
- lifecycleTransitionReason :: Maybe LifecycleTransitionReason
- name :: Maybe Text
- resourceARN :: Maybe Text
- rootVolumeSecurityStyle :: Maybe StorageVirtualMachineRootVolumeSecurityStyle
- storageVirtualMachineId :: Maybe Text
- subtype :: Maybe StorageVirtualMachineSubtype
- tags :: Maybe (NonEmpty Tag)
- uuid :: Maybe Text
- newStorageVirtualMachine :: StorageVirtualMachine
- storageVirtualMachine_activeDirectoryConfiguration :: Lens' StorageVirtualMachine (Maybe SvmActiveDirectoryConfiguration)
- storageVirtualMachine_creationTime :: Lens' StorageVirtualMachine (Maybe UTCTime)
- storageVirtualMachine_endpoints :: Lens' StorageVirtualMachine (Maybe SvmEndpoints)
- storageVirtualMachine_fileSystemId :: Lens' StorageVirtualMachine (Maybe Text)
- storageVirtualMachine_lifecycle :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineLifecycle)
- storageVirtualMachine_lifecycleTransitionReason :: Lens' StorageVirtualMachine (Maybe LifecycleTransitionReason)
- storageVirtualMachine_name :: Lens' StorageVirtualMachine (Maybe Text)
- storageVirtualMachine_resourceARN :: Lens' StorageVirtualMachine (Maybe Text)
- storageVirtualMachine_rootVolumeSecurityStyle :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineRootVolumeSecurityStyle)
- storageVirtualMachine_storageVirtualMachineId :: Lens' StorageVirtualMachine (Maybe Text)
- storageVirtualMachine_subtype :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineSubtype)
- storageVirtualMachine_tags :: Lens' StorageVirtualMachine (Maybe (NonEmpty Tag))
- storageVirtualMachine_uuid :: Lens' StorageVirtualMachine (Maybe Text)
- data StorageVirtualMachineFilter = StorageVirtualMachineFilter' {}
- newStorageVirtualMachineFilter :: StorageVirtualMachineFilter
- storageVirtualMachineFilter_name :: Lens' StorageVirtualMachineFilter (Maybe StorageVirtualMachineFilterName)
- storageVirtualMachineFilter_values :: Lens' StorageVirtualMachineFilter (Maybe [Text])
- data SvmActiveDirectoryConfiguration = SvmActiveDirectoryConfiguration' {}
- newSvmActiveDirectoryConfiguration :: SvmActiveDirectoryConfiguration
- svmActiveDirectoryConfiguration_netBiosName :: Lens' SvmActiveDirectoryConfiguration (Maybe Text)
- svmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' SvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryAttributes)
- data SvmEndpoint = SvmEndpoint' {}
- newSvmEndpoint :: SvmEndpoint
- svmEndpoint_dNSName :: Lens' SvmEndpoint (Maybe Text)
- svmEndpoint_ipAddresses :: Lens' SvmEndpoint (Maybe (NonEmpty Text))
- data SvmEndpoints = SvmEndpoints' {}
- newSvmEndpoints :: SvmEndpoints
- svmEndpoints_iscsi :: Lens' SvmEndpoints (Maybe SvmEndpoint)
- svmEndpoints_management :: Lens' SvmEndpoints (Maybe SvmEndpoint)
- svmEndpoints_nfs :: Lens' SvmEndpoints (Maybe SvmEndpoint)
- svmEndpoints_smb :: Lens' SvmEndpoints (Maybe SvmEndpoint)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TieringPolicy = TieringPolicy' {}
- newTieringPolicy :: TieringPolicy
- tieringPolicy_coolingPeriod :: Lens' TieringPolicy (Maybe Natural)
- tieringPolicy_name :: Lens' TieringPolicy (Maybe TieringPolicyName)
- data UpdateFileCacheLustreConfiguration = UpdateFileCacheLustreConfiguration' {}
- newUpdateFileCacheLustreConfiguration :: UpdateFileCacheLustreConfiguration
- updateFileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileCacheLustreConfiguration (Maybe Text)
- data UpdateFileSystemLustreConfiguration = UpdateFileSystemLustreConfiguration' {
- autoImportPolicy :: Maybe AutoImportPolicyType
- automaticBackupRetentionDays :: Maybe Natural
- dailyAutomaticBackupStartTime :: Maybe Text
- dataCompressionType :: Maybe DataCompressionType
- logConfiguration :: Maybe LustreLogCreateConfiguration
- rootSquashConfiguration :: Maybe LustreRootSquashConfiguration
- weeklyMaintenanceStartTime :: Maybe Text
- newUpdateFileSystemLustreConfiguration :: UpdateFileSystemLustreConfiguration
- updateFileSystemLustreConfiguration_autoImportPolicy :: Lens' UpdateFileSystemLustreConfiguration (Maybe AutoImportPolicyType)
- updateFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemLustreConfiguration (Maybe Natural)
- updateFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemLustreConfiguration (Maybe Text)
- updateFileSystemLustreConfiguration_dataCompressionType :: Lens' UpdateFileSystemLustreConfiguration (Maybe DataCompressionType)
- updateFileSystemLustreConfiguration_logConfiguration :: Lens' UpdateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration)
- updateFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' UpdateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration)
- updateFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemLustreConfiguration (Maybe Text)
- data UpdateFileSystemOntapConfiguration = UpdateFileSystemOntapConfiguration' {
- addRouteTableIds :: Maybe [Text]
- automaticBackupRetentionDays :: Maybe Natural
- dailyAutomaticBackupStartTime :: Maybe Text
- diskIopsConfiguration :: Maybe DiskIopsConfiguration
- fsxAdminPassword :: Maybe (Sensitive Text)
- removeRouteTableIds :: Maybe [Text]
- throughputCapacity :: Maybe Natural
- weeklyMaintenanceStartTime :: Maybe Text
- newUpdateFileSystemOntapConfiguration :: UpdateFileSystemOntapConfiguration
- updateFileSystemOntapConfiguration_addRouteTableIds :: Lens' UpdateFileSystemOntapConfiguration (Maybe [Text])
- updateFileSystemOntapConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemOntapConfiguration (Maybe Natural)
- updateFileSystemOntapConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text)
- updateFileSystemOntapConfiguration_diskIopsConfiguration :: Lens' UpdateFileSystemOntapConfiguration (Maybe DiskIopsConfiguration)
- updateFileSystemOntapConfiguration_fsxAdminPassword :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text)
- updateFileSystemOntapConfiguration_removeRouteTableIds :: Lens' UpdateFileSystemOntapConfiguration (Maybe [Text])
- updateFileSystemOntapConfiguration_throughputCapacity :: Lens' UpdateFileSystemOntapConfiguration (Maybe Natural)
- updateFileSystemOntapConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text)
- data UpdateFileSystemOpenZFSConfiguration = UpdateFileSystemOpenZFSConfiguration' {}
- newUpdateFileSystemOpenZFSConfiguration :: UpdateFileSystemOpenZFSConfiguration
- updateFileSystemOpenZFSConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Natural)
- updateFileSystemOpenZFSConfiguration_copyTagsToBackups :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Bool)
- updateFileSystemOpenZFSConfiguration_copyTagsToVolumes :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Bool)
- updateFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Text)
- updateFileSystemOpenZFSConfiguration_diskIopsConfiguration :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe DiskIopsConfiguration)
- updateFileSystemOpenZFSConfiguration_throughputCapacity :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Natural)
- updateFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Text)
- data UpdateFileSystemWindowsConfiguration = UpdateFileSystemWindowsConfiguration' {
- auditLogConfiguration :: Maybe WindowsAuditLogCreateConfiguration
- automaticBackupRetentionDays :: Maybe Natural
- dailyAutomaticBackupStartTime :: Maybe Text
- selfManagedActiveDirectoryConfiguration :: Maybe SelfManagedActiveDirectoryConfigurationUpdates
- throughputCapacity :: Maybe Natural
- weeklyMaintenanceStartTime :: Maybe Text
- newUpdateFileSystemWindowsConfiguration :: UpdateFileSystemWindowsConfiguration
- updateFileSystemWindowsConfiguration_auditLogConfiguration :: Lens' UpdateFileSystemWindowsConfiguration (Maybe WindowsAuditLogCreateConfiguration)
- updateFileSystemWindowsConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Natural)
- updateFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Text)
- updateFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' UpdateFileSystemWindowsConfiguration (Maybe SelfManagedActiveDirectoryConfigurationUpdates)
- updateFileSystemWindowsConfiguration_throughputCapacity :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Natural)
- updateFileSystemWindowsConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Text)
- data UpdateOntapVolumeConfiguration = UpdateOntapVolumeConfiguration' {}
- newUpdateOntapVolumeConfiguration :: UpdateOntapVolumeConfiguration
- updateOntapVolumeConfiguration_copyTagsToBackups :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool)
- updateOntapVolumeConfiguration_junctionPath :: Lens' UpdateOntapVolumeConfiguration (Maybe Text)
- updateOntapVolumeConfiguration_securityStyle :: Lens' UpdateOntapVolumeConfiguration (Maybe SecurityStyle)
- updateOntapVolumeConfiguration_sizeInMegabytes :: Lens' UpdateOntapVolumeConfiguration (Maybe Natural)
- updateOntapVolumeConfiguration_snapshotPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe Text)
- updateOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool)
- updateOntapVolumeConfiguration_tieringPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe TieringPolicy)
- data UpdateOpenZFSVolumeConfiguration = UpdateOpenZFSVolumeConfiguration' {}
- newUpdateOpenZFSVolumeConfiguration :: UpdateOpenZFSVolumeConfiguration
- updateOpenZFSVolumeConfiguration_dataCompressionType :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType)
- updateOpenZFSVolumeConfiguration_nfsExports :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport])
- updateOpenZFSVolumeConfiguration_readOnly :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Bool)
- updateOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Natural)
- updateOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int)
- updateOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int)
- updateOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota])
- data UpdateSvmActiveDirectoryConfiguration = UpdateSvmActiveDirectoryConfiguration' {}
- newUpdateSvmActiveDirectoryConfiguration :: UpdateSvmActiveDirectoryConfiguration
- updateSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' UpdateSvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryConfigurationUpdates)
- data Volume = Volume' {
- administrativeActions :: Maybe [AdministrativeAction]
- creationTime :: Maybe POSIX
- fileSystemId :: Maybe Text
- lifecycle :: Maybe VolumeLifecycle
- lifecycleTransitionReason :: Maybe LifecycleTransitionReason
- name :: Maybe Text
- ontapConfiguration :: Maybe OntapVolumeConfiguration
- openZFSConfiguration :: Maybe OpenZFSVolumeConfiguration
- resourceARN :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- volumeId :: Maybe Text
- volumeType :: Maybe VolumeType
- newVolume :: Volume
- volume_administrativeActions :: Lens' Volume (Maybe [AdministrativeAction])
- volume_creationTime :: Lens' Volume (Maybe UTCTime)
- volume_fileSystemId :: Lens' Volume (Maybe Text)
- volume_lifecycle :: Lens' Volume (Maybe VolumeLifecycle)
- volume_lifecycleTransitionReason :: Lens' Volume (Maybe LifecycleTransitionReason)
- volume_name :: Lens' Volume (Maybe Text)
- volume_ontapConfiguration :: Lens' Volume (Maybe OntapVolumeConfiguration)
- volume_openZFSConfiguration :: Lens' Volume (Maybe OpenZFSVolumeConfiguration)
- volume_resourceARN :: Lens' Volume (Maybe Text)
- volume_tags :: Lens' Volume (Maybe (NonEmpty Tag))
- volume_volumeId :: Lens' Volume (Maybe Text)
- volume_volumeType :: Lens' Volume (Maybe VolumeType)
- data VolumeFilter = VolumeFilter' {}
- newVolumeFilter :: VolumeFilter
- volumeFilter_name :: Lens' VolumeFilter (Maybe VolumeFilterName)
- volumeFilter_values :: Lens' VolumeFilter (Maybe [Text])
- data WindowsAuditLogConfiguration = WindowsAuditLogConfiguration' {}
- newWindowsAuditLogConfiguration :: WindowsAccessAuditLogLevel -> WindowsAccessAuditLogLevel -> WindowsAuditLogConfiguration
- windowsAuditLogConfiguration_auditLogDestination :: Lens' WindowsAuditLogConfiguration (Maybe Text)
- windowsAuditLogConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogConfiguration WindowsAccessAuditLogLevel
- windowsAuditLogConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogConfiguration WindowsAccessAuditLogLevel
- data WindowsAuditLogCreateConfiguration = WindowsAuditLogCreateConfiguration' {}
- newWindowsAuditLogCreateConfiguration :: WindowsAccessAuditLogLevel -> WindowsAccessAuditLogLevel -> WindowsAuditLogCreateConfiguration
- windowsAuditLogCreateConfiguration_auditLogDestination :: Lens' WindowsAuditLogCreateConfiguration (Maybe Text)
- windowsAuditLogCreateConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel
- windowsAuditLogCreateConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel
- data WindowsFileSystemConfiguration = WindowsFileSystemConfiguration' {
- activeDirectoryId :: Maybe Text
- aliases :: Maybe [Alias]
- auditLogConfiguration :: Maybe WindowsAuditLogConfiguration
- automaticBackupRetentionDays :: Maybe Natural
- copyTagsToBackups :: Maybe Bool
- dailyAutomaticBackupStartTime :: Maybe Text
- deploymentType :: Maybe WindowsDeploymentType
- maintenanceOperationsInProgress :: Maybe [FileSystemMaintenanceOperation]
- preferredFileServerIp :: Maybe Text
- preferredSubnetId :: Maybe Text
- remoteAdministrationEndpoint :: Maybe Text
- selfManagedActiveDirectoryConfiguration :: Maybe SelfManagedActiveDirectoryAttributes
- throughputCapacity :: Maybe Natural
- weeklyMaintenanceStartTime :: Maybe Text
- newWindowsFileSystemConfiguration :: WindowsFileSystemConfiguration
- windowsFileSystemConfiguration_activeDirectoryId :: Lens' WindowsFileSystemConfiguration (Maybe Text)
- windowsFileSystemConfiguration_aliases :: Lens' WindowsFileSystemConfiguration (Maybe [Alias])
- windowsFileSystemConfiguration_auditLogConfiguration :: Lens' WindowsFileSystemConfiguration (Maybe WindowsAuditLogConfiguration)
- windowsFileSystemConfiguration_automaticBackupRetentionDays :: Lens' WindowsFileSystemConfiguration (Maybe Natural)
- windowsFileSystemConfiguration_copyTagsToBackups :: Lens' WindowsFileSystemConfiguration (Maybe Bool)
- windowsFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' WindowsFileSystemConfiguration (Maybe Text)
- windowsFileSystemConfiguration_deploymentType :: Lens' WindowsFileSystemConfiguration (Maybe WindowsDeploymentType)
- windowsFileSystemConfiguration_maintenanceOperationsInProgress :: Lens' WindowsFileSystemConfiguration (Maybe [FileSystemMaintenanceOperation])
- windowsFileSystemConfiguration_preferredFileServerIp :: Lens' WindowsFileSystemConfiguration (Maybe Text)
- windowsFileSystemConfiguration_preferredSubnetId :: Lens' WindowsFileSystemConfiguration (Maybe Text)
- windowsFileSystemConfiguration_remoteAdministrationEndpoint :: Lens' WindowsFileSystemConfiguration (Maybe Text)
- windowsFileSystemConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' WindowsFileSystemConfiguration (Maybe SelfManagedActiveDirectoryAttributes)
- windowsFileSystemConfiguration_throughputCapacity :: Lens' WindowsFileSystemConfiguration (Maybe Natural)
- windowsFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' WindowsFileSystemConfiguration (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-03-01
of the Amazon FSx SDK configuration.
Errors
_ActiveDirectoryError :: AsError a => Fold a ServiceError Source #
An Active Directory error.
_BackupBeingCopied :: AsError a => Fold a ServiceError Source #
You can't delete a backup while it's being copied.
_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 :: AsError a => Fold a ServiceError Source #
No Amazon FSx backups were found based upon the supplied parameters.
_BackupRestoring :: AsError a => Fold a ServiceError Source #
You can't delete a backup while it's being used to restore a file system.
_BadRequest :: AsError a => Fold a ServiceError Source #
A generic error indicating a failure with a client request.
_DataRepositoryAssociationNotFound :: AsError a => Fold a ServiceError Source #
No data repository associations were found based upon the supplied parameters.
_DataRepositoryTaskEnded :: AsError a => Fold a ServiceError Source #
The data repository task could not be canceled because the task has already ended.
_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 :: AsError a => Fold a ServiceError Source #
The data repository task or tasks you specified could not be found.
_FileCacheNotFound :: AsError a => Fold a ServiceError Source #
No caches were found based upon supplied parameters.
_FileSystemNotFound :: AsError a => Fold a ServiceError Source #
No Amazon FSx file systems were found based upon supplied parameters.
_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 :: 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 :: AsError a => Fold a ServiceError Source #
A generic error indicating a server-side failure.
_InvalidDataRepositoryType :: AsError a => Fold a ServiceError Source #
You have filtered the response to a data repository type that is not supported.
_InvalidDestinationKmsKey :: AsError a => Fold a ServiceError Source #
The Key Management Service (KMS) key of the destination backup is not valid.
_InvalidExportPath :: AsError a => Fold a ServiceError Source #
The path provided for data repository export isn't valid.
_InvalidImportPath :: AsError a => Fold a ServiceError Source #
The path provided for data repository import isn't valid.
_InvalidNetworkSettings :: AsError a => Fold a ServiceError Source #
One or more network settings specified in the request are invalid.
_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 :: AsError a => Fold a ServiceError Source #
The Region provided for SourceRegion
is not valid or is in a different
Amazon Web Services partition.
_InvalidSourceKmsKey :: AsError a => Fold a ServiceError Source #
The Key Management Service (KMS) key of the source backup is not valid.
_MissingFileCacheConfiguration :: AsError a => Fold a ServiceError Source #
A cache configuration is required for this operation.
_MissingFileSystemConfiguration :: AsError a => Fold a ServiceError Source #
A file system configuration is required for this operation.
_MissingVolumeConfiguration :: AsError a => Fold a ServiceError Source #
A volume configuration is required for this operation.
_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 :: AsError a => Fold a ServiceError Source #
The resource specified does not support tagging.
_ResourceNotFound :: AsError a => Fold a ServiceError Source #
The resource specified by the Amazon Resource Name (ARN) can't be found.
_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 :: AsError a => Fold a ServiceError Source #
No Amazon FSx snapshots were found based on the supplied parameters.
_SourceBackupUnavailable :: AsError a => Fold a ServiceError Source #
The request was rejected because the lifecycle status of the source
backup isn't AVAILABLE
.
_StorageVirtualMachineNotFound :: AsError a => Fold a ServiceError Source #
No FSx for ONTAP SVMs were found based upon the supplied parameters.
_UnsupportedOperation :: AsError a => Fold a ServiceError Source #
The requested operation is not supported for this resource or API.
_VolumeNotFound :: AsError a => Fold a ServiceError Source #
No Amazon FSx volumes were found based upon the supplied parameters.
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_UPDATE
task to increase a file system's storage capacity has been completed successfully, aSTORAGE_OPTIMIZATION
task 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
ProgressPercent
property. WhenSTORAGE_OPTIMIZATION
has been completed successfully, the parentFILE_SYSTEM_UPDATE
action 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.
Instances
AliasLifecycle
newtype AliasLifecycle Source #
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 #
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.
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.
pattern BackupType_AUTOMATIC :: BackupType | |
pattern BackupType_AWS_BACKUP :: BackupType | |
pattern BackupType_USER_INITIATED :: BackupType |
Instances
DataCompressionType
newtype DataCompressionType Source #
pattern DataCompressionType_LZ4 :: DataCompressionType | |
pattern DataCompressionType_NONE :: DataCompressionType |
Instances
DataRepositoryLifecycle
newtype DataRepositoryLifecycle Source #
Instances
DataRepositoryTaskFilterName
newtype DataRepositoryTaskFilterName Source #
Instances
DataRepositoryTaskLifecycle
newtype DataRepositoryTaskLifecycle Source #
Instances
DataRepositoryTaskType
newtype DataRepositoryTaskType Source #
Instances
DeleteFileSystemOpenZFSOption
newtype DeleteFileSystemOpenZFSOption Source #
pattern DeleteFileSystemOpenZFSOption_DELETE_CHILD_VOLUMES_AND_SNAPSHOTS :: DeleteFileSystemOpenZFSOption |
Instances
DeleteOpenZFSVolumeOption
newtype DeleteOpenZFSVolumeOption Source #
Instances
DiskIopsConfigurationMode
newtype DiskIopsConfigurationMode Source #
pattern DiskIopsConfigurationMode_AUTOMATIC :: DiskIopsConfigurationMode | |
pattern DiskIopsConfigurationMode_USER_PROVISIONED :: DiskIopsConfigurationMode |
Instances
DriveCacheType
newtype DriveCacheType Source #
pattern DriveCacheType_NONE :: DriveCacheType | |
pattern DriveCacheType_READ :: DriveCacheType |
Instances
EventType
pattern EventType_CHANGED :: EventType | |
pattern EventType_DELETED :: EventType | |
pattern EventType_NEW :: EventType |
Instances
FileCacheLifecycle
newtype FileCacheLifecycle Source #
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 #
Instances
FileCacheType
newtype FileCacheType Source #
pattern FileCacheType_LUSTRE :: FileCacheType |
Instances
FileSystemLifecycle
newtype FileSystemLifecycle Source #
The lifecycle status of the file system.
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.
pattern FileSystemMaintenanceOperation_BACKING_UP :: FileSystemMaintenanceOperation | |
pattern FileSystemMaintenanceOperation_PATCHING :: FileSystemMaintenanceOperation |
Instances
FileSystemType
newtype FileSystemType Source #
The type of file system.
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.
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 #
pattern FlexCacheEndpointType_CACHE :: FlexCacheEndpointType | |
pattern FlexCacheEndpointType_NONE :: FlexCacheEndpointType | |
pattern FlexCacheEndpointType_ORIGIN :: FlexCacheEndpointType |
Instances
InputOntapVolumeType
newtype InputOntapVolumeType Source #
pattern InputOntapVolumeType_DP :: InputOntapVolumeType | |
pattern InputOntapVolumeType_RW :: InputOntapVolumeType |
Instances
LustreAccessAuditLogLevel
newtype LustreAccessAuditLogLevel Source #
Instances
LustreDeploymentType
newtype LustreDeploymentType Source #
Instances
NfsVersion
newtype NfsVersion Source #
pattern NfsVersion_NFS3 :: NfsVersion |
Instances
OntapDeploymentType
newtype OntapDeploymentType Source #
pattern OntapDeploymentType_MULTI_AZ_1 :: OntapDeploymentType | |
pattern OntapDeploymentType_SINGLE_AZ_1 :: OntapDeploymentType |
Instances
OntapVolumeType
newtype OntapVolumeType Source #
pattern OntapVolumeType_DP :: OntapVolumeType | |
pattern OntapVolumeType_LS :: OntapVolumeType | |
pattern OntapVolumeType_RW :: OntapVolumeType |
Instances
OpenZFSCopyStrategy
newtype OpenZFSCopyStrategy Source #
pattern OpenZFSCopyStrategy_CLONE :: OpenZFSCopyStrategy | |
pattern OpenZFSCopyStrategy_FULL_COPY :: OpenZFSCopyStrategy |
Instances
OpenZFSDataCompressionType
newtype OpenZFSDataCompressionType Source #
Instances
OpenZFSDeploymentType
newtype OpenZFSDeploymentType Source #
pattern OpenZFSDeploymentType_SINGLE_AZ_1 :: OpenZFSDeploymentType | |
pattern OpenZFSDeploymentType_SINGLE_AZ_2 :: OpenZFSDeploymentType |
Instances
OpenZFSQuotaType
newtype OpenZFSQuotaType Source #
pattern OpenZFSQuotaType_GROUP :: OpenZFSQuotaType | |
pattern OpenZFSQuotaType_USER :: OpenZFSQuotaType |
Instances
ReportFormat
newtype ReportFormat Source #
pattern ReportFormat_REPORT_CSV_20191124 :: ReportFormat |
Instances
ReportScope
newtype ReportScope Source #
pattern ReportScope_FAILED_FILES_ONLY :: ReportScope |
Instances
ResourceType
newtype ResourceType Source #
pattern ResourceType_FILE_SYSTEM :: ResourceType | |
pattern ResourceType_VOLUME :: ResourceType |
Instances
RestoreOpenZFSVolumeOption
newtype RestoreOpenZFSVolumeOption Source #
pattern RestoreOpenZFSVolumeOption_DELETE_CLONED_VOLUMES :: RestoreOpenZFSVolumeOption | |
pattern RestoreOpenZFSVolumeOption_DELETE_INTERMEDIATE_SNAPSHOTS :: RestoreOpenZFSVolumeOption |
Instances
SecurityStyle
newtype SecurityStyle Source #
pattern SecurityStyle_MIXED :: SecurityStyle | |
pattern SecurityStyle_NTFS :: SecurityStyle | |
pattern SecurityStyle_UNIX :: SecurityStyle |
Instances
SnapshotFilterName
newtype SnapshotFilterName Source #
pattern SnapshotFilterName_File_system_id :: SnapshotFilterName | |
pattern SnapshotFilterName_Volume_id :: SnapshotFilterName |
Instances
SnapshotLifecycle
newtype SnapshotLifecycle Source #
pattern SnapshotLifecycle_AVAILABLE :: SnapshotLifecycle | |
pattern SnapshotLifecycle_CREATING :: SnapshotLifecycle | |
pattern SnapshotLifecycle_DELETING :: SnapshotLifecycle | |
pattern SnapshotLifecycle_PENDING :: SnapshotLifecycle |
Instances
Status
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.
pattern StorageType_HDD :: StorageType | |
pattern StorageType_SSD :: StorageType |
Instances
StorageVirtualMachineFilterName
newtype StorageVirtualMachineFilterName Source #
Instances
StorageVirtualMachineLifecycle
newtype StorageVirtualMachineLifecycle Source #
Instances
StorageVirtualMachineRootVolumeSecurityStyle
newtype StorageVirtualMachineRootVolumeSecurityStyle Source #
Instances
StorageVirtualMachineSubtype
newtype StorageVirtualMachineSubtype Source #
Instances
TieringPolicyName
newtype TieringPolicyName Source #
pattern TieringPolicyName_ALL :: TieringPolicyName | |
pattern TieringPolicyName_AUTO :: TieringPolicyName | |
pattern TieringPolicyName_NONE :: TieringPolicyName | |
pattern TieringPolicyName_SNAPSHOT_ONLY :: TieringPolicyName |
Instances
VolumeFilterName
newtype VolumeFilterName Source #
pattern VolumeFilterName_File_system_id :: VolumeFilterName | |
pattern VolumeFilterName_Storage_virtual_machine_id :: VolumeFilterName |
Instances
VolumeLifecycle
newtype VolumeLifecycle Source #
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 #
pattern VolumeType_ONTAP :: VolumeType | |
pattern VolumeType_OPENZFS :: VolumeType |
Instances
WindowsAccessAuditLogLevel
newtype WindowsAccessAuditLogLevel Source #
Instances
WindowsDeploymentType
newtype WindowsDeploymentType Source #
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.
ActiveDirectoryBackupAttributes' | |
|
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.
activeDirectoryBackupAttributes_activeDirectoryId :: Lens' ActiveDirectoryBackupAttributes (Maybe Text) Source #
The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
activeDirectoryBackupAttributes_domainName :: Lens' ActiveDirectoryBackupAttributes (Maybe Text) Source #
The fully qualified domain name of the self-managed Active Directory directory.
activeDirectoryBackupAttributes_resourceARN :: Lens' ActiveDirectoryBackupAttributes (Maybe Text) Source #
Undocumented member.
AdministrativeAction
data AdministrativeAction Source #
Describes a specific Amazon FSx administrative action for the current Windows, Lustre, or OpenZFS file system.
See: newAdministrativeAction
smart constructor.
AdministrativeAction' | |
|
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.
administrativeAction_administrativeActionType :: Lens' AdministrativeAction (Maybe AdministrativeActionType) Source #
Undocumented member.
administrativeAction_failureDetails :: Lens' AdministrativeAction (Maybe AdministrativeActionFailureDetails) Source #
Undocumented member.
administrativeAction_progressPercent :: Lens' AdministrativeAction (Maybe Natural) Source #
The percentage-complete status of a STORAGE_OPTIMIZATION
administrative action. Does not apply to any other administrative action
type.
administrativeAction_requestTime :: Lens' AdministrativeAction (Maybe UTCTime) Source #
The time that the administrative action request was received.
administrativeAction_status :: Lens' AdministrativeAction (Maybe Status) Source #
Describes the status of the administrative action, as follows:
FAILED
- Amazon FSx failed to process the administrative action successfully.IN_PROGRESS
- Amazon FSx is processing the administrative action.PENDING
- Amazon FSx is waiting to process the administrative action.COMPLETED
- Amazon FSx has finished processing the administrative task.UPDATED_OPTIMIZING
- For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.
administrativeAction_targetFileSystemValues :: Lens' AdministrativeAction (Maybe FileSystem) Source #
Describes the target value for the administration action, provided in
the UpdateFileSystem
operation. Returned for FILE_SYSTEM_UPDATE
administrative actions.
administrativeAction_targetSnapshotValues :: Lens' AdministrativeAction (Maybe Snapshot) Source #
Undocumented member.
administrativeAction_targetVolumeValues :: Lens' AdministrativeAction (Maybe Volume) Source #
Undocumented member.
AdministrativeActionFailureDetails
data AdministrativeActionFailureDetails Source #
Provides information about a failed administrative action.
See: newAdministrativeActionFailureDetails
smart constructor.
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.
administrativeActionFailureDetails_message :: Lens' AdministrativeActionFailureDetails (Maybe Text) Source #
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.
Alias' | |
|
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.
alias_lifecycle :: Lens' Alias (Maybe AliasLifecycle) Source #
Describes the state of the DNS alias.
- AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
- CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
- CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
- DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
- DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.
alias_name :: Lens' Alias (Maybe Text) Source #
The name of the DNS alias. The alias name has to meet the following requirements:
- Formatted as a fully-qualified domain name (FQDN),
hostname.domain
, for example,accounting.example.com
. - Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
- Cannot start or end with a hyphen.
- Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
AutoExportPolicy
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.
AutoExportPolicy' | |
|
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
.
autoExportPolicy_events :: Lens' AutoExportPolicy (Maybe [EventType]) Source #
The AutoExportPolicy
can have the following event values:
NEW
- New files and directories are automatically exported to the data repository as they are added to the file system.CHANGED
- Changes to files and directories on the file system are automatically exported to the data repository.DELETED
- Files and directories are automatically deleted on the data repository when they are deleted on the file system.
You can define any combination of event types for your
AutoExportPolicy
.
AutoImportPolicy
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.
AutoImportPolicy' | |
|
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
.
autoImportPolicy_events :: Lens' AutoImportPolicy (Maybe [EventType]) Source #
The AutoImportPolicy
can have the following event values:
NEW
- Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.CHANGED
- Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.DELETED
- Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.
You can define any combination of event types for your
AutoImportPolicy
.
Backup
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.
Backup' | |
|
Instances
:: 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.
backup_directoryInformation :: Lens' Backup (Maybe ActiveDirectoryBackupAttributes) Source #
The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
backup_failureDetails :: Lens' Backup (Maybe BackupFailureDetails) Source #
Details explaining any failures that occurred when creating a backup.
backup_kmsKeyId :: Lens' Backup (Maybe Text) Source #
The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
backup_resourceARN :: Lens' Backup (Maybe Text) Source #
The Amazon Resource Name (ARN) for the backup resource.
backup_resourceType :: Lens' Backup (Maybe ResourceType) Source #
Specifies the resource type that's backed up.
backup_sourceBackupRegion :: Lens' Backup (Maybe Text) Source #
The source Region of the backup. Specifies the Region from where this backup is copied.
backup_tags :: Lens' Backup (Maybe (NonEmpty Tag)) Source #
The tags associated with a particular file system.
backup_lifecycle :: Lens' Backup BackupLifecycle Source #
The lifecycle status of the backup.
AVAILABLE
- The backup is fully available.PENDING
- For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.CREATING
- Amazon FSx is creating the backup.TRANSFERRING
- For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.COPYING
- Amazon FSx is copying the backup.DELETED
- Amazon FSx deleted the backup and it's no longer available.FAILED
- Amazon FSx couldn't finish the backup.
backup_type :: Lens' Backup BackupType Source #
The type of the file-system backup.
backup_fileSystem :: Lens' Backup FileSystem Source #
The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
BackupFailureDetails
data BackupFailureDetails Source #
If backup creation fails, this structure contains the details of that failure.
See: newBackupFailureDetails
smart constructor.
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.
backupFailureDetails_message :: Lens' BackupFailureDetails (Maybe Text) Source #
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.
CompletionReport' | |
|
Instances
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.
completionReport_format :: Lens' CompletionReport (Maybe ReportFormat) Source #
Required if Enabled
is set to true
. Specifies the format of the
CompletionReport
. REPORT_CSV_20191124
is the only format currently
supported. When Format
is set to REPORT_CSV_20191124
, the
CompletionReport
is provided in CSV format, and is delivered to
{path}/task-{id}/failures.csv
.
completionReport_path :: Lens' CompletionReport (Maybe Text) Source #
Required if Enabled
is set to true
. Specifies the location of the
report on the file system's linked S3 data repository. An absolute path
that defines where the completion report will be stored in the
destination location. The Path
you provide must be located within the
file system’s ExportPath. An example Path
value is
"s3://myBucket/myExportPath/optionalPrefix". The report provides
the following information for each file in the report: FilePath,
FileStatus, and ErrorCode. To learn more about a file system's
ExportPath
, see .
completionReport_scope :: Lens' CompletionReport (Maybe ReportScope) Source #
Required if Enabled
is set to true
. Specifies the scope of the
CompletionReport
; FAILED_FILES_ONLY
is the only scope currently
supported. When Scope
is set to FAILED_FILES_ONLY
, the
CompletionReport
only contains information about files that the data
repository task failed to process.
completionReport_enabled :: Lens' CompletionReport Bool Source #
Set Enabled
to True
to generate a CompletionReport
when the task
completes. If set to true
, then you need to provide a report Scope
,
Path
, and Format
. Set Enabled
to False
if you do not want a
CompletionReport
generated when the task completes.
CreateFileCacheLustreConfiguration
data CreateFileCacheLustreConfiguration Source #
The Amazon File Cache configuration for the cache that you are creating.
See: newCreateFileCacheLustreConfiguration
smart constructor.
CreateFileCacheLustreConfiguration' | |
|
Instances
newCreateFileCacheLustreConfiguration Source #
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.
createFileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileCacheLustreConfiguration (Maybe Text) Source #
Undocumented member.
createFileCacheLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileCacheLustreConfiguration Natural Source #
Provisions the amount of read and write throughput for each 1 tebibyte
(TiB) of cache storage capacity, in MB/s/TiB. The only supported value
is 1000
.
createFileCacheLustreConfiguration_deploymentType :: Lens' CreateFileCacheLustreConfiguration FileCacheLustreDeploymentType Source #
Specifies the cache deployment type, which must be CACHE_1
.
createFileCacheLustreConfiguration_metadataConfiguration :: Lens' CreateFileCacheLustreConfiguration FileCacheLustreMetadataConfiguration Source #
The configuration for a Lustre MDT (Metadata Target) storage volume.
CreateFileSystemLustreConfiguration
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.
CreateFileSystemLustreConfiguration' | |
|
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_1
SSD storage: 50, 100, 200 MB/s/TiB. - For
PERSISTENT_1
HDD storage: 12, 40 MB/s/TiB. - For
PERSISTENT_2
SSD storage: 125, 250, 500, 1000 MB/s/TiB.
$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.
createFileSystemLustreConfiguration_autoImportPolicy :: Lens' CreateFileSystemLustreConfiguration (Maybe AutoImportPolicyType) Source #
(Optional) Available with Scratch
and Persistent_1
deployment types.
When you create your file system, your existing S3 objects appear as
file and directory listings. Use this property to choose how Amazon FSx
keeps your file and directory listings up to date as you add or modify
objects in your linked S3 bucket. AutoImportPolicy
can have the
following values:
NONE
- (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.NEW
- AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.NEW_CHANGED_DELETED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
For more information, see Automatically import updates from your S3 bucket.
This parameter is not supported for file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #
Undocumented member.
createFileSystemLustreConfiguration_copyTagsToBackups :: Lens' CreateFileSystemLustreConfiguration (Maybe Bool) Source #
(Optional) Not available for use with file systems that are linked to a
data repository. A boolean flag indicating whether tags for the file
system should be copied to backups. The default value is false. If
CopyTagsToBackups
is set to true, all file system tags are copied to
all automatic and user-initiated backups when the user doesn't specify
any backup-specific tags. If CopyTagsToBackups
is set to true and you
specify one or more backup tags, only the specified tags are copied to
backups. If you specify one or more tags when creating a user-initiated
backup, no tags are copied from the file system, regardless of this
value.
(Default = false
)
For more information, see Working with backups in the Amazon FSx for Lustre User Guide.
createFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
Undocumented member.
createFileSystemLustreConfiguration_dataCompressionType :: Lens' CreateFileSystemLustreConfiguration (Maybe DataCompressionType) Source #
Sets the data compression configuration for the file system.
DataCompressionType
can have the following values:
NONE
- (Default) Data compression is turned off when the file system is created.LZ4
- Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.
createFileSystemLustreConfiguration_deploymentType :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreDeploymentType) Source #
(Optional) Choose SCRATCH_1
and SCRATCH_2
deployment types when you
need temporary storage and shorter-term processing of data. The
SCRATCH_2
deployment type provides in-transit encryption of data and
higher burst throughput capacity than SCRATCH_1
.
Choose PERSISTENT_1
for longer-term storage and for throughput-focused
workloads that aren’t latency-sensitive. PERSISTENT_1
supports
encryption of data in transit, and is available in all Amazon Web
Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2
for longer-term storage and for latency-sensitive
workloads that require the highest levels of IOPS/throughput.
PERSISTENT_2
supports SSD storage, and offers higher
PerUnitStorageThroughput
(up to 1000 MB/s/TiB). PERSISTENT_2
is
available in a limited number of Amazon Web Services Regions. For more
information, and an up-to-date list of Amazon Web Services Regions in
which PERSISTENT_2
is available, see
File system deployment options for FSx for Lustre
in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2
, and you set FileSystemTypeVersion
to
2.10
, the CreateFileSystem
operation fails.
Encryption of data in transit is automatically turned on when you access
SCRATCH_2
, PERSISTENT_1
and PERSISTENT_2
file systems from Amazon
EC2 instances that
support automatic encryption
in the Amazon Web Services Regions where they are available. For more
information about encryption in transit for FSx for Lustre file systems,
see
Encrypting data in transit
in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1
)
createFileSystemLustreConfiguration_driveCacheType :: Lens' CreateFileSystemLustreConfiguration (Maybe DriveCacheType) Source #
The type of drive cache used by PERSISTENT_1
file systems that are
provisioned with HDD storage devices. This parameter is required when
storage type is HDD. Set this property to READ
to improve the
performance for frequently accessed files by caching up to 20% of the
total storage capacity of the file system.
This parameter is required when StorageType
is set to HDD
.
createFileSystemLustreConfiguration_exportPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
(Optional) Available with Scratch
and Persistent_1
deployment types.
Specifies the path in the Amazon S3 bucket where the root of your Amazon
FSx file system is exported. The path must use the same Amazon S3 bucket
as specified in ImportPath. You can provide an optional prefix to which
new and changed data is to be exported from your Amazon FSx for Lustre
file system. If an ExportPath
value is not provided, Amazon FSx sets a
default export path,
s3://import-bucket/FSxLustre[creation-timestamp]
. The timestamp is
in UTC format, for example
s3://import-bucket/FSxLustre20181105T222312Z
.
The Amazon S3 export bucket must be the same as the import bucket
specified by ImportPath
. If you specify only a bucket name, such as
s3://import-bucket
, you get a 1:1 mapping of file system objects to
S3 bucket objects. This mapping means that the input data in S3 is
overwritten on export. If you provide a custom prefix in the export
path, such as s3://import-bucket/[custom-optional-prefix]
, Amazon
FSx exports the contents of your file system to that export prefix in
the Amazon S3 bucket.
This parameter is not supported for file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_importPath :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
(Optional) The path to the Amazon S3 bucket (including the optional
prefix) that you're using as the data repository for your Amazon FSx
for Lustre file system. The root of your FSx for Lustre file system will
be mapped to the root of the Amazon S3 bucket you select. An example is
s3://import-bucket/optional-prefix
. If you specify a prefix after
the Amazon S3 bucket name, only object keys with that prefix are loaded
into the file system.
This parameter is not supported for file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_importedFileChunkSize :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #
(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
This parameter is not supported for file systems with the Persistent_2
deployment type. Instead, use CreateDataRepositoryAssociation
to
create a data repository association to link your Lustre file system to
a data repository.
createFileSystemLustreConfiguration_logConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration) Source #
The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
createFileSystemLustreConfiguration_perUnitStorageThroughput :: Lens' CreateFileSystemLustreConfiguration (Maybe Natural) Source #
Required with PERSISTENT_1
and PERSISTENT_2
deployment types,
provisions the amount of read and write throughput for each 1 tebibyte
(TiB) of file system storage capacity, in MB/s/TiB. File system
throughput capacity is calculated by multiplying file system storage
capacity (TiB) by the PerUnitStorageThroughput
(MB/s/TiB). For a
2.4-TiB file system, provisioning 50 MB/s/TiB of
PerUnitStorageThroughput
yields 120 MB/s of file system throughput.
You pay for the amount of throughput that you provision.
Valid values:
- For
PERSISTENT_1
SSD storage: 50, 100, 200 MB/s/TiB. - For
PERSISTENT_1
HDD storage: 12, 40 MB/s/TiB. - For
PERSISTENT_2
SSD storage: 125, 250, 500, 1000 MB/s/TiB.
createFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' CreateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration) Source #
The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
createFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemLustreConfiguration (Maybe Text) Source #
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
CreateFileSystemOntapConfiguration
data CreateFileSystemOntapConfiguration Source #
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
See: newCreateFileSystemOntapConfiguration
smart constructor.
CreateFileSystemOntapConfiguration' | |
|
Instances
newCreateFileSystemOntapConfiguration Source #
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.
createFileSystemOntapConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemOntapConfiguration (Maybe Natural) Source #
Undocumented member.
createFileSystemOntapConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #
Undocumented member.
createFileSystemOntapConfiguration_diskIopsConfiguration :: Lens' CreateFileSystemOntapConfiguration (Maybe DiskIopsConfiguration) Source #
The SSD IOPS configuration for the FSx for ONTAP file system.
createFileSystemOntapConfiguration_endpointIpAddressRange :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
createFileSystemOntapConfiguration_fsxAdminPassword :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #
The ONTAP administrative password for the fsxadmin
user with which you
administer your file system using the NetApp ONTAP CLI and REST API.
createFileSystemOntapConfiguration_preferredSubnetId :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #
Required when DeploymentType
is set to MULTI_AZ_1
. This specifies
the subnet in which you want the preferred file server to be located.
createFileSystemOntapConfiguration_routeTableIds :: Lens' CreateFileSystemOntapConfiguration (Maybe [Text]) Source #
(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
createFileSystemOntapConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemOntapConfiguration (Maybe Text) Source #
Undocumented member.
createFileSystemOntapConfiguration_deploymentType :: Lens' CreateFileSystemOntapConfiguration OntapDeploymentType Source #
Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
MULTI_AZ_1
- (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.SINGLE_AZ_1
- A file system configured for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.
createFileSystemOntapConfiguration_throughputCapacity :: Lens' CreateFileSystemOntapConfiguration Natural Source #
Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
CreateFileSystemOpenZFSConfiguration
data CreateFileSystemOpenZFSConfiguration Source #
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
See: newCreateFileSystemOpenZFSConfiguration
smart constructor.
CreateFileSystemOpenZFSConfiguration' | |
|
Instances
newCreateFileSystemOpenZFSConfiguration Source #
:: 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_1
is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available, except US West (Oregon).SINGLE_AZ_2
- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache.Single_AZ_2
is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
$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.
createFileSystemOpenZFSConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Natural) Source #
Undocumented member.
createFileSystemOpenZFSConfiguration_copyTagsToBackups :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the file system should be
copied to backups. This value defaults to false
. If it's set to
true
, all tags for the file system are copied to all automatic and
user-initiated backups where the user doesn't specify tags. If this
value is true
, and you specify one or more tags, only the specified
tags are copied to backups. If you specify one or more tags when
creating a user-initiated backup, no tags are copied from the file
system, regardless of this value.
createFileSystemOpenZFSConfiguration_copyTagsToVolumes :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the file system should be
copied to volumes. This value defaults to false
. If it's set to
true
, all tags for the file system are copied to volumes where the
user doesn't specify tags. If this value is true
, and you specify one
or more tags, only the specified tags are copied to volumes. If you
specify one or more tags when creating the volume, no tags are copied
from the file system, regardless of this value.
createFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Text) Source #
Undocumented member.
createFileSystemOpenZFSConfiguration_diskIopsConfiguration :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe DiskIopsConfiguration) Source #
Undocumented member.
createFileSystemOpenZFSConfiguration_rootVolumeConfiguration :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe OpenZFSCreateRootVolumeConfiguration) Source #
The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.
createFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemOpenZFSConfiguration (Maybe Text) Source #
Undocumented member.
createFileSystemOpenZFSConfiguration_deploymentType :: Lens' CreateFileSystemOpenZFSConfiguration OpenZFSDeploymentType Source #
Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:
SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.Single_AZ_1
is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available, except US West (Oregon).SINGLE_AZ_2
- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache.Single_AZ_2
is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
createFileSystemOpenZFSConfiguration_throughputCapacity :: Lens' CreateFileSystemOpenZFSConfiguration Natural Source #
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
- For
SINGLE_AZ_1
, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. - For
SINGLE_AZ_2
, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
You pay for additional throughput capacity that you provision.
CreateFileSystemWindowsConfiguration
data CreateFileSystemWindowsConfiguration Source #
The configuration object for the Microsoft Windows file system used in
CreateFileSystem
and CreateFileSystemFromBackup
operations.
See: newCreateFileSystemWindowsConfiguration
smart constructor.
CreateFileSystemWindowsConfiguration' | |
|
Instances
newCreateFileSystemWindowsConfiguration Source #
:: 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).
createFileSystemWindowsConfiguration_activeDirectoryId :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #
The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
createFileSystemWindowsConfiguration_aliases :: Lens' CreateFileSystemWindowsConfiguration (Maybe [Text]) Source #
An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.
For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
An alias name has to meet the following requirements:
- Formatted as a fully-qualified domain name (FQDN),
hostname.domain
, for example,accounting.example.com
. - Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
- Cannot start or end with a hyphen.
- Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
createFileSystemWindowsConfiguration_auditLogConfiguration :: Lens' CreateFileSystemWindowsConfiguration (Maybe WindowsAuditLogCreateConfiguration) Source #
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
createFileSystemWindowsConfiguration_automaticBackupRetentionDays :: Lens' CreateFileSystemWindowsConfiguration (Maybe Natural) Source #
The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.
createFileSystemWindowsConfiguration_copyTagsToBackups :: Lens' CreateFileSystemWindowsConfiguration (Maybe Bool) Source #
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
createFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #
The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
createFileSystemWindowsConfiguration_deploymentType :: Lens' CreateFileSystemWindowsConfiguration (Maybe WindowsDeploymentType) Source #
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1
- Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage 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.
createFileSystemWindowsConfiguration_preferredSubnetId :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #
Required when DeploymentType
is set to MULTI_AZ_1
. This specifies
the subnet in which you want the preferred file server to be located.
For in-Amazon Web Services applications, we recommend that you launch
your clients in the same Availability Zone (AZ) as your preferred file
server to reduce cross-AZ data transfer costs and minimize latency.
createFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' CreateFileSystemWindowsConfiguration (Maybe SelfManagedActiveDirectoryConfiguration) Source #
Undocumented member.
createFileSystemWindowsConfiguration_weeklyMaintenanceStartTime :: Lens' CreateFileSystemWindowsConfiguration (Maybe Text) Source #
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
createFileSystemWindowsConfiguration_throughputCapacity :: Lens' CreateFileSystemWindowsConfiguration Natural Source #
Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
CreateOntapVolumeConfiguration
data CreateOntapVolumeConfiguration Source #
Specifies the configuration of the ONTAP volume that you are creating.
See: newCreateOntapVolumeConfiguration
smart constructor.
CreateOntapVolumeConfiguration' | |
|
Instances
newCreateOntapVolumeConfiguration Source #
:: 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:
RW
specifies a read/write volume.RW
is the default.DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
$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:
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.MIXED
if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
$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 thedefault
policy except that it only retains one snapshot from the weekly schedule.none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
$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.
createOntapVolumeConfiguration_copyTagsToBackups :: Lens' CreateOntapVolumeConfiguration (Maybe Bool) Source #
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
createOntapVolumeConfiguration_junctionPath :: Lens' CreateOntapVolumeConfiguration (Maybe Text) Source #
Specifies the location in the SVM's namespace where the volume is
mounted. The JunctionPath
must have a leading forward slash, such as
/vol3
.
createOntapVolumeConfiguration_ontapVolumeType :: Lens' CreateOntapVolumeConfiguration (Maybe InputOntapVolumeType) Source #
Specifies the type of volume you are creating. Valid values are the following:
RW
specifies a read/write volume.RW
is the default.DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
createOntapVolumeConfiguration_securityStyle :: Lens' CreateOntapVolumeConfiguration (Maybe SecurityStyle) Source #
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.MIXED
if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
createOntapVolumeConfiguration_snapshotPolicy :: Lens' CreateOntapVolumeConfiguration (Maybe Text) Source #
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule.none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
createOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' CreateOntapVolumeConfiguration (Maybe Bool) Source #
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
createOntapVolumeConfiguration_tieringPolicy :: Lens' CreateOntapVolumeConfiguration (Maybe TieringPolicy) Source #
Undocumented member.
createOntapVolumeConfiguration_sizeInMegabytes :: Lens' CreateOntapVolumeConfiguration Natural Source #
Specifies the size of the volume, in megabytes (MB), that you are creating.
createOntapVolumeConfiguration_storageVirtualMachineId :: Lens' CreateOntapVolumeConfiguration Text Source #
Specifies the ONTAP SVM in which to create the volume.
CreateOpenZFSOriginSnapshotConfiguration
data CreateOpenZFSOriginSnapshotConfiguration Source #
The snapshot configuration to use when creating an OpenZFS volume from a snapshot.
See: newCreateOpenZFSOriginSnapshotConfiguration
smart constructor.
CreateOpenZFSOriginSnapshotConfiguration' | |
|
Instances
newCreateOpenZFSOriginSnapshotConfiguration Source #
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.
createOpenZFSOriginSnapshotConfiguration_snapshotARN :: Lens' CreateOpenZFSOriginSnapshotConfiguration Text Source #
Undocumented member.
createOpenZFSOriginSnapshotConfiguration_copyStrategy :: Lens' CreateOpenZFSOriginSnapshotConfiguration OpenZFSCopyStrategy Source #
The strategy used when copying data from the snapshot to the new volume.
CLONE
- The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.FULL_COPY
- Copies all data from the snapshot to the new volume.
CreateOpenZFSVolumeConfiguration
data CreateOpenZFSVolumeConfiguration Source #
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
See: newCreateOpenZFSVolumeConfiguration
smart constructor.
CreateOpenZFSVolumeConfiguration' | |
|
Instances
newCreateOpenZFSVolumeConfiguration Source #
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.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the /Amazon FSx for OpenZFS User Guide/.
$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.
createOpenZFSVolumeConfiguration_copyTagsToSnapshots :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the volume should be copied
to snapshots. This value defaults to false
. If it's set to true
,
all tags for the volume are copied to snapshots where the user doesn't
specify tags. If this value is true
, and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or
more tags when creating the snapshot, no tags are copied from the
volume, regardless of this value.
createOpenZFSVolumeConfiguration_dataCompressionType :: Lens' CreateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #
Specifies the method used to compress the data on the volume. The
compression type is NONE
by default.
NONE
- Doesn't compress the data on the volume.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the /Amazon FSx for OpenZFS User Guide/.
createOpenZFSVolumeConfiguration_nfsExports :: Lens' CreateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #
The configuration object for mounting a Network File System (NFS) file system.
createOpenZFSVolumeConfiguration_originSnapshot :: Lens' CreateOpenZFSVolumeConfiguration (Maybe CreateOpenZFSOriginSnapshotConfiguration) Source #
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
createOpenZFSVolumeConfiguration_readOnly :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether the volume is read-only.
createOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Natural) Source #
Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.
createOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Int) Source #
Sets the maximum storage size in gibibytes (GiB) for the volume. You can
specify a quota that is larger than the storage on the parent volume. A
volume quota limits the amount of storage that the volume can consume to
the configured amount, but does not guarantee the space will be
available on the parent volume. To guarantee quota space, you must also
set StorageCapacityReservationGiB
. To not specify a storage capacity
quota, set this to -1
.
For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.
createOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' CreateOpenZFSVolumeConfiguration (Maybe Int) Source #
Specifies the amount of storage in gibibytes (GiB) to reserve from the
parent volume. Setting StorageCapacityReservationGiB
guarantees that
the specified amount of storage space on the parent volume will always
be available for the volume. You can't reserve more storage than the
parent volume has. To not specify a storage capacity reservation, set
this to 0
or -1
. For more information, see
Volume properties
in the Amazon FSx for OpenZFS User Guide.
createOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' CreateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #
An object specifying how much storage users or groups can use on the volume.
createOpenZFSVolumeConfiguration_parentVolumeId :: Lens' CreateOpenZFSVolumeConfiguration Text Source #
The ID of the volume to use as the parent volume of the volume that you are creating.
CreateSvmActiveDirectoryConfiguration
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.
CreateSvmActiveDirectoryConfiguration' | |
|
Instances
newCreateSvmActiveDirectoryConfiguration Source #
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.
createSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' CreateSvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryConfiguration) Source #
Undocumented member.
createSvmActiveDirectoryConfiguration_netBiosName :: Lens' CreateSvmActiveDirectoryConfiguration Text Source #
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
DataRepositoryAssociation
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.
DataRepositoryAssociation' | |
|
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
DataRepositorySubdirectories
parameter, 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
DataRepositorySubdirectories
parameter, 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 theDataRepositorySubdirectories
parameter.
- 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.
dataRepositoryAssociation_associationId :: Lens' DataRepositoryAssociation (Maybe Text) Source #
The system-generated, unique ID of the data repository association.
dataRepositoryAssociation_batchImportMetaDataOnCreate :: Lens' DataRepositoryAssociation (Maybe Bool) Source #
A boolean flag indicating whether an import data repository task to
import metadata should run after the data repository association is
created. The task runs if this flag is set to true
.
BatchImportMetaDataOnCreate
is not supported for data repositories
linked to an Amazon File Cache resource.
dataRepositoryAssociation_creationTime :: Lens' DataRepositoryAssociation (Maybe UTCTime) Source #
Undocumented member.
dataRepositoryAssociation_dataRepositoryPath :: Lens' DataRepositoryAssociation (Maybe Text) Source #
The path to the data repository that will be linked to the cache or file system.
For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:
- If you are not using the
DataRepositorySubdirectories
parameter, the path is to an NFS Export directory (or one of its subdirectories) in the formatnsf://nfs-domain-name/exportpath
. You can therefore link a single NFS Export to a single data repository association. - If you are using the
DataRepositorySubdirectories
parameter, the path is the domain name of the NFS file system in the formatnfs://filer-domain-name
, which indicates the root of the subdirectories specified with theDataRepositorySubdirectories
parameter.
- 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/
.
dataRepositoryAssociation_dataRepositorySubdirectories :: Lens' DataRepositoryAssociation (Maybe [Text]) Source #
For Amazon File Cache, a list of NFS Exports that will be linked with an
NFS data repository association. All the subdirectories must be on a
single NFS file system. The Export paths are in the format
/exportpath1
. To use this parameter, you must configure
DataRepositoryPath
as the domain name of the NFS file system. The NFS
file system domain name in effect is the root of the subdirectories.
Note that DataRepositorySubdirectories
is not supported for S3 data
repositories.
dataRepositoryAssociation_failureDetails :: Lens' DataRepositoryAssociation (Maybe DataRepositoryFailureDetails) Source #
Undocumented member.
dataRepositoryAssociation_fileCacheId :: Lens' DataRepositoryAssociation (Maybe Text) Source #
The globally unique ID of the Amazon File Cache resource.
dataRepositoryAssociation_fileCachePath :: Lens' DataRepositoryAssociation (Maybe Text) Source #
A path on the Amazon File Cache that points to a high-level directory
(such as /ns1/
) or subdirectory (such as /ns1/subdir/
) that
will be mapped 1-1 with DataRepositoryPath
. The leading forward slash
in the path is required. Two data repository associations cannot have
overlapping cache paths. For example, if a data repository is associated
with cache path /ns1/
, then you cannot link another data repository
with cache path /ns1/ns2
.
This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when
DataRepositorySubdirectories
is specified. If you specify root (/) as
the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
dataRepositoryAssociation_fileSystemId :: Lens' DataRepositoryAssociation (Maybe Text) Source #
Undocumented member.
dataRepositoryAssociation_fileSystemPath :: Lens' DataRepositoryAssociation (Maybe Text) Source #
A path on the Amazon FSx for Lustre file system that points to a
high-level directory (such as /ns1/
) or subdirectory (such as
/ns1/subdir/
) that will be mapped 1-1 with DataRepositoryPath
.
The leading forward slash in the name is required. Two data repository
associations cannot have overlapping file system paths. For example, if
a data repository is associated with file system path /ns1/
, then
you cannot link another data repository with file system path
/ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/
) as the file system path, you
can link only one data repository to the file system. You can only
specify "/" as the file system path for the first data repository
associated with a file system.
dataRepositoryAssociation_importedFileChunkSize :: Lens' DataRepositoryAssociation (Maybe Natural) Source #
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
dataRepositoryAssociation_lifecycle :: Lens' DataRepositoryAssociation (Maybe DataRepositoryLifecycle) Source #
Describes the state of a data repository association. The lifecycle can have the following values:
CREATING
- The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable.AVAILABLE
- The data repository association is available for use.MISCONFIGURED
- The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).UPDATING
- The data repository association is undergoing a customer initiated update that might affect its availability.DELETING
- The data repository association is undergoing a customer initiated deletion.FAILED
- The data repository association is in a terminal state that cannot be recovered.
dataRepositoryAssociation_nfs :: Lens' DataRepositoryAssociation (Maybe NFSDataRepositoryConfiguration) Source #
The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.
dataRepositoryAssociation_resourceARN :: Lens' DataRepositoryAssociation (Maybe Text) Source #
Undocumented member.
dataRepositoryAssociation_s3 :: Lens' DataRepositoryAssociation (Maybe S3DataRepositoryConfiguration) Source #
The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
dataRepositoryAssociation_tags :: Lens' DataRepositoryAssociation (Maybe (NonEmpty Tag)) Source #
Undocumented member.
DataRepositoryConfiguration
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.
DataRepositoryConfiguration' | |
|
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.
dataRepositoryConfiguration_autoImportPolicy :: Lens' DataRepositoryConfiguration (Maybe AutoImportPolicyType) Source #
Describes the file system's linked S3 data repository's
AutoImportPolicy
. The AutoImportPolicy configures how Amazon FSx keeps
your file and directory listings up to date as you add or modify objects
in your linked S3 bucket. AutoImportPolicy
can have the following
values:
NONE
- (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.NEW
- AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.NEW_CHANGED_DELETED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
dataRepositoryConfiguration_exportPath :: Lens' DataRepositoryConfiguration (Maybe Text) Source #
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
dataRepositoryConfiguration_failureDetails :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryFailureDetails) Source #
Undocumented member.
dataRepositoryConfiguration_importPath :: Lens' DataRepositoryConfiguration (Maybe Text) Source #
The import path to the Amazon S3 bucket (and optional prefix) that
you're using as the data repository for your FSx for Lustre file
system, for example s3://import-bucket/optional-prefix
. If a prefix
is specified after the Amazon S3 bucket name, only object keys with that
prefix are loaded into the file system.
dataRepositoryConfiguration_importedFileChunkSize :: Lens' DataRepositoryConfiguration (Maybe Natural) Source #
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
dataRepositoryConfiguration_lifecycle :: Lens' DataRepositoryConfiguration (Maybe DataRepositoryLifecycle) Source #
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING
- The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.AVAILABLE
- The data repository is available for use.MISCONFIGURED
- Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.UPDATING
- The data repository is undergoing a customer initiated update and availability may be impacted.FAILED
- The data repository is in a terminal state that cannot be recovered.
DataRepositoryFailureDetails
data DataRepositoryFailureDetails Source #
Provides detailed information about the data repository if its
Lifecycle
is set to MISCONFIGURED
or FAILED
.
See: newDataRepositoryFailureDetails
smart constructor.
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.
dataRepositoryFailureDetails_message :: Lens' DataRepositoryFailureDetails (Maybe Text) Source #
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.
DataRepositoryTask' | |
|
Instances
newDataRepositoryTask Source #
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_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data repository.IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
$sel:creationTime:DataRepositoryTask'
, dataRepositoryTask_creationTime
- Undocumented member.
dataRepositoryTask_capacityToRelease :: Lens' DataRepositoryTask (Maybe Natural) Source #
Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
dataRepositoryTask_endTime :: Lens' DataRepositoryTask (Maybe UTCTime) Source #
The time the system completed processing the task, populated after the task is complete.
dataRepositoryTask_failureDetails :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskFailureDetails) Source #
Failure message describing why the task failed, it is populated only
when Lifecycle
is set to FAILED
.
dataRepositoryTask_fileCacheId :: Lens' DataRepositoryTask (Maybe Text) Source #
The system-generated, unique ID of the cache.
dataRepositoryTask_fileSystemId :: Lens' DataRepositoryTask (Maybe Text) Source #
The globally unique ID of the file system.
dataRepositoryTask_paths :: Lens' DataRepositoryTask (Maybe [Text]) Source #
An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
(Default) If Paths
is not specified, Amazon FSx uses the file system
root directory.
dataRepositoryTask_report :: Lens' DataRepositoryTask (Maybe CompletionReport) Source #
Undocumented member.
dataRepositoryTask_resourceARN :: Lens' DataRepositoryTask (Maybe Text) Source #
Undocumented member.
dataRepositoryTask_startTime :: Lens' DataRepositoryTask (Maybe UTCTime) Source #
The time the system began processing the task.
dataRepositoryTask_status :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskStatus) Source #
Provides the status of the number of files that the task has processed successfully and failed to process.
dataRepositoryTask_tags :: Lens' DataRepositoryTask (Maybe (NonEmpty Tag)) Source #
Undocumented member.
dataRepositoryTask_taskId :: Lens' DataRepositoryTask Text Source #
The system-generated, unique 17-digit ID of the data repository task.
dataRepositoryTask_lifecycle :: Lens' DataRepositoryTask DataRepositoryTaskLifecycle Source #
The lifecycle status of the data repository task, as follows:
PENDING
- The task has not started.EXECUTING
- The task is in process.FAILED
- The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.SUCCEEDED
- The task has completed successfully.CANCELED
- The task was canceled and it did not complete.CANCELING
- The task is in process of being canceled.
You cannot delete an FSx for Lustre file system if there are data
repository tasks for the file system in the PENDING
or EXECUTING
states. Please retry when the data repository task is finished (with a
status of CANCELED
, SUCCEEDED
, or FAILED
). You can use the
DescribeDataRepositoryTask action to monitor the task status. Contact
the FSx team if you need to delete your file system immediately.
dataRepositoryTask_type :: Lens' DataRepositoryTask DataRepositoryTaskType Source #
The type of data repository task.
EXPORT_TO_REPOSITORY
tasks export from your Amazon FSx for Lustre file system to a linked data repository.IMPORT_METADATA_FROM_REPOSITORY
tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.
dataRepositoryTask_creationTime :: Lens' DataRepositoryTask UTCTime Source #
Undocumented member.
DataRepositoryTaskFailureDetails
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.
Instances
FromJSON DataRepositoryTaskFailureDetails Source # | |
Generic DataRepositoryTaskFailureDetails Source # | |
Read DataRepositoryTaskFailureDetails Source # | |
Show DataRepositoryTaskFailureDetails Source # | |
NFData DataRepositoryTaskFailureDetails Source # | |
Defined in Amazonka.FSx.Types.DataRepositoryTaskFailureDetails rnf :: DataRepositoryTaskFailureDetails -> () # | |
Eq DataRepositoryTaskFailureDetails Source # | |
Hashable DataRepositoryTaskFailureDetails Source # | |
type Rep DataRepositoryTaskFailureDetails Source # | |
Defined in Amazonka.FSx.Types.DataRepositoryTaskFailureDetails type Rep DataRepositoryTaskFailureDetails = D1 ('MetaData "DataRepositoryTaskFailureDetails" "Amazonka.FSx.Types.DataRepositoryTaskFailureDetails" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DataRepositoryTaskFailureDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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.
dataRepositoryTaskFailureDetails_message :: Lens' DataRepositoryTaskFailureDetails (Maybe Text) Source #
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.
DataRepositoryTaskFilter' | |
|
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-id
to retrieve data repository tasks for specific file systems. - Use
task-lifecycle
to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.
$sel:values:DataRepositoryTaskFilter'
, dataRepositoryTaskFilter_values
- Use Values to include the specific file system IDs and task lifecycle
states for the filters you are using.
dataRepositoryTaskFilter_name :: Lens' DataRepositoryTaskFilter (Maybe DataRepositoryTaskFilterName) Source #
Name of the task property to use in filtering the tasks returned in the response.
- Use
file-system-id
to retrieve data repository tasks for specific file systems. - Use
task-lifecycle
to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.
dataRepositoryTaskFilter_values :: Lens' DataRepositoryTaskFilter (Maybe [Text]) Source #
Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.
DataRepositoryTaskStatus
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.
DataRepositoryTaskStatus' | |
|
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
.
dataRepositoryTaskStatus_failedCount :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #
A running total of the number of files that the task failed to process.
dataRepositoryTaskStatus_lastUpdatedTime :: Lens' DataRepositoryTaskStatus (Maybe UTCTime) Source #
The time at which the task status was last updated.
dataRepositoryTaskStatus_releasedCapacity :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #
The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
dataRepositoryTaskStatus_succeededCount :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #
A running total of the number of files that the task has successfully processed.
dataRepositoryTaskStatus_totalCount :: Lens' DataRepositoryTaskStatus (Maybe Integer) Source #
The total number of files that the task will process. While a task is
executing, the sum of SucceededCount
plus FailedCount
may not equal
TotalCount
. When the task is complete, TotalCount
equals the sum of
SucceededCount
plus FailedCount
.
DeleteFileSystemLustreConfiguration
data DeleteFileSystemLustreConfiguration Source #
The configuration object for the Amazon FSx for Lustre file system being
deleted in the DeleteFileSystem
operation.
See: newDeleteFileSystemLustreConfiguration
smart constructor.
DeleteFileSystemLustreConfiguration' | |
|
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.
deleteFileSystemLustreConfiguration_finalBackupTags :: Lens' DeleteFileSystemLustreConfiguration (Maybe (NonEmpty Tag)) Source #
Use if SkipFinalBackup
is set to false
, and you want to apply an
array of tags to the final backup. If you have set the file system
property CopyTagsToBackups
to true, and you specify one or more
FinalBackupTags
when deleting a file system, Amazon FSx will not copy
any existing file system tags to the backup.
deleteFileSystemLustreConfiguration_skipFinalBackup :: Lens' DeleteFileSystemLustreConfiguration (Maybe Bool) Source #
Set SkipFinalBackup
to false if you want to take a final backup of the
file system you are deleting. By default, Amazon FSx will not take a
final backup on your behalf when the DeleteFileSystem
operation is
invoked. (Default = true)
The fsx:CreateBackup
permission is required if you set
SkipFinalBackup
to false
in order to delete the file system and take
a final backup.
DeleteFileSystemLustreResponse
data DeleteFileSystemLustreResponse Source #
The response object for the Amazon FSx for Lustre file system being
deleted in the DeleteFileSystem
operation.
See: newDeleteFileSystemLustreResponse
smart constructor.
DeleteFileSystemLustreResponse' | |
|
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.
deleteFileSystemLustreResponse_finalBackupId :: Lens' DeleteFileSystemLustreResponse (Maybe Text) Source #
The ID of the final backup for this file system.
deleteFileSystemLustreResponse_finalBackupTags :: Lens' DeleteFileSystemLustreResponse (Maybe (NonEmpty Tag)) Source #
The set of tags applied to the final backup.
DeleteFileSystemOpenZFSConfiguration
data DeleteFileSystemOpenZFSConfiguration Source #
The configuration object for the Amazon FSx for OpenZFS file system used
in the DeleteFileSystem
operation.
See: newDeleteFileSystemOpenZFSConfiguration
smart constructor.
DeleteFileSystemOpenZFSConfiguration' | |
|
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
.
deleteFileSystemOpenZFSConfiguration_finalBackupTags :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe (NonEmpty Tag)) Source #
A list of tags to apply to the file system's final backup.
deleteFileSystemOpenZFSConfiguration_options :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe [DeleteFileSystemOpenZFSOption]) Source #
To delete a file system if there are child volumes present below the
root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
. If
your file system has child volumes and you don't use this option, the
delete request will fail.
deleteFileSystemOpenZFSConfiguration_skipFinalBackup :: Lens' DeleteFileSystemOpenZFSConfiguration (Maybe Bool) Source #
By default, Amazon FSx for OpenZFS takes a final backup on your behalf
when the DeleteFileSystem
operation is invoked. Doing this helps
protect you from data loss, and we highly recommend taking the final
backup. If you want to skip taking a final backup, set this value to
true
.
DeleteFileSystemOpenZFSResponse
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.
DeleteFileSystemOpenZFSResponse' | |
|
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.
deleteFileSystemOpenZFSResponse_finalBackupId :: Lens' DeleteFileSystemOpenZFSResponse (Maybe Text) Source #
Undocumented member.
deleteFileSystemOpenZFSResponse_finalBackupTags :: Lens' DeleteFileSystemOpenZFSResponse (Maybe (NonEmpty Tag)) Source #
Undocumented member.
DeleteFileSystemWindowsConfiguration
data DeleteFileSystemWindowsConfiguration Source #
The configuration object for the Microsoft Windows file system used in
the DeleteFileSystem
operation.
See: newDeleteFileSystemWindowsConfiguration
smart constructor.
DeleteFileSystemWindowsConfiguration' | |
|
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.
deleteFileSystemWindowsConfiguration_finalBackupTags :: Lens' DeleteFileSystemWindowsConfiguration (Maybe (NonEmpty Tag)) Source #
A set of tags for your final backup.
deleteFileSystemWindowsConfiguration_skipFinalBackup :: Lens' DeleteFileSystemWindowsConfiguration (Maybe Bool) Source #
By default, Amazon FSx for Windows takes a final backup on your behalf
when the DeleteFileSystem
operation is invoked. Doing this helps
protect you from data loss, and we highly recommend taking the final
backup. If you want to skip this backup, use this flag to do so.
DeleteFileSystemWindowsResponse
data DeleteFileSystemWindowsResponse Source #
The response object for the Microsoft Windows file system used in the
DeleteFileSystem
operation.
See: newDeleteFileSystemWindowsResponse
smart constructor.
DeleteFileSystemWindowsResponse' | |
|
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.
deleteFileSystemWindowsResponse_finalBackupId :: Lens' DeleteFileSystemWindowsResponse (Maybe Text) Source #
The ID of the final backup for this file system.
deleteFileSystemWindowsResponse_finalBackupTags :: Lens' DeleteFileSystemWindowsResponse (Maybe (NonEmpty Tag)) Source #
The set of tags applied to the final backup.
DeleteVolumeOntapConfiguration
data DeleteVolumeOntapConfiguration Source #
Use to specify skipping a final backup, or to add tags to a final backup.
See: newDeleteVolumeOntapConfiguration
smart constructor.
DeleteVolumeOntapConfiguration' | |
|
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.
deleteVolumeOntapConfiguration_finalBackupTags :: Lens' DeleteVolumeOntapConfiguration (Maybe (NonEmpty Tag)) Source #
Undocumented member.
deleteVolumeOntapConfiguration_skipFinalBackup :: Lens' DeleteVolumeOntapConfiguration (Maybe Bool) Source #
Set to true if you want to skip taking a final backup of the volume you are deleting.
DeleteVolumeOntapResponse
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.
deleteVolumeOntapResponse_finalBackupId :: Lens' DeleteVolumeOntapResponse (Maybe Text) Source #
Undocumented member.
deleteVolumeOntapResponse_finalBackupTags :: Lens' DeleteVolumeOntapResponse (Maybe (NonEmpty Tag)) Source #
Undocumented member.
DeleteVolumeOpenZFSConfiguration
data DeleteVolumeOpenZFSConfiguration Source #
A value that specifies whether to delete all child volumes and snapshots.
See: newDeleteVolumeOpenZFSConfiguration
smart constructor.
DeleteVolumeOpenZFSConfiguration' | |
|
Instances
ToJSON DeleteVolumeOpenZFSConfiguration Source # | |
Generic DeleteVolumeOpenZFSConfiguration Source # | |
Read DeleteVolumeOpenZFSConfiguration Source # | |
Show DeleteVolumeOpenZFSConfiguration Source # | |
NFData DeleteVolumeOpenZFSConfiguration Source # | |
Defined in Amazonka.FSx.Types.DeleteVolumeOpenZFSConfiguration rnf :: DeleteVolumeOpenZFSConfiguration -> () # | |
Eq DeleteVolumeOpenZFSConfiguration Source # | |
Hashable DeleteVolumeOpenZFSConfiguration Source # | |
type Rep DeleteVolumeOpenZFSConfiguration Source # | |
Defined in Amazonka.FSx.Types.DeleteVolumeOpenZFSConfiguration type Rep DeleteVolumeOpenZFSConfiguration = D1 ('MetaData "DeleteVolumeOpenZFSConfiguration" "Amazonka.FSx.Types.DeleteVolumeOpenZFSConfiguration" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DeleteVolumeOpenZFSConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeleteOpenZFSVolumeOption])))) |
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
.
deleteVolumeOpenZFSConfiguration_options :: Lens' DeleteVolumeOpenZFSConfiguration (Maybe [DeleteOpenZFSVolumeOption]) Source #
To delete the volume's child volumes, snapshots, and clones, use the
string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
.
DiskIopsConfiguration
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.
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
).
diskIopsConfiguration_iops :: Lens' DiskIopsConfiguration (Maybe Natural) Source #
The total number of SSD IOPS provisioned for the file system.
diskIopsConfiguration_mode :: Lens' DiskIopsConfiguration (Maybe DiskIopsConfigurationMode) Source #
Specifies whether the number of IOPS for the file system is using the
system default (AUTOMATIC
) or was provisioned by the customer
(USER_PROVISIONED
).
FileCache
A description of a specific Amazon File Cache resource, which is a
response object from the DescribeFileCaches
operation.
See: newFileCache
smart constructor.
FileCache' | |
|
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.
fileCache_dNSName :: Lens' FileCache (Maybe Text) Source #
The Domain Name System (DNS) name for the cache.
fileCache_dataRepositoryAssociationIds :: Lens' FileCache (Maybe [Text]) Source #
A list of IDs of data repository associations that are associated with this cache.
fileCache_failureDetails :: Lens' FileCache (Maybe FileCacheFailureDetails) Source #
A structure providing details of any failures that occurred.
fileCache_fileCacheId :: Lens' FileCache (Maybe Text) Source #
The system-generated, unique ID of the cache.
fileCache_fileCacheType :: Lens' FileCache (Maybe FileCacheType) Source #
The type of cache, which must be LUSTRE
.
fileCache_fileCacheTypeVersion :: Lens' FileCache (Maybe Text) Source #
The Lustre version of the cache, which must be 2.12
.
fileCache_kmsKeyId :: Lens' FileCache (Maybe Text) Source #
Specifies the ID of the Key Management Service (KMS) key to use for
encrypting data on an Amazon File Cache. If a KmsKeyId
isn't
specified, the Amazon FSx-managed KMS key for your account is used. For
more information, see
Encrypt
in the Key Management Service API Reference.
fileCache_lifecycle :: Lens' FileCache (Maybe FileCacheLifecycle) Source #
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE
- The cache is in a healthy state, and is reachable and available for use.CREATING
- The new cache is being created.DELETING
- An existing cache is being deleted.UPDATING
- The cache is undergoing a customer-initiated update.FAILED
- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
fileCache_lustreConfiguration :: Lens' FileCache (Maybe FileCacheLustreConfiguration) Source #
The configuration for the Amazon File Cache resource.
fileCache_storageCapacity :: Lens' FileCache (Maybe Natural) Source #
The storage capacity of the cache in gibibytes (GiB).
FileCacheCreating
data FileCacheCreating Source #
The response object for the Amazon File Cache resource being created in
the CreateFileCache
operation.
See: newFileCacheCreating
smart constructor.
FileCacheCreating' | |
|
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.
fileCacheCreating_copyTagsToDataRepositoryAssociations :: Lens' FileCacheCreating (Maybe Bool) Source #
A boolean flag indicating whether tags for the cache should be copied to data repository associations.
fileCacheCreating_creationTime :: Lens' FileCacheCreating (Maybe UTCTime) Source #
Undocumented member.
fileCacheCreating_dNSName :: Lens' FileCacheCreating (Maybe Text) Source #
The Domain Name System (DNS) name for the cache.
fileCacheCreating_dataRepositoryAssociationIds :: Lens' FileCacheCreating (Maybe [Text]) Source #
A list of IDs of data repository associations that are associated with this cache.
fileCacheCreating_failureDetails :: Lens' FileCacheCreating (Maybe FileCacheFailureDetails) Source #
A structure providing details of any failures that occurred.
fileCacheCreating_fileCacheId :: Lens' FileCacheCreating (Maybe Text) Source #
The system-generated, unique ID of the cache.
fileCacheCreating_fileCacheType :: Lens' FileCacheCreating (Maybe FileCacheType) Source #
The type of cache, which must be LUSTRE
.
fileCacheCreating_fileCacheTypeVersion :: Lens' FileCacheCreating (Maybe Text) Source #
The Lustre version of the cache, which must be 2.12
.
fileCacheCreating_kmsKeyId :: Lens' FileCacheCreating (Maybe Text) Source #
Specifies the ID of the Key Management Service (KMS) key to use for
encrypting data on an Amazon File Cache. If a KmsKeyId
isn't
specified, the Amazon FSx-managed KMS key for your account is used. For
more information, see
Encrypt
in the Key Management Service API Reference.
fileCacheCreating_lifecycle :: Lens' FileCacheCreating (Maybe FileCacheLifecycle) Source #
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE
- The cache is in a healthy state, and is reachable and available for use.CREATING
- The new cache is being created.DELETING
- An existing cache is being deleted.UPDATING
- The cache is undergoing a customer-initiated update.FAILED
- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
fileCacheCreating_lustreConfiguration :: Lens' FileCacheCreating (Maybe FileCacheLustreConfiguration) Source #
The configuration for the Amazon File Cache resource.
fileCacheCreating_networkInterfaceIds :: Lens' FileCacheCreating (Maybe [Text]) Source #
Undocumented member.
fileCacheCreating_ownerId :: Lens' FileCacheCreating (Maybe Text) Source #
Undocumented member.
fileCacheCreating_resourceARN :: Lens' FileCacheCreating (Maybe Text) Source #
Undocumented member.
fileCacheCreating_storageCapacity :: Lens' FileCacheCreating (Maybe Natural) Source #
The storage capacity of the cache in gibibytes (GiB).
fileCacheCreating_subnetIds :: Lens' FileCacheCreating (Maybe [Text]) Source #
Undocumented member.
fileCacheCreating_tags :: Lens' FileCacheCreating (Maybe (NonEmpty Tag)) Source #
Undocumented member.
fileCacheCreating_vpcId :: Lens' FileCacheCreating (Maybe Text) Source #
Undocumented member.
FileCacheDataRepositoryAssociation
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.
FileCacheDataRepositoryAssociation' | |
|
Instances
newFileCacheDataRepositoryAssociation Source #
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
DataRepositorySubdirectories
parameter, 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
DataRepositorySubdirectories
parameter, 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 theDataRepositorySubdirectories
parameter.
- If you are not using the
- The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix/
.
fileCacheDataRepositoryAssociation_dataRepositorySubdirectories :: Lens' FileCacheDataRepositoryAssociation (Maybe [Text]) Source #
A list of NFS Exports that will be linked with this data repository
association. The Export paths are in the format /exportpath1
. To use
this parameter, you must configure DataRepositoryPath
as the domain
name of the NFS file system. The NFS file system domain name in effect
is the root of the subdirectories. Note that
DataRepositorySubdirectories
is not supported for S3 data
repositories.
fileCacheDataRepositoryAssociation_nfs :: Lens' FileCacheDataRepositoryAssociation (Maybe FileCacheNFSConfiguration) Source #
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
fileCacheDataRepositoryAssociation_fileCachePath :: Lens' FileCacheDataRepositoryAssociation Text Source #
A path on the cache that points to a high-level directory (such as
/ns1/
) or subdirectory (such as /ns1/subdir/
) that will be
mapped 1-1 with DataRepositoryPath
. The leading forward slash in the
name is required. Two data repository associations cannot have
overlapping cache paths. For example, if a data repository is associated
with cache path /ns1/
, then you cannot link another data repository
with cache path /ns1/ns2
.
This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when
DataRepositorySubdirectories
is specified. If you specify root (/) as
the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
fileCacheDataRepositoryAssociation_dataRepositoryPath :: Lens' FileCacheDataRepositoryAssociation Text Source #
The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:
The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
- If you are not using the
DataRepositorySubdirectories
parameter, the path is to an NFS Export directory (or one of its subdirectories) in the formatnsf://nfs-domain-name/exportpath
. You can therefore link a single NFS Export to a single data repository association. - If you are using the
DataRepositorySubdirectories
parameter, the path is the domain name of the NFS file system in the formatnfs://filer-domain-name
, which indicates the root of the subdirectories specified with theDataRepositorySubdirectories
parameter.
- 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.
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.
fileCacheFailureDetails_message :: Lens' FileCacheFailureDetails (Maybe Text) Source #
A message describing any failures that occurred.
FileCacheLustreConfiguration
data FileCacheLustreConfiguration Source #
The configuration for the Amazon File Cache resource.
See: newFileCacheLustreConfiguration
smart constructor.
FileCacheLustreConfiguration' | |
|
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.
fileCacheLustreConfiguration_deploymentType :: Lens' FileCacheLustreConfiguration (Maybe FileCacheLustreDeploymentType) Source #
The deployment type of the Amazon File Cache resource, which must be
CACHE_1
.
fileCacheLustreConfiguration_logConfiguration :: Lens' FileCacheLustreConfiguration (Maybe LustreLogConfiguration) Source #
The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.
fileCacheLustreConfiguration_metadataConfiguration :: Lens' FileCacheLustreConfiguration (Maybe FileCacheLustreMetadataConfiguration) Source #
The configuration for a Lustre MDT (Metadata Target) storage volume.
fileCacheLustreConfiguration_mountName :: Lens' FileCacheLustreConfiguration (Maybe Text) Source #
You use the MountName
value when mounting the cache. If you pass a
cache ID to the DescribeFileCaches
operation, it returns the the
MountName
value as part of the cache's description.
fileCacheLustreConfiguration_perUnitStorageThroughput :: Lens' FileCacheLustreConfiguration (Maybe Natural) Source #
Per unit storage throughput represents the megabytes per second of read
or write throughput per 1 tebibyte of storage provisioned. Cache
throughput capacity is equal to Storage capacity (TiB) *
PerUnitStorageThroughput (MB/s/TiB). The only supported value is
1000
.
fileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' FileCacheLustreConfiguration (Maybe Text) Source #
Undocumented member.
FileCacheLustreMetadataConfiguration
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.
FileCacheLustreMetadataConfiguration' | |
|
Instances
newFileCacheLustreMetadataConfiguration Source #
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.
fileCacheLustreMetadataConfiguration_storageCapacity :: Lens' FileCacheLustreMetadataConfiguration Natural Source #
The storage capacity of the Lustre MDT (Metadata Target) storage volume
in gibibytes (GiB). The only supported value is 2400
GiB.
FileCacheNFSConfiguration
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.
FileCacheNFSConfiguration' | |
|
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.
fileCacheNFSConfiguration_dnsIps :: Lens' FileCacheNFSConfiguration (Maybe [Text]) Source #
A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
fileCacheNFSConfiguration_version :: Lens' FileCacheNFSConfiguration NfsVersion Source #
The version of the NFS (Network File System) protocol of the NFS data
repository. The only supported value is NFS3
, which indicates that the
data repository must support the NFSv3 protocol.
FileSystem
data FileSystem Source #
A description of a specific Amazon FSx file system.
See: newFileSystem
smart constructor.
FileSystem' | |
|
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_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account.- Amazon FSx for NetApp ONTAP
- Amazon FSx for OpenZFS
- Amazon FSx for Windows File Server
$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.
fileSystem_administrativeActions :: Lens' FileSystem (Maybe [AdministrativeAction]) Source #
A list of administrative actions for the file system that are in process
or waiting to be processed. Administrative actions describe changes to
the Amazon FSx system that you have initiated using the
UpdateFileSystem
operation.
fileSystem_creationTime :: Lens' FileSystem (Maybe UTCTime) Source #
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
fileSystem_dNSName :: Lens' FileSystem (Maybe Text) Source #
The Domain Name System (DNS) name for the file system.
fileSystem_failureDetails :: Lens' FileSystem (Maybe FileSystemFailureDetails) Source #
Undocumented member.
fileSystem_fileSystemId :: Lens' FileSystem (Maybe Text) Source #
The system-generated, unique 17-digit ID of the file system.
fileSystem_fileSystemType :: Lens' FileSystem (Maybe FileSystemType) Source #
The type of Amazon FSx file system, which can be LUSTRE
, WINDOWS
,
ONTAP
, or OPENZFS
.
fileSystem_fileSystemTypeVersion :: Lens' FileSystem (Maybe Text) Source #
The Lustre version of the Amazon FSx for Lustre file system, either
2.10
or 2.12
.
fileSystem_kmsKeyId :: Lens' FileSystem (Maybe Text) Source #
The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service KMS key for your account.- Amazon FSx for NetApp ONTAP
- Amazon FSx for OpenZFS
- Amazon FSx for Windows File Server
fileSystem_lifecycle :: Lens' FileSystem (Maybe FileSystemLifecycle) Source #
The lifecycle status of the file system. The following are the possible values and what they mean:
AVAILABLE
- The file system is in a healthy state, and is reachable and available for use.CREATING
- Amazon FSx is creating the new file system.DELETING
- Amazon FSx is deleting an existing file system.FAILED
- An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.MISCONFIGURED
- The file system is in a failed but recoverable state.MISCONFIGURED_UNAVAILABLE
- (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.UPDATING
- The file system is undergoing a customer-initiated update.
fileSystem_lustreConfiguration :: Lens' FileSystem (Maybe LustreFileSystemConfiguration) Source #
Undocumented member.
fileSystem_networkInterfaceIds :: Lens' FileSystem (Maybe [Text]) Source #
The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
fileSystem_ontapConfiguration :: Lens' FileSystem (Maybe OntapFileSystemConfiguration) Source #
The configuration for this Amazon FSx for NetApp ONTAP file system.
fileSystem_openZFSConfiguration :: Lens' FileSystem (Maybe OpenZFSFileSystemConfiguration) Source #
The configuration for this Amazon FSx for OpenZFS file system.
fileSystem_ownerId :: Lens' FileSystem (Maybe Text) Source #
The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.
fileSystem_resourceARN :: Lens' FileSystem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the file system resource.
fileSystem_storageCapacity :: Lens' FileSystem (Maybe Natural) Source #
The storage capacity of the file system in gibibytes (GiB).
fileSystem_storageType :: Lens' FileSystem (Maybe StorageType) Source #
The type of storage the file system is using. If set to SSD
, the file
system uses solid state drive storage. If set to HDD
, the file system
uses hard disk drive storage.
fileSystem_subnetIds :: Lens' FileSystem (Maybe [Text]) Source #
Specifies the IDs of the subnets that the file system is accessible
from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1
file system
deployment type, there are two subnet IDs, one for the preferred file
server and one for the standby file server. The preferred file server
subnet identified in the PreferredSubnetID
property. All other file
systems have only one subnet ID.
For FSx for Lustre file systems, and Single-AZ Windows file systems,
this is the ID of the subnet that contains the file system's endpoint.
For MULTI_AZ_1
Windows and ONTAP file systems, the file system
endpoint is available in the PreferredSubnetID
.
fileSystem_tags :: Lens' FileSystem (Maybe (NonEmpty Tag)) Source #
The tags to associate with the file system. For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
fileSystem_vpcId :: Lens' FileSystem (Maybe Text) Source #
The ID of the primary virtual private cloud (VPC) for the file system.
fileSystem_windowsConfiguration :: Lens' FileSystem (Maybe WindowsFileSystemConfiguration) Source #
The configuration for this Amazon FSx for Windows File Server file system.
FileSystemEndpoint
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.
fileSystemEndpoint_dNSName :: Lens' FileSystemEndpoint (Maybe Text) Source #
Undocumented member.
fileSystemEndpoint_ipAddresses :: Lens' FileSystemEndpoint (Maybe (NonEmpty Text)) Source #
IP addresses of the file system endpoint.
FileSystemEndpoints
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.
FileSystemEndpoints' | |
|
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.
fileSystemEndpoints_intercluster :: Lens' FileSystemEndpoints (Maybe FileSystemEndpoint) Source #
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
fileSystemEndpoints_management :: Lens' FileSystemEndpoints (Maybe FileSystemEndpoint) Source #
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
FileSystemFailureDetails
data FileSystemFailureDetails Source #
A structure providing details of any failures that occurred.
See: newFileSystemFailureDetails
smart constructor.
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.
fileSystemFailureDetails_message :: Lens' FileSystemFailureDetails (Maybe Text) Source #
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.
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.
filter_name :: Lens' Filter (Maybe FilterName) Source #
The name for this filter.
filter_values :: Lens' Filter (Maybe [Text]) Source #
The values of the filter. These are all the values for any of the applied filters.
LifecycleTransitionReason
data LifecycleTransitionReason Source #
Describes why a resource lifecycle state changed.
See: newLifecycleTransitionReason
smart constructor.
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.
lifecycleTransitionReason_message :: Lens' LifecycleTransitionReason (Maybe Text) Source #
Undocumented member.
LustreFileSystemConfiguration
data LustreFileSystemConfiguration Source #
The configuration for the Amazon FSx for Lustre file system.
See: newLustreFileSystemConfiguration
smart constructor.
LustreFileSystemConfiguration' | |
|
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_1
SSD storage: 50, 100, 200. - For
PERSISTENT_1
HDD storage: 12, 40. - For
PERSISTENT_2
SSD 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.
lustreFileSystemConfiguration_automaticBackupRetentionDays :: Lens' LustreFileSystemConfiguration (Maybe Natural) Source #
Undocumented member.
lustreFileSystemConfiguration_copyTagsToBackups :: Lens' LustreFileSystemConfiguration (Maybe Bool) Source #
A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
lustreFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' LustreFileSystemConfiguration (Maybe Text) Source #
Undocumented member.
lustreFileSystemConfiguration_dataCompressionType :: Lens' LustreFileSystemConfiguration (Maybe DataCompressionType) Source #
The data compression configuration for the file system.
DataCompressionType
can have the following values:
NONE
- Data compression is turned off for the file system.LZ4
- Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression.
lustreFileSystemConfiguration_dataRepositoryConfiguration :: Lens' LustreFileSystemConfiguration (Maybe DataRepositoryConfiguration) Source #
Undocumented member.
lustreFileSystemConfiguration_deploymentType :: Lens' LustreFileSystemConfiguration (Maybe LustreDeploymentType) Source #
The deployment type of the FSx for Lustre file system. /Scratch deployment type/ is designed for temporary storage and shorter-term processing of data.
SCRATCH_1
and SCRATCH_2
deployment types are best suited for when
you need temporary storage and shorter-term processing of data. The
SCRATCH_2
deployment type provides in-transit encryption of data and
higher burst throughput capacity than SCRATCH_1
.
The PERSISTENT_1
and PERSISTENT_2
deployment type is used for
longer-term storage and workloads and encryption of data in transit.
PERSISTENT_2
is built on Lustre v2.12 and offers higher
PerUnitStorageThroughput
(up to 1000 MB/s/TiB) along with a lower
minimum storage capacity requirement (600 GiB). To learn more about FSx
for Lustre deployment types, see
FSx for Lustre deployment options.
The default is SCRATCH_1
.
lustreFileSystemConfiguration_driveCacheType :: Lens' LustreFileSystemConfiguration (Maybe DriveCacheType) Source #
The type of drive cache used by PERSISTENT_1
file systems that are
provisioned with HDD storage devices. This parameter is required when
StorageType
is HDD. When set to READ
the file system has an SSD
storage cache that is sized to 20% of the file system's storage
capacity. This improves the performance for frequently accessed files by
caching up to 20% of the total storage capacity.
This parameter is required when StorageType
is set to HDD.
lustreFileSystemConfiguration_logConfiguration :: Lens' LustreFileSystemConfiguration (Maybe LustreLogConfiguration) Source #
The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.
lustreFileSystemConfiguration_mountName :: Lens' LustreFileSystemConfiguration (Maybe Text) Source #
You use the MountName
value when mounting the file system.
For the SCRATCH_1
deployment type, this value is always "fsx
". For
SCRATCH_2
, PERSISTENT_1
, and PERSISTENT_2
deployment types, this
value is a string that is unique within an Amazon Web Services Region.
lustreFileSystemConfiguration_perUnitStorageThroughput :: Lens' LustreFileSystemConfiguration (Maybe Natural) Source #
Per unit storage throughput represents the megabytes per second of read
or write throughput per 1 tebibyte of storage provisioned. File system
throughput capacity is equal to Storage capacity (TiB) *
PerUnitStorageThroughput (MB/s/TiB). This option is only valid for
PERSISTENT_1
and PERSISTENT_2
deployment types.
Valid values:
- For
PERSISTENT_1
SSD storage: 50, 100, 200. - For
PERSISTENT_1
HDD storage: 12, 40. - For
PERSISTENT_2
SSD storage: 125, 250, 500, 1000.
lustreFileSystemConfiguration_rootSquashConfiguration :: Lens' LustreFileSystemConfiguration (Maybe LustreRootSquashConfiguration) Source #
The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
lustreFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' LustreFileSystemConfiguration (Maybe Text) Source #
The preferred start time to perform weekly maintenance, formatted
d:HH:MM in the UTC time zone. Here, d
is the weekday number, from 1
through 7, beginning with Monday and ending with Sunday.
LustreLogConfiguration
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.
LustreLogConfiguration' | |
|
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.
lustreLogConfiguration_destination :: Lens' LustreLogConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
lustreLogConfiguration_level :: Lens' LustreLogConfiguration LustreAccessAuditLogLevel Source #
The data repository events that are logged by Amazon FSx.
WARN_ONLY
- only warning events are logged.ERROR_ONLY
- only error events are logged.WARN_ERROR
- both warning events and error events are logged.DISABLED
- logging of data repository events is turned off.
Note that Amazon File Cache uses a default setting of WARN_ERROR
,
which can't be changed.
LustreLogCreateConfiguration
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.
LustreLogCreateConfiguration' | |
|
Instances
newLustreLogCreateConfiguration Source #
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/fsx
prefix. - If you do not provide a destination, Amazon FSx will create and use
a log stream in the CloudWatch Logs
/aws/fsx/lustre
log group (for Amazon FSx for Lustre) or/aws/fsx/filecache
(for Amazon File Cache). - If
Destination
is provided and the resource does not exist, the request will fail with aBadRequest
error. - If
Level
is 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.
lustreLogCreateConfiguration_destination :: Lens' LustreLogCreateConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) that specifies the destination of the logs.
The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
- The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
- The name of the Amazon CloudWatch Logs log group must begin with the
/aws/fsx
prefix. - If you do not provide a destination, Amazon FSx will create and use
a log stream in the CloudWatch Logs
/aws/fsx/lustre
log group (for Amazon FSx for Lustre) or/aws/fsx/filecache
(for Amazon File Cache). - If
Destination
is provided and the resource does not exist, the request will fail with aBadRequest
error. - If
Level
is set toDISABLED
, you cannot specify a destination inDestination
.
lustreLogCreateConfiguration_level :: Lens' LustreLogCreateConfiguration LustreAccessAuditLogLevel Source #
Sets which data repository events are logged by Amazon FSx.
WARN_ONLY
- only warning events are logged.ERROR_ONLY
- only error events are logged.WARN_ERROR
- both warning events and error events are logged.DISABLED
- logging of data repository events is turned off.
LustreRootSquashConfiguration
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.
LustreRootSquashConfiguration' | |
|
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.
lustreRootSquashConfiguration_noSquashNids :: Lens' LustreRootSquashConfiguration (Maybe [Text]) Source #
When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:
- A single address is described in standard Lustre NID format by
specifying the client’s IP address followed by the Lustre network ID
(for example,
10.0.1.6@tcp
). - An address range is described using a dash to separate the range
(for example,
10.0.[2-10].[1-255]@tcp
).
lustreRootSquashConfiguration_rootSquash :: Lens' LustreRootSquashConfiguration (Maybe Text) Source #
You enable root squash by setting a user ID (UID) and group ID (GID) for
the file system in the format UID:GID
(for example, 365534:65534
).
The UID and GID values can range from 0
to 4294967294
:
- A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.
- A value of
0
(zero) for UID and GID indicates root, and therefore disables root squash.
When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.
NFSDataRepositoryConfiguration
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.
NFSDataRepositoryConfiguration' | |
|
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.
nFSDataRepositoryConfiguration_autoExportPolicy :: Lens' NFSDataRepositoryConfiguration (Maybe AutoExportPolicy) Source #
This parameter is not supported for Amazon File Cache.
nFSDataRepositoryConfiguration_dnsIps :: Lens' NFSDataRepositoryConfiguration (Maybe [Text]) Source #
A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
nFSDataRepositoryConfiguration_version :: Lens' NFSDataRepositoryConfiguration NfsVersion Source #
The version of the NFS (Network File System) protocol of the NFS data
repository. Currently, the only supported value is NFS3
, which
indicates that the data repository must support the NFSv3 protocol.
OntapFileSystemConfiguration
data OntapFileSystemConfiguration Source #
Configuration for the FSx for NetApp ONTAP file system.
See: newOntapFileSystemConfiguration
smart constructor.
OntapFileSystemConfiguration' | |
|
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.
ontapFileSystemConfiguration_automaticBackupRetentionDays :: Lens' OntapFileSystemConfiguration (Maybe Natural) Source #
Undocumented member.
ontapFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #
Undocumented member.
ontapFileSystemConfiguration_deploymentType :: Lens' OntapFileSystemConfiguration (Maybe OntapDeploymentType) Source #
Specifies the FSx for ONTAP file system deployment type in use in the file system.
MULTI_AZ_1
- (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.SINGLE_AZ_1
- A file system configured for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.
ontapFileSystemConfiguration_diskIopsConfiguration :: Lens' OntapFileSystemConfiguration (Maybe DiskIopsConfiguration) Source #
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
ontapFileSystemConfiguration_endpointIpAddressRange :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #
(Multi-AZ only) The IP address range in which the endpoints to access your file system are created.
The Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger. If you do not specify this optional parameter, Amazon FSx will automatically select a CIDR block for you.
ontapFileSystemConfiguration_endpoints :: Lens' OntapFileSystemConfiguration (Maybe FileSystemEndpoints) Source #
The Management
and Intercluster
endpoints that are used to access
data or to manage the file system using the NetApp ONTAP CLI, REST API,
or NetApp SnapMirror.
ontapFileSystemConfiguration_preferredSubnetId :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #
Undocumented member.
ontapFileSystemConfiguration_routeTableIds :: Lens' OntapFileSystemConfiguration (Maybe [Text]) Source #
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
ontapFileSystemConfiguration_throughputCapacity :: Lens' OntapFileSystemConfiguration (Maybe Natural) Source #
Undocumented member.
ontapFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' OntapFileSystemConfiguration (Maybe Text) Source #
Undocumented member.
OntapVolumeConfiguration
data OntapVolumeConfiguration Source #
The configuration of an Amazon FSx for NetApp ONTAP volume.
See: newOntapVolumeConfiguration
smart constructor.
OntapVolumeConfiguration' | |
|
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:
NONE
specifies that the volume doesn't have a FlexCache configuration.NONE
is the default.ORIGIN
specifies that the volume is the origin volume for a FlexCache volume.CACHE
specifies that the volume is a FlexCache volume.
$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:
RW
specifies a read/write volume.RW
is the default.DP
specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.LS
specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
$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 thedefault
policy except that it only retains one snapshot from the weekly schedule.none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
$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).
ontapVolumeConfiguration_copyTagsToBackups :: Lens' OntapVolumeConfiguration (Maybe Bool) Source #
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
ontapVolumeConfiguration_flexCacheEndpointType :: Lens' OntapVolumeConfiguration (Maybe FlexCacheEndpointType) Source #
Specifies the FlexCache endpoint type of the volume. Valid values are the following:
NONE
specifies that the volume doesn't have a FlexCache configuration.NONE
is the default.ORIGIN
specifies that the volume is the origin volume for a FlexCache volume.CACHE
specifies that the volume is a FlexCache volume.
ontapVolumeConfiguration_junctionPath :: Lens' OntapVolumeConfiguration (Maybe Text) Source #
Specifies the directory that network-attached storage (NAS) clients use
to mount the volume, along with the storage virtual machine (SVM) Domain
Name System (DNS) name or IP address. You can create a JunctionPath
directly below a parent volume junction or on a directory within a
volume. A JunctionPath
for a volume named vol3
might be
/vol1/vol2/vol3
, or /vol1/dir2/vol3
, or even
/dir1/dir2/vol3
.
ontapVolumeConfiguration_ontapVolumeType :: Lens' OntapVolumeConfiguration (Maybe OntapVolumeType) Source #
Specifies the type of volume. Valid values are the following:
RW
specifies a read/write volume.RW
is the default.DP
specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.LS
specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
ontapVolumeConfiguration_securityStyle :: Lens' OntapVolumeConfiguration (Maybe SecurityStyle) Source #
The security style for the volume, which can be UNIX
, NTFS
, or
MIXED
.
ontapVolumeConfiguration_sizeInMegabytes :: Lens' OntapVolumeConfiguration (Maybe Natural) Source #
The configured size of the volume, in megabytes (MBs).
ontapVolumeConfiguration_snapshotPolicy :: Lens' OntapVolumeConfiguration (Maybe Text) Source #
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule.none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
ontapVolumeConfiguration_storageEfficiencyEnabled :: Lens' OntapVolumeConfiguration (Maybe Bool) Source #
The volume's storage efficiency setting.
ontapVolumeConfiguration_storageVirtualMachineId :: Lens' OntapVolumeConfiguration (Maybe Text) Source #
The ID of the volume's storage virtual machine.
ontapVolumeConfiguration_storageVirtualMachineRoot :: Lens' OntapVolumeConfiguration (Maybe Bool) Source #
A Boolean flag indicating whether this volume is the root volume for its
storage virtual machine (SVM). Only one volume on an SVM can be the root
volume. This value defaults to false
. If this value is true
, then
this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first
delete all non-root volumes. This flag, when set to false
, helps you
identify which volumes to delete before you can delete the SVM.
ontapVolumeConfiguration_tieringPolicy :: Lens' OntapVolumeConfiguration (Maybe TieringPolicy) Source #
The volume's TieringPolicy
setting.
ontapVolumeConfiguration_uuid :: Lens' OntapVolumeConfiguration (Maybe Text) Source #
The volume's universally unique identifier (UUID).
OpenZFSClientConfiguration
data OpenZFSClientConfiguration Source #
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
See: newOpenZFSClientConfiguration
smart constructor.
OpenZFSClientConfiguration' | |
|
Instances
newOpenZFSClientConfiguration Source #
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:
crossmnt
is used by default. If you don't specifycrossmnt
when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.sync
is used by default. If you instead specifyasync
, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
openZFSClientConfiguration_clients :: Lens' OpenZFSClientConfiguration Text Source #
A value that specifies who can mount the file system. You can provide a
wildcard character (*
), an IP address (0.0.0.0
), or a CIDR address
(192.0.2.0/24
). By default, Amazon FSx uses the wildcard character
when specifying the client.
openZFSClientConfiguration_options :: Lens' OpenZFSClientConfiguration (NonEmpty Text) Source #
The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:
crossmnt
is used by default. If you don't specifycrossmnt
when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.sync
is used by default. If you instead 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.
OpenZFSCreateRootVolumeConfiguration' | |
|
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.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
$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.
openZFSCreateRootVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the volume should be copied
to snapshots of the volume. This value defaults to false
. If it's set
to true
, all tags for the volume are copied to snapshots where the
user doesn't specify tags. If this value is true
and you specify one
or more tags, only the specified tags are copied to snapshots. If you
specify one or more tags when creating the snapshot, no tags are copied
from the volume, regardless of this value.
openZFSCreateRootVolumeConfiguration_dataCompressionType :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #
Specifies the method used to compress the data on the volume. The
compression type is NONE
by default.
NONE
- Doesn't compress the data on the volume.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
openZFSCreateRootVolumeConfiguration_nfsExports :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #
The configuration object for mounting a file system.
openZFSCreateRootVolumeConfiguration_readOnly :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether the volume is read-only. Setting this
value to true
can be useful after you have completed changes to a
volume and no longer want changes to occur.
openZFSCreateRootVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe Natural) Source #
Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
openZFSCreateRootVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSCreateRootVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #
An object specifying how much storage users or groups can use on the volume.
OpenZFSFileSystemConfiguration
data OpenZFSFileSystemConfiguration Source #
The configuration for the Amazon FSx for OpenZFS file system.
See: newOpenZFSFileSystemConfiguration
smart constructor.
OpenZFSFileSystemConfiguration' | |
|
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.
openZFSFileSystemConfiguration_automaticBackupRetentionDays :: Lens' OpenZFSFileSystemConfiguration (Maybe Natural) Source #
Undocumented member.
openZFSFileSystemConfiguration_copyTagsToBackups :: Lens' OpenZFSFileSystemConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags on the file system should be
copied to backups. If it's set to true
, all tags on the file system
are copied to all automatic backups and any user-initiated backups where
the user doesn't specify any tags. If this value is true
and you
specify one or more tags, only the specified tags are copied to backups.
If you specify one or more tags when creating a user-initiated backup,
no tags are copied from the file system, regardless of this value.
openZFSFileSystemConfiguration_copyTagsToVolumes :: Lens' OpenZFSFileSystemConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the volume should be copied
to snapshots. This value defaults to false
. If it's set to true
,
all tags for the volume are copied to snapshots where the user doesn't
specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or
more tags when creating the snapshot, no tags are copied from the
volume, regardless of this value.
openZFSFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' OpenZFSFileSystemConfiguration (Maybe Text) Source #
Undocumented member.
openZFSFileSystemConfiguration_deploymentType :: Lens' OpenZFSFileSystemConfiguration (Maybe OpenZFSDeploymentType) Source #
Specifies the file-system deployment type. Amazon FSx for OpenZFS
supports
SINGLE_AZ_1
and SINGLE_AZ_2
.
openZFSFileSystemConfiguration_diskIopsConfiguration :: Lens' OpenZFSFileSystemConfiguration (Maybe DiskIopsConfiguration) Source #
Undocumented member.
openZFSFileSystemConfiguration_rootVolumeId :: Lens' OpenZFSFileSystemConfiguration (Maybe Text) Source #
The ID of the root volume of the OpenZFS file system.
openZFSFileSystemConfiguration_throughputCapacity :: Lens' OpenZFSFileSystemConfiguration (Maybe Natural) Source #
The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).
openZFSFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' OpenZFSFileSystemConfiguration (Maybe Text) Source #
Undocumented member.
OpenZFSNfsExport
data OpenZFSNfsExport Source #
The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.
See: newOpenZFSNfsExport
smart constructor.
OpenZFSNfsExport' | |
|
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.
openZFSNfsExport_clientConfigurations :: Lens' OpenZFSNfsExport [OpenZFSClientConfiguration] Source #
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.
OpenZFSOriginSnapshotConfiguration' | |
|
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.
openZFSOriginSnapshotConfiguration_copyStrategy :: Lens' OpenZFSOriginSnapshotConfiguration (Maybe OpenZFSCopyStrategy) Source #
The strategy used when copying data from the snapshot to the new volume.
CLONE
- The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.FULL_COPY
- Copies all data from the snapshot to the new volume.
openZFSOriginSnapshotConfiguration_snapshotARN :: Lens' OpenZFSOriginSnapshotConfiguration (Maybe Text) Source #
Undocumented member.
OpenZFSUserOrGroupQuota
data OpenZFSUserOrGroupQuota Source #
The configuration for how much storage a user or group can use on the volume.
See: newOpenZFSUserOrGroupQuota
smart constructor.
OpenZFSUserOrGroupQuota' | |
|
Instances
newOpenZFSUserOrGroupQuota Source #
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).
openZFSUserOrGroupQuota_type :: Lens' OpenZFSUserOrGroupQuota OpenZFSQuotaType Source #
A value that specifies whether the quota applies to a user or group.
openZFSUserOrGroupQuota_id :: Lens' OpenZFSUserOrGroupQuota Natural Source #
The ID of the user or group.
openZFSUserOrGroupQuota_storageCapacityQuotaGiB :: Lens' OpenZFSUserOrGroupQuota Natural Source #
The amount of storage that the user or group can use in gibibytes (GiB).
OpenZFSVolumeConfiguration
data OpenZFSVolumeConfiguration Source #
The configuration of an Amazon FSx for OpenZFS volume.
See: newOpenZFSVolumeConfiguration
smart constructor.
OpenZFSVolumeConfiguration' | |
|
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.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
$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
.
openZFSVolumeConfiguration_copyTagsToSnapshots :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the volume should be copied
to snapshots. This value defaults to false
. If it's set to true
,
all tags for the volume are copied to snapshots where the user doesn't
specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or
more tags when creating the snapshot, no tags are copied from the
volume, regardless of this value.
openZFSVolumeConfiguration_dataCompressionType :: Lens' OpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #
Specifies the method used to compress the data on the volume. The
compression type is NONE
by default.
NONE
- Doesn't compress the data on the volume.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
openZFSVolumeConfiguration_deleteClonedVolumes :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.
openZFSVolumeConfiguration_deleteIntermediateSnaphots :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.
openZFSVolumeConfiguration_nfsExports :: Lens' OpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #
The configuration object for mounting a Network File System (NFS) file system.
openZFSVolumeConfiguration_originSnapshot :: Lens' OpenZFSVolumeConfiguration (Maybe OpenZFSOriginSnapshotConfiguration) Source #
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
openZFSVolumeConfiguration_parentVolumeId :: Lens' OpenZFSVolumeConfiguration (Maybe Text) Source #
The ID of the parent volume.
openZFSVolumeConfiguration_readOnly :: Lens' OpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether the volume is read-only.
openZFSVolumeConfiguration_recordSizeKiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural) Source #
The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the /Amazon FSx for OpenZFS User Guide/.
openZFSVolumeConfiguration_restoreToSnapshot :: Lens' OpenZFSVolumeConfiguration (Maybe Text) Source #
Specifies the ID of the snapshot to which the volume was restored.
openZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural) Source #
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
openZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' OpenZFSVolumeConfiguration (Maybe Natural) Source #
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
openZFSVolumeConfiguration_userAndGroupQuotas :: Lens' OpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #
An object specifying how much storage users or groups can use on the volume.
openZFSVolumeConfiguration_volumePath :: Lens' OpenZFSVolumeConfiguration (Maybe Text) Source #
The path to the volume from the root volume. For example,
fsx/parentVolume/volume1
.
S3DataRepositoryConfiguration
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.
S3DataRepositoryConfiguration' | |
|
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.
s3DataRepositoryConfiguration_autoExportPolicy :: Lens' S3DataRepositoryConfiguration (Maybe AutoExportPolicy) Source #
Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.
s3DataRepositoryConfiguration_autoImportPolicy :: Lens' S3DataRepositoryConfiguration (Maybe AutoImportPolicy) Source #
Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.
SelfManagedActiveDirectoryAttributes
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.
SelfManagedActiveDirectoryAttributes' | |
|
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.
selfManagedActiveDirectoryAttributes_dnsIps :: Lens' SelfManagedActiveDirectoryAttributes (Maybe (NonEmpty Text)) Source #
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
selfManagedActiveDirectoryAttributes_domainName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #
The fully qualified domain name of the self-managed AD directory.
selfManagedActiveDirectoryAttributes_fileSystemAdministratorsGroup :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #
The name of the domain group whose members have administrative privileges for the FSx file system.
selfManagedActiveDirectoryAttributes_organizationalUnitDistinguishedName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #
The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
selfManagedActiveDirectoryAttributes_userName :: Lens' SelfManagedActiveDirectoryAttributes (Maybe Text) Source #
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
SelfManagedActiveDirectoryConfiguration
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.
SelfManagedActiveDirectoryConfiguration' | |
|
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.
selfManagedActiveDirectoryConfiguration_fileSystemAdministratorsGroup :: Lens' SelfManagedActiveDirectoryConfiguration (Maybe Text) Source #
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
selfManagedActiveDirectoryConfiguration_organizationalUnitDistinguishedName :: Lens' SelfManagedActiveDirectoryConfiguration (Maybe Text) Source #
(Optional) The fully qualified distinguished name of the organizational
unit within your self-managed AD directory. Amazon FSx only accepts OU
as the direct parent of the file system. An example is
OU=FSx,DC=yourdomain,DC=corp,DC=com
. To learn more, see
RFC 2253. If none is provided, the
FSx file system is created in the default location of your self-managed
AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
selfManagedActiveDirectoryConfiguration_domainName :: Lens' SelfManagedActiveDirectoryConfiguration Text Source #
The fully qualified domain name of the self-managed AD directory, such
as corp.example.com
.
selfManagedActiveDirectoryConfiguration_userName :: Lens' SelfManagedActiveDirectoryConfiguration Text Source #
The user name for the service account on your self-managed AD domain
that Amazon FSx will use to join to your AD domain. This account must
have the permission to join computers to the domain in the
organizational unit provided in OrganizationalUnitDistinguishedName
,
or in the default location of your AD domain.
selfManagedActiveDirectoryConfiguration_password :: Lens' SelfManagedActiveDirectoryConfiguration Text Source #
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
selfManagedActiveDirectoryConfiguration_dnsIps :: Lens' SelfManagedActiveDirectoryConfiguration (NonEmpty Text) Source #
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
SelfManagedActiveDirectoryConfigurationUpdates
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.
SelfManagedActiveDirectoryConfigurationUpdates' | |
|
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
.
selfManagedActiveDirectoryConfigurationUpdates_dnsIps :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe (NonEmpty Text)) Source #
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
selfManagedActiveDirectoryConfigurationUpdates_password :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe Text) Source #
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
selfManagedActiveDirectoryConfigurationUpdates_userName :: Lens' SelfManagedActiveDirectoryConfigurationUpdates (Maybe Text) Source #
The user name for the service account on your self-managed AD domain
that Amazon FSx will use to join to your AD domain. This account must
have the permission to join computers to the domain in the
organizational unit provided in OrganizationalUnitDistinguishedName
.
Snapshot
A snapshot of an Amazon FSx for OpenZFS volume.
See: newSnapshot
smart constructor.
Snapshot' | |
|
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.
snapshot_administrativeActions :: Lens' Snapshot (Maybe [AdministrativeAction]) Source #
A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
snapshot_lifecycle :: Lens' Snapshot (Maybe SnapshotLifecycle) Source #
The lifecycle status of the snapshot.
PENDING
- Amazon FSx hasn't started creating the snapshot.CREATING
- Amazon FSx is creating the snapshot.DELETING
- Amazon FSx is deleting the snapshot.AVAILABLE
- The snapshot is fully available.
snapshot_lifecycleTransitionReason :: Lens' Snapshot (Maybe LifecycleTransitionReason) Source #
Undocumented member.
snapshot_volumeId :: Lens' Snapshot (Maybe Text) Source #
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.
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.
snapshotFilter_name :: Lens' SnapshotFilter (Maybe SnapshotFilterName) Source #
The name of the filter to use. You can filter by the file-system-id
or
by volume-id
.
snapshotFilter_values :: Lens' SnapshotFilter (Maybe [Text]) Source #
The file-system-id
or volume-id
that you are filtering for.
StorageVirtualMachine
data StorageVirtualMachine Source #
Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.
See: newStorageVirtualMachine
smart constructor.
StorageVirtualMachine' | |
|
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).
storageVirtualMachine_activeDirectoryConfiguration :: Lens' StorageVirtualMachine (Maybe SvmActiveDirectoryConfiguration) Source #
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
storageVirtualMachine_creationTime :: Lens' StorageVirtualMachine (Maybe UTCTime) Source #
Undocumented member.
storageVirtualMachine_endpoints :: Lens' StorageVirtualMachine (Maybe SvmEndpoints) Source #
The endpoints that are used to access data or to manage the SVM using
the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the
Iscsi
, Management
, Nfs
, and Smb
endpoints.
storageVirtualMachine_fileSystemId :: Lens' StorageVirtualMachine (Maybe Text) Source #
Undocumented member.
storageVirtualMachine_lifecycle :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineLifecycle) Source #
Describes the SVM's lifecycle status.
CREATED
- The SVM is fully available for use.CREATING
- Amazon FSx is creating the new SVM.DELETING
- Amazon FSx is deleting an existing SVM.FAILED
- Amazon FSx was unable to create the SVM.MISCONFIGURED
- The SVM is in a failed but recoverable state.PENDING
- Amazon FSx has not started creating the SVM.
storageVirtualMachine_lifecycleTransitionReason :: Lens' StorageVirtualMachine (Maybe LifecycleTransitionReason) Source #
Describes why the SVM lifecycle state changed.
storageVirtualMachine_name :: Lens' StorageVirtualMachine (Maybe Text) Source #
The name of the SVM, if provisioned.
storageVirtualMachine_resourceARN :: Lens' StorageVirtualMachine (Maybe Text) Source #
Undocumented member.
storageVirtualMachine_rootVolumeSecurityStyle :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineRootVolumeSecurityStyle) Source #
The security style of the root volume of the SVM.
storageVirtualMachine_storageVirtualMachineId :: Lens' StorageVirtualMachine (Maybe Text) Source #
The SVM's system generated unique ID.
storageVirtualMachine_subtype :: Lens' StorageVirtualMachine (Maybe StorageVirtualMachineSubtype) Source #
Describes the SVM's subtype.
storageVirtualMachine_tags :: Lens' StorageVirtualMachine (Maybe (NonEmpty Tag)) Source #
Undocumented member.
storageVirtualMachine_uuid :: Lens' StorageVirtualMachine (Maybe Text) Source #
The SVM's UUID (universally unique identifier).
StorageVirtualMachineFilter
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.
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.
storageVirtualMachineFilter_name :: Lens' StorageVirtualMachineFilter (Maybe StorageVirtualMachineFilterName) Source #
The name for this filter.
storageVirtualMachineFilter_values :: Lens' StorageVirtualMachineFilter (Maybe [Text]) Source #
The values of the filter. These are all the values for any of the applied filters.
SvmActiveDirectoryConfiguration
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.
SvmActiveDirectoryConfiguration' | |
|
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.
svmActiveDirectoryConfiguration_netBiosName :: Lens' SvmActiveDirectoryConfiguration (Maybe Text) Source #
The NetBIOS name of the Active Directory computer object that is joined to your SVM.
svmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' SvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryAttributes) Source #
Undocumented member.
SvmEndpoint
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.
svmEndpoint_dNSName :: Lens' SvmEndpoint (Maybe Text) Source #
Undocumented member.
svmEndpoint_ipAddresses :: Lens' SvmEndpoint (Maybe (NonEmpty Text)) Source #
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.
SvmEndpoints' | |
|
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.
svmEndpoints_iscsi :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
svmEndpoints_management :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #
An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
svmEndpoints_nfs :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #
An endpoint for connecting using the Network File System (NFS) protocol.
svmEndpoints_smb :: Lens' SvmEndpoints (Maybe SvmEndpoint) Source #
An endpoint for connecting using the Server Message Block (SMB) protocol.
Tag
Specifies a key-value pair for a resource tag.
See: newTag
smart constructor.
Tag' | |
|
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
.
tag_key :: Lens' Tag Text Source #
A value that specifies the TagKey
, the name of the tag. Tag keys must
be unique for the resource to which they are attached.
tag_value :: Lens' Tag Text Source #
A value that specifies the TagValue
, the value assigned to the
corresponding tag key. Tag values can be null and don't have to be
unique in a tag set. For example, you can have a key-value pair in a tag
set of finances : April
and also of payroll : April
.
TieringPolicy
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.
TieringPolicy' | |
|
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.
tieringPolicy_coolingPeriod :: Lens' TieringPolicy (Maybe Natural) Source #
Specifies the number of days that user data in a volume must remain
inactive before it is considered "cold" and moved to the capacity
pool. Used with the AUTO
and SNAPSHOT_ONLY
tiering policies. Enter a
whole number between 2 and 183. Default values are 31 days for AUTO
and 2 days for SNAPSHOT_ONLY
.
tieringPolicy_name :: Lens' TieringPolicy (Maybe TieringPolicyName) Source #
Specifies the tiering policy used to transition data. Default value is
SNAPSHOT_ONLY
.
SNAPSHOT_ONLY
- moves cold snapshots to the capacity pool storage tier.AUTO
- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.ALL
- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.NONE
- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
UpdateFileCacheLustreConfiguration
data UpdateFileCacheLustreConfiguration Source #
The configuration update for an Amazon File Cache resource.
See: newUpdateFileCacheLustreConfiguration
smart constructor.
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.
updateFileCacheLustreConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileCacheLustreConfiguration (Maybe Text) Source #
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.
UpdateFileSystemLustreConfiguration' | |
|
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.
updateFileSystemLustreConfiguration_autoImportPolicy :: Lens' UpdateFileSystemLustreConfiguration (Maybe AutoImportPolicyType) Source #
(Optional) When you create your file system, your existing S3 objects
appear as file and directory listings. Use this property to choose how
Amazon FSx keeps your file and directory listing up to date as you add
or modify objects in your linked S3 bucket. AutoImportPolicy
can have
the following values:
NONE
- (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.NEW
- AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.NEW_CHANGED_DELETED
- AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
The AutoImportPolicy
parameter is not supported for Lustre file
systems with the Persistent_2
deployment type. Instead, use to update
a data repository association on your Persistent_2
file system.
updateFileSystemLustreConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemLustreConfiguration (Maybe Natural) Source #
Undocumented member.
updateFileSystemLustreConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemLustreConfiguration (Maybe Text) Source #
Undocumented member.
updateFileSystemLustreConfiguration_dataCompressionType :: Lens' UpdateFileSystemLustreConfiguration (Maybe DataCompressionType) Source #
Sets the data compression configuration for the file system.
DataCompressionType
can have the following values:
NONE
- Data compression is turned off for the file system.LZ4
- Data compression is turned on with the LZ4 algorithm.
If you don't use DataCompressionType
, the file system retains its
current data compression configuration.
For more information, see Lustre data compression.
updateFileSystemLustreConfiguration_logConfiguration :: Lens' UpdateFileSystemLustreConfiguration (Maybe LustreLogCreateConfiguration) Source #
The Lustre logging configuration used when updating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
updateFileSystemLustreConfiguration_rootSquashConfiguration :: Lens' UpdateFileSystemLustreConfiguration (Maybe LustreRootSquashConfiguration) Source #
The Lustre root squash configuration used when updating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
updateFileSystemLustreConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemLustreConfiguration (Maybe Text) Source #
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
UpdateFileSystemOntapConfiguration
data UpdateFileSystemOntapConfiguration Source #
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
See: newUpdateFileSystemOntapConfiguration
smart constructor.
UpdateFileSystemOntapConfiguration' | |
|
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.
updateFileSystemOntapConfiguration_addRouteTableIds :: Lens' UpdateFileSystemOntapConfiguration (Maybe [Text]) Source #
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
updateFileSystemOntapConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemOntapConfiguration (Maybe Natural) Source #
Undocumented member.
updateFileSystemOntapConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text) Source #
Undocumented member.
updateFileSystemOntapConfiguration_diskIopsConfiguration :: Lens' UpdateFileSystemOntapConfiguration (Maybe DiskIopsConfiguration) Source #
The SSD IOPS (input/output operations per second) configuration for an
Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of
storage capacity, but you can provision additional IOPS per GB of
storage. The configuration consists of an IOPS mode (AUTOMATIC
or
USER_PROVISIONED
), and in the case of USER_PROVISIONED
IOPS, the
total number of SSD IOPS provisioned.
updateFileSystemOntapConfiguration_fsxAdminPassword :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text) Source #
The ONTAP administrative password for the fsxadmin
user.
updateFileSystemOntapConfiguration_removeRouteTableIds :: Lens' UpdateFileSystemOntapConfiguration (Maybe [Text]) Source #
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
updateFileSystemOntapConfiguration_throughputCapacity :: Lens' UpdateFileSystemOntapConfiguration (Maybe Natural) Source #
Specifies the throughput of an FSx for NetApp ONTAP file system, measured in megabytes per second (MBps). Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
updateFileSystemOntapConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemOntapConfiguration (Maybe Text) Source #
Undocumented member.
UpdateFileSystemOpenZFSConfiguration
data UpdateFileSystemOpenZFSConfiguration Source #
The configuration updates for an Amazon FSx for OpenZFS file system.
See: newUpdateFileSystemOpenZFSConfiguration
smart constructor.
UpdateFileSystemOpenZFSConfiguration' | |
|
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.
updateFileSystemOpenZFSConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Natural) Source #
Undocumented member.
updateFileSystemOpenZFSConfiguration_copyTagsToBackups :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the file system should be
copied to backups. This value defaults to false
. If it's set to
true
, all tags for the file system are copied to all automatic and
user-initiated backups where the user doesn't specify tags. If this
value is true
and you specify one or more tags, only the specified
tags are copied to backups. If you specify one or more tags when
creating a user-initiated backup, no tags are copied from the file
system, regardless of this value.
updateFileSystemOpenZFSConfiguration_copyTagsToVolumes :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Bool) Source #
A Boolean value indicating whether tags for the volume should be copied
to snapshots. This value defaults to false
. If it's set to true
,
all tags for the volume are copied to snapshots where the user doesn't
specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or
more tags when creating the snapshot, no tags are copied from the
volume, regardless of this value.
updateFileSystemOpenZFSConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Text) Source #
Undocumented member.
updateFileSystemOpenZFSConfiguration_diskIopsConfiguration :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe DiskIopsConfiguration) Source #
Undocumented member.
updateFileSystemOpenZFSConfiguration_throughputCapacity :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Natural) Source #
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
- For
SINGLE_AZ_1
, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. - For
SINGLE_AZ_2
, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
updateFileSystemOpenZFSConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemOpenZFSConfiguration (Maybe Text) Source #
Undocumented member.
UpdateFileSystemWindowsConfiguration
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.
UpdateFileSystemWindowsConfiguration' | |
|
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.
updateFileSystemWindowsConfiguration_auditLogConfiguration :: Lens' UpdateFileSystemWindowsConfiguration (Maybe WindowsAuditLogCreateConfiguration) Source #
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system..
updateFileSystemWindowsConfiguration_automaticBackupRetentionDays :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Natural) Source #
The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups.
updateFileSystemWindowsConfiguration_dailyAutomaticBackupStartTime :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Text) Source #
The preferred time to start the daily automatic backup, in the UTC time
zone, for example, 02:00
updateFileSystemWindowsConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' UpdateFileSystemWindowsConfiguration (Maybe SelfManagedActiveDirectoryConfigurationUpdates) Source #
The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.
updateFileSystemWindowsConfiguration_throughputCapacity :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Natural) Source #
Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.
updateFileSystemWindowsConfiguration_weeklyMaintenanceStartTime :: Lens' UpdateFileSystemWindowsConfiguration (Maybe Text) Source #
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.
UpdateOntapVolumeConfiguration
data UpdateOntapVolumeConfiguration Source #
Used to specify changes to the ONTAP configuration for the volume you are updating.
See: newUpdateOntapVolumeConfiguration
smart constructor.
UpdateOntapVolumeConfiguration' | |
|
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 thedefault
policy except that it only retains one snapshot from the weekly schedule.none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
$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.
updateOntapVolumeConfiguration_copyTagsToBackups :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool) Source #
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
updateOntapVolumeConfiguration_junctionPath :: Lens' UpdateOntapVolumeConfiguration (Maybe Text) Source #
Specifies the location in the SVM's namespace where the volume is
mounted. The JunctionPath
must have a leading forward slash, such as
/vol3
.
updateOntapVolumeConfiguration_securityStyle :: Lens' UpdateOntapVolumeConfiguration (Maybe SecurityStyle) Source #
The security style for the volume, which can be UNIX
. NTFS
, or
MIXED
.
updateOntapVolumeConfiguration_sizeInMegabytes :: Lens' UpdateOntapVolumeConfiguration (Maybe Natural) Source #
Specifies the size of the volume in megabytes.
updateOntapVolumeConfiguration_snapshotPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe Text) Source #
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule.none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
updateOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool) Source #
Default is false
. Set to true to enable the deduplication,
compression, and compaction storage efficiency features on the volume.
updateOntapVolumeConfiguration_tieringPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe TieringPolicy) Source #
Update the volume's data tiering policy.
UpdateOpenZFSVolumeConfiguration
data UpdateOpenZFSVolumeConfiguration Source #
Used to specify changes to the OpenZFS configuration for the volume that you are updating.
See: newUpdateOpenZFSVolumeConfiguration
smart constructor.
UpdateOpenZFSVolumeConfiguration' | |
|
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.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
$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.
updateOpenZFSVolumeConfiguration_dataCompressionType :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe OpenZFSDataCompressionType) Source #
Specifies the method used to compress the data on the volume. The
compression type is NONE
by default.
NONE
- Doesn't compress the data on the volume.NONE
is the default.ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
updateOpenZFSVolumeConfiguration_nfsExports :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSNfsExport]) Source #
The configuration object for mounting a Network File System (NFS) file system.
updateOpenZFSVolumeConfiguration_readOnly :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Bool) Source #
A Boolean value indicating whether the volume is read-only.
updateOpenZFSVolumeConfiguration_recordSizeKiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Natural) Source #
Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
updateOpenZFSVolumeConfiguration_storageCapacityQuotaGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int) Source #
The maximum amount of storage in gibibytes (GiB) that the volume can use
from its parent. You can specify a quota larger than the storage on the
parent volume. You can specify a value of -1
to unset a volume's
storage capacity quota.
updateOpenZFSVolumeConfiguration_storageCapacityReservationGiB :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe Int) Source #
The amount of storage in gibibytes (GiB) to reserve from the parent
volume. You can't reserve more storage than the parent volume has
reserved. You can specify a value of -1
to unset a volume's storage
capacity reservation.
updateOpenZFSVolumeConfiguration_userAndGroupQuotas :: Lens' UpdateOpenZFSVolumeConfiguration (Maybe [OpenZFSUserOrGroupQuota]) Source #
An object specifying how much storage users or groups can use on the volume.
UpdateSvmActiveDirectoryConfiguration
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.
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.
updateSvmActiveDirectoryConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' UpdateSvmActiveDirectoryConfiguration (Maybe SelfManagedActiveDirectoryConfigurationUpdates) Source #
Undocumented member.
Volume
Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
See: newVolume
smart constructor.
Volume' | |
|
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.
volume_administrativeActions :: Lens' Volume (Maybe [AdministrativeAction]) Source #
A list of administrative actions for the volume that are in process or
waiting to be processed. Administrative actions describe changes to the
volume that you have initiated using the UpdateVolume
action.
volume_lifecycle :: Lens' Volume (Maybe VolumeLifecycle) Source #
The lifecycle status of the volume.
AVAILABLE
- The volume is fully available for use.CREATED
- The volume has been created.CREATING
- Amazon FSx is creating the new volume.DELETING
- Amazon FSx is deleting an existing volume.FAILED
- Amazon FSx was unable to create the volume.MISCONFIGURED
- The volume is in a failed but recoverable state.PENDING
- Amazon FSx hasn't started creating the volume.
volume_lifecycleTransitionReason :: Lens' Volume (Maybe LifecycleTransitionReason) Source #
The reason why the volume lifecycle status changed.
volume_ontapConfiguration :: Lens' Volume (Maybe OntapVolumeConfiguration) Source #
Undocumented member.
volume_openZFSConfiguration :: Lens' Volume (Maybe OpenZFSVolumeConfiguration) Source #
The configuration of an Amazon FSx for OpenZFS volume.
volume_volumeType :: Lens' Volume (Maybe VolumeType) Source #
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.
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.
volumeFilter_name :: Lens' VolumeFilter (Maybe VolumeFilterName) Source #
The name for this filter.
volumeFilter_values :: Lens' VolumeFilter (Maybe [Text]) Source #
The values of the filter. These are all the values for any of the applied filters.
WindowsAuditLogConfiguration
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.
WindowsAuditLogConfiguration' | |
|
Instances
newWindowsAuditLogConfiguration Source #
:: 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.
windowsAuditLogConfiguration_auditLogDestination :: Lens' WindowsAuditLogConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.
The name of the Amazon CloudWatch Logs log group must begin with the
/aws/fsx
prefix. The name of the Amazon Kinesis Data Firehouse
delivery stream must begin with the aws-fsx
prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
windowsAuditLogConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogConfiguration WindowsAccessAuditLogLevel Source #
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY
- only successful attempts to access files or folders are logged.FAILURE_ONLY
- only failed attempts to access files or folders are logged.SUCCESS_AND_FAILURE
- both successful attempts and failed attempts to access files or folders are logged.DISABLED
- access auditing of files and folders is turned off.
windowsAuditLogConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogConfiguration WindowsAccessAuditLogLevel Source #
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY
- only successful attempts to access file shares are logged.FAILURE_ONLY
- only failed attempts to access file shares are logged.SUCCESS_AND_FAILURE
- both successful attempts and failed attempts to access file shares are logged.DISABLED
- access auditing of file shares is turned off.
WindowsAuditLogCreateConfiguration
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.
WindowsAuditLogCreateConfiguration' | |
|
Instances
newWindowsAuditLogCreateConfiguration Source #
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/fsx
prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with theaws-fsx
prefix. - If you do not provide a destination in
AuditLogDestination
, Amazon FSx will create and use a log stream in the CloudWatch Logs/aws/fsx/windows
log group. - If
AuditLogDestination
is provided and the resource does not exist, the request will fail with aBadRequest
error. - If
FileAccessAuditLogLevel
andFileShareAccessAuditLogLevel
are 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.
windowsAuditLogCreateConfiguration_auditLogDestination :: Lens' WindowsAuditLogCreateConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:
- The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
- The name of the Amazon CloudWatch Logs log group must begin with the
/aws/fsx
prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with theaws-fsx
prefix. - If you do not provide a destination in
AuditLogDestination
, Amazon FSx will create and use a log stream in the CloudWatch Logs/aws/fsx/windows
log group. - If
AuditLogDestination
is provided and the resource does not exist, the request will fail with aBadRequest
error. - If
FileAccessAuditLogLevel
andFileShareAccessAuditLogLevel
are both set toDISABLED
, you cannot specify a destination inAuditLogDestination
.
windowsAuditLogCreateConfiguration_fileAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel Source #
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY
- only successful attempts to access files or folders are logged.FAILURE_ONLY
- only failed attempts to access files or folders are logged.SUCCESS_AND_FAILURE
- both successful attempts and failed attempts to access files or folders are logged.DISABLED
- access auditing of files and folders is turned off.
windowsAuditLogCreateConfiguration_fileShareAccessAuditLogLevel :: Lens' WindowsAuditLogCreateConfiguration WindowsAccessAuditLogLevel Source #
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY
- only successful attempts to access file shares are logged.FAILURE_ONLY
- only failed attempts to access file shares are logged.SUCCESS_AND_FAILURE
- both successful attempts and failed attempts to access file shares are logged.DISABLED
- access auditing of file shares is turned off.
WindowsFileSystemConfiguration
data WindowsFileSystemConfiguration Source #
The configuration for this Microsoft Windows file system.
See: newWindowsFileSystemConfiguration
smart constructor.
WindowsFileSystemConfiguration' | |
|
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.
windowsFileSystemConfiguration_activeDirectoryId :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
windowsFileSystemConfiguration_aliases :: Lens' WindowsFileSystemConfiguration (Maybe [Alias]) Source #
Undocumented member.
windowsFileSystemConfiguration_auditLogConfiguration :: Lens' WindowsFileSystemConfiguration (Maybe WindowsAuditLogConfiguration) Source #
The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
windowsFileSystemConfiguration_automaticBackupRetentionDays :: Lens' WindowsFileSystemConfiguration (Maybe Natural) Source #
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
windowsFileSystemConfiguration_copyTagsToBackups :: Lens' WindowsFileSystemConfiguration (Maybe Bool) Source #
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
windowsFileSystemConfiguration_dailyAutomaticBackupStartTime :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #
The preferred time to take daily automatic backups, in the UTC time zone.
windowsFileSystemConfiguration_deploymentType :: Lens' WindowsFileSystemConfiguration (Maybe WindowsDeploymentType) Source #
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1
- Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.SINGLE_AZ_1
- (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.SINGLE_AZ_2
- Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems.
windowsFileSystemConfiguration_maintenanceOperationsInProgress :: Lens' WindowsFileSystemConfiguration (Maybe [FileSystemMaintenanceOperation]) Source #
The list of maintenance operations in progress for this file system.
windowsFileSystemConfiguration_preferredFileServerIp :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #
For MULTI_AZ_1
deployment types, the IP address of the primary, or
preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.
windowsFileSystemConfiguration_preferredSubnetId :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #
For MULTI_AZ_1
deployment types, it specifies the ID of the subnet
where the preferred file server is located. Must be one of the two
subnet IDs specified in SubnetIds
property. Amazon FSx serves traffic
from this subnet except in the event of a failover to the secondary file
server.
For SINGLE_AZ_1
and SINGLE_AZ_2
deployment types, this value is the
same as that for SubnetIDs
. For more information, see
Availability and durability: Single-AZ and Multi-AZ file systems.
windowsFileSystemConfiguration_remoteAdministrationEndpoint :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #
For MULTI_AZ_1
deployment types, use this endpoint when performing
administrative tasks on the file system using Amazon FSx Remote
PowerShell.
For SINGLE_AZ_1
and SINGLE_AZ_2
deployment types, this is the DNS
name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
windowsFileSystemConfiguration_selfManagedActiveDirectoryConfiguration :: Lens' WindowsFileSystemConfiguration (Maybe SelfManagedActiveDirectoryAttributes) Source #
Undocumented member.
windowsFileSystemConfiguration_throughputCapacity :: Lens' WindowsFileSystemConfiguration (Maybe Natural) Source #
The throughput of the Amazon FSx file system, measured in megabytes per second.
windowsFileSystemConfiguration_weeklyMaintenanceStartTime :: Lens' WindowsFileSystemConfiguration (Maybe Text) Source #
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.