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

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::Backup

Defined in:

(unknown)

Overview

A backup of an Amazon FSx for file system.

Returned by:

• CreateBackupResponse#backup

See Also:

• AWS API Documentation

Instance Attribute Summary

• #backup_id ⇒ String

  The ID of the backup.

• #creation_time ⇒ Time

  The time when a particular backup was created.

• #directory_information ⇒ Types::ActiveDirectoryBackupAttributes

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

• #failure_details ⇒ Types::BackupFailureDetails

  Details explaining any failures that occur when creating a backup.

• #file_system ⇒ Types::FileSystem

  Metadata of the file system associated with the backup.

• #kms_key_id ⇒ String

  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.

• #lifecycle ⇒ String

  The lifecycle status of the backup.

• #progress_percent ⇒ Integer

  The current percent of progress of an asynchronous task.

  .

• #resource_arn ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  Tags associated with a particular file system.

• #type ⇒ String

  The type of the file system backup.

Instance Attribute Details

#backup_id ⇒ String

The ID of the backup.

Returns:

• (String) —

  The ID of the backup.

#creation_time ⇒ Time

The time when a particular backup was created.

Returns:

• (Time) —

  The time when a particular backup was created.

#directory_information ⇒ Types::ActiveDirectoryBackupAttributes

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

Returns:

• (Types::ActiveDirectoryBackupAttributes) —

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

#failure_details ⇒ Types::BackupFailureDetails

Details explaining any failures that occur when creating a backup.

Returns:

• (Types::BackupFailureDetails) —

  Details explaining any failures that occur when creating a backup.

#file_system ⇒ Types::FileSystem

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

Returns:

• (Types::FileSystem) —

  Metadata of the file system associated with the backup.

#kms_key_id ⇒ String

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) —

  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.

#lifecycle ⇒ String

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.

  Possible values:

  • AVAILABLE
  • CREATING
  • TRANSFERRING
  • DELETED
  • FAILED

Returns:

• (String) —

  The lifecycle status of the backup.

#progress_percent ⇒ Integer

The current percent of progress of an asynchronous task.

Returns:

• (Integer) —

  The current percent of progress of an asynchronous task.

  .

#resource_arn ⇒ String

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

Returns:

• (String) —

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

#tags ⇒ Array<Types::Tag>

Tags associated with a particular file system.

Returns:

• (Array<Types::Tag>) —

  Tags associated with a particular file system.

#type ⇒ String

The type of the file system backup.

Possible values:

• AUTOMATIC
• USER_INITIATED
• AWS_BACKUP

Returns:

• (String) —

  The type of the file system backup.