Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data respository.
For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups.
For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows backups.
If a backup with the specified client request token exists, and the
parameters match, this operation returns the description of the existing
backup. If a backup specified client request token exists, and the
parameters don't match, this operation returns
IncompatibleParameterError. If a backup with the specified client
request token doesn't exist, create_backup does
the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial
lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a
create_backup operation without the risk of
creating an extra backup. This approach can be useful when an initial
call fails in a way that makes it unclear whether a backup was created.
If you use the same client request token and the initial call created a
backup, the operation returns a successful result because all the
parameters are the same.
The create_backup operation returns while the
backup's lifecycle state is still CREATING. You can check the backup
creation status by calling the
describe_backups operation, which returns the
backup state along with other information.
fsx_create_backup(FileSystemId, ClientRequestToken, Tags)A list with the following syntax:
list(
Backup = list(
BackupId = "string",
Lifecycle = "AVAILABLE"|"CREATING"|"TRANSFERRING"|"DELETED"|"FAILED"|"PENDING",
FailureDetails = list(
Message = "string"
),
Type = "AUTOMATIC"|"USER_INITIATED"|"AWS_BACKUP",
ProgressPercent = 123,
CreationTime = as.POSIXct(
"2015-01-01"
),
KmsKeyId = "string",
ResourceARN = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
FileSystem = list(
OwnerId = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
FileSystemId = "string",
FileSystemType = "WINDOWS"|"LUSTRE",
Lifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING",
FailureDetails = list(
Message = "string"
),
StorageCapacity = 123,
StorageType = "SSD"|"HDD",
VpcId = "string",
SubnetIds = list(
"string"
),
NetworkInterfaceIds = list(
"string"
),
DNSName = "string",
KmsKeyId = "string",
ResourceARN = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
WindowsConfiguration = list(
ActiveDirectoryId = "string",
SelfManagedActiveDirectoryConfiguration = list(
DomainName = "string",
OrganizationalUnitDistinguishedName = "string",
FileSystemAdministratorsGroup = "string",
UserName = "string",
DnsIps = list(
"string"
)
),
DeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2",
RemoteAdministrationEndpoint = "string",
PreferredSubnetId = "string",
PreferredFileServerIp = "string",
ThroughputCapacity = 123,
MaintenanceOperationsInProgress = list(
"PATCHING"|"BACKING_UP"
),
WeeklyMaintenanceStartTime = "string",
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = TRUE|FALSE,
Aliases = list(
list(
Name = "string",
Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"
)
)
),
LustreConfiguration = list(
WeeklyMaintenanceStartTime = "string",
DataRepositoryConfiguration = list(
Lifecycle = "CREATING"|"AVAILABLE"|"MISCONFIGURED"|"UPDATING"|"DELETING",
ImportPath = "string",
ExportPath = "string",
ImportedFileChunkSize = 123,
AutoImportPolicy = "NONE"|"NEW"|"NEW_CHANGED",
FailureDetails = list(
Message = "string"
)
),
DeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1",
PerUnitStorageThroughput = 123,
MountName = "string",
DailyAutomaticBackupStartTime = "string",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = TRUE|FALSE,
DriveCacheType = "NONE"|"READ"
),
AdministrativeActions = list(
list(
AdministrativeActionType = "FILE_SYSTEM_UPDATE"|"STORAGE_OPTIMIZATION"|"FILE_SYSTEM_ALIAS_ASSOCIATION"|"FILE_SYSTEM_ALIAS_DISASSOCIATION",
ProgressPercent = 123,
RequestTime = as.POSIXct(
"2015-01-01"
),
Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING",
TargetFileSystemValues = list(),
FailureDetails = list(
Message = "string"
)
)
)
),
DirectoryInformation = list(
DomainName = "string",
ActiveDirectoryId = "string"
)
)
)
[required] The ID of the file system to back up.
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
(Optional) The tags to apply to the backup at backup creation. The key
value of the Name tag appears in the console as the backup name. If
you have set CopyTagsToBackups to true, and you specify one or more
tags using the create_backup action, no existing
file system tags are copied from the file system to the backup.
svc$create_backup(
FileSystemId = "string",
ClientRequestToken = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
if (FALSE) {
# This operation creates a new backup.
svc$create_backup(
FileSystemId = "fs-0498eed5fe91001ec",
Tags = list(
list(
Key = "Name",
Value = "MyBackup"
)
)
)
}
Run the code above in your browser using DataLab