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, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The ID of the backup.

Returns:

  • (String)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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 directory to which the Windows File Server instance is joined.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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 occurred when creating a backup.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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

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

Returns:



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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 hasn't 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 Amazon S3.

  • COPYING - Amazon FSx is copying the backup.

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

  • FAILED - Amazon FSx couldn't finish the backup.

Returns:

  • (String)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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

Displays the current percent of progress of an asynchronous task.

Returns:

  • (Integer)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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's backed up.

Returns:

  • (String)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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 that you are copying.

Returns:

  • (String)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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>

The tags associated with a particular file system.

Returns:



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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)


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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 or Amazon FSx for OpenZFS volume.

Returns:



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 579

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