Backup - Amazon FSx

Backup

A backup of an Amazon FSx for 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

DirectoryInformation

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

Type: ActiveDirectoryBackupAttributes object

Required: No

FailureDetails

Details explaining any failures that occur when creating a backup.

Type: BackupFailureDetails object

Required: No

FileSystem

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

KmsKeyId

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup of the Amazon FSx for Windows file system's data at rest. Amazon FSx for Lustre does not support KMS encryption.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^.{1,2048}$

Required: No

Lifecycle

The lifecycle status of the backup.

Type: String

Valid Values: AVAILABLE | CREATING | DELETED | FAILED

Required: Yes

ProgressPercent

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

Tags

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

Type

The type of the file system backup.

Type: String

Valid Values: AUTOMATIC | USER_INITIATED

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: