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

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

Overview

Note:

When making an API call, you may pass UpdateFileSystemRequest data as a hash:

{
  file_system_id: "FileSystemId", # required
  client_request_token: "ClientRequestToken",
  storage_capacity: 1,
  windows_configuration: {
    weekly_maintenance_start_time: "WeeklyTime",
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    throughput_capacity: 1,
    self_managed_active_directory_configuration: {
      user_name: "DirectoryUserName",
      password: "DirectoryPassword",
      dns_ips: ["IpAddress"],
    },
    audit_log_configuration: {
      file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
      file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
      audit_log_destination: "GeneralARN",
    },
  },
  lustre_configuration: {
    weekly_maintenance_start_time: "WeeklyTime",
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED, NEW_CHANGED_DELETED
    data_compression_type: "NONE", # accepts NONE, LZ4
    log_configuration: {
      level: "DISABLED", # required, accepts DISABLED, WARN_ONLY, ERROR_ONLY, WARN_ERROR
      destination: "GeneralARN",
    },
  },
  ontap_configuration: {
    automatic_backup_retention_days: 1,
    daily_automatic_backup_start_time: "DailyTime",
    fsx_admin_password: "AdminPassword",
    weekly_maintenance_start_time: "WeeklyTime",
    disk_iops_configuration: {
      mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
      iops: 1,
    },
  },
  open_zfs_configuration: {
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    copy_tags_to_volumes: false,
    daily_automatic_backup_start_time: "DailyTime",
    throughput_capacity: 1,
    weekly_maintenance_start_time: "WeeklyTime",
    disk_iops_configuration: {
      mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
      iops: 1,
    },
  },
}

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 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.

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

Returns:

  • (String)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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

#file_system_idString

The ID of the file system that you are updating.

Returns:

  • (String)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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

#lustre_configurationTypes::UpdateFileSystemLustreConfiguration

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



7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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

#ontap_configurationTypes::UpdateFileSystemOntapConfiguration

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



7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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

#open_zfs_configurationTypes::UpdateFileSystemOpenZFSConfiguration

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



7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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

#storage_capacityInteger

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.

Returns:

  • (Integer)


7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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

#windows_configurationTypes::UpdateFileSystemWindowsConfiguration

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



7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7816

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