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

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 file system. You can create a new file system from a backup to protect against data loss.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_idString

The ID of the backup.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#creation_timeTime

The time when a particular backup was created.

Returns:

  • (Time)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#failure_detailsTypes::BackupFailureDetails

Details explaining any failures that occur when creating a backup.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#kms_key_idString

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#lifecycleString

The lifecycle status of the backup.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#progress_percentInteger

The current percent of progress of an asynchronous task.

Returns:

  • (Integer)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#resource_arnString

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

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags associated with a particular file system.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end

#typeString

The type of the backup.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 106

class Backup < Struct.new(
  :backup_id,
  :lifecycle,
  :failure_details,
  :type,
  :progress_percent,
  :creation_time,
  :kms_key_id,
  :resource_arn,
  :tags,
  :file_system,
  :directory_information)
  include Aws::Structure
end