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 Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The ID of the backup.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#creation_timeTime

The time when a particular backup was created.

Returns:

  • (Time)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information,
  :owner_id,
  :source_backup_id,
  :source_backup_region,
  :resource_type,
  :volume)
  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.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#failure_detailsTypes::BackupFailureDetails

Details explaining any failures that occur when creating a backup.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information,
  :owner_id,
  :source_backup_id,
  :source_backup_region,
  :resource_type,
  :volume)
  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:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#kms_key_idString

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

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#lifecycleString

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

  • CREATING - Amazon FSx is creating the backup.

  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.

  • COPYING - Amazon FSx is copying the backup.

  • DELETED - Amazon FSx deleted the backup and it is no longer available.

  • FAILED - Amazon FSx could not complete the backup.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#owner_idString

An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#progress_percentInteger

The current percent of progress of an asynchronous task.

Returns:

  • (Integer)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#resource_arnString

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

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#resource_typeString

Specifies the resource type that is backed up.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#source_backup_idString

The ID of the source backup. Specifies the backup you are copying.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#source_backup_regionString

The source Region of the backup. Specifies the Region from where this backup is copied.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#tagsArray<Types::Tag>

Tags associated with a particular file system.

Returns:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#typeString

The type of the file system backup.

Returns:

  • (String)


421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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

#volumeTypes::Volume

Describes an Amazon FSx for NetApp ONTAP volume.

Returns:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 421

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