Backup
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.
Contents
- BackupId
-
The ID of the backup.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 128.
Pattern:
^(backup-[0-9a-f]{8,})$Required: Yes
- CreationTime
-
The time when a particular backup was created.
Type: Timestamp
Required: Yes
- FileSystem
-
The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
Type: FileSystem object
Required: Yes
- Lifecycle
-
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.
Type: String
Valid Values:
AVAILABLE | CREATING | TRANSFERRING | DELETED | FAILED | PENDING | COPYINGRequired: Yes
-
- Type
-
The type of the file-system backup.
Type: String
Valid Values:
AUTOMATIC | USER_INITIATED | AWS_BACKUPRequired: Yes
- DirectoryInformation
-
The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
Type: ActiveDirectoryBackupAttributes object
Required: No
- FailureDetails
-
Details explaining any failures that occurred when creating a backup.
Type: BackupFailureDetails object
Required: No
- KmsKeyId
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^.{1,2048}$Required: No
- OwnerId
-
An AWS account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^\d{12}$Required: No
- ProgressPercent
-
Displays the current percent of progress of an asynchronous task.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- ResourceARN
-
The Amazon Resource Name (ARN) for the backup resource.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 512.
Pattern:
^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(?<!-)):){4}(?!/).{0,1024}$Required: No
- ResourceType
-
Specifies the resource type that's backed up.
Type: String
Valid Values:
FILE_SYSTEM | VOLUMERequired: No
- SizeInBytes
-
The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.
Type: Long
Valid Range: Minimum value of 0.
Required: No
- SourceBackupId
-
The ID of the source backup. Specifies the backup that you are copying.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 128.
Pattern:
^(backup-[0-9a-f]{8,})$Required: No
- SourceBackupRegion
-
The source Region of the backup. Specifies the Region from where this backup is copied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
^[a-z0-9-]{1,20}$Required: No
- Tags
-
The tags associated with a particular file system.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- Volume
-
Describes an Amazon FSx volume.
Type: Volume object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
