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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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

• #failure_details ⇒ Types::BackupFailureDetails

  Details explaining any failures that occurred when creating a backup.

• #file_system ⇒ Types::FileSystem

  The metadata of the file system associated with the backup.

• #kms_key_id ⇒ String

  The ID of the Key Management Service (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.

• #owner_id ⇒ String

  An Amazon Web Services account ID.

• #progress_percent ⇒ Integer

  Displays the current percent of progress of an asynchronous task.

• #resource_arn ⇒ String

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

• #resource_type ⇒ String

  Specifies the resource type that’s backed up.

• #size_in_bytes ⇒ Integer

  The size of the backup in bytes.

• #source_backup_id ⇒ String

  The ID of the source backup.

• #source_backup_region ⇒ String

  The source Region of the backup.

• #tags ⇒ Array<Types::Tag>

  The tags associated with a particular file system.

• #type ⇒ String

  The type of the file-system backup.

• #volume ⇒ Types::Volume

  Describes an Amazon FSx volume.

Instance Attribute Details

#backup_id ⇒ String

The ID of the backup.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time when a particular backup was created.

Returns:

• (Time)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#directory_information ⇒ Types::ActiveDirectoryBackupAttributes

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

Returns:

• (Types::ActiveDirectoryBackupAttributes)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#failure_details ⇒ Types::BackupFailureDetails

Details explaining any failures that occurred when creating a backup.

Returns:

• (Types::BackupFailureDetails)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#file_system ⇒ Types::FileSystem

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

Returns:

• (Types::FileSystem)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle ⇒ String

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)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

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)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#progress_percent ⇒ Integer

Displays the current percent of progress of an asynchronous task.

Returns:

• (Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

Specifies the resource type that’s backed up.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_bytes ⇒ Integer

The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.

Returns:

• (Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_region ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags associated with a particular file system.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the file-system backup.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end

#volume ⇒ Types::Volume

Describes an Amazon FSx volume.

Returns:

• (Types::Volume)

# File 'lib/aws-sdk-fsx/types.rb', line 662

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,
  :size_in_bytes)
  SENSITIVE = []
  include Aws::Structure
end