Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.UpdateFileSystem

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.

For Amazon FSx for Windows File Server file systems, you can update the following properties:

```
AuditLogConfiguration
```
```
AutomaticBackupRetentionDays
```
```
DailyAutomaticBackupStartTime
```
```
SelfManagedActiveDirectoryConfiguration
```
```
StorageCapacity
```
```
ThroughputCapacity
```
```
WeeklyMaintenanceStartTime
```

For Amazon FSx for Lustre file systems, you can update the following properties:

```
AutoImportPolicy
```
```
AutomaticBackupRetentionDays
```
```
DailyAutomaticBackupStartTime
```
```
DataCompressionType
```
```
LustreRootSquashConfiguration
```
```
StorageCapacity
```
```
WeeklyMaintenanceStartTime
```

For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:

```
AutomaticBackupRetentionDays
```
```
DailyAutomaticBackupStartTime
```
```
DiskIopsConfiguration
```
```
FsxAdminPassword
```
```
StorageCapacity
```
```
ThroughputCapacity
```
```
WeeklyMaintenanceStartTime
```

For the Amazon FSx for OpenZFS file systems, you can update the following properties:

```
AutomaticBackupRetentionDays
```
```
CopyTagsToBackups
```
```
CopyTagsToVolumes
```
```
DailyAutomaticBackupStartTime
```
```
ThroughputCapacity
```
```
WeeklyMaintenanceStartTime
```

Synopsis

Creating a Request

data UpdateFileSystem Source #

The request object for the UpdateFileSystem operation.

See: newUpdateFileSystem smart constructor.

Constructors

UpdateFileSystem'

Fields

clientRequestToken :: Maybe Text
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
lustreConfiguration :: Maybe UpdateFileSystemLustreConfiguration
ontapConfiguration :: Maybe UpdateFileSystemOntapConfiguration
openZFSConfiguration :: Maybe UpdateFileSystemOpenZFSConfiguration
The configuration updates for an Amazon FSx for OpenZFS file system.
storageCapacity :: Maybe Natural
Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server, Amazon FSx for Lustre, or Amazon FSx for NetApp ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.
You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide.
For Lustre file systems, the storage capacity target value can be the following:
- For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
- For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.
- For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.
For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
windowsConfiguration :: Maybe UpdateFileSystemWindowsConfiguration
The configuration updates for an Amazon FSx for Windows File Server file system.
fileSystemId :: Text
The ID of the file system that you are updating.

Instances

Instances details

ToJSON UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods toJSON :: UpdateFileSystem -> Value # toEncoding :: UpdateFileSystem -> Encoding # toJSONList :: [UpdateFileSystem] -> Value # toEncodingList :: [UpdateFileSystem] -> Encoding #
ToHeaders UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods toHeaders :: UpdateFileSystem -> [Header] #
ToPath UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods toPath :: UpdateFileSystem -> ByteString #
ToQuery UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods toQuery :: UpdateFileSystem -> QueryString #
AWSRequest UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Associated Types type AWSResponse UpdateFileSystem # Methods request :: (Service -> Service) -> UpdateFileSystem -> Request UpdateFileSystem # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateFileSystem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFileSystem))) #
Generic UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Associated Types type Rep UpdateFileSystem :: Type -> Type # Methods from :: UpdateFileSystem -> Rep UpdateFileSystem x # to :: Rep UpdateFileSystem x -> UpdateFileSystem #
Show UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods showsPrec :: Int -> UpdateFileSystem -> ShowS # show :: UpdateFileSystem -> String # showList :: [UpdateFileSystem] -> ShowS #
NFData UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods rnf :: UpdateFileSystem -> () #
Eq UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods (==) :: UpdateFileSystem -> UpdateFileSystem -> Bool # (/=) :: UpdateFileSystem -> UpdateFileSystem -> Bool #
Hashable UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods hashWithSalt :: Int -> UpdateFileSystem -> Int # hash :: UpdateFileSystem -> Int #
type AWSResponse UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem type AWSResponse UpdateFileSystem = UpdateFileSystemResponse
type Rep UpdateFileSystem Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem type Rep UpdateFileSystem = D1 ('MetaData "UpdateFileSystem" "Amazonka.FSx.UpdateFileSystem" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "UpdateFileSystem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lustreConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateFileSystemLustreConfiguration)) :: S1 ('MetaSel ('Just "ontapConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateFileSystemOntapConfiguration)))) :: ((S1 ('MetaSel ('Just "openZFSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateFileSystemOpenZFSConfiguration)) :: S1 ('MetaSel ('Just "storageCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "windowsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateFileSystemWindowsConfiguration)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateFileSystem Source #

Arguments

:: Text	`UpdateFileSystem`
-> UpdateFileSystem

Create a value of UpdateFileSystem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

UpdateFileSystem, updateFileSystem_lustreConfiguration - Undocumented member.

UpdateFileSystem, updateFileSystem_ontapConfiguration - Undocumented member.

UpdateFileSystem, updateFileSystem_openZFSConfiguration - The configuration updates for an Amazon FSx for OpenZFS file system.

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

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

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

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

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

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

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

UpdateFileSystem, updateFileSystem_windowsConfiguration - The configuration updates for an Amazon FSx for Windows File Server file system.

UpdateFileSystem, updateFileSystem_fileSystemId - The ID of the file system that you are updating.

Request Lenses

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

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

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

Undocumented member.

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

Undocumented member.

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

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

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

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

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

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

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

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

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

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

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

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

updateFileSystem_fileSystemId :: Lens' UpdateFileSystem Text Source #

The ID of the file system that you are updating.

Destructuring the Response

data UpdateFileSystemResponse Source #

The response object for the UpdateFileSystem operation.

See: newUpdateFileSystemResponse smart constructor.

Constructors

UpdateFileSystemResponse'
Fields fileSystem :: Maybe FileSystem A description of the file system that was updated. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateFileSystemResponse Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Associated Types type Rep UpdateFileSystemResponse :: Type -> Type # Methods from :: UpdateFileSystemResponse -> Rep UpdateFileSystemResponse x # to :: Rep UpdateFileSystemResponse x -> UpdateFileSystemResponse #
Read UpdateFileSystemResponse Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods readsPrec :: Int -> ReadS UpdateFileSystemResponse # readList :: ReadS [UpdateFileSystemResponse] # readPrec :: ReadPrec UpdateFileSystemResponse # readListPrec :: ReadPrec [UpdateFileSystemResponse] #
Show UpdateFileSystemResponse Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods showsPrec :: Int -> UpdateFileSystemResponse -> ShowS # show :: UpdateFileSystemResponse -> String # showList :: [UpdateFileSystemResponse] -> ShowS #
NFData UpdateFileSystemResponse Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods rnf :: UpdateFileSystemResponse -> () #
Eq UpdateFileSystemResponse Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem Methods (==) :: UpdateFileSystemResponse -> UpdateFileSystemResponse -> Bool # (/=) :: UpdateFileSystemResponse -> UpdateFileSystemResponse -> Bool #
type Rep UpdateFileSystemResponse Source #
Instance details Defined in Amazonka.FSx.UpdateFileSystem type Rep UpdateFileSystemResponse = D1 ('MetaData "UpdateFileSystemResponse" "Amazonka.FSx.UpdateFileSystem" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "UpdateFileSystemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSystem)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateFileSystemResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateFileSystemResponse'`
-> UpdateFileSystemResponse

Create a value of UpdateFileSystemResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateFileSystemResponse, updateFileSystemResponse_fileSystem - A description of the file system that was updated.

$sel:httpStatus:UpdateFileSystemResponse', updateFileSystemResponse_httpStatus - The response's http status code.

Response Lenses

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

A description of the file system that was updated.

updateFileSystemResponse_httpStatus :: Lens' UpdateFileSystemResponse Int Source #

The response's http status code.