paws.storage (version 0.1.9)

fsx_create_backup: Creates a backup of an existing Amazon FSx file system

Description

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.

Usage

fsx_create_backup(FileSystemId, ClientRequestToken, Tags)

Arguments

FileSystemId

[required] The ID of the file system to back up.

ClientRequestToken

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.

Tags

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

Request syntax

svc$create_backup(
  FileSystemId = "string",
  ClientRequestToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Details

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 an Amazon S3 data respository.

For more information, see https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-backups.html.

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, 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.

Examples

# NOT RUN {
# This operation creates a new backup.
svc$create_backup(
  FileSystemId = "fs-0498eed5fe91001ec",
  Tags = list(
    list(
      Key = "Name",
      Value = "MyBackup"
    )
  )
)
# }
# NOT RUN {
# }