Class: Aws::FSx::Types::UpdateFileSystemRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

The request object for the ‘UpdateFileSystem` operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A string of up to 63 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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

The ID of the file system that you are updating.

Returns:

  • (String)


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configurationTypes::UpdateFileSystemLustreConfiguration

The configuration object for Amazon FSx for Lustre file systems used in the ‘UpdateFileSystem` operation.



9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_configurationTypes::UpdateFileSystemOntapConfiguration

The configuration updates for an Amazon FSx for NetApp ONTAP file system.



9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configurationTypes::UpdateFileSystemOpenZFSConfiguration

The configuration updates for an FSx for OpenZFS file system.



9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacityInteger

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

<note markdown=“1”> You can’t make a storage capacity increase request if there is an existing storage capacity increase request in progress.

</note>

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 *FSx for Lustre User Guide*.

For FSx for OpenZFS 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] in the *FSx for OpenZFS User Guide*.

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 FSxfor Windows File Server 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*.

[1]: docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html [2]: docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html [3]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html [4]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html

Returns:

  • (Integer)


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

Specifies the file system’s storage type.

Returns:

  • (String)


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#windows_configurationTypes::UpdateFileSystemWindowsConfiguration

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



9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
# File 'lib/aws-sdk-fsx/types.rb', line 9235

class UpdateFileSystemRequest < Struct.new(
  :file_system_id,
  :client_request_token,
  :storage_capacity,
  :windows_configuration,
  :lustre_configuration,
  :ontap_configuration,
  :open_zfs_configuration,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end