You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A backup of an Amazon FSx for file system.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The ID of the backup.

Returns:

  • (String)

    The ID of the backup.

#creation_timeTime

The time when a particular backup was created.

Returns:

  • (Time)

    The time when a particular backup was created.

#directory_informationTypes::ActiveDirectoryBackupAttributes

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

Returns:

#failure_detailsTypes::BackupFailureDetails

Details explaining any failures that occur when creating a backup.

Returns:

#file_systemTypes::FileSystem

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

Returns:

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

    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.

#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.

    Possible values:

    • AVAILABLE
    • CREATING
    • TRANSFERRING
    • DELETED
    • FAILED

Returns:

  • (String)

    The lifecycle status of the backup.

#progress_percentInteger

The current percent of progress of an asynchronous task.

Returns:

  • (Integer)

    The current percent of progress of an asynchronous task.

    .

#resource_arnString

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

Returns:

  • (String)

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

#tagsArray<Types::Tag>

Tags associated with a particular file system.

Returns:

  • (Array<Types::Tag>)

    Tags associated with a particular file system.

#typeString

The type of the file system backup.

Possible values:

  • AUTOMATIC
  • USER_INITIATED

Returns:

  • (String)

    The type of the file system backup.