Struct aws_sdk_fsx::client::fluent_builders::CreateBackup

pub struct CreateBackup<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateBackup.

Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to 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 with the following configuration:

• a Persistent deployment type

• is 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.

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.

Implementations

impl<C, M, R> CreateBackup<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateBackupOutput, SdkError<CreateBackupError>> where
    R::Policy: SmithyRetryPolicy<CreateBackupInputOperationOutputAlias, CreateBackupOutput, CreateBackupError, CreateBackupInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn file_system_id(self, inp: impl Into<String>) -> Self

The ID of the file system to back up.

pub fn set_file_system_id(self, input: Option<String>) -> Self

The ID of the file system to back up.

pub fn client_request_token(self, inp: impl Into<String>) -> Self

(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 Command Line Interface (CLI) or an Amazon Web Services SDK.

pub fn set_client_request_token(self, input: Option<String>) -> Self

(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 Command Line Interface (CLI) or an Amazon Web Services SDK.

pub fn tags(self, inp: impl Into<Tag>) -> Self

Appends an item to Tags.

To override the contents of this collection use set_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 action, no existing file system tags are copied from the file system to the backup.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

pub fn volume_id(self, inp: impl Into<String>) -> Self

The ID of he FSx for NetApp ONTAP volume to back up.

pub fn set_volume_id(self, input: Option<String>) -> Self

The ID of he FSx for NetApp ONTAP volume to back up.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateBackup<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.