Class: Aws::FSx::Types::AdministrativeAction

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

Overview

Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#administrative_action_type ⇒ String

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.

    • For Windows, storage optimization is the process of migrating the file system data to the new, 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. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .

Returns:

  • (String) 


168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end

#failure_details ⇒ Types::AdministrativeActionFailureDetails

Provides information about a failed administrative action.

Returns:



168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end

#progress_percent ⇒ Integer

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.

Returns:

  • (Integer) 


168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end

#request_time ⇒ Time

Time that the administrative action request was received.

Returns:

  • (Time) 


168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

Returns:

  • (String) 


168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end

#target_file_system_values ⇒ Types::FileSystem

Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

Returns:



168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end

#target_volume_values ⇒ Types::Volume

Describes an Amazon FSx for NetApp ONTAP volume.

Returns:



168
169
170
171
172
173
174
175
176
177
178
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 168

class AdministrativeAction < Struct.new(
  :administrative_action_type,
  :progress_percent,
  :request_time,
  :status,
  :target_file_system_values,
  :failure_details,
  :target_volume_values)
  SENSITIVE = []
  include Aws::Structure
end