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

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::UpdateFileSystemRequest

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

The request object for the ‘UpdateFileSystem` operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates.

• #file_system_id ⇒ String

  The ID of the file system that you are updating.

• #file_system_type_version ⇒ String

  The Lustre version you are updating an FSx for Lustre file system to.

• #lustre_configuration ⇒ Types::UpdateFileSystemLustreConfiguration

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

• #network_type ⇒ String

  Changes the network type of an FSx for OpenZFS file system.

• #ontap_configuration ⇒ Types::UpdateFileSystemOntapConfiguration

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

• #open_zfs_configuration ⇒ Types::UpdateFileSystemOpenZFSConfiguration

  The configuration updates for an FSx for OpenZFS file system.

• #storage_capacity ⇒ Integer

  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.

• #storage_type ⇒ String

  Specifies the file system’s storage type.

• #windows_configuration ⇒ Types::UpdateFileSystemWindowsConfiguration

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

Instance Attribute Details

#client_request_token ⇒ String

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)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#file_system_id ⇒ String

The ID of the file system that you are updating.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#file_system_type_version ⇒ String

The Lustre version you are updating an FSx for Lustre file system to. Valid values are ‘2.12` and `2.15`. The value you choose must be newer than the file system’s current Lustre version.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#lustre_configuration ⇒ Types::UpdateFileSystemLustreConfiguration

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

Returns:

• (Types::UpdateFileSystemLustreConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#network_type ⇒ String

Changes the network type of an FSx for OpenZFS file system.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#ontap_configuration ⇒ Types::UpdateFileSystemOntapConfiguration

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

Returns:

• (Types::UpdateFileSystemOntapConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#open_zfs_configuration ⇒ Types::UpdateFileSystemOpenZFSConfiguration

The configuration updates for an FSx for OpenZFS file system.

Returns:

• (Types::UpdateFileSystemOpenZFSConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#storage_capacity ⇒ Integer

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. For second-generation FSx for ONTAP file systems, you can also decrease the storage capacity. Specifies the storage capacity target value, in GiB, 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, when increasing storage capacity, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. When decreasing storage capacity on second-generation file systems, the target value must be at least 9 percent smaller than the current SSD storage capacity. For more information, see [File system storage capacity and 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/storage-capacity-and-IOPS.html

Returns:

• (Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#storage_type ⇒ String

Specifies the file system’s storage type.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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

#windows_configuration ⇒ Types::UpdateFileSystemWindowsConfiguration

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

Returns:

• (Types::UpdateFileSystemWindowsConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 10364

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