Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateBackup

Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

A Persistent deployment type
Are not linked to a data repository

For more information about backups, see the following:

For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS 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 with the 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, CreateBackup 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 CreateBackup 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 CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Request Syntax


{
   "ClientRequestToken": "string",
   "FileSystemId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VolumeId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

(Optional) A string of up to 63 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.

Type: String

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

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

FileSystemId

The ID of the file system to back up.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 21.

Pattern: ^(fs-[0-9a-f]{8,})$

Required: No

Tags

(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 CreateBackup operation, no existing file system tags are copied from the file system to the backup.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

VolumeId

(Optional) The ID of the FSx for ONTAP volume to back up.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

Required: No

Response Syntax


{
   "Backup": { 
      "BackupId": "string",
      "CreationTime": number,
      "DirectoryInformation": { 
         "ActiveDirectoryId": "string",
         "DomainName": "string",
         "ResourceARN": "string"
      },
      "FailureDetails": { 
         "Message": "string"
      },
      "FileSystem": { 
         "AdministrativeActions": [ 
            { 
               "AdministrativeActionType": "string",
               "FailureDetails": { 
                  "Message": "string"
               },
               "ProgressPercent": number,
               "RemainingTransferBytes": number,
               "RequestTime": number,
               "Status": "string",
               "TargetFileSystemValues": "FileSystem",
               "TargetSnapshotValues": { 
                  "AdministrativeActions": [ 
                     "AdministrativeAction"
                  ],
                  "CreationTime": number,
                  "Lifecycle": "string",
                  "LifecycleTransitionReason": { 
                     "Message": "string"
                  },
                  "Name": "string",
                  "ResourceARN": "string",
                  "SnapshotId": "string",
                  "Tags": [ 
                     { 
                        "Key": "string",
                        "Value": "string"
                     }
                  ],
                  "VolumeId": "string"
               },
               "TargetVolumeValues": { 
                  "AdministrativeActions": [ 
                     "AdministrativeAction"
                  ],
                  "CreationTime": number,
                  "FileSystemId": "string",
                  "Lifecycle": "string",
                  "LifecycleTransitionReason": { 
                     "Message": "string"
                  },
                  "Name": "string",
                  "OntapConfiguration": { 
                     "AggregateConfiguration": { 
                        "Aggregates": [ "string" ],
                        "TotalConstituents": number
                     },
                     "CopyTagsToBackups": boolean,
                     "FlexCacheEndpointType": "string",
                     "JunctionPath": "string",
                     "OntapVolumeType": "string",
                     "SecurityStyle": "string",
                     "SizeInBytes": number,
                     "SizeInMegabytes": number,
                     "SnaplockConfiguration": { 
                        "AuditLogVolume": boolean,
                        "AutocommitPeriod": { 
                           "Type": "string",
                           "Value": number
                        },
                        "PrivilegedDelete": "string",
                        "RetentionPeriod": { 
                           "DefaultRetention": { 
                              "Type": "string",
                              "Value": number
                           },
                           "MaximumRetention": { 
                              "Type": "string",
                              "Value": number
                           },
                           "MinimumRetention": { 
                              "Type": "string",
                              "Value": number
                           }
                        },
                        "SnaplockType": "string",
                        "VolumeAppendModeEnabled": boolean
                     },
                     "SnapshotPolicy": "string",
                     "StorageEfficiencyEnabled": boolean,
                     "StorageVirtualMachineId": "string",
                     "StorageVirtualMachineRoot": boolean,
                     "TieringPolicy": { 
                        "CoolingPeriod": number,
                        "Name": "string"
                     },
                     "UUID": "string",
                     "VolumeStyle": "string"
                  },
                  "OpenZFSConfiguration": { 
                     "CopyStrategy": "string",
                     "CopyTagsToSnapshots": boolean,
                     "DataCompressionType": "string",
                     "DeleteClonedVolumes": boolean,
                     "DeleteIntermediateData": boolean,
                     "DeleteIntermediateSnaphots": boolean,
                     "DestinationSnapshot": "string",
                     "NfsExports": [ 
                        { 
                           "ClientConfigurations": [ 
                              { 
                                 "Clients": "string",
                                 "Options": [ "string" ]
                              }
                           ]
                        }
                     ],
                     "OriginSnapshot": { 
                        "CopyStrategy": "string",
                        "SnapshotARN": "string"
                     },
                     "ParentVolumeId": "string",
                     "ReadOnly": boolean,
                     "RecordSizeKiB": number,
                     "RestoreToSnapshot": "string",
                     "SourceSnapshotARN": "string",
                     "StorageCapacityQuotaGiB": number,
                     "StorageCapacityReservationGiB": number,
                     "UserAndGroupQuotas": [ 
                        { 
                           "Id": number,
                           "StorageCapacityQuotaGiB": number,
                           "Type": "string"
                        }
                     ],
                     "VolumePath": "string"
                  },
                  "ResourceARN": "string",
                  "Tags": [ 
                     { 
                        "Key": "string",
                        "Value": "string"
                     }
                  ],
                  "VolumeId": "string",
                  "VolumeType": "string"
               },
               "TotalTransferBytes": number
            }
         ],
         "CreationTime": number,
         "DNSName": "string",
         "FailureDetails": { 
            "Message": "string"
         },
         "FileSystemId": "string",
         "FileSystemType": "string",
         "FileSystemTypeVersion": "string",
         "KmsKeyId": "string",
         "Lifecycle": "string",
         "LustreConfiguration": { 
            "AutomaticBackupRetentionDays": number,
            "CopyTagsToBackups": boolean,
            "DailyAutomaticBackupStartTime": "string",
            "DataCompressionType": "string",
            "DataRepositoryConfiguration": { 
               "AutoImportPolicy": "string",
               "ExportPath": "string",
               "FailureDetails": { 
                  "Message": "string"
               },
               "ImportedFileChunkSize": number,
               "ImportPath": "string",
               "Lifecycle": "string"
            },
            "DeploymentType": "string",
            "DriveCacheType": "string",
            "LogConfiguration": { 
               "Destination": "string",
               "Level": "string"
            },
            "MountName": "string",
            "PerUnitStorageThroughput": number,
            "RootSquashConfiguration": { 
               "NoSquashNids": [ "string" ],
               "RootSquash": "string"
            },
            "WeeklyMaintenanceStartTime": "string"
         },
         "NetworkInterfaceIds": [ "string" ],
         "OntapConfiguration": { 
            "AutomaticBackupRetentionDays": number,
            "DailyAutomaticBackupStartTime": "string",
            "DeploymentType": "string",
            "DiskIopsConfiguration": { 
               "Iops": number,
               "Mode": "string"
            },
            "EndpointIpAddressRange": "string",
            "Endpoints": { 
               "Intercluster": { 
                  "DNSName": "string",
                  "IpAddresses": [ "string" ]
               },
               "Management": { 
                  "DNSName": "string",
                  "IpAddresses": [ "string" ]
               }
            },
            "FsxAdminPassword": "string",
            "HAPairs": number,
            "PreferredSubnetId": "string",
            "RouteTableIds": [ "string" ],
            "ThroughputCapacity": number,
            "ThroughputCapacityPerHAPair": number,
            "WeeklyMaintenanceStartTime": "string"
         },
         "OpenZFSConfiguration": { 
            "AutomaticBackupRetentionDays": number,
            "CopyTagsToBackups": boolean,
            "CopyTagsToVolumes": boolean,
            "DailyAutomaticBackupStartTime": "string",
            "DeploymentType": "string",
            "DiskIopsConfiguration": { 
               "Iops": number,
               "Mode": "string"
            },
            "EndpointIpAddress": "string",
            "EndpointIpAddressRange": "string",
            "PreferredSubnetId": "string",
            "RootVolumeId": "string",
            "RouteTableIds": [ "string" ],
            "ThroughputCapacity": number,
            "WeeklyMaintenanceStartTime": "string"
         },
         "OwnerId": "string",
         "ResourceARN": "string",
         "StorageCapacity": number,
         "StorageType": "string",
         "SubnetIds": [ "string" ],
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "VpcId": "string",
         "WindowsConfiguration": { 
            "ActiveDirectoryId": "string",
            "Aliases": [ 
               { 
                  "Lifecycle": "string",
                  "Name": "string"
               }
            ],
            "AuditLogConfiguration": { 
               "AuditLogDestination": "string",
               "FileAccessAuditLogLevel": "string",
               "FileShareAccessAuditLogLevel": "string"
            },
            "AutomaticBackupRetentionDays": number,
            "CopyTagsToBackups": boolean,
            "DailyAutomaticBackupStartTime": "string",
            "DeploymentType": "string",
            "DiskIopsConfiguration": { 
               "Iops": number,
               "Mode": "string"
            },
            "MaintenanceOperationsInProgress": [ "string" ],
            "PreferredFileServerIp": "string",
            "PreferredSubnetId": "string",
            "RemoteAdministrationEndpoint": "string",
            "SelfManagedActiveDirectoryConfiguration": { 
               "DnsIps": [ "string" ],
               "DomainName": "string",
               "FileSystemAdministratorsGroup": "string",
               "OrganizationalUnitDistinguishedName": "string",
               "UserName": "string"
            },
            "ThroughputCapacity": number,
            "WeeklyMaintenanceStartTime": "string"
         }
      },
      "KmsKeyId": "string",
      "Lifecycle": "string",
      "OwnerId": "string",
      "ProgressPercent": number,
      "ResourceARN": "string",
      "ResourceType": "string",
      "SourceBackupId": "string",
      "SourceBackupRegion": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string",
      "Volume": { 
         "AdministrativeActions": [ 
            { 
               "AdministrativeActionType": "string",
               "FailureDetails": { 
                  "Message": "string"
               },
               "ProgressPercent": number,
               "RemainingTransferBytes": number,
               "RequestTime": number,
               "Status": "string",
               "TargetFileSystemValues": { 
                  "AdministrativeActions": [ 
                     "AdministrativeAction"
                  ],
                  "CreationTime": number,
                  "DNSName": "string",
                  "FailureDetails": { 
                     "Message": "string"
                  },
                  "FileSystemId": "string",
                  "FileSystemType": "string",
                  "FileSystemTypeVersion": "string",
                  "KmsKeyId": "string",
                  "Lifecycle": "string",
                  "LustreConfiguration": { 
                     "AutomaticBackupRetentionDays": number,
                     "CopyTagsToBackups": boolean,
                     "DailyAutomaticBackupStartTime": "string",
                     "DataCompressionType": "string",
                     "DataRepositoryConfiguration": { 
                        "AutoImportPolicy": "string",
                        "ExportPath": "string",
                        "FailureDetails": { 
                           "Message": "string"
                        },
                        "ImportedFileChunkSize": number,
                        "ImportPath": "string",
                        "Lifecycle": "string"
                     },
                     "DeploymentType": "string",
                     "DriveCacheType": "string",
                     "LogConfiguration": { 
                        "Destination": "string",
                        "Level": "string"
                     },
                     "MountName": "string",
                     "PerUnitStorageThroughput": number,
                     "RootSquashConfiguration": { 
                        "NoSquashNids": [ "string" ],
                        "RootSquash": "string"
                     },
                     "WeeklyMaintenanceStartTime": "string"
                  },
                  "NetworkInterfaceIds": [ "string" ],
                  "OntapConfiguration": { 
                     "AutomaticBackupRetentionDays": number,
                     "DailyAutomaticBackupStartTime": "string",
                     "DeploymentType": "string",
                     "DiskIopsConfiguration": { 
                        "Iops": number,
                        "Mode": "string"
                     },
                     "EndpointIpAddressRange": "string",
                     "Endpoints": { 
                        "Intercluster": { 
                           "DNSName": "string",
                           "IpAddresses": [ "string" ]
                        },
                        "Management": { 
                           "DNSName": "string",
                           "IpAddresses": [ "string" ]
                        }
                     },
                     "FsxAdminPassword": "string",
                     "HAPairs": number,
                     "PreferredSubnetId": "string",
                     "RouteTableIds": [ "string" ],
                     "ThroughputCapacity": number,
                     "ThroughputCapacityPerHAPair": number,
                     "WeeklyMaintenanceStartTime": "string"
                  },
                  "OpenZFSConfiguration": { 
                     "AutomaticBackupRetentionDays": number,
                     "CopyTagsToBackups": boolean,
                     "CopyTagsToVolumes": boolean,
                     "DailyAutomaticBackupStartTime": "string",
                     "DeploymentType": "string",
                     "DiskIopsConfiguration": { 
                        "Iops": number,
                        "Mode": "string"
                     },
                     "EndpointIpAddress": "string",
                     "EndpointIpAddressRange": "string",
                     "PreferredSubnetId": "string",
                     "RootVolumeId": "string",
                     "RouteTableIds": [ "string" ],
                     "ThroughputCapacity": number,
                     "WeeklyMaintenanceStartTime": "string"
                  },
                  "OwnerId": "string",
                  "ResourceARN": "string",
                  "StorageCapacity": number,
                  "StorageType": "string",
                  "SubnetIds": [ "string" ],
                  "Tags": [ 
                     { 
                        "Key": "string",
                        "Value": "string"
                     }
                  ],
                  "VpcId": "string",
                  "WindowsConfiguration": { 
                     "ActiveDirectoryId": "string",
                     "Aliases": [ 
                        { 
                           "Lifecycle": "string",
                           "Name": "string"
                        }
                     ],
                     "AuditLogConfiguration": { 
                        "AuditLogDestination": "string",
                        "FileAccessAuditLogLevel": "string",
                        "FileShareAccessAuditLogLevel": "string"
                     },
                     "AutomaticBackupRetentionDays": number,
                     "CopyTagsToBackups": boolean,
                     "DailyAutomaticBackupStartTime": "string",
                     "DeploymentType": "string",
                     "DiskIopsConfiguration": { 
                        "Iops": number,
                        "Mode": "string"
                     },
                     "MaintenanceOperationsInProgress": [ "string" ],
                     "PreferredFileServerIp": "string",
                     "PreferredSubnetId": "string",
                     "RemoteAdministrationEndpoint": "string",
                     "SelfManagedActiveDirectoryConfiguration": { 
                        "DnsIps": [ "string" ],
                        "DomainName": "string",
                        "FileSystemAdministratorsGroup": "string",
                        "OrganizationalUnitDistinguishedName": "string",
                        "UserName": "string"
                     },
                     "ThroughputCapacity": number,
                     "WeeklyMaintenanceStartTime": "string"
                  }
               },
               "TargetSnapshotValues": { 
                  "AdministrativeActions": [ 
                     "AdministrativeAction"
                  ],
                  "CreationTime": number,
                  "Lifecycle": "string",
                  "LifecycleTransitionReason": { 
                     "Message": "string"
                  },
                  "Name": "string",
                  "ResourceARN": "string",
                  "SnapshotId": "string",
                  "Tags": [ 
                     { 
                        "Key": "string",
                        "Value": "string"
                     }
                  ],
                  "VolumeId": "string"
               },
               "TargetVolumeValues": "Volume",
               "TotalTransferBytes": number
            }
         ],
         "CreationTime": number,
         "FileSystemId": "string",
         "Lifecycle": "string",
         "LifecycleTransitionReason": { 
            "Message": "string"
         },
         "Name": "string",
         "OntapConfiguration": { 
            "AggregateConfiguration": { 
               "Aggregates": [ "string" ],
               "TotalConstituents": number
            },
            "CopyTagsToBackups": boolean,
            "FlexCacheEndpointType": "string",
            "JunctionPath": "string",
            "OntapVolumeType": "string",
            "SecurityStyle": "string",
            "SizeInBytes": number,
            "SizeInMegabytes": number,
            "SnaplockConfiguration": { 
               "AuditLogVolume": boolean,
               "AutocommitPeriod": { 
                  "Type": "string",
                  "Value": number
               },
               "PrivilegedDelete": "string",
               "RetentionPeriod": { 
                  "DefaultRetention": { 
                     "Type": "string",
                     "Value": number
                  },
                  "MaximumRetention": { 
                     "Type": "string",
                     "Value": number
                  },
                  "MinimumRetention": { 
                     "Type": "string",
                     "Value": number
                  }
               },
               "SnaplockType": "string",
               "VolumeAppendModeEnabled": boolean
            },
            "SnapshotPolicy": "string",
            "StorageEfficiencyEnabled": boolean,
            "StorageVirtualMachineId": "string",
            "StorageVirtualMachineRoot": boolean,
            "TieringPolicy": { 
               "CoolingPeriod": number,
               "Name": "string"
            },
            "UUID": "string",
            "VolumeStyle": "string"
         },
         "OpenZFSConfiguration": { 
            "CopyStrategy": "string",
            "CopyTagsToSnapshots": boolean,
            "DataCompressionType": "string",
            "DeleteClonedVolumes": boolean,
            "DeleteIntermediateData": boolean,
            "DeleteIntermediateSnaphots": boolean,
            "DestinationSnapshot": "string",
            "NfsExports": [ 
               { 
                  "ClientConfigurations": [ 
                     { 
                        "Clients": "string",
                        "Options": [ "string" ]
                     }
                  ]
               }
            ],
            "OriginSnapshot": { 
               "CopyStrategy": "string",
               "SnapshotARN": "string"
            },
            "ParentVolumeId": "string",
            "ReadOnly": boolean,
            "RecordSizeKiB": number,
            "RestoreToSnapshot": "string",
            "SourceSnapshotARN": "string",
            "StorageCapacityQuotaGiB": number,
            "StorageCapacityReservationGiB": number,
            "UserAndGroupQuotas": [ 
               { 
                  "Id": number,
                  "StorageCapacityQuotaGiB": number,
                  "Type": "string"
               }
            ],
            "VolumePath": "string"
         },
         "ResourceARN": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "VolumeId": "string",
         "VolumeType": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Backup

A description of the backup.

Type: Backup object

Errors

For information about the errors that are common to all actions, see Common Errors.

BackupInProgress

Another backup is already under way. Wait for completion before initiating additional backups of this file system.

HTTP Status Code: 400

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

FileSystemNotFound

No Amazon FSx file systems were found based upon supplied parameters.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

ServiceLimitExceeded

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

HTTP Status Code: 400

UnsupportedOperation

The requested operation is not supported for this resource or API.

HTTP Status Code: 400

VolumeNotFound

No Amazon FSx volumes were found based upon the supplied parameters.

HTTP Status Code: 400