Class: Aws::FSx::Types::Backup

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

Overview

A backup of an Amazon FSx for file system.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The ID of the backup.

Returns:

  • (String)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The time when a particular backup was created.

Returns:

  • (Time)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#directory_informationTypes::ActiveDirectoryBackupAttributes

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#failure_detailsTypes::BackupFailureDetails

Details explaining any failures that occur when creating a backup.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#file_systemTypes::FileSystem

Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

Returns:

  • (String)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycleString

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • CREATING - FSx is creating the backup.

  • TRANSFERRING - For Lustre file systems only; FSx is transferring the backup to S3.

  • DELETED - The backup was deleted is no longer available.

  • FAILED - Amazon FSx could not complete the backup.

Returns:

  • (String)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#progress_percentInteger

The current percent of progress of an asynchronous task.

Returns:

  • (Integer)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

The Amazon Resource Name (ARN) for the backup resource.

Returns:

  • (String)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags associated with a particular file system.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the file system backup.

Returns:

  • (String)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 216

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  SENSITIVE = []
  include Aws::Structure
end